【springboot中使用拦截器】

阿里云国内75折回扣微信号：monov8

阿里云国际，腾讯云国际，低至75折。AWS 93折免费开户实名账号代冲值优惠多多微信号：monov8 飞机：@monov6

1.拦截器原理

1.定义拦截器：
2.配置拦截器
3.解决静态资源被拦截

2.拦截器使用实例

2.1判断用户有没有登录
2.2取消拦截操作

1.拦截器原理

拦截器的原理很简单，是AOP 的一种实现，专门拦截对动态资源的后台请求，即拦截对控制层的请求。使用场景比较多的是判断用户是否有权限请求后台，更拔高一层的使
用场景也有，比如拦截器可以结合websocket 一起使用，用来拦截websocket 请求，然后做相应的处理等等。拦截器不会拦截静态资源，Spring Boot 的默认静态目录为resources/static，该目录下的静态页面、js、css、图片等等，不会被拦截（也要看如何实现，有些情况也会拦截，我在下文会指出）。

1.定义拦截器：

//定义拦截器
public class MyInterceptor implements HandlerInterceptor {
    private Logger logger = LoggerFactory.getLogger(MyInterceptor.class);
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response,Object handler)
            throws Exception
    {
        HandlerMethod handlerMethod = (HandlerMethod) handler;
        Method method = handlerMethod.getMethod();
        String MethodName = method.getName();
        logger.info("===拦截到了方法：{},在该方法之前执行====",MethodName);
        return true;//返回true才会继续执行，返回false则取消当前请求

    }
    @Override
    public void postHandle(HttpServletRequest request,
                           HttpServletResponse response, Object handler, ModelAndView
                                   modelAndView) throws Exception {
        logger.info("执行完方法之后进执行(Controller 方法调用之后)，但是此 时还没进行视图渲染");
    }
    @Override
    public void afterCompletion(HttpServletRequest request,
                                HttpServletResponse response, Object handler, Exception ex) throws
            Exception {
        logger.info("整个请求都处理完咯，DispatcherServlet 也渲染了对应的 视图咯，此时我可以做一些清理的工作了");
    }

}

2.配置拦截器

@Configuration
//定义完拦截器之后配置拦截器
//在Spring Boot 2.0 之前，我们都是直接继承WebMvcConfigurerAdapter 类，然后重写
//addInterceptors 方法来实现拦截器的配置。但是在Spring Boot 2.0 之后，该方法已
//经被废弃了（当然，也可以继续用），取而代之的是WebMvcConfigurationSupport 方法，如下：
public class MyInterceptorConfig extends WebMvcConfigurationSupport {

    @Override
    protected void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(new MyInterceptor()).addPathPatterns("/**");
//addPathPatterns 方法是添加要拦截的请求，这里我们拦截所有的请求。这
super.addInterceptors(registry);

    }
}

启动：

访问controller层下的任意路径，查看控制台输出：

【springboot中使用拦截器】_java

3.解决静态资源被拦截

虽然Spring Boot 2.0 废弃了WebMvcConfigurerAdapter，但是
WebMvcConfigurationSupport 又会导致默认的静态资源被拦截，这就需要我们手动将静态资源放开。
如何放开呢？除了在MyInterceptorConfig 配置类中重写addInterceptors 方法外，还需要再重写一个方法：addResourceHandlers，将静态资源放开：

/**
* 用来指定静态资源不被拦截，否则继承WebMvcConfigurationSupport 这种方式
会导致静态资源无法直接访问
* @param registry
*/
@Override
protected void addResourceHandlers(ResourceHandlerRegistry
registry) {
registry.addResourceHandler("/**").addResourceLocations("classpath:/sta
tic/");
super.addResourceHandlers(registry);
}

这样配置好之后，重启项目，静态资源也可以正常访问了。
另外一种更方便的方式来配置：
不继承WebMvcConfigurationSupport 类，直接实现WebMvcConfigurer 接口，然后重写addInterceptors 方法，将自定义的拦截器添加进去即可，如下：

@Configuration
public class MyInterceptorConfig implements
WebMvcConfigurer
 {
@Override
public void addInterceptors(InterceptorRegistry registry) {
// 实现WebMvcConfigurer 不会导致静态资源被拦截
registry.addInterceptor(new
MyInterceptor()).addPathPatterns("/**");
}
}

由于这两种方式的不同，继承WebMvcConfigurationSupport 类的方式可以用在前后端分离的项目中，后台不需要访问静态资源（就不需要放开静态资源了）；实现WebMvcConfigure 接口的方式可以用在非前后端分离的项目中，因为需要读取一些图片、css、js 文件等等。

2.拦截器使用实例

2.1判断用户有没有登录

一般用户登录功能我们可以这么做，要么往session 中写一个user，要么针对每个user 生成一个token，第二种要更好一点，那么针对第二种方式，如果用户登录成功了，每次请求的时候都会带上该用户的token，如果未登录，则没有该token，服务端可以检测这个token 参数的有无来判断用户有没有登录，从而实现拦截功能。我们改造一下preHandle 方法，如下：

public class MyInterceptor implements HandlerInterceptor {

    private static final Logger logger = LoggerFactory.getLogger(MyInterceptor.class);

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {

        HandlerMethod handlerMethod = (HandlerMethod) handler;
        Method method = handlerMethod.getMethod();
        String methodName = method.getName();
        logger.info("====拦截到了方法：{}，在该方法执行之前执行====", methodName);

        // 通过方法，可以获取该方法上的自定义注解，然后通过注解来判断该方法是否要被拦截
        // @UnInterception 是我们自定义的注解
        UnInterception unInterception = method.getAnnotation(UnInterception.class);
        if (null != unInterception) {
            return true;
        }


        // 判断用户有没有登陆，一般登陆之后的用户都有一个对应的token
        String token = request.getParameter("token");
        if (null == token || "".equals(token)) {
            logger.info("用户未登录，没有权限执行……请登录");
            return false;
        }

        // 返回true才会继续执行，返回false则取消当前请求
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        logger.info("执行完方法之后进执行(Controller方法调用之后)，但是此时还没进行视图渲染");
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        logger.info("整个请求都处理完咯，DispatcherServlet也渲染了对应的视图咯，此时我可以做一些清理的工作了");
    }
}

2.2取消拦截操作

我们可以定义一个注解，该注解专门用来取消拦截操作，如果某个Controller 中的方法我们不需要拦截掉，即可在该方法上加上我们自定义的注解即可，
下面先定义一个注解：

/**
* 该注解用来指定某个方法不用拦截
*/
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface UnInterception {
}

然后在Controller 中的某个方法上添加该注解，在拦截器处理方法中添加该注解取消拦截的逻辑

@Override
public boolean preHandle(HttpServletRequest request,
HttpServletResponse response, Object handler) throws Exception {
HandlerMethod handlerMethod = (HandlerMethod) handler;
Method method = handlerMethod.getMethod();
String methodName = method.getName();
logger.info("====拦截到了方法：{}，在该方法执行之前执行====",methodName);
// 通过方法，可以获取该方法上的自定义注解，然后通过注解来判断该方法是否要被拦截
// @UnInterception 是我们自定义的注解
UnInterception unInterception =
method.getAnnotation(UnInterception.class);
if (null != unInterception) {
return true;
}
// 返回true 才会继续执行，返回false 则取消当前请求
return true;
}

阿里云国内75折回扣微信号：monov8

阿里云国际，腾讯云国际，低至75折。AWS 93折免费开户实名账号代冲值优惠多多微信号：monov8 飞机：@monov6

标签: Spring