Spring AOP总结

骑猪看日落 2022-03-01 05:37 206阅读 0赞

## Terminology ##

Joint Point： public method in Spring Managed Bean  
Point cut： The actual joint point that that we have delcared  
Advice: The fucntionality we want to apply  
Aspect: combine point cut and advice  
Weaving: The process of applying an aspect to our system

## Maven类库 ##

引用如下类库说明：

<dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-aop</artifactId>
        </dependency>

## 启用Aspect AOP ##

在Spring Boot应用中的Configuration类上使用@EnableAspectJAutoProxy，在Spring应用中启动对于Aspect功能支持。  
例如：

@Configuration
    @Slf4j
    @EnableAspectJAutoProxy
    public class AppConfig {
        @Bean(initMethod = "init", destroyMethod = "clearup")
        public Game game() {
            return new Game();
        }
    
        @Bean
        public Rain rain(Game game) {
            return new Rain(game);
        }
    }

## 常用Annotation ##

@Aspect – 作用是把当前类标识为一个切面供容器读取  
@Pointcut – (切入点):就是带有通知的连接点，在程序中主要体现为书写切入点表达式  
@Before – 标识一个前置增强方法，相当于BeforeAdvice的功能  
@AfterReturning – 后置增强，相当于AfterReturningAdvice，方法退出时执行  
@AfterThrowing – 异常抛出增强，相当于ThrowsAdvice  
@After – final增强，不管是抛出异常或者正常退出都会执行  
@Around – 环绕增强，相当于MethodInterceptor

## 应用场景 ##

通过预编译方式和运行期动态代理实现程序功能的一种开发技术。在日常开发当中经常用来记录日志，方法跟踪、事务，权限等

## 使用AoP ##

示例如下：

@Aspect
    @Component
    @Slf4j
    public class LoggingAspect {
        /*
        @Before("execution(void org.cjf.beans..*.set*(*))")
        public void callSetter(JoinPoint joinPoint) {
            log.info("setter is invoked....");
            log.info("method:{}, params:{}, target:{}", joinPoint.getSignature().getName(),
                    joinPoint.getArgs(), joinPoint.getTarget());
        }
        */
    
        @Around("execution(String playGame())")
        public Object checkForRain(ProceedingJoinPoint proceedingJoinPoint) throws Throwable{
           boolean rain = Math.random() < 0.5;
    
           Object result = null;
           if (rain) {
               log.info(proceedingJoinPoint.getTarget() + " rain out");
           }
           else {
               result = proceedingJoinPoint.proceed();
               log.info("result:{}", result.toString());
           }
    
           return result;
        }
    }

测试用例2:

@Aspect
    @Component
    @Slf4j
    public class LoggerAspect {
        /**
         * controller目录下，所有类的所有方法
         */
        @Pointcut("execution(public * org.cjf.beans.controller..*.*(..))")
        public void getPointCut() {
        }
    
        //前置通知
        @Before("getPointCut()")
        public void beforeMethod(JoinPoint joinPoint){
            log.info("调用了前置通知");
    
        }
    
        //@After: 后置通知
        @After("getPointCut()")
        public void afterMethod(JoinPoint joinPoint){
            log.info("调用了后置通知");
        }
    
        //@AfterRunning: 返回通知 rsult为返回内容
        @AfterReturning(value="getPointCut()",returning="result")
        public void afterReturningMethod(JoinPoint joinPoint,Object result){
            log.info("调用了返回通知");
        }
    
        //@AfterThrowing: 异常通知
        @AfterThrowing(value="getPointCut()",throwing="e")
        public void afterReturningMethod(JoinPoint joinPoint, Exception e){
            log.info("调用了异常通知");
        }
    
        //@Around：环绕通知
        @Around("getPointCut()")
        public Object Around(ProceedingJoinPoint pjp) throws Throwable {
            log.info("around执行方法之前");
            Object object = pjp.proceed();
            log.info("around执行方法之后--返回值：" +object);
            return object;
        }
    }

在这里展示了@Around/@Before两个注解的使用方法，其中使用execution来定义aop的切入点，其可以支持方法，一类方法和所有方法等各种粒度的捕获和拦截。

详细使用可以参考Spring的官方文档： [https://docs.spring.io/spring/docs/5.1.5.RELEASE/spring-framework-reference/core.html\#aop-extensibility][https_docs.spring.io_spring_docs_5.1.5.RELEASE_spring-framework-reference_core.html_aop-extensibility]

## 总结 ##

AOP可以提供一种无侵入方式的方法增强和拦截，帮助开发者实现各类灵活性与功能增强的使用。

[https_docs.spring.io_spring_docs_5.1.5.RELEASE_spring-framework-reference_core.html_aop-extensibility]: https://docs.spring.io/spring/docs/5.1.5.RELEASE/spring-framework-reference/core.html#aop-extensibility