Springboot拦截器

面向切面编程是spring的精华之一，springboot也不例外，springboot并不制造新的东西，而是对springmvc进行封装，大大降低我们程序员的开发成本

在一个大型的项目之中，拦截器是必不可少的。

不废话：

首先，我们创建一个类，实现HandlerInterceptor接口，这个接口是spring提供的拦截器接口，他依赖于spring的web包，具体写法如下

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

在HandlerInterceptor接口之中有3个方法，分别是

 boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
      throws Exception

这个方法是进入controller层调用，返回boolean类型，如果返回true则正常进行接下来的逻辑，如果返回false则证明效验失败，

HttpServletResponse 会直接返回

 

postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,
      @Nullable ModelAndView modelAndView) throws Exception

处理请求完成后视图渲染之前的处理操作

afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler,
      @Nullable Exception ex) throws Exception 

视图渲染之后的操作

具体代码如下

package com.example.demo;

import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

public class MyHandlerInterceptor implements HandlerInterceptor {


    /**
     * 进入controller层之前拦截请求
     * @return
     * @throws Exception
     */
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
            throws Exception {
        System.out.println("进入controller层之前拦截请求");
        return true;
    }


    // --------------处理请求完成后视图渲染之前的处理操作---------------
    @Override
    public void postHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o,
                           ModelAndView modelAndView) throws Exception {
        System.out.println("处理请求完成后视图渲染之前的处理操作");
    }

    // ---------------视图渲染之后的操作-------------------------0
    @Override
    public void afterCompletion(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse,
                                Object o, Exception e) throws Exception {
        System.out.println("视图渲染之后的操作");
    }


}

我们写个接口来测试一下

package com.example.demo;

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class DemoA {


    @RequestMapping(value="test")
    public String test(){
        System.out.println("逻辑处理中...........");
        return "1111111";
    }
}

从打印的信息可以知道，我们的拦截器并没有配置成功，那么是我们那里写错了吗？

其实配置并没有错，只是并没有生效而已，为什么没有生效呢？

因为我们没有对拦截器进行注册，我们需要事先告诉springboot，我们有一个拦截器，怎么告诉呢，很简单，添加一个注册类就可以了

还是尚一章提到的WebMvcConfigurer接口，里面有一个方法叫做addInterceptors，从名字我们就可以看出来是添加拦截器的，函数原型如下：

void addInterceptors(InterceptorRegistry registry)

具体代码如下

package com.example.demo;

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 Config  implements WebMvcConfigurer {


    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        //拦截规则：/**代表为所有请求添加拦截件
        registry.addInterceptor(new MyHandlerInterceptor()).addPathPatterns("/**");
    }


}

我们在测试一下

这就成功了，

一般情况下我们都是用拦截器来做一些权限配置，当然，也可以干别的，具体看需求，

源码地址：https://gitee.com/ww2510095/springboot_learning