spring如何自定义校验 • Worktile社区

worktile

Worktile官方账号

Spring框架提供了丰富的校验机制，可以满足大部分的校验需求。如果需要更复杂的校验逻辑，可以自定义校验注解和校验器。

自定义校验注解：

创建一个注解类，使用@Constraint注解标注，并指定校验器类。
例如：

@Target({ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = CustomValidator.class)
public @interface CustomValidation {
    String message() default "Invalid value";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
}

创建校验器类实现ConstraintValidator接口，并实现其中的两个方法。
例如：

public class CustomValidator implements ConstraintValidator<CustomValidation, String> {
    
    @Override
    public void initialize(CustomValidation constraintAnnotation) {
        // 初始化校验器
    }
    
    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        // 校验逻辑
        // 返回true表示校验通过，返回false表示校验不通过
    }
}

使用自定义的校验注解：

在需要校验的属性上添加自定义的注解。
例如：

public class User {
    @CustomValidation
    private String username;
}

在需要进行校验的地方使用Spring提供的校验工具进行校验。
例如：

@RestController
public class UserController {
    @PostMapping("/users")
    public void createUser(@Valid @RequestBody User user) {
        // 处理创建用户的逻辑
    }
}

以上就是Spring自定义校验的基本步骤。通过自定义校验注解和校验器，我们可以实现更复杂的校验逻辑，并且与Spring校验框架很好地集成在一起。

1年前 0条评论

不及物动词

这个人很懒，什么都没有留下～

在Spring框架中，我们可以通过自定义注解和实现javax.validation.ConstraintValidator接口来实现自定义校验。下面详细介绍如何自定义校验。

创建自定义注解
我们首先需要创建一个自定义注解来标记需要进行校验的字段。该注解需要使用@Constraint注解进行修饰，并指定一个校验器类。

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
@Constraint(validatedBy = MyValidator.class)
public @interface MyValidation {
    String message() default "Invalid input";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
}

在上述代码中，@Retention(RetentionPolicy.RUNTIME)用于指定注解在运行时可用，@Target(ElementType.FIELD)用于指定注解只能应用在字段上，@Constraint(validatedBy = MyValidator.class)则用于指定校验器类。

实现校验器
然后，我们需要实现javax.validation.ConstraintValidator接口来自定义校验逻辑。

public class MyValidator implements ConstraintValidator<MyValidation, String> {
    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        // 自定义校验逻辑
        return value != null && value.startsWith("prefix");
    }
}

在上述代码中，我们实现了ConstraintValidator<MyValidation, String>接口，并重写了isValid方法来定义校验逻辑。参数value表示需要校验的字段的值，context表示校验上下文环境。在isValid方法中，我们可以根据具体需求编写校验逻辑，并返回一个布尔值表示校验结果。

在实体类中使用自定义注解
接下来，我们可以在需要进行校验的字段上使用自定义注解。

public class User {
    @MyValidation
    private String name;
    
    // getter and setter
}

在上述代码中，我们在name字段上使用了自定义注解@MyValidation来标记该字段需要进行校验。

添加校验
我们需要在适当的地方执行校验操作，例如在Controller中的方法上使用@Validated注解进行校验。

@RestController
@Validated
public class UserController {
    
    @PostMapping("/users")
    public ResponseEntity<String> createUser(@RequestBody @Valid User user) {
        // 执行业务逻辑
        return ResponseEntity.ok("User created successfully");
    }
}

在上述代码中，我们使用了@Validated注解来开启校验功能，并在createUser方法的@RequestBody参数上使用了@Valid注解来表示对该参数进行校验。

处理校验结果
如果校验失败，Spring会抛出MethodArgumentNotValidException异常，我们可以通过自定义异常处理器来对异常进行处理，并返回自定义的错误信息。

@ControllerAdvice
public class GlobalExceptionHandler {
    
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public ResponseEntity<Object> handleValidationExceptions(MethodArgumentNotValidException ex) {
        List<String> errors = ex.getBindingResult()
                                .getFieldErrors()
                                .stream()
                                .map(error -> error.getField() + ": " + error.getDefaultMessage())
                                .collect(Collectors.toList());
        return ResponseEntity.badRequest().body(errors);
    }
}

在上述代码中，我们通过@ExceptionHandler(MethodArgumentNotValidException.class)注解来指定对MethodArgumentNotValidException异常进行处理。在处理方法中，我们获取校验结果的字段错误信息，并将其封装为自定义的错误信息列表返回。

通过以上步骤，我们就成功地实现了Spring自定义校验。

1年前 0条评论

fiy

Worktile&PingCode市场小伙伴

在Spring框架中，校验是一个常见的需求。Spring对校验提供了很好的支持，并且允许开发者自定义校验规则。

下面将介绍如何在Spring中进行自定义校验。

定义校验注解

首先，需要定义一个校验注解，以标识要校验的字段或参数。可以使用Spring自带的注解（如@NotNull）、自定义注解，或者使用Hibernate Validator提供的注解（如@Email、@Size等）。

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = CustomValidator.class)
public @interface CustomValidation {
    String message() default "Invalid value";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
}

创建校验器

接下来，需要创建一个校验器，实现ConstraintValidator接口。在该校验器中，编写校验逻辑。

public class CustomValidator implements ConstraintValidator<CustomValidation, String> {

    @Override
    public void initialize(CustomValidation constraintAnnotation) {
        // 初始化操作，可获得注解的属性
    }

    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        // 校验逻辑，返回true或false
    }
}

应用校验注解

在需要进行校验的字段或参数上添加自定义的校验注解。

public class User {
    @CustomValidation
    private String username;

    // getters and setters
}

在控制器中校验

在控制器方法中使用@Valid注解，启用校验功能，并处理校验结果。

@RestController
public class UserController {
    @PostMapping("/users")
    public String createUser(@Valid @RequestBody User user, BindingResult result) {
        if (result.hasErrors()) {
            // 处理校验错误
        }
        // ...创建用户逻辑
    }
}

以上就是在Spring中自定义校验的方法，通过定义校验注解、创建校验器、应用校验注解以及在控制器中进行校验，可以实现对字段和参数的自定义校验。在校验逻辑中，可以访问其他的依赖注入的组件，实现更复杂的校验逻辑。

1年前 0条评论