SpringBoot拦截器的使用

   一、前言

        在Spring Boot中，拦截器（Interceptor）用于在请求处理前后执行一些操作，例如日志记录、权限验证、请求参数处理等。拦截器是基于Spring的HandlerInterceptor接口实现的，可以在请求到达控制器之前（preHandle）、请求处理完毕之后（postHandle）和视图渲染完毕之后（afterCompletion）执行自定义逻辑。

1. 创建拦截器类

首先，创建一个拦截器类 demoMyInterceptor，实现 HandlerInterceptor 接口。

package cn.best.scholarflow.framework;

import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

@Component
public class demoMyInterceptor implements HandlerInterceptor {

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

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        logger.info("**拦截器 preHandle** - 请求处理之前");
        return true; // 返回 true 表示继续处理请求
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        logger.info("**拦截器 postHandle** - 请求处理之后");
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        logger.info("**拦截器 afterCompletion** - 请求完成之后");
    }
}

2. 配置拦截器

创建一个配置类 WebConfig，将拦截器注册到Spring MVC中。

package com.example.demo;

import cn.best.scholarflow.framework.demoMyInterceptor;
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.WebMvcConfigurer;

@Configuration
public class WebConfig implements WebMvcConfigurer {

    @Autowired
    private demoMyInterceptor demomyinterceptor;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(demomyinterceptor).addPathPatterns("/zh/**");
    }
}

3. 创建控制器

创建一个简单的控制器 demoController，用于处理 /zh/hello 请求。

package com.example.demo;

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

@RestController
@RequestMapping("/zh")
public class demoController {

    @GetMapping("/hello")
    public String sayHello() {
        return "Hello, Interceptor!";
    }
}

4. 启动应用程序

确保你的主应用程序类在正确的包中，以便Spring Boot能够扫描到所有的组件。

package com.example.demo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class DemoApplication {
    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }
}

5. 测试拦截器

启动Spring Boot应用程序，并访问 /zh/hello 接口，观察控制台输出。

启动应用程序

启动 DemoApplication 类，应用程序将在默认端口8080上运行。

访问接口

打开浏览器或使用工具（如Postman）访问 http://localhost:8080/zh/hello。

观察控制台输出

你应该在控制台看到以下日志输出：

**拦截器 preHandle** - 请求处理之前
**拦截器 postHandle** - 请求处理之后
**拦截器 afterCompletion** - 请求完成之后

这表明拦截器在请求处理的不同阶段正确地记录了日志。