重庆分公司,新征程启航
为企业提供网站建设、域名注册、服务器等服务
在Java的服务端开发当中,拦截器是很常见的业务场景,这里对Java开发当中几种常见的拦截器的实现方式进行记录和分析。案例说明基于Spring Boot环境。
成都创新互联坚持“要么做到,要么别承诺”的工作理念,服务领域包括:成都网站建设、网站建设、企业官网、英文网站、手机端网站、网站推广等服务,满足客户于互联网时代的冀州网站设计、移动媒体设计的需求,帮助企业找到有效的互联网解决方案。努力成为您成熟可靠的网络建设合作伙伴!
一:实现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注解,创建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;}}
上面这两种拦截请求的实现是基于JavaEE提供的Filter接口实现的,缺点在于,该拦截器实际上是一个过滤器,执行代码的方法doFilter只提供了request,response等参数,当请求进入被过滤器拦截的时候,我们并不知道这个请求是由哪个控制器的哪个方法来执行的。
三:使用springMVC提供的拦截器,实现org.springframework.web.servlet.HandlerInterceptor接口:
创建自定义的拦截器:
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);}}
创建配置类:
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对象无法获取具体执行方法的参数信息。
四:利用Spring的切面(AOP)实现拦截器:
引入jar包:
!-- --dependencygroupIdorg.springframework.boot/groupIdartifactIdspring-boot-starter-aop/artifactId/dependency
创建切片类:
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实现的拦截器功能十分强大,具体详解请参考spring官网网站的文档。
区别如下:
1 、拦截器是基于java的反射机制的,而过滤器是基于函数回调。
2 、拦截器不依赖与servlet容器,过滤器依赖与servlet容器。
3 、拦截器只能对action请求起作用,而过滤器则可以对几乎所有的请求起作用。
4 、拦截器可以访问action上下文、值栈里的对象,而过滤器不能访问。
5 、在action的生命周期中,拦截器可以多次被调用,而过滤器只能在容器初始化时被调用一次。
使用如下:
在Servlet作为过滤器使用时,它可以对客户的请求进行处理。处理完成后,它会交给下一个过滤器处理,这样,客户的请求在过滤链里逐个处理,直到请求发送到目标为止。例如,某网站里有提交“修改的注册信息”的网页,当用户填写完修改信息并提交后,服务器在进行处理时需要做两项工作:判断客户端的会话是否有效;对提交的数据进行统一编码。
这两项工作可以在由两个过滤器组成的过滤链里进行处理。当过滤器处理成功后,把提交的数据发送到最终目标;如果过滤器处理不成功,将把视图派发到指定的错误页面。
扩展资料:
拦截器,在AOP(Aspect-Oriented Programming)中用于在某个方法或字段被访问之前,进行拦截然后在之前或之后加入某些操作。拦截是AOP的一种实现策略。
在Webwork的中文文档的解释为——拦截器是动态拦截Action调用的对象。它提供了一种机制可以使开发者可以定义在一个action执行的前后执行的代码,也可以在一个action执行前阻止其执行。同时也是提供了一种可以提取action中可重用的部分的方式。
过滤器是一个程序,它先于与之相关的servlet或JSP页面运行在服务器上。过滤器可附加到一个或多个servlet或JSP页面上,并且可以检查进入这些资源的请求信息。
参考资料:百度百科-java
本文将用简洁的代码构建一个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
// 假设现在的token有如下数据
List tokenList = Arrays.asList("111", "222", "333");
// 这个方法是在访问接口之前执行的,我们只需要在这里写验证登陆状态的业务逻辑,就可以在用户调用指定接口之前验证登陆状态了
@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是通过拦截器,可以继续访问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博主「魔王别嚣张」的原创文章,遵循CC 4.0 BY-SA版权协议,转载请附上原文出处链接及本声明。
原文链接:
拦截器在在流行的开源框架中很常见 依赖的技术就是Java的动态代理
理解拦截器的核心原理对理解这些开源框架的体系结构至关重要
下面以一个简单的模型的来说明拦截器的实现的一般方法
模型分为以下模块
业务组件 是被代理和被拦截的对象
代理处理器 实现了InvocationHandler接口的一个对象
代理对象 Proxy对象
拦截器 普通的JavaBean 在调用业务方法的之前或者之后会自动拦截并执行自己的一些方法
客户端 执行业务处理的入口
以下是模型的实现
一 业务组件 分为业务接口和业务类
/**
* 业务组件接口
*/
public interface BusinessInterface {
public void doSomething();
}
/**
* 业务组件
*/
public class BusinessClass implements BusinessInterface{
public void doSomething() {
System out println( 业务组件BusinessClass方法调用:doSomething() );
}
}
二 代理处理器 包含了业务对象绑定动态代理类的处理 并实现了 InvocationHandler接口的invoke方法
import java lang reflect InvocationHandler;
import java lang reflect Method;
import java lang reflect Proxy;
/**
* 动态代理处理器工具
*/
public class DynamicProxyHandler implements InvocationHandler {
private Object business; //被代理对象
private InterceptorClass interceptor = new InterceptorClass(); //拦截器
/**
* 动态生成一个代理类对象 并绑定被代理类和代理处理器
*
* @param business
* @return 代理类对象
*/
public Object bind(Object business) {
this business = business;
return Proxy newProxyInstance(
//被代理类 的ClassLoader
business getClass() getClassLoader()
//要被代理 的接口 本方法返回对象会自动声称实现了这些接口
business getClass() getInterfaces()
//代理处理 器对象
this);
}
/**
* 代理要调用的方法 并在方法调用前后调用连接器的方法
*
* @param proxy 代理类对象
* @param method 被代理的接口方法
* @param args 被代理接口方法的参数
* @return 方法调用返回的结果
* @throws Throwable
*/
public Object invoke(Object proxy Method method Object[] args) throws Throwable {
Object result = null;
interceptor before();
result=method invoke(business args);
interceptor after();
return null; //To change body of implemented methods use File | Settings | File Templates
}
}
三 拦截器 普通的JavaBean 在调用业务方法的之前或者之后会自动拦截并执行自己的 一些方法
/**
* 拦截器
*/
public class InterceptorClass {
public void before(){
System out println( 拦截器InterceptorClass方法调用:before()! );
}
public void after(){
System out println( 拦截器InterceptorClass方法调用:after()! );
}
}
四 模拟客户端 执行业务处理的入口
/**
* 客户端
*/
public class Client {
public static void main(String args[]) {
DynamicProxyHandler handler = new DynamicProxyHandler();
BusinessInterface business = new BusinessClass();
BusinessInterface businessProxy = (BusinessInterface) handler bind(business);
businessProxy doSomething();
}
lishixinzhi/Article/program/Java/hx/201311/27143
!-- 整合Spring --
constant name="struts.objectFactory" value="spring"/
!-- 开启使用开发模式,详细错误提示 --
constant name="struts.devMode" value="false"/
!-- 指定每次请求到达,重新加载资源文件 --
!-- constant name="struts.i18n.reload" value="true"/ --
!-- 指定每次配置文件更改后,自动重新加载 --
!-- constant name="struts.configuration.xml.reload" value="true"/ --
!-- 指定XSLT Result使用样式表缓存 --
!-- constant name="struts.xslt.nocache" value="true"/ --
!-- 设置该应用使用的解码集 --
constant name="struts.i18n.encoding" value="UTF-8"/constant
!-- struts2 中默认提供了一些访问静态成员的方式,但是默认是关闭的,所以应该在struts2的配置文件中先设置 --
constant name="struts.ognl.allowStaticMethodAccess" value="true"/
include file="struts-default.xml" /
include file="struts-action.xml" /
---------------------------------------------------
struts-action.xml:
package name="com.lj.actions" extends="struts-default"
!-- 拦截器-验证用户登录 --
interceptors
!-- interceptor name="check" class ="com.lj.interceptor.CheckLoginInterceptor" / --
interceptor name="authority" class="com.lj.interceptor.MyFilterInterceptor"/ !--上面自定义的拦截器类--
interceptor-stack name="myDefault"
interceptor-ref name="authority" !-- 引用拦截器 --
param name="includeMethods"queryByAll,queryByWhere,queryByAdId,queryByAdminAll,queryByWhere2CSV,adCheck,adDelete,delete,save,update,accredit,showInfo,appCheck/param !-- 设置需要拦截的方法,多个以逗号隔开 --
/interceptor-ref
interceptor-ref name="defaultStack"/interceptor-ref
/interceptor-stack
/interceptors
default-interceptor-ref name="myDefault"/default-interceptor-ref
!-- 全局跳转页面 --
global-results
result name="error_limit"/jsp/admin/error_limit.jsp/result
result name="list_sys_login"/jsp/admin/list_sys_login.jsp/result
/global-results
!-- 广告管理——广告审核 --
action name="AdCheck" class="com.lj.actions.AdCheckAction"
result name="list_ad_sh"/jsp/admin/list_ad_sh.jsp/result
/action
!-- 广告管理——广告列表 --
action name="AdList" class="com.lj.actions.AdListAction"
result name="list_ad_ls"/jsp/admin/list_ad_ls.jsp/result
/action