AOP我想大家都很清楚,有時候我們需要處理一些請求日志,或者對某些方法進行一些監控,如果出現例外情況應該進行怎么樣的處理,現在,我們從spring-boot中引入AOP.
[開發環境:jdk版本號為1.8,spring
boot的版本號為1.4.1]{style=”background-color:#FF0000”}
首先,我們先引入jar包,
POM文件添加如下內容:
|
1
2
3
4
5
6
7
8
9
10
11
|
<!--引用AOP--><dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-aop</artifactId></dependency><!--引用GSON,用于打印--><dependency> <groupId>com.google.code.gson</groupId> <artifactId>gson</artifactId> <version>2.7</version></dependency> |
引入jar包后,我們在boot的啟動方法,增加兩個簡單的請求處理方法:
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
|
@SpringBootApplication(scanBasePackages = {"com"})@RestControllerpublic class DemoApplication{ public static void main(String[] args) { SpringApplication.run(DemoApplication.class, args); } //測試無參的get請求 @RequestMapping(value = "/testAspect",method = RequestMethod.GET) public UserVo test(){ UserVo userVo = new UserVo(); userVo.setAge("23"); userVo.setName("賀小五"); userVo.setSex("男"); return userVo; } //測試有參的get請求,讓aop打印參數內容 @RequestMapping(value = "/testAspectArgs",method = RequestMethod.GET) public UserVo test(String name,String age,String sex){ UserVo userVo = new UserVo(); userVo.setName(name); userVo.setAge(age); userVo.setSex(sex); return userVo; } |
增加了兩個簡單的處理請求方法后,我們來增加我們的aop
|
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
|
/** * 項目名:SpringBootDemo * 創建人:賀小五 * 創建時間:16/12/4 下午7:05 * 類名:AspectDemo * 類描述: *///申明是個切面@Aspect//申明是個spring管理的bean@Component@Order(1)public class AspectDemo { private Logger log = Logger.getLogger(getClass()); private Gson gson = new Gson(); //申明一個切點 里面是 execution表達式 @Pointcut("execution(public * com.example.DemoApplication.*(..))") private void controllerAspect(){} //請求method前打印內容 @Before(value = "controllerAspect()") public void methodBefore(JoinPoint joinPoint){ ServletRequestAttributes requestAttributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes(); HttpServletRequest request = requestAttributes.getRequest(); //打印請求內容 log.info("===============請求內容==============="); log.info("請求地址:"+request.getRequestURL().toString()); log.info("請求方式:"+request.getMethod()); log.info("請求類方法:"+joinPoint.getSignature()); log.info("請求類方法參數:"+ Arrays.toString(joinPoint.getArgs())); log.info("===============請求內容==============="); } //在方法執行完結后打印返回內容 @AfterReturning(returning = "o",pointcut = "controllerAspect()") public void methodAfterReturing(Object o ){ log.info("--------------返回內容----------------"); log.info("Response內容:"+gson.toJson(o)); log.info("--------------返回內容----------------"); } |
兩者配置好之后,接下來,我們請求,然后查看打印日志,首先,啟動我們的容器,然后我們先請求有參的處理請求方法的,打印日志如下:
{width=”1232”
height=”132”}
可以發現,請求的url,method,以及args參數的值,還有類型,以及返回的內容都打印出來了,說明,這是AOP攔截成功了.
接下來,我們測試下請求無參的處理請求方法,打印日志如下:
{width=”1100”
height=”130”}
我們可以發現,這個方法,打印的方法參數是個空數組,是因為方法不需要參數傳遞.
以上就是springboot引用aop進行處理web的日志處理,下面將添加AOP切面的主要幾個注解,下面只是對注解的描述跟使用,具體測試,作者就不進行測試了,各位看官有興趣的話,可以自己測試一下:
類注解:
@Aspect將一個類定義為一個切面類
@order(i)標記切面類的處理優先級,i值越小,優先級別越高.PS:可以注解類,也能注解到方法上
方法注解:
@Pointcut定義一個方法為切點里面的內容為一個表達式,下面詳細介紹
@Before 在切點前執行方法,內容為指定的切點
@After 在切點后,return前執行,
@AfterReturning在切入點,return后執行,如果想對某些方法的返回參數進行處理,可以在這操作
@Around 環繞切點,在進入切點前,跟切點后執行
@AfterThrowing 在切點后拋出異常進行處理
@order(i) 標記切點的優先級,i越小,優先級越高
@Pointcut注解組合使用:
上面代碼中,我們定義了一個切點,該切點只進行處理指定路徑的:
|
1
2
|
@Pointcut("execution(public * com.example.DemoApplication.*(..))")private void controllerAspect(){} |
現在,我們在定義一個處理其他路徑下的切點:
|
1
2
|
@Pointcut("execution(public * com.demo.*.*(..))")private void controllerDemo(){} |
以上切點,都是分別處理不同的內容,如果我們需要一個切點來處理他們兩者,我們可以這么配置:
|
1
2
|
@Pointcut(value = "controllerAspect()||controllerDemo()")private void all(){} |
在@Pointcut注解內,直接引用其它被@Pointcut注解過的方法名稱,這樣,該切點就可以處理兩個路徑下的方法
@Pointcut注解中的execution表達式: public * com.demo.*.*(..)
第一個 public 表示方法的修飾符,可以用*代替
第一個 * 表示 返回值,*代表所有
com.demo.* 包路徑,.*表示路徑下的所有包
第三個.* 表示路徑下,所有包下的所有類的方法
(..) 表示不限方法參數
關于@order(i)注解的一些注意事項:
注解類,i值是,值越小,優先級越高
注解方法,分兩種情況
注解的是 @Before 是i值越小,優先級越高
注解的是 @After或者@AfterReturning 中,i值越大,優先級越高
總結兩者的概括就是:
在切入點前的操作，按order的值由小到大執行
在切入點后的操作，按order的值由大到小執行
延伸:
有看官可能會問,如果我要打印請求從進來,到結束,所需要的時間,定義一個成員變量,用來統計時間,同時給@Before跟@AfterReturning訪問,可能會有同步的問題,所以我們引用一個ThreadLocal指定泛型的對象,在@Before記錄請求的時間,在@AfterReturning扣除記錄的時間,就是消耗的時間,代碼如下:
|
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
|
/** * 項目名:SpringBootDemo * 創建人:賀小五 * 創建時間:16/12/4 下午7:05 * 類名:AspectDemo * 類描述: *///申明是個切面@Aspect//申明是個spring管理的bean@Component@Order(1)public class AspectDemo { private Logger log = Logger.getLogger(getClass()); private Gson gson = new Gson(); ThreadLocal<Long> startTime = new ThreadLocal<Long>(); //申明一個切點 里面是 execution表達式 @Pointcut("execution(public * com.example.DemoApplication.*(..))") private void controllerAspect() { } //請求method前打印內容 @Before(value = "controllerAspect()") public void methodBefore(JoinPoint joinPoint) { startTime.set(System.currentTimeMillis()); ServletRequestAttributes requestAttributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes(); HttpServletRequest request = requestAttributes.getRequest(); //打印請求內容 log.info("===============請求內容==============="); log.info("請求地址:" + request.getRequestURL().toString()); log.info("請求方式:" + request.getMethod()); log.info("請求類方法:" + joinPoint.getSignature()); log.info("請求類方法參數:" + Arrays.toString(joinPoint.getArgs())); log.info("===============請求內容==============="); } //在方法執行完結后打印返回內容 @AfterReturning(returning = "o", pointcut = "controllerAspect()") public void methodAfterReturing(Object o) { log.info("--------------返回內容----------------"); log.info("Response內容:" + gson.toJson(o)); log.info("--------------返回內容----------------"); log.info("請求處理時間為:"+(System.currentTimeMillis() - startTime.get())); }} |
以上,均為本人測試而得出的結果,可能會有出入,或者錯誤,歡迎指正.
以上就是本文的全部內容，希望對大家的學習有所幫助，也希望大家多多支持服務器之家。
原文鏈接：https://my.oschina.net/u/2278977/blog/799786
