从Spring Boot Filter发送RESTFUL API JSON响应

Question

我正在使用以下过滤器检查API请求中是否存在特定的HTTP标头。

@Component
@RequiredArgsConstructor
public class HeaderValidationFilter extends OncePerRequestFilter {
private final ObjectMapper objectMapper;

@Override
protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException {
        
String headerValue = request.getHeader("RANDOM_HEADER");

if(Objects.isNull(headerValue)) {
    ResponseEntity<Object> responseToSend = ResponseGen.create("FAILED", "Missing Authentication Header", new Object())));

    response.setHeader("Content-Type", "application/json");
    response.setStatus(HttpServletResponse.SC_UNAUTHORIZED);
    response.getOutputStream().write(responseToSend);
    return;
}

    filterChain.doFilter(request, response);
}

它将响应返回为JSON，但添加的对象键，例如标题，statuscode等，我提供的有效载荷放置在body中。由于我在项目上定义了标准错误响应，因此我无法返回响应。 （请参阅以下响应）

{
"headers": {},
"body": {
    "status": "FAILURE",
    "message": "Missing Authentication Header",
    "data": {}
},
"statusCode": "UNAUTHORIZED",
"statusCodeValue": 401
}

我希望响应仅以这种格式：

{
    "status": "FAILED",
    "message": "Missing Authentication Header",
    "data": {}
}

我尝试使用@controllerAdvice fleffers @controllerAdvice @controllerAdvice >由于它是在dispatcherservlet之前执行的，

有人可以帮助我吗？

Answer 1

您看到的JSON

{
"headers": {...},
"body": {...},
"statusCode": ...,
"statusCodeValue": ...
}

是您在过滤器中作为响应写入的序列化响应性：

ResponseEntity<Object> responseToSend = ResponseGen.create("FAILED", "Missing Authentication Header", new Object())));

显然，如果您需要另一种格式的响应，则必须使用序列化的对象作为回应。例如

@Data
@AllArgsConstructor
class StandardError {
    private String status;
    private String message;
    private Object data;
}

....

@Override
protected void doFilterInternal(HttpServletRequest request, 
                                HttpServletResponse response, 
                                FilterChain filterChain) throws ServletException, IOException {
    ...
    if (Objects.isNull(headerValue)) {
        StandardError responseToSend = new StandardError("FAILED", "Missing Authentication Header", new Object());

        response.setHeader("Content-Type", "application/json");
        response.setStatus(HttpServletResponse.SC_UNAUTHORIZED);
        response.getOutputStream().write(responseToSend);
        return;
    }
    ...