spring系列

06 Spirng中的AOP

2020-04-26  本文已影响0人  better_future

AOP 相关术语

Joinpoint( 连接点):

所谓连接点是指那些被拦截到的点。在 spring 中,这些点指的是方法,因为 spring 只支持方法类型的连接点。


image.png
Pointcut( 切入点):

所谓切入点是指我们要对哪些 Joinpoint 进行拦截的定义。


image.png
Advice( 通知/ 增强):

所谓通知是指拦截到 Joinpoint 之后所要做的事情就是通知。
通知的类型:前置通知,后置通知,异常通知,最终通知,环绕通知。

Introduction( 引介):

引介是一种特殊的通知在不修改类代码的前提下, Introduction 可以在运行期为类动态地添加一些方法或 Field。

Target( 目标对象):

代理的目标对象。

Weaving( 织入):

是指把增强应用到目标对象来创建新的代理对象的过程。
spring 采用动态代理织入,而 AspectJ 采用编译期织入和类装载期织入。

Proxy (代理):

一个类被 AOP 织入增强后,就产生一个结果代理类。

Aspect( 切面):

是切入点和通知(引介)的结合。

<dependencies>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context</artifactId>
            <version>5.0.2.RELEASE</version>
        </dependency>

        <dependency>
            <groupId>org.aspectj</groupId>
            <artifactId>aspectjweaver</artifactId>
            <version>1.8.7</version>
        </dependency>
    </dependencies>

定义业务层接口

/**
 * 账户的业务层接口
 */
public interface IAccountService {

    /**
     * 模拟保存账户
     */
   void saveAccount();

    /**
     * 模拟更新账户
     * @param i
     */
   void updateAccount(int i);

    /**
     * 删除账户
     * @return
     */
   int  deleteAccount();
}

定义业务层实现类

public class AccountServiceImpl implements IAccountService{

    @Override
    public void saveAccount() {
        System.out.println("执行了保存");
    }

    @Override
    public void updateAccount(int i) {
        System.out.println("执行了更新"+i);

    }

    @Override
    public int deleteAccount() {
        System.out.println("执行了删除");
        return 0;
    }
}

定义一个日志类,提供打印日志的方法

public class Logger {
    public  void printLog(){
        System.out.println("Logger类中的pringLog方法开始记录日志了。。。");
    }
}

现在要对业务层中的方法进行增强,在业务层方法执行之前进行切入,使用日志类打印日志。

使用xml方式实现spring AOP

bean.xml

<?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: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/aop
        http://www.springframework.org/schema/aop/spring-aop.xsd">

    <!-- 配置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>
        <!--配置切面 -->
        <aop:aspect id="logAdvice" ref="logger">
            <!-- 配置通知的类型,并且建立通知方法和切入点方法的关联-->
            <aop:before method="printLog" pointcut="execution(* com.itheima.service.impl.*.*(..))"></aop:before>
        </aop:aspect>
    </aop:config>
</beans>

分析

spring中基于XML的AOP配置步骤

关键字: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.*.*(..)

测试

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();
        as.updateAccount(1);
        as.deleteAccount();
    }
}

结果

Logger类中的pringLog方法开始记录日志了。。。
执行了保存
Logger类中的pringLog方法开始记录日志了。。。
执行了更新1
Logger类中的pringLog方法开始记录日志了。。。
执行了删除
其他通知类型
 <!--配置AOP-->
    <aop:config>
        <!--配置切面 -->
        <aop:aspect id="logAdvice" ref="logger">
         <!-- 配置通知切入点,进行引用-->
            <aop:pointcut id="pt1" expression="execution(* com.itheima.service.impl.*.*(..))"/>
           
            <!--前置通知 方法执行之前执行-->
           <aop:before method="printLogBefore" pointcut-ref="pt1"/>
            <!--后置通知,在切入点方法正常执行之后执行,它和异常通知只能有一个执行-->
           <aop:after-returning method="printLogAfterReturning" pointcut-ref="pt1"/>
            <!--异常通知,在切入点方法执行产生异常之后执行,它和after-returning只能有一个执行-->
           <aop:after-throwing method="printLogAfterThrowoing" pointcut-ref="pt1"/>
            <!--最终通知,无论切入点方法是否正常执行都会在其后面执行-->
            <aop:after method="printLogAfter" pointcut-ref="pt1"/>
        </aop:aspect>
    </aop:config>
public class Logger {

    /**
     * 用于打印日志:计划让其在切入点方法执行之前执行(切入点方法就是业务层方法)
     */
    public  void printLogBefore(){
        System.out.println("printLogBefore。。。");
    }


    public  void printLogAfterReturning(){
        System.out.println("printLogAfterReturning。。。");
    }
    public  void printLogAfterThrowoing(){
        System.out.println("printLogAfterThrowoing。。。");
    }
    public  void printLogthrowoing(){
        System.out.println("printLogthrowoing。。。");
    }
    public  void printLogAfter(){
        System.out.println("printLogAfter。。。");
    }

}

当切入点的方法正常执行测试结果

 @Override
    public void saveAccount() {
        System.out.println("执行了保存");
    }

//执行结果
printLogBefore。。。
执行了保存
printLogAfterReturning。。。
printLogAfter。。。

当切入点的方法发生异常时

@Override
    public void saveAccount() {
        int i = 1/0 ;
        System.out.println("执行了保存");
    }
//结果
printLogBefore。。。
printLogAfterThrowoing。。。
printLogAfter。。。

spring中的环绕通知

是spring框架为我们提供的一种可以在代码中手动控制增强方法何时执行的方式

 <!--环绕通知-->
<aop:around method="printLogAround" pointcut-ref="pt1"/>
public  void printLogAround(){
        System.out.println("printLogAround。。。");
    }

执行结果

printLogAround。。。

问题:
当配置了环绕通知后,切入点方法没有执行,而通知方法执行了
分析:通过对比动态代理中的环绕通知代码,发现动态代理的环绕通知有明确的切入点方法调用,而我们这个没有

解决:
Spring框架为我们提供了一个接口:ProceedingJoinPoint.该接口有一个方法proceed(),此方法就相当于明确调用切入点方法,该接口可以作为环绕通知的方法参数,在程序执行时,spring框架会为我们提供该接口的实现类

改造log中的环绕通知方法

    public Object transactionAround(ProceedingJoinPoint joinPoint){
        Object returnValue = null;
        try {
            Object[] args = joinPoint.getArgs(); //获取方法执行所需参数
            System.out.println("环绕前置通知");
            returnValue = joinPoint.proceed(); //切入点方法执行
            System.out.println("环绕后置通知");
            return returnValue;
        }catch (Throwable throwable){
            System.out.println("环绕通知异常");
            throw new RuntimeException(throwable);
        }finally {
            System.out.println("环绕通知最终结束通知");
        }
    }

在我们的catch里面,捕获到了异常之后,我们的catch模块里面的语句,还会接着执行,当我们执行到return之后,我们不会立即返回,而是会接着执行finally块里面的代码,只有执行完,才会继续执行我们的return值,

  <!--环绕通知-->
<aop:around method="transactionAround" pointcut-ref="pt1"/>
 public static void main(String[] args) {
        //1.获取容器
        ApplicationContext ac = new ClassPathXmlApplicationContext("bean.xml");
        //2.获取对象
        IAccountService as = (IAccountService) ac.getBean("accountService");
        //3.执行方法
        as.updateAccount(2);
    }

切入点方法 正常执行结果

@Override
    public void updateAccount(int i) {
        System.out.println("执行了更新"+i);
    }
//结果
环绕前置通知
执行了更新2
环绕后置通知
环绕通知最终结束通知

切入点方法 异常执行结果

@Override
    public void updateAccount(int i) {
        int a = 1/0;
        System.out.println("执行了更新"+i);
    }
//结果
环绕前置通知
环绕通知异常
环绕通知最终结束通知

基于注解的AOP配置

pom依赖与上节的相同
bean.xml文件

<?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:aop="http://www.springframework.org/schema/aop"
       xmlns:context="http://www.springframework.org/schema/context"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
        http://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/aop
        http://www.springframework.org/schema/aop/spring-aop.xsd
        http://www.springframework.org/schema/context
        http://www.springframework.org/schema/context/spring-context.xsd">

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

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

业务层接口实现类

@Service("accountService")
public class AccountServiceImpl implements IAccountService{

    @Override
    public void saveAccount() {
        System.out.println("执行了保存");
    }

    @Override
    public void updateAccount(int i) {
        System.out.println("执行了更新"+i);

    }

    @Override
    public int deleteAccount() {
        System.out.println("执行了删除");
        return 0;
    }
}

对业务层接口实现类的方法进行增强
Logger类

@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方法开始记录日志了。。。");
    }

注意:
@Aspect 表示当前类是一个切面类
@Component("logger") 加载log类到spring容器中去
@Pointcut("execution(* com.itheima.service.impl.*.*(..))")配置切入点
Before("pt1()")对方法配置前置通知,值是切入点的方法名称

测试

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();
    }
}

结果

前置通知Logger类中的beforePrintLog方法开始记录日志了。。。
执行了保存

同理配置 后置通知、异常通知、最终通知

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

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

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

切入点方法(业务层方法)正常执行结果

前置通知Logger类中的beforePrintLog方法开始记录日志了。。。
执行了保存
最终通知Logger类中的afterPrintLog方法开始记录日志了。。。
后置通知Logger类中的afterReturningPrintLog方法开始记录日志了。。。

异常执行结果

 @Override
    public void saveAccount() {
        int i = 1/0;
        System.out.println("执行了保存");
    }
//结果
前置通知Logger类中的beforePrintLog方法开始记录日志了。。。
最终通知Logger类中的afterPrintLog方法开始记录日志了。。。
异常通知Logger类中的afterThrowingPrintLog方法开始记录日志了。。。

环绕通知

 /**
     * 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方法开始记录日志了。。。最终");
        }
    }

正常执行结果

Logger类中的aroundPringLog方法开始记录日志了。。。前置
执行了保存
Logger类中的aroundPringLog方法开始记录日志了。。。后置
Logger类中的aroundPringLog方法开始记录日志了。。。最终

异常执行结果

Logger类中的aroundPringLog方法开始记录日志了。。。前置
Logger类中的aroundPringLog方法开始记录日志了。。。异常
Logger类中的aroundPringLog方法开始记录日志了。。。最终

不使用XML的配置方式

@Configuration
@ComponentScan(basePackages="com.itheima")
@EnableAspectJAutoProxy //
public class SpringConfiguration {
}

[图片上传失败...(image-81f18d-1587879896853)]

上一篇下一篇

猜你喜欢

热点阅读