Spring Validation 失败时避免显示被拒绝的值

Spring Validation 是一个强大的数据验证框架，但在处理请求 Bean 验证失败时，默认会将导致验证失败的“被拒绝的值”包含在错误信息中。这可能会暴露用户敏感数据，例如包含特殊字符的个人信息。为了解决这个问题，我们需要自定义 Spring 的错误处理机制，避免直接显示这些被拒绝的值。

原因分析

Spring 框架已经提供了一个基础类 ResponseEntityExceptionHandler，专门用于处理 MethodArgumentNotValidException 异常，它使用 handleMethodArgumentNotValid() 方法来处理验证失败的情况。这意味着，如果直接在 @ControllerAdvice 中使用 MethodArgumentNotValidException，自定义的异常处理方法可能不会被调用，因为 Spring 默认的处理逻辑会优先执行。

解决方案

为了能够自定义错误处理逻辑，我们需要覆盖 ResponseEntityExceptionHandler 的 handleMethodArgumentNotValid() 方法。通过这种方式，我们可以拦截验证失败的异常，并返回自定义的错误信息，从而避免显示被拒绝的值。

示例代码

芦笋演示

一键出成片的录屏演示软件，专为制作产品演示、教学课程和使用教程而设计。

34

查看详情

以下是一个示例代码，展示了如何覆盖 handleMethodArgumentNotValid() 方法并自定义错误信息：

import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import org.springframework.web.context.request.WebRequest;
import org.springframework.web.servlet.mvc.method.annotation.ResponseEntityExceptionHandler;

import java.util.Map;

@RestControllerAdvice
public class CustomExceptionHandler extends ResponseEntityExceptionHandler {

    @Override
    protected ResponseEntity<Object> handleMethodArgumentNotValid(MethodArgumentNotValidException ex, HttpHeaders headers, HttpStatus status, WebRequest request) {
        Map<String, String> error = Map.of("message", "Field value not valid.");
        return handleExceptionInternal(ex, error, headers, HttpStatus.BAD_REQUEST, request);
    }
}

代码解释：

1. @RestControllerAdvice: 这是一个 Spring 注解，用于声明一个全局异常处理类。
2. CustomExceptionHandler extends ResponseEntityExceptionHandler: 自定义的异常处理类继承了 ResponseEntityExceptionHandler，从而可以覆盖其方法。
3. handleMethodArgumentNotValid(): 这个方法覆盖了父类的同名方法，用于处理 MethodArgumentNotValidException 异常。
4. Map<String, String> error = Map.of("message", "Field value not valid.");: 这里创建了一个包含自定义错误信息的 Map。
5. handleExceptionInternal(): 这个方法是 ResponseEntityExceptionHandler 提供的一个工具方法，用于构建 ResponseEntity 对象，并返回给客户端。

注意事项

• 在自定义错误信息时，要确保信息简洁明了，能够帮助用户理解错误原因，但不要暴露敏感数据。
• 可以根据实际需求，自定义错误信息的格式和内容。例如，可以添加错误码，方便客户端进行错误处理。
• 在测试环境中，可以考虑保留详细的错误信息，方便调试和排错。但在生产环境中，要确保不暴露敏感数据。

总结

通过覆盖 ResponseEntityExceptionHandler 的 handleMethodArgumentNotValid() 方法，我们可以有效地控制 Spring Validation 失败时的错误信息，避免显示被拒绝的值，从而保护用户敏感数据。这种方法不仅简单易用，而且具有很强的灵活性，可以根据实际需求进行自定义。在开发 Spring 应用时，应该充分考虑数据安全问题，并采取相应的措施来保护用户隐私。

以上就是Spring Validation 失败时避免显示被拒绝的值的详细内容，更多请关注php中文网其它相关文章！