java拦截器代码,java interceptor拦截器

提示：扫一扫查出行
【扫一扫了解最新限行尾号】
复制提示

Java实现拦截HTTP请求的几种方式

在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官网网站的文档。

相关问答

Q1: java如何实现拦截短信功能

java里的拦截器是动态拦截Action调用的对象，它提供了一种机制可以使开发者在一个Action执行的前后执行一段代码，也可以在一个Action

执行前阻止其执行，同时也提供了一种可以提取Action中可重用部分代码的方式。在AOP中，拦截器用于在某个方法或者字段被访问之前，进行拦截

然后再之前或者之后加入某些操作。目前，我们需要掌握的主要是Spring的拦截器，Struts2的拦截器不用深究，知道即可。

2，拦截器的原理

大部分时候，拦截器方法都是通过代理的方式来调用的。Struts2的拦截器实现相对简单。当请求到达Struts2的ServletDispatcher时，Struts2

会查找配置文件，并根据配置实例化相对的拦截器对象，然后串成一个列表（List），最后一个一个的调用列表中的拦截器。Struts2的拦截器是可

插拔的，拦截器是AOP的一个实现。Struts2拦截器栈就是将拦截器按一定的顺序连接成一条链。在访问被拦截的方法或者字段时，Struts2拦截器链

中的拦截器就会按照之前定义的顺序进行调用。

3，自定义拦截器的步骤

第一步：自定义一个实现了Interceptor接口的类，或者继承抽象类AbstractInterceptor。

第二步：在配置文件中注册定义的拦截器。

第三步：在需要使用Action中引用上述定义的拦截器，为了方便也可以将拦截器定义为默认的拦截器，这样在不加特殊说明的情况下，所有的

Action都被这个拦截器拦截。

4，过滤器与拦截器的区别

过滤器可以简单的理解为“取你所想取”，过滤器关注的是web请求；拦截器可以简单的理解为“拒你所想拒”，拦截器关注的是方法调用，比如拦截

敏感词汇。

4.1，拦截器是基于java反射机制来实现的，而过滤器是基于函数回调来实现的。（有人说，拦截器是基于动态代理来实现的）

4.2，拦截器不依赖servlet容器，过滤器依赖于servlet容器。

4.3，拦截器只对Action起作用，过滤器可以对所有请求起作用。

4.4，拦截器可以访问Action上下文和值栈中的对象，过滤器不能。

4.5，在Action的生命周期中，拦截器可以多次调用，而过滤器只能在容器初始化时调用一次。

5，Spring拦截器

Q2: 求JAVA拦截器代码和配置文件！就是每次请求action之前都会执行配置的java类

strut2的拦截器的一个例子。。。

拦截器定义，，这里是一个判断超时的拦截器功能

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 内置的默认拦截器 --

result name="config"/user/config.jsp/result

/result

//拦截器的实现。。。。。。。

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();

}

Q3: 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

}

————————————————

原文链接：