Spring Boot中的数据验证规则应用

大家好，我是微赚淘客返利系统3.0的小编，是个冬天不穿秋裤，天冷也要风度的程序猿！

在Spring Boot应用中，数据验证是一个关键环节，它确保了接收到的数据满足业务规则和格式要求。Spring提供了一套完整的数据验证框架，结合Hibernate Validator实现Java Bean的数据校验。以下是在Spring Boot中应用数据验证规则的方法。

1. 添加依赖

首先，在项目的pom.xml中添加Spring Boot的验证依赖和Hibernate Validator。

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>
  • 1.
  • 2.
  • 3.
  • 4.

2. 定义验证注解

使用JSR 380（Bean Validation 2.0）中定义的注解来标记Java Bean的属性。

import javax.validation.constraints.NotBlank;
import javax.validation.constraints.Size;

public class User {

    @NotBlank(message = "用户名不能为空")
    @Size(min = 3, max = 50, message = "用户名长度必须在3到50个字符之间")
    private String username;

    // 其他属性、getter和setter
}
  • 1.
  • 2.
  • 3.
  • 4.
  • 5.
  • 6.
  • 7.
  • 8.
  • 9.
  • 10.
  • 11.

3. 手动触发验证

可以在Service层手动触发验证，确保数据的正确性。

import org.springframework.validation.annotation.Validated;
import javax.validation.Valid;
import cn.juwatech.service.UserService;

@Validated
public class UserService {

    public void createUser(@Valid User user) {
        // 创建用户逻辑
    }
}
  • 1.
  • 2.
  • 3.
  • 4.
  • 5.
  • 6.
  • 7.
  • 8.
  • 9.
  • 10.
  • 11.

4. 异常处理

定义全局异常处理器来处理验证过程中抛出的异常。

import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import javax.validation.ConstraintViolationException;

@RestControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(ConstraintViolationException.class)
    public ResponseEntity<String> handleValidationException(ConstraintViolationException e) {
        // 处理验证异常
    }
}
  • 1.
  • 2.
  • 3.
  • 4.
  • 5.
  • 6.
  • 7.
  • 8.
  • 9.
  • 10.
  • 11.
  • 12.

5. 定制验证消息

可以定制验证失败时返回的消息。

# application.properties
validation.custom.username.message=用户名格式不正确
  • 1.
  • 2.

6. 组验证

在某些情况下，同一个Bean的不同方法可能需要不同的验证规则。

public class User {

    @NotBlank(message = "{validation.username.create}", groups = CreateGroup.class)
    private String username;

    public interface CreateGroup {}
    public interface UpdateGroup {}
}
  • 1.
  • 2.
  • 3.
  • 4.
  • 5.
  • 6.
  • 7.
  • 8.

7. 自定义验证注解

创建自定义的验证注解来满足特定的验证需求。

import javax.validation.Constraint;
import javax.validation.Payload;

@Constraint(validatedBy = YourCustomValidator.class)
@Target({ ElementType.FIELD })
@Retention(RetentionPolicy.RUNTIME)
public @interface YourCustomValidation {
    String message() default "default message";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
}
  • 1.
  • 2.
  • 3.
  • 4.
  • 5.
  • 6.
  • 7.
  • 8.
  • 9.
  • 10.
  • 11.

8. 验证结果处理

在Controller层处理验证结果，并返回相应的响应。

import org.springframework.http.ResponseEntity;
import org.springframework.validation.BindingResult;

@GetMapping("/users")
public ResponseEntity<?> createUser(@Valid User user, BindingResult result) {
    if (result.hasErrors()) {
        // 返回错误信息
    }
    // 正常逻辑
}
  • 1.
  • 2.
  • 3.
  • 4.
  • 5.
  • 6.
  • 7.
  • 8.
  • 9.
  • 10.

9. 方法级验证

使用@Validated注解在方法级别进行验证。

@PutMapping("/users/{id}")
public ResponseEntity<?> updateUser(@PathVariable Long id, @Valid User user, BindingResult result) {
    // 更新用户逻辑
}
  • 1.
  • 2.
  • 3.
  • 4.

10. 嵌套验证

对于嵌套对象，也可以进行验证。

public class User {

    @Valid
    private Address address;

    // Address类定义
}
  • 1.
  • 2.
  • 3.
  • 4.
  • 5.
  • 6.
  • 7.

11. 验证API

使用Spring的验证API进行编程式验证。

import org.springframework.validation.Validator;
import javax.validation.ConstraintValidatorContext;

public class YourCustomValidator implements ConstraintValidator<YourCustomValidation, String> {

    private Validator validator;

    @Override
    public void initialize(YourCustomValidation constraintAnnotation) {
        // 初始化
    }

    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        // 验证逻辑
    }
}
  • 1.
  • 2.
  • 3.
  • 4.
  • 5.
  • 6.
  • 7.
  • 8.
  • 9.
  • 10.
  • 11.
  • 12.
  • 13.
  • 14.
  • 15.
  • 16.
  • 17.

12. 验证测试

编写单元测试来验证验证逻辑的正确性。

import static org.springframework.test.web.servlet.result.MockMvcResultMatchers闪.status;

@RunWith(SpringRunner.class)
@WebMvcTest(YourController.class)
public class YourControllerTest {

    @Test
    public void testCreateUserWithInvalidData() throws Exception {
        // 发送请求并验证状态码
    }
}
  • 1.
  • 2.
  • 3.
  • 4.
  • 5.
  • 6.
  • 7.
  • 8.
  • 9.
  • 10.
  • 11.

通过上述方法，我们可以在Spring Boot应用中有效地应用数据验证规则，确保接收到的数据满足我们的业务需求和格式要求。