strut2的攔截器的一個例子。。。
創(chuàng)新互聯(lián)公司主營烏審網(wǎng)站建設的網(wǎng)絡公司,主營網(wǎng)站建設方案,app開發(fā)定制,烏審h5微信小程序定制開發(fā)搭建,烏審網(wǎng)站營銷推廣歡迎烏審等地區(qū)企業(yè)咨詢
攔截器定義,,這里是一個判斷超時的攔截器功能
interceptors
interceptor name="Timeout" class="com.myproject.util.TimeOutInterceptor"/
/interceptors
action定義。。。。。。。。。。。
action name="cf*" method="{1}" class="com.myproject.action.user.ConfigAction"
!-- 引用自定義的攔截器 --
interceptor-ref name="Timeout"
param name="excludeMethods"
Switch,UpdCss !-- action中的這兩個方法生效 --
/param
/interceptor-ref
interceptor-ref name="basicStack"/ !-- struts 內(nèi)置的默認攔截器 --
result name="config"/user/config.jsp/result
/result
//攔截器的實現(xiàn)。。。。。。。
package com.myproject.util;
import com.opensymphony.xwork2.ActionInvocation;
import com.opensymphony.xwork2.interceptor.MethodFilterInterceptor;
import java.util.Map;
/**
* 通用攔截器,判斷用戶超時
* @author maodrc
*/
public class TimeOutInterceptor extends MethodFilterInterceptor {
@Override
protected String doIntercept(ActionInvocation ai) throws Exception {
Map sessionMap = ai.getInvocationContext().getSession();
String username = (String) sessionMap.get("username");
if (com.maxneting.util.Util.isNull(username)) {
return "timeout";
} else {
return ai.invoke();
}
}
}
本文將用簡潔的代碼構建一個springboot的攔截器。攔截器的使用很簡單,定義一個自己的攔截器,向配置中添加一下就可以使用。為了方便,之后又引入了注解。
目錄和概述
概述
假設需求:訪問項目的controller是都要進行"token驗證",除了某些像登錄之類的方法。
項目結構:
TokenInterceptor.java 自定義攔截器
InterceptorConfig.java 添加攔截器進入項目
NoNeedToken.java 自定義注解
TestController.java 測試接口
1、自定義攔截器
在 TokenInterceptor.java 中輸入以下代碼,以下的代碼將生成一個在請求到達controller前進行攔截的攔截器
import com.alibaba.fastjson.JSONObject;
import org.springframework.lang.Nullable;
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.PrintWriter;
import java.util.Arrays;
import java.util.List;
@Component
public class TokenInterceptor implements HandlerInterceptor {undefined
// 假設現(xiàn)在的token有如下數(shù)據(jù)
List tokenList = Arrays.asList("111", "222", "333");
// 這個方法是在訪問接口之前執(zhí)行的,我們只需要在這里寫驗證登陸狀態(tài)的業(yè)務邏輯,就可以在用戶調(diào)用指定接口之前驗證登陸狀態(tài)了
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {undefined
// 設置返回為json格式,使用UTF-8
response.setCharacterEncoding("UTF-8");
response.setContentType("application/json; charset=utf-8");
String token = request.getHeader("token");
PrintWriter out;
// 之后寫你的判斷邏輯:return true是通過攔截器,可以繼續(xù)訪問controller,return false是不通過
if (token == null || !tokenList.contains(token)) {undefined
// 如果失敗了返回{state:"false", msg:"token is null or wrong"}
JSONObject res = new JSONObject();
res.put("state","false");
res.put("msg","token is null or wrong");
out = response.getWriter();
out.append(res.toString());
return false;
}
// 否則返回true 進入controller
return true;
}
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable ModelAndView modelAndView) throws Exception {undefined
}
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable Exception ex) throws Exception {undefined
}
}
————————————————
版權聲明:本文為CSDN博主「魔王別囂張」的原創(chuàng)文章,遵循CC 4.0 BY-SA版權協(xié)議,轉(zhuǎn)載請附上原文出處鏈接及本聲明。
原文鏈接:
在Java的服務端開發(fā)當中,攔截器是很常見的業(yè)務場景,這里對Java開發(fā)當中幾種常見的攔截器的實現(xiàn)方式進行記錄和分析。案例說明基于Spring Boot環(huán)境。
一:實現(xiàn)javax.servlet.Filter接口(使用過濾器方式攔截請求)
import org.springframework.stereotype.Component;import javax.servlet.*;import java.io.IOException;import java.util.Date;@Componentpublic class TimeInterceptor implements Filter {@Overridepublic void init(FilterConfig filterConfig) throws ServletException {System.out.println("time filter init");}@Overridepublic void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {System.out.println("time filter start");long start = new Date().getTime();filterChain.doFilter(servletRequest, servletResponse);System.out.println("time filter 耗時:"+(new Date().getTime()-start));System.out.println("time filter finish");}@Overridepublic void destroy() {System.out.println("time filter destroy");}}
如使用@Compent注解聲明不需要加入其它配置即可使得攔截器生效,但是默認攔截/*,會攔截所有請求。
二:使用@Bean注入自定義攔截器,依然上面的代碼,去掉@Compent注解,創(chuàng)建TimeWebConfig配置類:
import org.springframework.boot.web.servlet.FilterRegistrationBean;import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.Configuration;import java.util.ArrayList;import java.util.List;@Configurationpublic class TimeWebConfig {@Beanpublic FilterRegistrationBean timeFilter(){FilterRegistrationBean registrationBean = new FilterRegistrationBean();TimeInterceptor interceptor = new TimeInterceptor();registrationBean.setFilter(interceptor);ListString urls = new ArrayList();urls.add("/user/*");registrationBean.setUrlPatterns(urls);return registrationBean;}}
上面這兩種攔截請求的實現(xiàn)是基于JavaEE提供的Filter接口實現(xiàn)的,缺點在于,該攔截器實際上是一個過濾器,執(zhí)行代碼的方法doFilter只提供了request,response等參數(shù),當請求進入被過濾器攔截的時候,我們并不知道這個請求是由哪個控制器的哪個方法來執(zhí)行的。
三:使用springMVC提供的攔截器,實現(xiàn)org.springframework.web.servlet.HandlerInterceptor接口:
創(chuàng)建自定義的攔截器:
import org.springframework.stereotype.Component;import org.springframework.web.method.HandlerMethod;import org.springframework.web.servlet.HandlerInterceptor;import org.springframework.web.servlet.ModelAndView;import javax.servlet.http.HttpServletRequest;import javax.servlet.http.HttpServletResponse;import java.util.Date;@Componentpublic class MyInterceptor implements HandlerInterceptor {@Overridepublic boolean preHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object handler) throws Exception {System.out.println("preHandler");System.out.println(((HandlerMethod) handler).getBean().getClass().getName());System.out.println(((HandlerMethod) handler).getMethod().getName());httpServletRequest.setAttribute("start", new Date().getTime());return true;}@Overridepublic void postHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, ModelAndView modelAndView) throws Exception {System.out.println("postHandler");Long start = (Long) httpServletRequest.getAttribute("start");System.out.println("time interceptor 耗時:"+(new Date().getTime()-start));}@Overridepublic void afterCompletion(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, Exception e) throws Exception {System.out.println("afterCompletion");Long start = (Long) httpServletRequest.getAttribute("start");System.out.println("time interceptor 耗時:"+(new Date().getTime()-start));System.out.println("ex is:"+e);}}
創(chuàng)建配置類:
import org.springframework.beans.factory.annotation.Autowired;import org.springframework.context.annotation.Configuration;import org.springframework.web.servlet.config.annotation.InterceptorRegistry;import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;@Configurationpublic class WebConfig extends WebMvcConfigurerAdapter {@Autowiredprivate MyInterceptor interceptor;@Overridepublic void addInterceptors(InterceptorRegistry registry) {registry.addInterceptor(interceptor).addPathPatterns("/user/*").excludePathPatterns("/blog/*");}}
此種方式的攔截器當中我們能夠獲取攔截的請求對應的類和方法的相關信息,缺點在于該handler對象無法獲取具體執(zhí)行方法的參數(shù)信息。
四:利用Spring的切面(AOP)實現(xiàn)攔截器:
引入jar包:
!-- --dependencygroupIdorg.springframework.boot/groupIdartifactIdspring-boot-starter-aop/artifactId/dependency
創(chuàng)建切片類:
import org.aspectj.lang.ProceedingJoinPoint;import org.aspectj.lang.annotation.Around;import org.aspectj.lang.annotation.Aspect;import org.springframework.stereotype.Component;import java.util.Date;@Aspect@Componentpublic class TimeAspect {@Around("execution(* com.qinker.controller.UserController.*(..))")public Object handlerControllerMethod(ProceedingJoinPoint point) throws Throwable {System.out.println("time aspect start");long start = new Date().getTime();Object[] args = point.getArgs();for (Object obj : args) {System.out.println("arg is:"+obj);}Object obj = point.proceed();//具體方法的返回值System.out.println("aspect 耗時:"+(new Date().getTime()-start));System.out.println("time aspect end");return obj;}}
aspectj基于AOP實現(xiàn)的攔截器功能十分強大,具體詳解請參考spring官網(wǎng)網(wǎng)站的文檔。
java里的攔截器是動態(tài)攔截Action調(diào)用的對象,它提供了一種機制可以使開發(fā)者在一個Action執(zhí)行的前后執(zhí)行一段代碼,也可以在一個Action
執(zhí)行前阻止其執(zhí)行,同時也提供了一種可以提取Action中可重用部分代碼的方式。在AOP中,攔截器用于在某個方法或者字段被訪問之前,進行攔截
然后再之前或者之后加入某些操作。目前,我們需要掌握的主要是Spring的攔截器,Struts2的攔截器不用深究,知道即可。
2,攔截器的原理
大部分時候,攔截器方法都是通過代理的方式來調(diào)用的。Struts2的攔截器實現(xiàn)相對簡單。當請求到達Struts2的ServletDispatcher時,Struts2
會查找配置文件,并根據(jù)配置實例化相對的攔截器對象,然后串成一個列表(List),最后一個一個的調(diào)用列表中的攔截器。Struts2的攔截器是可
插拔的,攔截器是AOP的一個實現(xiàn)。Struts2攔截器棧就是將攔截器按一定的順序連接成一條鏈。在訪問被攔截的方法或者字段時,Struts2攔截器鏈
中的攔截器就會按照之前定義的順序進行調(diào)用。
3,自定義攔截器的步驟
第一步:自定義一個實現(xiàn)了Interceptor接口的類,或者繼承抽象類AbstractInterceptor。
第二步:在配置文件中注冊定義的攔截器。
第三步:在需要使用Action中引用上述定義的攔截器,為了方便也可以將攔截器定義為默認的攔截器,這樣在不加特殊說明的情況下,所有的
Action都被這個攔截器攔截。
4,過濾器與攔截器的區(qū)別
過濾器可以簡單的理解為“取你所想取”,過濾器關注的是web請求;攔截器可以簡單的理解為“拒你所想拒”,攔截器關注的是方法調(diào)用,比如攔截
敏感詞匯。
4.1,攔截器是基于java反射機制來實現(xiàn)的,而過濾器是基于函數(shù)回調(diào)來實現(xiàn)的。(有人說,攔截器是基于動態(tài)代理來實現(xiàn)的)
4.2,攔截器不依賴servlet容器,過濾器依賴于servlet容器。
4.3,攔截器只對Action起作用,過濾器可以對所有請求起作用。
4.4,攔截器可以訪問Action上下文和值棧中的對象,過濾器不能。
4.5,在Action的生命周期中,攔截器可以多次調(diào)用,而過濾器只能在容器初始化時調(diào)用一次。
5,Spring攔截器