spring-aop(一)快速上手

最新推荐文章于 2022-01-13 23:27:38 发布

weixin_奢望

最新推荐文章于 2022-01-13 23:27:38 发布

阅读量156

点赞数

分类专栏： SSM

本文链接：https://blog.csdn.net/weixin_44523741/article/details/96428232

版权

SSM 专栏收录该内容

11 篇文章 0 订阅

订阅专栏

重要内容：

基于xml形式的spring-aop
基于注解形式的spring-aop
纯注解的形式

简介

springaop是为了简化使用动态代理环绕增强某个方法而在配置文件中导致的IOC和DI配置过于臃肿

比如我们定义一个类，这个类里有三个方法，我们怎么在调用方法前都先执行一条输出语句呢？很简单通过动态代理就能实现，但是我们怎么通过spring-aop配置文件的写法来达成我们的目的呢？

这是我们要增强的类，全文都会使用到

@Component
public class honshitImpl implements Honshit {
    @Override
    public void fuqian() {
        System.out.println("man can fuqian");
    }

    @Override
    public void shouqian() {
        System.out.println("man canshouqian");
    }
}

这是我们的通知类，用来增强我们的通知类方法，可用于前置通知可和后置通知

@Component
public class Logger  {
    

    @Override
    public void before(Method method, Object[] args, Object target) throws Throwable {
        System.out.println("Logger类中的pringLog方法开始记录日志了。。。");
    }


}

基于配置文件形式的spring-aop：

来看我们的配置文件如何编写的：

     <!--写法一-->
     spring中基于XML的AOP配置步骤
    1、把通知Bean也交给spring来管理
    2、使用aop:config标签表明开始AOP的配置
    3、使用aop:aspect标签表明配置切面
            id属性：是给切面提供一个唯一标识
            ref属性：是指定通知类bean的Id。
    4、在aop:aspect标签的内部使用对应标签来配置通知的类型
           我们现在示例是让printLog方法在切入点方法执行之前之前：所以是前置通知
           aop:before：表示配置前置通知
                method属性：用于指定Logger类中哪个方法是前置通知
                pointcut属性：用于指定切入点表达式，该表达式的含义指的是对业务层中哪些方法增强

    切入点表达式的写法：
     关键字：execution(表达式)
      ⑴表达式：
          访问修饰符  返回值  包名.包名.包名...类名.方法名(参数列表)
      ⑵标准的表达式写法：
          public void com.itheima.service.impl.AccountServiceImpl.saveAccount()
      ⑶访问修饰符可以省略
          void com.itheima.service.impl.AccountServiceImpl.saveAccount()
      ⑷返回值可以使用通配符，表示任意返回值
          * com.itheima.service.impl.AccountServiceImpl.saveAccount()
      ⑸包名可以使用通配符，表示任意包。但是有几级包，就需要写几个*.
          * *.*.*.*.AccountServiceImpl.saveAccount())
      ⑹包名可以使用..表示当前包及其子包
          * *..AccountServiceImpl.saveAccount()
      ⑺类名和方法名都可以使用*来实现通配
          * *..*.*() 表示任意访问权限、任意包及其子包的任意类的任意方法。
      参数列表：
          可以直接写数据类型：
              基本类型直接写名称           int
              引用类型写包名.类名的方式   java.lang.String
          可以使用通配符表示任意类型，但是必须有参数
          可以使用..表示有无参数均可，有参数可以是任意类型
      ⑻全通配写法：
          * *..*.*(..)
         
      实际开发中切入点表达式的通常写法：
          切到业务层实现类下的所有方法
              * com.itheima.service.impl.*.*(..)
       (9)还有一种写法： expression="bean(honshitImpl) ：代表honshitImpl对象中的每一个方法前后都是要增强的切点位置
     <!--写法二-->
    1、把通知Bean也交给spring来管理
    2、使用aop:config标签表明开始AOP的配置
    3、使用aop:pointcut标签表明给哪个bean配置切面
    4、使用aop:advice 表面用哪个类给切点增强 

  -->

写法一小案例：

这是配置文件：

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:aop="http://www.springframework.org/schema/aop"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
       http://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/context
         http://www.springframework.org/schema/context/spring-context.xsd
         http://www.springframework.org/schema/aop
         http://www.springframework.org/schema/aop/spring-aop.xsd">

    <!--扫描包 把切入点和增强类都引入-->
    <context:component-scan base-package="com.itszt"></context:component-scan>

<aop:config>
    <!--
        描述了一个切点，这个切点的id是pointcut1，将来通过id来引用这个切点
        切点位置：aspectJ表达来描述，bean(honshitImpl) 代表honshitImpl对象中的每一个方法前后都是要增强的切点位置
     -->
     <aop:pointcut id="pointcut1" expression="bean(honshitImpl)"></aop:pointcut>


     <!--
     写法一：配切面：直接引入类，aop会根据类实现的接口来帮你判断是前置还是后置
     -->
     <aop:advisor advice-ref="logger" pointcut-ref="pointcut1"></aop:advisor>
     <aop:advisor advice-ref="logger2" pointcut-ref="pointcut1"></aop:advisor>
 </aop:config>

</beans>

我们来看一下logger类

//这是实现了前置接口
@Component
public class Logger implements MethodBeforeAdvice {

    @Override
    public void before(Method method, Object[] args, Object target) throws Throwable {
        System.out.println("Logger类中的pringLog方法开始记录日志了。。。");
    }
}

//这是实现了后置接口
@Component
public class Logger2 implements AfterReturningAdvice {
    @Override
    public void afterReturning(Object returnValue, Method method, Object[] args, Object target) throws Throwable {
        System.out.println("日志记录结束");
    }
}

我们来测试一下：

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration("classpath:spring-config.xml")
public class Test1 {

    @Resource
    Honshit honshit;

    @Test
    public void test1(){

      honshit.fuqian();
      
    }

}

控制台结果：
在这里插入图片描述

写法二小案例

这是配置文件

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:aop="http://www.springframework.org/schema/aop"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
       http://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/context
         http://www.springframework.org/schema/context/spring-context.xsd
         http://www.springframework.org/schema/aop
         http://www.springframework.org/schema/aop/spring-aop.xsd">

    <!--扫描包 把切入点和增强类都引入-->
    <context:component-scan base-package="com.itszt"></context:component-scan>


   <aop:config>
       <!--
          描述了一个切点，这个切点的id是pointcut1，将来通过id来引用这个切点
          切点位置：aspectJ表达来描述，bean(honshitImpl) 代表honshitImpl对象中的每一个方法前后都是要增强的切点位置
       -->
       <aop:pointcut id="pointcut1" expression="bean(honshitImpl)"></aop:pointcut>


       <!--
       写法一：配切面：某个adivce 作用在某个pointcut
       -->
       <aop:advisor advice-ref="logger" pointcut-ref="pointcut1"></aop:advisor>
       <aop:advisor advice-ref="logger2" pointcut-ref="pointcut1"></aop:advisor>

       <!--
        写法二：
        -->

       <aop:aspect id="logAdvice" ref="logger">
           <!-- 配置通知的类型，并且建立通知方法和切入点方法的关联-->
           <aop:before method="前置" pointcut="bean(honshitImpl)"></aop:before>
       </aop:aspect>

       <aop:aspect id="logAdvice" ref="logger">
           <!-- 配置通知的类型，并且建立通知方法和切入点方法的关联-->
           <aop:after method="后置" pointcut="bean(honshitImpl)"></aop:after>
       </aop:aspect>
    </aop:config>

</beans>

看看我们的通知类：

@Component
public class Logger implements MethodBeforeAdvice {

  public void 前置(){
        System.out.println("Logger类中的pringLog方法真的要开始记录日志了");
  }

    public void 后置(){
        System.out.println("Logger类中的pringLog方法真的要记录结束了");
  }

    @Override
    public void before(Method method, Object[] args, Object target) throws Throwable {
        System.out.println("Logger类中的pringLog方法开始记录日志了。。。");
    }

}

编写一个测试类：

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration("classpath:spring-config.xml")
public class Test1 {

    @Resource
    Honshit honshit;
    @Test
    public void test1(){

      honshit.fuqian();
    }
}

控制台打印结果：
在这里插入图片描述

其他增强类的写法：

 <!--这是配置文件的编写-->
<?xml version="1.0" encoding="UTF-8"?>
<beans 这里是一些schema约束，请从官网查阅。。。

 <!-- 配置srping的Ioc,把service对象配置进来-->
 <bean id="accountService" class="com.itheima.service.impl.AccountServiceImpl"></bean>


 <!-- 配置Logger类 -->
 <bean id="logger" class="com.itheima.utils.Logger"></bean>

 <!--配置AOP-->
 <aop:config>
     <!-- 配置切入点表达式 id属性用于指定表达式的唯一标识。expression属性用于指定表达式内容
           此标签写在aop:aspect标签内部只能当前切面使用。
           它还可以写在aop:aspect外面，此时就变成了所有切面可用
       -->
     <aop:pointcut id="pt1" expression="execution(* com.itheima.service.impl.*.*(..))"></aop:pointcut>
  <!--配置切面 -->
   <aop:aspect id="logAdvice" ref="logger">
   <!-- 配置前置通知：在切入点方法执行之前执行-->
     <aop:before method="beforePrintLog" pointcut-ref="pt1" ></aop:before>

     <!-- 配置后置通知：在切入点方法正常执行之后值。它和异常通知永远只能执行一个-->
     <aop:after-returning method="afterReturningPrintLog" pointcut-ref="pt1"></aop:after-returning>

     <!-- 配置异常通知：在切入点方法执行产生异常之后执行。它和后置通知永远只能执行一个-->
     <aop:after-throwing method="afterThrowingPrintLog" pointcut-ref="pt1"></aop:after-throwing>

     <!-- 配置最终通知：无论切入点方法是否正常执行它都会在其后面执行-->
     <aop:after method="afterPrintLog" pointcut-ref="pt1"></aop:after>

   </aop:aspect>
 </aop:config>

</beans>

来看看我们的通知类发生了什么变化

public class Logger {
    //前置通知
    public  void beforePrintLog(){
        System.out.println("前置通知Logger类中的beforePrintLog方法开始记录日志了。。。");
    }
    //后置通知
    public  void afterReturningPrintLog(){
        System.out.println("后置通知Logger类中的afterReturningPrintLog方法开始记录日志了。。。");
    }
    //异常通知
    public  void afterThrowingPrintLog(){
        System.out.println("异常通知Logger类中的afterThrowingPrintLog方法开始记录日志了。。。");
    }

    //最终通知
    public  void afterPrintLog(){
        System.out.println("最终通知Logger类中的afterPrintLog方法开始记录日志了。。。");
    }

   
}

环绕通知

我们之前都是通过配置文件的形式来完成对切入点方法的增强，现在我们通过java代码的形式完成同样功能，spring框架把它称作环绕增强
步骤
1、在 <aop:aspect>中引入标签<aop:around>

<!--配置AOP-->
 <aop:config>
  <!-- 配置切入点表达式 id属性用于指定表达式的唯一标识。expression属性用于指定表达式内容
         此标签写在aop:aspect标签内部只能当前切面使用。
         它还可以写在aop:aspect外面，此时就变成了所有切面可用
     -->
   <aop:pointcut id="pt1" expression="execution(* com.itheima.service.impl.*.*(..))"></aop:pointcut>
   <!--配置切面 -->
   <aop:aspect id="logAdvice" ref="logger">
       <!-- 配置前置通知：在切入点方法执行之前执行
       <aop:before method="beforePrintLog" pointcut-ref="pt1" ></aop:before>-->

       <!-- 配置后置通知：在切入点方法正常执行之后值。它和异常通知永远只能执行一个
       <aop:after-returning method="afterReturningPrintLog" pointcut-ref="pt1"></aop:after-returning>-->

       <!-- 配置异常通知：在切入点方法执行产生异常之后执行。它和后置通知永远只能执行一个
       <aop:after-throwing method="afterThrowingPrintLog" pointcut-ref="pt1"></aop:after-throwing>-->

       <!-- 配置最终通知：无论切入点方法是否正常执行它都会在其后面执行
       <aop:after method="afterPrintLog" pointcut-ref="pt1"></aop:after>-->

       <!-- 配置环绕通知 详细的注释请看Logger类中-->
       <aop:around method="aroundPringLog" pointcut-ref="pt1"></aop:around>
   </aop:aspect>
 </aop:config>

2、在通知类编写环绕代码

	/**
	 * 环绕通知
	 * 问题：
	 *      当我们配置了环绕通知之后，切入点方法没有执行，而通知方法执行了。
	 * 分析：
	 *      通过对比动态代理中的环绕通知代码，发现动态代理的环绕通知有明确的切入点方法调用，而我们的代码中没有。
	 * 解决：
	 *      Spring框架为我们提供了一个接口：ProceedingJoinPoint。该接口有一个方法proceed()，此方法就相当于明确调用切入点方法。
	 *      该接口可以作为环绕通知的方法参数，在程序执行时，spring框架会为我们提供该接口的实现类供我们使用。直接使用就完事了。。
	 *
	 * spring中的环绕通知：
	 *      它是spring框架为我们提供的一种可以在代码中手动控制增强方法何时执行的方式。
	 */
 public class Logger {
 
   public Object aroundPringLog(ProceedingJoinPoint pjp){
   
Object rtValue = null;
	try{
	    Object[] args = pjp.getArgs();//得到方法执行所需的参数
	
	    System.out.println("Logger类中的aroundPringLog方法开始记录日志了。。。前置");
	
	    rtValue = pjp.proceed(args);//明确调用业务层方法（切入点方法）
	
	    System.out.println("Logger类中的aroundPringLog方法开始记录日志了。。。后置");

    return rtValue;
	}catch (Throwable t){
	    System.out.println("Logger类中的aroundPringLog方法开始记录日志了。。。异常");
	    throw new RuntimeException(t);
	}finally {
  	  System.out.println("Logger类中的aroundPringLog方法开始记录日志了。。。最终");
        }
    }
    
//测试类，为了方便写一起--------------------------------------------------

public class AOPTest {

  public static void main(String[] args) {
       //1.获取容器
       ApplicationContext ac = new ClassPathXmlApplicationContext("bean.xml");
       //2.获取对象
       IAccountService as = (IAccountService)ac.getBean("accountService");
       //3.执行方法
       as.saveAccount();
   }
}

为了简化配置写法，我们将使用基于注解形式的spring-aop

基于注解形式的spring-aop

步骤：
1、告知spring要扫描的包
2、配置spring开启注解AOP的支持

<!--配置文件：-->
<?xml version="1.0" encoding="UTF-8"?>
<beans 这里是一些schema约束，请从官网查阅。

    <!-- 配置spring创建容器时要扫描的包-->
    <context:component-scan base-package="com.itheima"></context:component-scan>

    <!-- 配置spring开启注解AOP的支持 -->
    <aop:aspectj-autoproxy></aop:aspectj-autoproxy>
</beans>

3、通知类添加注解@Aspect
4、引入切点方法，切点方法名作为默认id
5、在@Before、@AfterReturning、@AfterThrowing这些方法名填入切点方法，即完成了每次调用这个方法，则增强这个方法的写法。

//通知类--------------------------------------------------
@Component("logger")
@Aspect//表示当前类是一个切面类
public class Logger {

    @Pointcut("execution(* com.itheima.service.impl.*.*(..))")
    private void pt1(){}

    /**
     * 前置通知
     */
//    @Before("pt1()")
    public  void beforePrintLog(){
        System.out.println("前置通知Logger类中的beforePrintLog方法开始记录日志了。。。");
    }

    /**
     * 后置通知
     */
//    @AfterReturning("pt1()")
    public  void afterReturningPrintLog(){
        System.out.println("后置通知Logger类中的afterReturningPrintLog方法开始记录日志了。。。");
    }
    /**
     * 异常通知
     */
//    @AfterThrowing("pt1()")
    public  void afterThrowingPrintLog(){
        System.out.println("异常通知Logger类中的afterThrowingPrintLog方法开始记录日志了。。。");
    }

    /**
     * 最终通知
     */
//    @After("pt1()")
    public  void afterPrintLog(){
        System.out.println("最终通知Logger类中的afterPrintLog方法开始记录日志了。。。");
    }

    /**
     * 环绕通知
     * 问题：
     *      当我们配置了环绕通知之后，切入点方法没有执行，而通知方法执行了。
     * 分析：
     *      通过对比动态代理中的环绕通知代码，发现动态代理的环绕通知有明确的切入点方法调用，而我们的代码中没有。
     * 解决：
     *      Spring框架为我们提供了一个接口：ProceedingJoinPoint。该接口有一个方法proceed()，此方法就相当于明确调用切入点方法。
     *      该接口可以作为环绕通知的方法参数，在程序执行时，spring框架会为我们提供该接口的实现类供我们使用。
     *
     * spring中的环绕通知：
     *      它是spring框架为我们提供的一种可以在代码中手动控制增强方法何时执行的方式。
     */
    @Around("pt1()")
public Object aroundPringLog(ProceedingJoinPoint pjp){
  Object rtValue = null;
   try{
       Object[] args = pjp.getArgs();//得到方法执行所需的参数

       System.out.println("Logger类中的aroundPringLog方法开始记录日志了。。。前置");

       rtValue = pjp.proceed(args);//明确调用业务层方法（切入点方法）

       System.out.println("Logger类中的aroundPringLog方法开始记录日志了。。。后置");

       return rtValue;
   }catch (Throwable t){
       System.out.println("Logger类中的aroundPringLog方法开始记录日志了。。。异常");
       throw new RuntimeException(t);
   }finally {
       System.out.println("Logger类中的aroundPringLog方法开始记录日志了。。。最终");
    }
  }
}

//被代理类-------------------------------------------------为了便于查看，我们和通知类写在一起
@Service("accountService")
public class AccountServiceImpl implements IAccountService{

    @Override
    public void saveAccount() {
        System.out.println("执行了保存");
        int i=1/0;
    }
    @Override
    public void updateAccount(int i) {
        System.out.println("执行了更新"+i);
    }
    @Override
    public int deleteAccount() {
        System.out.println("执行了删除");
        return 0;
    }
}
//测试方法--------------------------------------------------依然写在一起
public class AOPTest {

    public static void main(String[] args) {
        //1.获取容器
        ApplicationContext ac = new ClassPathXmlApplicationContext("bean.xml");
        //2.获取对象
        IAccountService as = (IAccountService)ac.getBean("accountService");
        //3.执行方法
        as.saveAccount();
    }
}

纯注解的形式

@Configuration
@EnableTransactionManagement 
public class Logger{ 

}

只是添加一个注解就行了，这里就不演示了

weixin_奢望

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
spring-aop(一)快速上手

只提供代码自用简介springaop是为了简化使用动态代理环绕增强某个方法而在配置文件中导致的IOC和DI配置过于臃肿spring-aop的应用比如我们定义一个类，这个类里有三个方法，我们怎么在调用方法前都先执行一条输出语句呢？很简单通过动态代理就能实现，但是我们怎么通过spring-aop配置文件的写法来达成我们的目的呢？接下来我们写一个demopublic class Accou...
复制链接

扫一扫

专栏目录