天天看點

面試官:Spring 注解 @After,@Around,@Before 的執行順序是?

AOP中有

@Before

@After

@Around

@AfterRunning

注解等等。

首先上下自己的代碼,定義了切點的定義

@Aspect
@Component
public class LogApsect {

    private static final Logger logger = LoggerFactory.getLogger(LogApsect.class);

    ThreadLocal<Long> startTime = new ThreadLocal<>();

    // 第一個*代表傳回類型不限
    // 第二個*代表所有類
    // 第三個*代表所有方法
    // (..) 代表參數不限
    @Pointcut("execution(public * com.lmx.blog.controller.*.*(..))")
    @Order(2)
    public void pointCut(){};

    @Pointcut("@annotation(com.lmx.blog.annotation.RedisCache)")
    @Order(1) // Order 代表優先級,數字越小優先級越高
    public void annoationPoint(){};

    @Before(value = "annoationPoint() || pointCut()")
    public void before(JoinPoint joinPoint){
        System.out.println("方法執行前執行......before");
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = attributes.getRequest();
        logger.info("<=====================================================");
        logger.info("請求來源: =》" + request.getRemoteAddr());
        logger.info("請求URL:" + request.getRequestURL().toString());
        logger.info("請求方式:" + request.getMethod());
        logger.info("響應方法:" + joinPoint.getSignature().getDeclaringTypeName() + "." + joinPoint.getSignature().getName());
        logger.info("請求參數:" + Arrays.toString(joinPoint.getArgs()));
        logger.info("------------------------------------------------------");
        startTime.set(System.currentTimeMillis());
    }

    // 定義需要比對的切點表達式,同時需要比對參數
    @Around("pointCut() && args(arg)")
    public Response around(ProceedingJoinPoint pjp,String arg) throws Throwable{
        System.out.println("name:" + arg);
        System.out.println("方法環繞start...around");
        String result = null;
        try{
            result = pjp.proceed().toString() + "aop String";
            System.out.println(result);
        }catch (Throwable e){
            e.printStackTrace();
        }
        System.out.println("方法環繞end...around");
        return (Response) pjp.proceed();
    }

    @After("within(com.lmx.blog.controller.*Controller)")
    public void after(){
        System.out.println("方法之後執行...after.");
    }

    @AfterReturning(pointcut="pointCut()",returning = "rst")
    public void afterRunning(Response rst){
        if(startTime.get() == null){
            startTime.set(System.currentTimeMillis());
        }
        System.out.println("方法執行完執行...afterRunning");
        logger.info("耗時(毫秒):" +  (System.currentTimeMillis() - startTime.get()));
        logger.info("傳回資料:{}", rst);
        logger.info("==========================================>");
    }

    @AfterThrowing("within(com.lmx.blog.controller.*Controller)")
    public void afterThrowing(){
        System.out.println("異常出現之後...afterThrowing");
    }


}      

推薦一個 Spring Boot 基礎教程及實戰示例:

https://github.com/javastacks/spring-boot-best-practice

@Before,@After,@Around注解的差別大家可以自行百度下。總之就是@Around可以實作@Before和@After的功能,并且隻需要在一個方法中就可以實作。

首先我們來測試一個方法用于擷取資料庫一條記錄的

@RequestMapping("/achieve")
public Response achieve(){
    System.out.println("方法執行-----------");
    return Response.ok(articleDetailSercice.getPrimaryKeyById(1L));
}      

以下是控制台列印的日志

方法執行前執行......before
2018-11-23 16:31:59.795 [http-nio-8888-exec-9] INFO  c.l.blog.config.LogApsect - <=====================================================
2018-11-23 16:31:59.795 [http-nio-8888-exec-9] INFO  c.l.blog.config.LogApsect - 請求來源: =》0:0:0:0:0:0:0:1
2018-11-23 16:31:59.795 [http-nio-8888-exec-9] INFO  c.l.blog.config.LogApsect - 請求URL:http://localhost:8888/user/achieve
2018-11-23 16:31:59.795 [http-nio-8888-exec-9] INFO  c.l.blog.config.LogApsect - 請求方式:GET
2018-11-23 16:31:59.795 [http-nio-8888-exec-9] INFO  c.l.blog.config.LogApsect - 響應方法:com.lmx.blog.controller.UserController.achieve
2018-11-23 16:31:59.796 [http-nio-8888-exec-9] INFO  c.l.blog.config.LogApsect - 請求參數:[]
2018-11-23 16:31:59.796 [http-nio-8888-exec-9] INFO  c.l.blog.config.LogApsect - ------------------------------------------------------
方法執行-----------
2018-11-23 16:31:59.806 [http-nio-8888-exec-9] DEBUG c.l.b.m.A.selectPrimaryKey - ==>  Preparing: select * from article_detail where id = ? 
2018-11-23 16:31:59.806 [http-nio-8888-exec-9] DEBUG c.l.b.m.A.selectPrimaryKey - ==>  Preparing: select * from article_detail where id = ? 
2018-11-23 16:31:59.806 [http-nio-8888-exec-9] DEBUG c.l.b.m.A.selectPrimaryKey - ==> Parameters: 1(Long)
2018-11-23 16:31:59.806 [http-nio-8888-exec-9] DEBUG c.l.b.m.A.selectPrimaryKey - ==> Parameters: 1(Long)
2018-11-23 16:31:59.814 [http-nio-8888-exec-9] DEBUG c.l.b.m.A.selectPrimaryKey - <==      Total: 1
2018-11-23 16:31:59.814 [http-nio-8888-exec-9] DEBUG c.l.b.m.A.selectPrimaryKey - <==      Total: 1
方法之後執行...after.
方法執行完執行...afterRunning
2018-11-23 16:31:59.824 [http-nio-8888-exec-9] INFO  c.l.blog.config.LogApsect - 耗時(毫秒):27
2018-11-23 16:31:59.824 [http-nio-8888-exec-9] INFO  c.l.blog.config.LogApsect - 傳回資料:com.lmx.blog.common.Response@8675ce5
2018-11-23 16:31:59.824 [http-nio-8888-exec-9] INFO  c.l.blog.config.LogApsect - ==========================================>      

可以看到,因為沒有比對@Around的規則,是以沒有進行環繞通知。(PS:我定義的環繞通知意思是要符合是 controller 包下的方法并且方法必須帶有參數,而上述方法沒有參數,是以隻走了@before和@after方法,不符合@Around的比對邏輯)

我們再試一下另一個帶有參數的方法

@RedisCache(type = Response.class)
@RequestMapping("/sendEmail")
public Response sendEmailToAuthor(String content){
    System.out.println("測試執行次數");
    return Response.ok(true);
}      

以下是該部分代碼的console列印

name:第二封郵件呢
方法環繞start...around
方法執行前執行......before
2018-11-23 16:34:55.347 [http-nio-8888-exec-2] INFO  c.l.blog.config.LogApsect - <=====================================================
2018-11-23 16:34:55.347 [http-nio-8888-exec-2] INFO  c.l.blog.config.LogApsect - 請求來源: =》0:0:0:0:0:0:0:1
2018-11-23 16:34:55.347 [http-nio-8888-exec-2] INFO  c.l.blog.config.LogApsect - 請求URL:http://localhost:8888/user/sendEmail
2018-11-23 16:34:55.348 [http-nio-8888-exec-2] INFO  c.l.blog.config.LogApsect - 請求方式:GET
2018-11-23 16:34:55.348 [http-nio-8888-exec-2] INFO  c.l.blog.config.LogApsect - 響應方法:com.lmx.blog.controller.UserController.sendEmailToAuthor
2018-11-23 16:34:55.348 [http-nio-8888-exec-2] INFO  c.l.blog.config.LogApsect - 請求參數:[第二封郵件呢]
2018-11-23 16:34:55.348 [http-nio-8888-exec-2] INFO  c.l.blog.config.LogApsect - ------------------------------------------------------
測試執行次數
com.lmx.blog.common.Response@6d17f2fdaop String
方法環繞end...around
方法執行前執行......before
2018-11-23 16:34:55.349 [http-nio-8888-exec-2] INFO  c.l.blog.config.LogApsect - <=====================================================
2018-11-23 16:34:55.349 [http-nio-8888-exec-2] INFO  c.l.blog.config.LogApsect - 請求來源: =》0:0:0:0:0:0:0:1
2018-11-23 16:34:55.349 [http-nio-8888-exec-2] INFO  c.l.blog.config.LogApsect - 請求URL:http://localhost:8888/user/sendEmail
2018-11-23 16:34:55.349 [http-nio-8888-exec-2] INFO  c.l.blog.config.LogApsect - 請求方式:GET
2018-11-23 16:34:55.349 [http-nio-8888-exec-2] INFO  c.l.blog.config.LogApsect - 響應方法:com.lmx.blog.controller.UserController.sendEmailToAuthor
2018-11-23 16:34:55.349 [http-nio-8888-exec-2] INFO  c.l.blog.config.LogApsect - 請求參數:[第二封郵件呢]
2018-11-23 16:34:55.350 [http-nio-8888-exec-2] INFO  c.l.blog.config.LogApsect - ------------------------------------------------------
測試執行次數
方法之後執行...after.
方法執行完執行...afterRunning
2018-11-23 16:34:55.350 [http-nio-8888-exec-2] INFO  c.l.blog.config.LogApsect - 耗時(毫秒):0
2018-11-23 16:34:55.350 [http-nio-8888-exec-2] INFO  c.l.blog.config.LogApsect - 傳回資料:com.lmx.blog.common.Response@79f85428
2018-11-23 16:34:55.350 [http-nio-8888-exec-2] INFO  c.l.blog.config.LogApsect - ==========================================>      

顯而易見,該方法符合 @Around 環繞通知的比對規則,是以進入了@Around的邏輯,但是發現了問題,所有的方法都被執行了2次,不管是切面層還是方法層。(有人估計要問我不是用的自定義注解 @RedisCache(type = Response.class) 麼。為什麼會符合 @Around的比對規則呢,這個等會在下面說)

我們分析日志的列印順序可以得出,在執行環繞方法時候,會優先進入 @Around下的方法。@Around的方法再貼一下代碼。

// 定義需要比對的切點表達式,同時需要比對參數
@Around("pointCut() && args(arg)")
public Response around(ProceedingJoinPoint pjp,String arg) throws Throwable{
    System.out.println("name:" + arg);
    System.out.println("方法環繞start...around");
    String result = null;
    try{
        result = pjp.proceed().toString() + "aop String";
        System.out.println(result);
    }catch (Throwable e){
        e.printStackTrace();
    }
    System.out.println("方法環繞end...around");
    return (Response) pjp.proceed();
}      

列印了前兩行代碼以後,轉而去執行了 @Before方法,是因為中途觸發了 ProceedingJoinPoint.proceed() 方法。這個方法的作用是執行被代理的方法,也就是說執行了這個方法之後會執行我們controller的方法,而後執行 @before,@after,然後回到@Around執行未執行的方法,最後執行 @afterRunning,如果有異常抛出能執行 @AfterThrowing

也就是說環繞的執行順序是 @Around→@Before→@After→@Around執行 ProceedingJoinPoint.proceed() 之後的操作→@AfterRunning(如果有異常→@AfterThrowing)

而我們上述的日志相當于把上述結果執行了2遍,根本原因在于 ProceedingJoinPoint.proceed() 這個方法,可以發現在@Around 方法中我們使用了2次這個方法,然而每次調用這個方法時都會走一次@Before→@After→@Around執行 ProceedingJoinPoint.proceed() 之後的操作→@AfterRunning(如果有異常→@AfterThrowing)。是以問題是出現在這裡。是以更改@Around部分的代碼即可解決該問題。更改之後的代碼如下:

@Around("pointCut() && args(arg)")
public Response around(ProceedingJoinPoint pjp,String arg) throws Throwable{
    System.out.println("name:" + arg);
    System.out.println("方法環繞start...around");
    String result = null;
    Object object = pjp.proceed();
    try{
        result = object.toString() + "aop String";
        System.out.println(result);
    }catch (Throwable e){
        e.printStackTrace();
    }
    System.out.println("方法環繞end...around");
    return (Response) object;
}      

更改代碼之後的運作結果

name:第二封郵件呢
方法環繞start...around
方法執行前執行......before
2018-11-23 16:52:14.315 [http-nio-8888-exec-4] INFO  c.l.blog.config.LogApsect - <=====================================================
2018-11-23 16:52:14.315 [http-nio-8888-exec-4] INFO  c.l.blog.config.LogApsect - 請求來源: =》0:0:0:0:0:0:0:1
2018-11-23 16:52:14.315 [http-nio-8888-exec-4] INFO  c.l.blog.config.LogApsect - 請求URL:http://localhost:8888/user/sendEmail
2018-11-23 16:52:14.315 [http-nio-8888-exec-4] INFO  c.l.blog.config.LogApsect - 請求方式:GET
2018-11-23 16:52:14.316 [http-nio-8888-exec-4] INFO  c.l.blog.config.LogApsect - 響應方法:com.lmx.blog.controller.UserController.sendEmailToAuthor
2018-11-23 16:52:14.316 [http-nio-8888-exec-4] INFO  c.l.blog.config.LogApsect - 請求參數:[第二封郵件呢]
2018-11-23 16:52:14.316 [http-nio-8888-exec-4] INFO  c.l.blog.config.LogApsect - ------------------------------------------------------
測試執行次數
com.lmx.blog.common.Response@1b1c76afaop String
方法環繞end...around
方法之後執行...after.
方法執行完執行...afterRunning
2018-11-23 16:52:14.316 [http-nio-8888-exec-4] INFO  c.l.blog.config.LogApsect - 耗時(毫秒):0
2018-11-23 16:52:14.316 [http-nio-8888-exec-4] INFO  c.l.blog.config.LogApsect - 傳回資料:com.lmx.blog.common.Response@1b1c76af
2018-11-23 16:52:14.316 [http-nio-8888-exec-4] INFO  c.l.blog.config.LogApsect - ==========================================>      

回到上述未解決的問題,為什麼我定義了切面的另一個注解還可以進入@Around方法呢?

因為我們的方法仍然在controller下,是以滿足該需求,如果我們定義了controller包下的某個controller才有用。例如:

@Pointcut("execution(public * com.lmx.blog.controller.UserController.*(..))")      

而如果我們剛才定義的方法是寫在 TestController 之下的,那麼就不符合 @Around方法的比對規則了,也不符合@before和@after的注解規則,是以不會比對任何一個規則,如果需要比對特定的方法,可以用自定義的注解形式或者特性controller下的方法

①:特性的注解形式

@Pointcut("@annotation(com.lmx.blog.annotation.RedisCache)")
@Order(1) // Order 代表優先級,數字越小優先級越高
public void annoationPoint(){};      

然後在所需要的方法上加入

@RedisCache

注解,在

@Before

@After

@Around

等方法上添加該切點的方法名(“

annoationPoint()

”),如果有多個注解需要比對則用

||

隔開

②:指定controller或者指定controller下的方法

@Pointcut("execution(public * com.lmx.blog.controller.UserController.*(..))")
@Order(2)
public void pointCut(){};      

該部分代碼是指定了 com.lmx.blog.controller包下的UserController下的所有方法。

第一個*代表的是傳回類型不限

第二個*代表的是該controller下的所有方法,(..)代表的是參數不限

總結

當方法符合切點規則不符合環繞通知的規則時候,執行的順序如下

@Before→@After→@AfterRunning(如果有異常→@AfterThrowing)

當方法符合切點規則并且符合環繞通知的規則時候,執行的順序如下

@Around→@Before→@Around→@After執行 ProceedingJoinPoint.proceed() 之後的操作→@AfterRunning(如果有異常→@AfterThrowing)