filter惹骂、interceptor苏携、aspect
- Filter過濾器
- Interceptor攔截器
- Aspect切片
Filter過濾器
過濾器依賴于servlet容器。在實(shí)現(xiàn)上对粪，基于函數(shù)回調(diào)右冻，它可以對(duì)幾乎所有請(qǐng)求進(jìn)行過濾，一個(gè)過濾器實(shí)例只能在容器初始化時(shí)調(diào)用一次著拭。
過濾器可以攔截到方法的請(qǐng)求和響應(yīng)(ServletRequest request, ServletResponse response),并對(duì)請(qǐng)求響應(yīng)做出過濾操作纱扭。
使用過濾器的目的是用來做一些過濾操作，對(duì)請(qǐng)求的數(shù)據(jù)進(jìn)行獲取儡遮，或者替換請(qǐng)求數(shù)據(jù)乳蛾，或者權(quán)限攔截檢查，比如：在過濾器中修改字符編碼鄙币；在過濾器中修改HttpServletRequest的一些參數(shù)肃叶，過濾關(guān)鍵字：過濾低俗文字、危險(xiǎn)字符等爱榔。
切面的方法說明
@Aspect 作用是把當(dāng)前類標(biāo)識(shí)為一個(gè)切面供容器讀取
@Before 標(biāo)識(shí)一個(gè)前置增強(qiáng)方法被环，相當(dāng)于BeforeAdvice的功能
@AfterReturning 后置增強(qiáng)，相當(dāng)于AfterReturningAdvice详幽，方法退出時(shí)執(zhí)行
@AfterThrowing 異常拋出增強(qiáng)，相當(dāng)于ThrowsAdvice
@After final增強(qiáng)浸锨，不管是拋出異炒狡福或者正常退出都會(huì)執(zhí)行
@Around 環(huán)繞增強(qiáng)，相當(dāng)于MethodInterceptor
除了@Around外柱搜，每個(gè)方法里都可以加或者不加參數(shù)JoinPoint迟郎，如果有用JoinPoint的地方就加，不加也可以聪蘸，JoinPoint里包含了類名宪肖、被切面的方法名表制，參數(shù)等屬性，可供讀取使用控乾。@Around參數(shù)必須為ProceedingJoinPoint么介，pjp.proceed相應(yīng)于執(zhí)行被切面的方法。@AfterReturning方法里蜕衡，可以加returning = “XXX”壤短，XXX即為在controller里方法的返回值，本例中的返回值是“first controller”慨仿。@AfterThrowing方法里久脯，可以加throwing = "XXX"
切面PointCut的切入點(diǎn)
execution切點(diǎn)函數(shù)
- execution函數(shù)用于匹配方法執(zhí)行的連接點(diǎn)，語(yǔ)法為：
execution(方法修飾符(可選) 返回類型 方法名 參數(shù) 異常模式(可選))
例如：
execution(* com.imooc.controller.UserController.*(..))
第一個(gè) * 代表的是所有的返回值類型镰吆，
com.imooc.controller.UserController.*代表的是com.imooc.controller包下UserController類的所有方法帘撰，
(..)代表的是所有的參數(shù)
Filter代碼實(shí)例
@Component
public class TimeFilter implements Filter {
private static final Logger LOGGER = LoggerFactory.getLogger(TimeFilter.class);
@Override
public void init(FilterConfig filterConfig) throws ServletException {}
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
HttpServletRequest request = (HttpServletRequest) servletRequest;
String uri = request.getRequestURI();
long start = System.currentTimeMillis();
filterChain.doFilter(servletRequest,servletResponse);
long end = System.currentTimeMillis();
LOGGER.info("請(qǐng)求地址 : [{}], 耗時(shí) : [{}]",uri, (end-start)/3600);
}
@Override
public void destroy() {
}
}
- 實(shí)現(xiàn)javax.servlet.Filter接口，并重寫接口的三個(gè)方法万皿，其中doFilter方法是必須實(shí)現(xiàn)的摧找，其它兩個(gè)方法是接口的默認(rèn)方法；
- doFilter方法 提供請(qǐng)求的ServletRequest和響應(yīng)的ServletResponse對(duì)象
- Filter中無法獲取其它對(duì)象相寇，例如Controller 即Filter中不支持對(duì)象注入(@AutoWired). 在Spring中 web容器的加載順序是：Listener -> Filter -> Servlet, 先初始化Listener慰于，然后進(jìn)行Filter初始化，再接口進(jìn)行Servlet的初始化過程唤衫。然后我們的Controller對(duì)象即在Servlet容器初始化后進(jìn)行初始化的婆赠，所以在Filter初始化時(shí)，注解獲取Bean的還沒有進(jìn)行初始化佳励，即沒法注入休里。
public interface Filter {
default void init(FilterConfig filterConfig) throws ServletException {
}
void doFilter(ServletRequest var1, ServletResponse var2, FilterChain var3) throws IOException, ServletException;
default void destroy() {
}
}
Filter配置
Filter過濾器實(shí)例已經(jīng)書寫完畢，但是使其生效需要進(jìn)行配置赃承，一般有兩種方式進(jìn)行配置：
- 第一個(gè)方案在Filter上面加上@Component
@Component
public class TimeFilter implements Filter {
...
}
-
第二個(gè)方案配置化注冊(cè)過濾器
該方案的特點(diǎn)就是可以細(xì)化到過濾哪些規(guī)則的URL
@Configuration
public class FilterConfig {
@Bean
FilterRegistrationBean<TimeFilter> filterRegistrationBean() {
FilterRegistrationBean<TimeFilter> registrationBean = new FilterRegistrationBean();
TimeFilter timeFilter = new TimeFilter();
registrationBean.setFilter(timeFilter);
registrationBean.setUrlPatterns(Arrays.asList("/*"));
return registrationBean;
}
}
容器啟動(dòng)輸出：
com.ams.admin.filters.TimeFilter : init...
調(diào)用請(qǐng)求輸出
2019-09-04 14:11:27.424 INFO 66854 --- [io-10001-exec-2] com.ams.admin.filters.TimeFilter : 請(qǐng)求地址 : [/group/single], 耗時(shí) : [10334] ms
2019-09-04 14:11:34.236 INFO 66854 --- [io-10001-exec-3] com.ams.admin.filters.TimeFilter : 請(qǐng)求地址 : [/group/single], 耗時(shí) : [14] ms
2019-09-04 14:11:35.442 INFO 66854 --- [io-10001-exec-4] com.ams.admin.filters.TimeFilter : 請(qǐng)求地址 : [/group/single], 耗時(shí) : [14] ms
容器銷毀輸出
2019-09-04 14:19:16.148 INFO 66854 --- [ Thread-31] o.s.s.concurrent.ThreadPoolTaskExecutor : Shutting down ExecutorService 'applicationTaskExecutor'
2019-09-04 14:19:16.149 INFO 66854 --- [ Thread-31] com.alibaba.druid.pool.DruidDataSource : {dataSource-3} closed
2019-09-04 14:19:16.158 INFO 66854 --- [ Thread-31] com.ams.admin.filters.TimeFilter : destroy...
Filter 總結(jié)
- 過濾器（Filter）是基于函數(shù)回調(diào)妙黍；
- Filter隨web應(yīng)用的啟動(dòng)而啟動(dòng)，只初始化一次瞧剖，隨web應(yīng)用的停止而銷毀拭嫁；
- 啟動(dòng)服務(wù)器時(shí)加載過濾器的實(shí)例，并調(diào)用init()方法來初始化實(shí)例抓于；
- 每一次請(qǐng)求時(shí)都只調(diào)用方法doFilter()進(jìn)行處理做粤；
- 停止服務(wù)器時(shí)調(diào)用destroy()方法，銷毀實(shí)例捉撮。
Interceptor攔截器
Interceptor基于Java的反射機(jī)制怕品，屬于面向切面編程（AOP）的一種運(yùn)用，就是在一個(gè)方法前巾遭，調(diào)用一個(gè)方法肉康，或者在方法后闯估，調(diào)用一個(gè)方法。其實(shí)我們所了解的代理機(jī)制其實(shí)就是一種攔截器的實(shí)現(xiàn)吼和。而我們此處討論的攔截器是針對(duì)web框架所說的涨薪，所以依賴于web框架。
- 在web開發(fā)中纹安，攔截器是經(jīng)常用到的功能尤辱。它可以幫我們驗(yàn)證是否登陸、預(yù)先設(shè)置數(shù)據(jù)以及統(tǒng)計(jì)方法的執(zhí)行效率等厢岂。在spring中攔截器有兩種光督，第一種是HandlerInterceptor，第二種是MethodInterceptor塔粒。HandlerInterceptor是SpringMVC中的攔截器结借，它攔截的是Http請(qǐng)求的信息，優(yōu)先于MethodInterceptor卒茬。而MethodInterceptor是springAOP的船老。前者攔截的是請(qǐng)求的地址，而后者是攔截controller中的方法圃酵，因?yàn)橄旅嬉獙spect柳畔，就不詳細(xì)講述MethodInterceptor
代碼實(shí)例
public class AmsInterceptor implements HandlerInterceptor {
private static final Logger LOGGER = LoggerFactory.getLogger(AmsInterceptor.class);
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
HandlerMethod method = (HandlerMethod) handler;
String cn = method.getBean().getClass().getName();
String mn = method.getMethod().getName();
LOGGER.info("preHandle -> [{}]#[{}]#[{}]", cn, mn, readRaw(request.getInputStream()));
return true;
}
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
LOGGER.info("postHandle -> [{}]#[{}]", request.getRequestURI(), request.getPathInfo());
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
LOGGER.info("afterCompletion -> [{}]#[{}]", request.getRequestURI(), request.getPathInfo());
}
public static String readRaw(InputStream inputStream) {
String result = "";
try {
ByteArrayOutputStream outSteam = new ByteArrayOutputStream();
byte[] buffer = new byte[1024];
int len;
while ((len = inputStream.read(buffer)) != -1) {
outSteam.write(buffer, 0, len);
}
outSteam.close();
inputStream.close();
result = new String(outSteam.toByteArray(), "UTF-8");
} catch (IOException e) {
e.printStackTrace();
}
return result;
}
}
Interceptor配置
- 繼承WebMvcConfigurationSupport
@Configuration
public class InterceptorConfig extends WebMvcConfigurationSupport {
@Autowired
AmsInterceptor amsInterceptor;
/**
* Override this method to add Spring MVC interceptors for
* pre- and post-processing of controller invocation.
*
* @param registry
* @see InterceptorRegistry
*/
@Override
protected void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(amsInterceptor).addPathPatterns(Arrays.asList("/**"));
}
}
輸出
2019-09-05 11:27:29.585 INFO 77598 --- [io-10001-exec-4] com.ams.admin.filters.TimeFilter : 請(qǐng)求地址 : [/group/single]
2019-09-05 11:27:29.586 INFO 77598 --- [io-10001-exec-4] c.ams.admin.interceptor.AmsInterceptor : preHandle : [com.ams.admin.controller.AmsGroupController]#[operateEntity]#[{ "name":"三部", "groupAmsid":"0003", "remark":"三部", "systemId": 1, "operator":"maozw"}]
2019-09-05 11:27:29.586 INFO 77598 --- [io-10001-exec-4] c.a.admin.controller.AmsGroupController : controller
2019-09-05 11:27:29.603 INFO 77598 --- [io-10001-exec-4] c.ams.admin.interceptor.AmsInterceptor : postHandle : [/group/single]
2019-09-05 11:27:29.603 INFO 77598 --- [io-10001-exec-4] c.ams.admin.interceptor.AmsInterceptor : afterCompletion : [/group/single]
2019-09-05 11:27:29.603 INFO 77598 --- [io-10001-exec-4] com.ams.admin.filters.TimeFilter : 請(qǐng)求地址 : [/group/single], 耗時(shí) : [18] ms
執(zhí)行流程解釋
- 簡(jiǎn)要說明一下Interceptor執(zhí)行流程，
- 我們通過日志可以看出郭赐，執(zhí)行流程 TimeFilter -> preHandle -> controller -> postHandle -> afterCompletion
我們看下SpringMVC的核心類 org.springframework.web.servlet.DispatcherServlet
protected void doDispatch(HttpServletRequest request, HttpServletResponse response) throws Exception {
...
try {
...
try {
...
if (!mappedHandler.applyPreHandle(processedRequest, response)) {
return;
}
// Actually invoke the handler.
mv = ha.handle(processedRequest, response, mappedHandler.getHandler());
if (asyncManager.isConcurrentHandlingStarted()) {
return;
}
applyDefaultViewName(processedRequest, mv);
mappedHandler.applyPostHandle(processedRequest, response, mv);
}
catch (Exception ex) {
...
}
finally {
...
if (asyncManager.isConcurrentHandlingStarted()) {
// Instead of postHandle and afterCompletion
if (mappedHandler != null) {
mappedHandler.applyAfterConcurrentHandlingStarted(processedRequest, response);
}
}
}
}
以上是刪除一些無關(guān)代碼之后的：
mappedHandler.applyPreHandle(processedRequest, response) 這個(gè)方法執(zhí)行薪韩，就是執(zhí)行的攔截器的preHandler方法
mappedHandler.applyPostHandle(processedRequest, response, mv)； postHandler方法的執(zhí)行捌锭，當(dāng)controller內(nèi)部有異常俘陷，posthandler方法是不會(huì)執(zhí)行的。
mappedHandler.applyAfterConcurrentHandlingStarted(processedRequest, response); ****afterCompletion方法观谦，不管controller內(nèi)部是否有異常拉盾，都會(huì)執(zhí)行此方法；此方法還會(huì)有個(gè)Exception ex這個(gè)參數(shù)豁状；如果有異常捉偏，ex會(huì)有異常值；沒有異常 此值為null
根據(jù)上面的流程我們知道ha.handle(processedRequest, response, mappedHandler.getHandler());方法才會(huì)對(duì)請(qǐng)求參數(shù)進(jìn)行組裝方法參數(shù)泻红，所以我們是在攔截器中可以拿到Http原始請(qǐng)求和響應(yīng)信息告私，也可以獲取到ioc的bean(controller)但是這個(gè)這個(gè)方法的參數(shù)是沒法通過haner對(duì)象去獲取。
值得一提的事情承桥，因?yàn)槲以贗nterceptor中獲取了ServletRequest的InputStream 這個(gè)操作會(huì)導(dǎo)致后續(xù)在Controller中獲取不到流，解決辦法我會(huì)在另一篇幅中進(jìn)行說明：詳見【】
Aspect切片
AOP操作可以對(duì)操作進(jìn)行橫向的攔截,最大的優(yōu)勢(shì)在于他可以獲取執(zhí)行方法的參數(shù),對(duì)方法進(jìn)行統(tǒng)一的處理根悼。常見使用日志,事務(wù),請(qǐng)求參數(shù)安全驗(yàn)證等凶异。
- 可以拿得到方法響應(yīng)中參數(shù)的值蜀撑，但是拿不到原始的Http請(qǐng)求和相對(duì)應(yīng)響應(yīng)的方法，基于Controller層剩彬。對(duì)于統(tǒng)一異常處理和日志記錄非常方便酷麦，有效地減少了代碼的重復(fù)率。
代碼實(shí)例
@Aspect
@Component
@Slf4j
public class ControllerAspect {
private static final Logger LOGGER = LoggerFactory.getLogger(ControllerAspect.class);
@Around("execution(* com.ams.admin.controller.*.*(..))")
public Object handlerControlerMethod(ProceedingJoinPoint joinPoint) throws Throwable {
Object[] args = joinPoint.getArgs();
LOGGER.info("aop before... [{}]", args);
Object proceed = joinPoint.proceed();
LOGGER.info("aop after...");
return proceed;
}
}
配置使其生效
@EnableTransactionManagement(proxyTargetClass = true)
輸出
2019-09-05 15:18:06.748 INFO 80313 --- [io-10001-exec-2] com.ams.admin.filters.TimeFilter : 請(qǐng)求地址 : [/group/single]
2019-09-05 15:18:06.750 INFO 80313 --- [io-10001-exec-2] c.ams.admin.interceptor.AmsInterceptor : preHandle : [com.ams.admin.controller.AmsGroupController$$EnhancerBySpringCGLIB$$7f16fb78]#[operateEntity]#[{ "name":"三部", "groupAmsid":"0003", "remark":"三部", "systemId": 1, "operator":"maozw"}]
2019-09-05 15:18:06.752 INFO 80313 --- [io-10001-exec-2] com.ams.admin.aspect.ControllerAspect : aop before... [AmsGroup(id=null, groupAmsid=0003, name=三部, systemId=1, remark=三部, createDate=null, modifyDate=null, operator=maozw)]
2019-09-05 15:18:06.755 INFO 80313 --- [io-10001-exec-2] c.a.admin.controller.AmsGroupController : controller
2019-09-05 15:18:16.909 INFO 80313 --- [io-10001-exec-2] com.ams.admin.aspect.ControllerAspect : aop after...
2019-09-05 15:18:16.910 INFO 80313 --- [io-10001-exec-2] c.ams.admin.interceptor.AmsInterceptor : postHandle : [/group/single]
2019-09-05 15:18:16.910 INFO 80313 --- [io-10001-exec-2] c.ams.admin.interceptor.AmsInterceptor : afterCompletion : [/group/single]
2019-09-05 15:18:16.911 INFO 80313 --- [io-10001-exec-2] com.ams.admin.filters.TimeFilter : 請(qǐng)求地址 : [/group/single], 耗時(shí) : [10163] ms
小結(jié)
Filter
參數(shù)：ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain
作用：可以獲取原始的http請(qǐng)求和響應(yīng)對(duì)象喉恋，無法獲取請(qǐng)求控制器
Interceptor
參數(shù)：HttpServletRequest request, HttpServletResponse response, Object handler
作用：可以獲取原始的http請(qǐng)求和響應(yīng)對(duì)象沃饶，可以獲取到控制器和方法，但獲取不到方法參數(shù)
Aspect
參數(shù)：ProceedingJoinPoint joinPoint
作用：無法獲取原始的http請(qǐng)求和響應(yīng)對(duì)象轻黑，可以獲取到控制器和方法糊肤，也可以獲取方法參數(shù)
