springboot自定义校验
时间: 2023-09-10 08:11:17 浏览: 104
Spring Boot 提供了一种基于注解的方式来实现校验,即使用 `javax.validation` 标准规范中的注解来实现校验。如果需要自定义校验规则,可以按照以下步骤进行:
1. 创建自定义注解
```java
@Target({ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = MyValidator.class)
public @interface MyValidation {
String message() default "Invalid field";
Class<?>[] groups() default {};
Class<? extends Payload>[] payload() default {};
}
```
2. 创建自定义校验器
```java
public class MyValidator implements ConstraintValidator<MyValidation, String> {
@Override
public void initialize(MyValidation constraintAnnotation) {
// 初始化
}
@Override
public boolean isValid(String value, ConstraintValidatorContext context) {
// 自定义校验逻辑
return value != null && value.startsWith("prefix");
}
}
```
3. 在需要校验的字段上添加自定义注解
```java
public class MyEntity {
@MyValidation
private String myField;
// getter/setter
}
```
4. 在 Controller 中使用 `@Validated` 注解进行校验
```java
@RestController
@RequestMapping("/my-entity")
@Validated
public class MyController {
@PostMapping
public MyEntity create(@RequestBody @Valid MyEntity entity) {
// 创建实体
}
}
```
在上面的示例中,`MyValidation` 注解和 `MyValidator` 校验器实现了一个自定义的校验规则,用于判断字符串是否以 "prefix" 开头。在 `MyEntity` 实体类中,使用了 `@MyValidation` 注解来标注需要校验的字段。在 `MyController` 中,使用了 `@Validated` 注解来开启校验,并在 `create()` 方法中使用 `@RequestBody @Valid` 注解来对请求体进行校验。
以上就是使用 Spring Boot 自定义校验规则的步骤。需要注意的是,自定义的校验注解需要使用 `@Constraint` 注解进行标注,并指定校验器的实现类。校验器需要实现 `ConstraintValidator` 接口,并指定校验注解和校验字段的类型。在校验逻辑中,可以使用 `ConstraintValidatorContext` 对象来进行错误信息的设置。在 Controller 中,需要使用 `@Validated` 注解开启校验,并在需要校验的参数上使用 `@Valid` 注解。
阅读全文