[Java知识库]springboot拦截器Interceptor的使用

springmvc 中的拦截器可以对请求进行判别， 在请求到达控制器之前， 把非法的请求给拦截掉
下面来说一说， 它在springboot中的使用

拦截器是可以有多个的， 对不同的 url 进行拦截
我们这个例子设想的是， 如果用户登录过， 就会用户设置一个 session , 如果session中 有user 的信息，就说明用户是登录过的

1. 我们先创建一个 User 的实例对象 domain

public class User {
    private Integer id;
    private String name;
    private Integer age;
    public User() {
    }
    public User(Integer id, String name, Integer age) {
        this.id = id;
        this.name = name;
        this.age = age;
    }
    public Integer getId() {
        return id;
    }
    public void setId(Integer id) {
        this.id = id;
    }
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public Integer getAge() {
        return age;
    }
    public void setAge(Integer age) {
        this.age = age;
    }
}

2.创建一个拦截器 LoginInterceptor 实现 HandlerInterceptor 接口，并实现其方法， 主要是 preHandle方法，其它的可以不用管

package com.huang.interceptor;
import com.huang.domain.User;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;

public class LoginInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        //如果用户登录过才可以访问
        HttpSession session = request.getSession();
        User user = (User)session.getAttribute("user");
        if(user == null){
            response.sendRedirect(request.getContextPath()+"/user/login");
            return false;
        }else{
            return true;
        }
    }
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {

    }
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {

    }
}

在我们的springmvc项目中， 创建好拦截器， 下一步就是要在 springmvc的配置文件xml 中去 写 interceptors > interceptor > bean class=“拦截器的全类名”
但是在 springboot中， 我们不用这样写了， 我们可以使用 配置类的方式去完成

所以我们新建一个配置类 InterceptorConfig 去实现 WebMvcConfigurer 接口

package com.huang.configure;
import com.huang.interceptor.LoginInterceptor;
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 InterceptorConfig implements WebMvcConfigurer {

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new LoginInterceptor()).addPathPatterns("/user/**").excludePathPatterns("/user/login","/user/logout","/user/setsession");
    }
}

注意 我们要使用一个注解 @Configuration 表示这是一个配置类， springboot 在启动的时候会自动扫瞄这个类
上面的代码可以看出， InterceptorRegistry 是一个 interceptor的注册器类，使用 addInterceptor(new XXXInterceptor) 来把这个拦截器类注册好， addPathPatterns("/user/**") 这个方法是被重构过的， 可以接受多个字符串参数， 也可以接受一个list的集合， 也就是匹配的 url ， excludePathPatterns() 也是重构过的， 表示哪些 url 是排除的， 也就是不经过这个拦截器

上面的拦截器和注册都完成了， 我们就可以在控制器中写几个方法测试了

package com.huang.controller;

import com.huang.domain.User;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpSession;

@Controller
@RequestMapping(value="/user")
public class UserController {

    @RequestMapping(value="/login")
    @ResponseBody
    public String userlogin(){
        return "跳转到用户登录的页面";
    }


    @RequestMapping(value="/gomain")
    @ResponseBody
    public String goMain(){
        return "这是用户进入后的页面";
    }

    @RequestMapping(value="/logout")
    @ResponseBody
    public String logout(){
        return "这是用户登出界面";
    }

    @RequestMapping(value="/setsession")
    @ResponseBody
    public Object setSession(HttpServletRequest request){
        HttpSession session = request.getSession();
        session.setAttribute("user",new User(1,"huang",20));
        return "OK";
    }

}

在用户没有请求过 /user/setsession的时候，如果用户请求了 /user/gomain 拦截器就会发挥作用， 把它跳转到/user/login的接口上去，
如果用户请求过/user/setsession的话， 再去请求/user/gomain 拦截器就会放行， 请求到相应的结果