自工作后，除了一些小項目配置事務使用過 AOP，真正自己寫 AOP 機會很少，另一方面在工作后還沒有寫過自定義注解，一直很好奇注解是怎么實現他想要的功能的，剛好做項目的時候，經常有人日志打得不夠全，經常出現問題了，查日志的才發現忘記打了，所以趁此機會，搜了一些資料，用 AOP + 自定義注解，實現請求攔截，自定義打日志，玩一下這兩個東西，以下是自己完的一個小例子，也供需要的同學參考。
1. 注解如下：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
|
package cn.bridgeli.demo.annotation; import java.lang.annotation.ElementType;import java.lang.annotation.Retention;import java.lang.annotation.RetentionPolicy;import java.lang.annotation.Target; /** * @author bridgeli */@Target(ElementType.METHOD)@Retention(RetentionPolicy.RUNTIME)public @interface MyLog { /** * 方法描述 * * @return */ String desc() default "";} |
2. 切面
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
|
package cn.bridgeli.demo.annotation; import cn.bridgeli.utils.AuthorizeUtil;import cn.bridgeli.entity.Principal;import lombok.extern.slf4j.Slf4j;import org.apache.commons.lang3.StringUtils;import org.aspectj.lang.ProceedingJoinPoint;import org.aspectj.lang.annotation.Around;import org.aspectj.lang.annotation.Aspect;import org.aspectj.lang.annotation.Pointcut;import org.springframework.stereotype.Component; /** * @author bridgeli * 1. 這是一個切面類 */@Aspect@Component@Slf4jpublic class MyLogAspect { /** * 2. PointCut表示這是一個切點，@annotation表示這個切點切到一個注解上，后面帶該注解的全類名 * 切面最主要的就是切點，所有的故事都圍繞切點發生 * logPointCut()代表切點名稱 */ @Pointcut("@annotation(cn.bridgeli.demo.annotation.MyLog)") public void logPointCut() { } /** * 3. 環繞通知 * * @param joinPoint * @param myLog * @return */ @Around(value = "logPointCut() && @annotation(myLog)", argNames = "joinPoint,myLog") public Object logAround(ProceedingJoinPoint joinPoint, MyLog myLog) { // 獲取方法名 String methodFullPathName = joinPoint.getTarget().getClass().getName() + "#" + joinPoint.getSignature().getName(); // 獲取參數 String params = StringUtils.join(joinPoint.getArgs(), ";"); Principal currentUser = AuthorizeUtil.getCurrentUser(); log.info("當前登陸用戶：" + (null == currentUser ? "" : currentUser.toString()) + "，進入 [ " + methodFullPathName + " ] 方法, 方法的描述：" + myLog.desc() + "，參數為:" + params); // 繼續執行方法 long startTime = System.currentTimeMillis(); Object result = null; try { result = joinPoint.proceed(); } catch (Throwable e) { log.error("切面執行報錯，參數：" + params, e); } long elapsed = System.currentTimeMillis() - startTime; log.info("[ " + methodFullPathName + " ] 方法執行結束，返回值為：" + (null == result ? "" : result.toString()) + "，用時：" + elapsed); return result; }} |
然后只需要在想使用的地方 @MyLog 就可以了，當然也可以加上 @MyLog(desc = “這是方法描述”)，這樣打出來的日志還會有方法是做什么的，別人看日志的時候能夠一目了然。
需要說明的是，我在寫這個切面的時候遇到的一個小問題，在網上看 AOP 的注解，很多人在舉例子的時候都是不關注 @Around 的返回值，所以方法的返回值都寫的 void，因為我對 AOP 也不是很熟，所以當時同樣寫了一個 void，結果寫好一測試，返回攔截也正常，日志也打印了，被攔截的方法執行也挺正常，但是就是沒有了返回值，當時還很奇怪，然后隨便試了下返回值改成 Object，竟然對了，所以這是一個小坑，也是很多人沒有說明的一點，大家可以注意下，其實這個問題也很容易想到，@Around 是環繞攔截，在執行完被攔截的方法之后，會繼續執行切面方法，如果切面方法沒有返回值，那么自然而然就沒有返回值了，同理 @After 攔截個人猜測也應該有同樣的問題，大家可以測試下。
以上就是Spring AOP 實現自定義注解的示例的詳細內容，更多關于Spring AOP 實現自定義注解的資料請關注服務器之家其它相關文章！
原文鏈接：http://www.bridgeli.cn/archives/655
