詳解SpringBoot AOP 攔截器(Aspect注解方式)
常用用于實(shí)現(xiàn)攔截的有:Filter、HandlerInterceptor、MethodInterceptor
第一種Filter屬于Servlet提供的,后兩者是spring提供的,HandlerInterceptor屬于Spring MVC項(xiàng)目提供的,用來(lái)攔截請(qǐng)求,在MethodInterceptor之前執(zhí)行。
實(shí)現(xiàn)一個(gè)HandlerInterceptor可以實(shí)現(xiàn)接口HandlerInterceptor,也可以繼承HandlerInterceptorAdapter類,兩種方法一樣。這個(gè)不在本文范圍,具體使用之前已經(jīng)寫過(guò)SpringBoot的(SpringMVC的使用一樣,區(qū)別只是配置)
MethodInterceptor是AOP項(xiàng)目中的攔截器,它攔截的目標(biāo)是方法,即使不是Controller中的方法。
實(shí)現(xiàn)MethodInterceptor攔截器大致也分為兩種,一種是實(shí)現(xiàn)MethodInterceptor接口,另一種利用Aspect的注解或配置。
關(guān)于實(shí)現(xiàn)MethodInterceptor接口的這種方法,還需要在配置文件中做配置,在SpringMVC中使用還可以,在SpringBoot中使用起來(lái)似乎沒(méi)有那么方便。
本文主要還是說(shuō)Aspect注解方式,個(gè)人覺得這種方法才比較靈活,與配置與工程整個(gè)代碼都沒(méi)有耦合(你添加一個(gè)類,做幾個(gè)注解就可以用了,無(wú)需在其他地方再做什么),更易應(yīng)用。
首先為你的SpringBoot項(xiàng)目添加maven依賴,讓其支持aop(其實(shí)就是自動(dòng)引入aop需要的一些jar)
在pom.xml中添加依賴:
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-aop</artifactId> </dependency>
然后創(chuàng)建Aspect測(cè)試類:
package com.shanhy.sboot.aop; import org.aspectj.lang.JoinPoint; import org.aspectj.lang.annotation.After; import org.aspectj.lang.annotation.Aspect; import org.aspectj.lang.annotation.Before; import org.springframework.core.annotation.Order; import org.springframework.stereotype.Component; @Aspect // FOR AOP @Order(-99) // 控制多個(gè)Aspect的執(zhí)行順序,越小越先執(zhí)行 @Component public class TestAspect { @Before("@annotation(test)")// 攔截被TestAnnotation注解的方法;如果你需要攔截指定package指定規(guī)則名稱的方法,可以使用表達(dá)式execution(...),具體百度一下資料一大堆 public void beforeTest(JoinPoint point, TestAnnotation test) throws Throwable { System.out.println("beforeTest:" + test.name()); } @After("@annotation(test)") public void afterTest(JoinPoint point, TestAnnotation test) { System.out.println("afterTest:" + test.name()); } }
這樣就完成了,然后創(chuàng)建一個(gè)Controller驗(yàn)證一下:
@RestController @RequestMapping("/test") public class TestController { @TestAnnotation(name="abc") @RequestMapping("/show") public String show() { return "OK"; } @RequestMapping("/show2") public String show2() { return "OK2"; } }
此時(shí)我們?cè)L問(wèn)show請(qǐng)求,就會(huì)被攔截,控制臺(tái)會(huì)打印輸出。如果請(qǐng)求show2則不會(huì)被攔截。
注意:
1、在application.properties中也不需要添加spring.aop.auto=true,因?yàn)檫@個(gè)默認(rèn)就是true,值為true就是啟用@EnableAspectJAutoProxy注解了。
2、你不需要手工添加 @EnableAspectJAutoProxy 注解。
3、當(dāng)你需要使用CGLIB來(lái)實(shí)現(xiàn)AOP的時(shí)候,需要配置spring.aop.proxy-target-class=true,這個(gè)默認(rèn)值是false,不然默認(rèn)使用的是標(biāo)準(zhǔn)Java的實(shí)現(xiàn)。
其實(shí)aspectj的攔截器會(huì)被解析成AOP中的advice,最終被適配成MethodInterceptor,這些都是Spring自動(dòng)完成的,如果你有興趣,詳細(xì)的過(guò)程請(qǐng)參考springAOP的實(shí)現(xiàn)。
關(guān)于集中攔截方法的區(qū)別總結(jié):
HandlerInterceptoer攔截的是請(qǐng)求地址,所以針對(duì)請(qǐng)求地址做一些驗(yàn)證、預(yù)處理等操作比較合適。當(dāng)你需要統(tǒng)計(jì)請(qǐng)求的響應(yīng)時(shí)間時(shí)MethodInterceptor將不太容易做到,因?yàn)樗赡芸缭胶芏喾椒ɑ蛘咧簧婕暗揭呀?jīng)定義好的方法中一部分代碼。
MethodInterceptor利用的是AOP的實(shí)現(xiàn)機(jī)制,在本文中只說(shuō)明了使用方式,關(guān)于原理和機(jī)制方面介紹的比較少,因?yàn)橐f(shuō)清楚這些需要講出AOP的相當(dāng)一部分內(nèi)容。在對(duì)一些普通的方法上的攔截HandlerInterceptoer就無(wú)能為力了,這時(shí)候只能利用AOP的MethodInterceptor。
Filter是Servlet規(guī)范規(guī)定的,不屬于spring框架,也是用于請(qǐng)求的攔截。但是它適合更粗粒度的攔截,在請(qǐng)求前后做一些編解碼處理、日志記錄等。
以上就是本文的全部?jī)?nèi)容,希望對(duì)大家的學(xué)習(xí)有所幫助,也希望大家多多支持腳本之家。
相關(guān)文章
詳解MyBatis的XML實(shí)現(xiàn)方法(附帶注解方式實(shí)現(xiàn))
這篇文章主要詳細(xì)介紹了MyBatis的XML實(shí)現(xiàn)方法(附帶注解方式實(shí)現(xiàn)),文中通過(guò)代碼示例給大家講解的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作有一定的幫助,需要的朋友可以參考下2024-05-05Spring Boot中Bean定義方調(diào)用方式解析
這篇文章主要介紹了Spring Boot中Bean定義方調(diào)用方式解析,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2020-07-07SpringBoot集成SwaggerUi以及啟動(dòng)時(shí)遇到的錯(cuò)誤
這篇文章主要介紹了SpringBoot集成SwaggerUi以及啟動(dòng)時(shí)遇到的錯(cuò)誤,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2020-06-06Spring?MVC中@Controller和@RequestMapping注解使用
這篇文章主要介紹了Spring?MVC中@Controller和@RequestMapping注解使用,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2022-02-02