统一响应头？困在“SetHeader怪圈”！

2023-08-25 18:13:26

SpringBoot 中 SetHeader 的终极指南：告别困扰，轻松设置统一响应头

在 SpringBoot 中设置统一响应头，是每个后端开发者的必经之路。但很多时候，我们会遇到令人头疼的错误提示和接口无响应的现象。本文将深入探究 SetHeader 常见问题，并提供切实可行的解决方案，助你轻松告别困扰。

错误提示：incorrect header check

当出现 "incorrect header check" 错误提示时，这意味着你的代码可能存在语法错误或拼写错误。仔细检查你的代码，确保一切正确无误。另外，还要检查你的版本是否兼容。Spring Boot 版本需要与你使用的依赖库版本相匹配。

SetHeader 失效：接口无响应

如果你的响应头设置无效，接口也没有响应，则可能是以下原因导致的：

@CrossOrigin 注解缺失： 使用 @CrossOrigin 注解允许跨域请求，并在其中设置允许的请求头。
Filter 配置错误： 在 SpringBoot 主类中添加一个实现 Filter 接口的类，并在其中设置统一响应头。
WebMvcConfigurerAdapter 配置错误： 扩展 WebMvcConfigurerAdapter 并重写 addCorsMappings 方法，允许跨域请求。
@RestControllerAdvice 注解缺失： 使用 @RestControllerAdvice 注解统一处理异常。
日志中存在错误信息： 查看日志，看看是否有任何错误信息。
配置文件配置错误： 仔细检查 SpringBoot 配置文件，确保配置正确。

解决方案

1. 使用 @CrossOrigin 注解

@CrossOrigin(origins = "*", allowedHeaders = "x-requested-with")
@RequestMapping("/api/v1/users")
public class UserController {
    // ...
}

2. 在 SpringBoot 主类中配置 Filter

public class SetHeaderFilter implements Filter {

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        ((HttpServletResponse) response).addHeader("Access-Control-Allow-Origin", "*");
        ((HttpServletResponse) response).addHeader("Access-Control-Allow-Methods", "GET, POST, PUT, DELETE");
        ((HttpServletResponse) response).addHeader("Access-Control-Allow-Headers", "x-requested-with, Content-Type");
        chain.doFilter(request, response);
    }
}

3. 使用 WebMvcConfigurerAdapter

public class WebConfig extends WebMvcConfigurerAdapter {

    @Override
    public void addCorsMappings(CorsRegistry registry) {
        registry.addMapping("/api/v1/**")
                .allowedOrigins("*")
                .allowedMethods("GET", "POST", "PUT", "DELETE")
                .allowedHeaders("x-requested-with, Content-Type");
    }
}

4. 使用 @RestControllerAdvice 注解

@RestControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(Exception.class)
    public ResponseEntity<Object> handleException(Exception ex) {
        return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body(ex.getMessage());
    }
}