Spring boot 拦截器preHandle中返回数据

原创

mob64ca12e08acf 2024-10-07 04:24:16 ©著作权

文章标签 拦截器 spring 数据 文章分类 spring boot 后端开发

©著作权归作者所有：来自51CTO博客作者mob64ca12e08acf的原创作品，请联系作者获取转载授权，否则将追究法律责任

Spring Boot 拦截器 preHandle 中返回数据

在微服务框架中，Spring Boot因其便捷性和功能强大被广泛使用。而Spring Boot中的拦截器（Interceptor）是一个非常有用的工具。拦截器可以在请求处理前进行一些额外的操作，例如权限验证、日志记录等。而preHandle方法则是拦截器的核心部分，负责在请求处理前执行相应的逻辑。

在本文中，我们将讨论如何在preHandle中返回数据，以及结合代码示例来解释这一过程。

拦截器概述

拦截器可以通过实现HandlerInterceptor接口来创建。该接口包含三个方法：

preHandle(HttpServletRequest request, HttpServletResponse response, Object handler): 在控制器方法之前被调用。
postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView): 在控制器方法之后被调用，并且在视图渲染之前。
afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex): 在整个请求完成之后被调用，可以用于清理工作。

创建一个拦截器

首先，我们需要创建一个拦截器类，实现HandlerInterceptor接口。以下是一个简单的示例，其中preHandle方法返回一个JSON格式的数据：

import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerInterceptor;

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

@Component
public class CustomInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 设置响应类型
        response.setContentType("application/json;charset=UTF-8");

        // 模拟返回的 JSON 数据
        String jsonResponse = "{\"message\":\"Unauthorized access!\"}";

        // 返回 JSON 数据
        response.getWriter().write(jsonResponse);
        response.getWriter().flush();
        
        // 返回 false，表示请求处理不再继续
        return false;
    }
}

注册拦截器

接下来，我们需要在Spring Boot的配置类中注册这个拦截器：

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
    CustomInterceptor customInterceptor;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(customInterceptor)
                .addPathPatterns("/**"); // 所有路径都需要拦截
    }
}

测试拦截器

假设我们有一个简单的控制器用来处理请求：

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

@RestController
public class TestController {

    @GetMapping("/test")
    public String test() {
        return "This is a test endpoint!";
    }
}

当你访问/test路径时，拦截器将会拦截请求并返回JSON格式的错误消息，而不会继续处理控制器方法中的逻辑。

关系图

在这里，我们可以使用Mermaid语法来表示拦截器和请求之间的关系。

erDiagram
    User {
        String username
        String password
    }
    Request {
        String method
        String url
    }
    Response {
        String body
        int status
    }
    
    User ||--o{ Request : makes
    Request ||--o| Response : generates

甘特图

使用Mermaid语法创建一个简单的甘特图，展示请求处理流程中的各个步骤。

gantt
    title 请求处理流程
    dateFormat  YYYY-MM-DD
    section 拦截器处理
    进入 preHandle       :a1, 2023-10-01, 30m
    返回 JSON 数据      :after a1  , 30m
    section 控制器处理
    进入控制器         :a2, after a1, 1h
    返回结果           :after a2  , 30m