Spring Boot 进行验证

数据验证是应用程序开发中的重要组成部分。它确保只有符合预定义标准的高质量数据才会被处理。Spring Boot是Java生态系统中一款著名的框架，提供了强大且简单的验证方法供开发人员使用。本文全面介绍了Spring Boot应用中如何进行验证，让您能够有效地实施这些重要技术。

在Spring Boot中进行数据验证的重要性

在Spring Boot中，数据验证是至关重要的，就像在任何应用程序中一样。它涉及确保在处理数据之前，接收到的数据与某些标准相符。验证检查的示例包括验证字段不为空、电子邮件格式正确或数字落在特定范围内。

Spring Boot通过利用Java Bean验证规范提供的注释（也称为JSR 380）以及其参考实现Hibernate Validator来简化处理数据验证的过程。

在Spring Boot中设置验证

为了启动这个过程，Spring Boot的starter依赖项使将Bean验证API及其Hibernate Validator实现轻松融入项目变得更加容易。通过将spring-boot-starter-web依赖项添加到构建配置文件中，Hibernate Validator会被隐式地包含进来。

<dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-web</artifactId>
</dependency>

有了这个设置，我们可以开始在Spring Boot应用程序中实现数据验证。

实现Bean验证API

Bean验证API提供了一系列用于对象属性验证的注解。这些注解可以应用到您的Java Bean字段或getters上。以下是一个示例：

public class User {
   @NotNull
   @Size(min = 2, max = 30)
   private String name;
   @NotNull
   @Email
   private String email;
   // getters and setters
}

在这个User类中，我们使用@NotNull、@Size和@Email注解来定义对姓名和电子邮件字段的验证规则。在控制器中应用验证要激活这些验证，您控制器方法中的对象参数应该用@Valid注解进行标注。如果对象无效，则会引发异常。下面是它的工作原理：

@PostMapping("/users")
public ResponseEntity<String> addUser(@Valid @RequestBody User user) {
   // method logic
}

在这种情况下，@Valid注解会触发User对象的验证。如果违反了任何验证规则，将引发MethodArgumentNotValidException异常。

定制错误消息

可以直接向Bean验证注解添加自定义错误消息，以获得更个性化的体验−

public class User {
   @NotNull(message = "Name cannot be null")
   @Size(min = 2, max = 30, message = "Name must be between 2 and 30 characters")
   private String name;
   @NotNull(message = "Email cannot be null")
   @Email(message = "Email should be valid")
   private String email;
   // getters and setters
}

处理验证异常

Spring Boot还通过@ControllerAdvice注释提供了一种全局处理异常的方式。您可以创建一个类来处理MethodArgumentNotValidException并返回自定义的响应：

@ControllerAdvice
public class GlobalExceptionHandler {
   @ExceptionHandler(MethodArgumentNotValidException.class)
   public ResponseEntity<List<String>handleValidationExceptions(MethodArgumentNotValidException ex) {
   List<String> errors = ex.getBindingResult()
      .getAllErrors().stream()
      .map(ObjectError::getDefaultMessage
      .collect(Collectors.toList());
   return new ResponseEntity<>(errors, HttpStatus.BAD_REQUEST);
   }
}

在这个GlobalExceptionHandler类中，handleValidationExceptions方法被注解@ExceptionHandler标记，以指定在MethodArgumentNotValidException被抛出时应该调用它。这个方法从异常中提取所有的错误，并将它们收集到一个列表中，然后以BAD_REQUEST状态返回响应实体。

高级验证: 创建自定义注解

Spring Boot还提供了创建自定义验证注解的灵活性。这个特性允许开发人员编写自己的特定规则，这些规则不受标准Bean验证约束的限制。

例如，如果您想验证一个字符串不包含任何数字字符，您可以创建一个NoNumbers约束注解和一个关联的验证类。

@Target({ ElementType.FIELD, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = NoNumbersValidator.class)
public @interface NoNumbers {
   String message() default "Field should not contain numeric characters";
   Class<>[] groups() default { };
   Class< extends Payload>[] payload() default { };
}

然后在验证器类中实现ConstraintValidator接口－

public class NoNumbersValidator implements ConstraintValidator {
   @Override
   public boolean isValid(String value, ConstraintValidatorContext context) {
      return value != null && !value.matches(".*\d.*");
   }
}

结论

Spring Boot中的数据验证提供了一种确保应用程序数据可靠性和质量的重要机制。使用Bean Validation API和Hibernate Validator，您可以轻松实现和自定义验证规则。此外，通过了解如何处理异常和创建自定义验证规则，您可以为Spring Boot应用程序建立一个稳健且灵活的验证系统。