← 返回首页
SpringBoot基础教程(二十三)
发表时间：2020-10-27 18:23:21
Interceptor(拦截器)

拦截器：Interceptor 在AOP（Aspect-Oriented Programming）中用于在某个方法或字段被访问之前，进行拦截然后在之前或之后加入某些操作。比如日志，安全等。一般拦截器方法都是通过动态代理的方式实现。可以通过它来进行权限验证，或者判断用户是否登陆，或者是像12306 判断当前时间是否是购票时间。

从上图我们可以发现，拦截器的主要作用的是拦截方法(动作)，过滤器能做的事拦截器都能做，而拦截器做的事过滤器不一定做的了。

SpringBoot中配置拦截器步骤：

1.定义拦截器类。

在interceptor包下定义拦截器类MyInterceptor 

package com.oracle.interceptor;

//用户自定义的拦截器

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
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.lang.reflect.Method;

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);
        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.在拦截器配置类中注册拦截器。 在config包下定义拦截器配置类,添加@Configuration注解并实现WebMvcConfigurer接口。

package com.oracle.config;

import com.oracle.interceptor.MyInterceptor;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration
public class MyInterceptorConfig implements WebMvcConfigurer {

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        // /** 表示拦截所有动作。
        registry.addInterceptor(new MyInterceptor()).addPathPatterns("/users/*");
    }

}

3.分别创建UsersController和CourseController测试UsersController里的方法是否被拦截。 UsersController.java

package com.oracle.controller;

import com.oracle.entity.Users;
import com.oracle.json.JsonData;
import com.oracle.json.JsonResult;
import com.oracle.service.UsersService;
import org.springframework.web.bind.annotation.*;
import javax.annotation.Resource;

@RestController
@RequestMapping("users")
public class UsersController {

    @Resource
    private UsersService usersService;

    @GetMapping("auth")
    public R login(String username, String password){
        //判断一下，我们规定用户名必须是admin,密码必须是admin才能登录成功。
        if("admin".equals(username)&&"admin".equals(password)){
            Users loginUser = new Users(100,username,password);
            return R.ok("loginSuccess",loginUser);
        }else{
            return R.fail("loginFailure");
        }
    }

    @PostMapping("/")
    public R reg(@RequestBody Users user){
        System.out.println("注册用户对象");
        System.out.println(user);

        return R.ok("regSuccess");
    }
}

CourseController.java

package com.oracle.controller;

import com.oracle.json.JsonData;
import com.oracle.json.JsonResult;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

//有关课程的控制器
@RestController
@RequestMapping("course")
public class CourseController {

    @GetMapping("{cid}")
    public R  queryCourseInfo(@PathVariable("cid") String cid){
        System.out.println("查询课程编号是：" + cid);
        return R.ok("querySuccess");
    }
}

4.使用postman分别测试UsersContoller和CourseController接口方法是否被拦截。

我们发现，UsersController里的接口方法都被拦截。 CourseContrller里的方法没有被拦截。

尽量避免将拦截器的拦截URL配置为/**,这样会造成SpringBoot的static下静态资源无法访问的现象。例如： 修改MyInterceptorConfig 配置，让MyInterceptor拦截器拦截所有请求。


@Configuration
public class MyInterceptorConfig implements WebMvcConfigurer {

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
         //配置拦截所有请求，会造成静态资源无法访问。
        registry.addInterceptor(new MyInterceptor()).addPathPatterns("/**");
    }

}

访问static下的静态资源，比如index.html页面时，会出现500服务器内部错误。

如果非要配置这样的拦截URL，我们必须在application.yml中，重写配置SpringBoot项目的静态资源的解析路径和访问URL。如下：

spring:
  mvc:
    static-path-pattern: /static/**
  resources:
    static-locations: classpath:/static

同时修改MyInterceptorConfig配置类，在注册拦截器时，排除/static/* 下的所有资源，表示不被拦截。

@Configuration
public class MyInterceptorConfig implements WebMvcConfigurer {

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
         //配置拦截所有请求，会造成静态资源无法访问。
        registry.addInterceptor(new MyInterceptor()).addPathPatterns("/**").excludePathPatterns("/static/**");
    }

}

这样访问static目录下的所有静态资源，必须统一添加前缀static即可。例如：访问resources/static/index.html页面的访问路径就是 http://localhost:8080/上下文名字/static/index.html

访问static下的静态资源，比如index.html页面时，正常显示页面。