如何在SpringBoot项目中灵活配置自定义拦截接口路径

本文主要是介绍如何在SpringBoot项目中灵活配置自定义拦截接口路径，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

假如现在需要拦截例如以 /zjdl/huz/performance/board 开头的接口

1. 在 `ResponseBodyAdvice` 中检查请求路径

你可以在 beforeBodyWrite 方法中通过 ServerHttpRequest 对象获取请求的 URL，然后检查是否匹配特定的路径。这样可以确保只有匹配的请求路径被拦截并处理。

示例如下：

import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.springframework.core.MethodParameter;
import org.springframework.http.MediaType;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.http.server.ServerHttpRequest;
import org.springframework.http.server.ServerHttpResponse;
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice;@Component
public class CommonResultResponseBodyAdvice implements ResponseBodyAdvice<Object> {private final ObjectMapper objectMapper = new ObjectMapper();@Overridepublic boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {// 仅处理返回类型为 CommonResult 的响应return CommonResult.class.isAssignableFrom(returnType.getParameterType());}@Overridepublic Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType,Class<? extends HttpMessageConverter<?>> selectedConverterType,ServerHttpRequest request, ServerHttpResponse response) {// 获取请求的 URIString path = request.getURI().getPath();// 判断请求路径是否以 /zjdl/huz/performance/board 开头if (path.startsWith("/zjdl/huz/performance/board")) {if (body instanceof CommonResult) {CommonResult<?> result = (CommonResult<?>) body;// 使用 Jackson 将 data 转换为 JsonNode 处理JsonNode dataNode = objectMapper.valueToTree(result.getData());StringUtil.processJsonNode(dataNode);// 将处理后的 JsonNode 重新设置回 CommonResultresult.setData(objectMapper.convertValue(dataNode, new TypeReference<Object>() {}));}}return body;}
}

2. 在拦截器中控制 `ResponseBodyAdvice`

另一种方式是结合 HandlerInterceptor 和 ResponseBodyAdvice，在拦截器中设置一个标记，指示当前请求是否需要由 ResponseBodyAdvice 处理。

2.1 自定义拦截器

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;@Component
public class CustomInterceptor implements HandlerInterceptor {@Overridepublic boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {// 在请求处理之前执行if (request.getRequestURI().startsWith("/zjdl/huz/performance/board")) {request.setAttribute("intercepted", true);}return true;}@Overridepublic void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {// 请求处理之后但在视图渲染之前执行}@Overridepublic void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {// 请求完成后执行}
}

2.2 修改 `ResponseBodyAdvice` 判断标记

在 ResponseBodyAdvice 中，你可以检查请求中是否包含这个标记来决定是否进行处理。

import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.springframework.core.MethodParameter;
import org.springframework.http.MediaType;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.http.server.ServerHttpRequest;
import org.springframework.http.server.ServerHttpResponse;
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice;@Component
public class CommonResultResponseBodyAdvice implements ResponseBodyAdvice<Object> {private final ObjectMapper objectMapper = new ObjectMapper();@Overridepublic boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {// 仅处理返回类型为 CommonResult 的响应return CommonResult.class.isAssignableFrom(returnType.getParameterType());}@Overridepublic Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType,Class<? extends HttpMessageConverter<?>> selectedConverterType,ServerHttpRequest request, ServerHttpResponse response) {// 通过 HttpServletRequest 获取标记HttpServletRequest servletRequest = (HttpServletRequest) request;Boolean intercepted = (Boolean) servletRequest.getAttribute("intercepted");if (Boolean.TRUE.equals(intercepted)) {if (body instanceof CommonResult) {CommonResult<?> result = (CommonResult<?>) body;// 使用 Jackson 将 data 转换为 JsonNode 处理JsonNode dataNode = objectMapper.valueToTree(result.getData());StringUtil.processJsonNode(dataNode);// 将处理后的 JsonNode 重新设置回 CommonResultresult.setData(objectMapper.convertValue(dataNode, new TypeReference<Object>() {}));}}return body;}
}

3. 配置拦截器

最后，将拦截器配置到 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 {@Autowiredprivate CustomInterceptor customInterceptor;@Overridepublic void addInterceptors(InterceptorRegistry registry) {registry.addInterceptor(customInterceptor).addPathPatterns("/zjdl/huz/performance/board/**");}
}