spring如何自定义去校验

worktile 1年前其他 33

共3条回复我来回复

不及物动词

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

自定义校验是在Spring中处理表单数据验证时非常有用的功能。Spring提供了多种方法来自定义校验，下面介绍一种常用的方法。

创建自定义校验器：
首先，需要创建一个自定义的校验器类，该类实现Spring的Validator接口。例如，创建一个名为CustomValidator的校验器类，代码如下：

import org.springframework.stereotype.Component;
import org.springframework.validation.Errors;
import org.springframework.validation.ValidationUtils;
import org.springframework.validation.Validator;

@Component
public class CustomValidator implements Validator {
    
    @Override
    public boolean supports(Class<?> clazz) {
        return YourModelClass.class.isAssignableFrom(clazz);
    }

    @Override
    public void validate(Object target, Errors errors) {
        ValidationUtils.rejectIfEmptyOrWhitespace(errors, "fieldName", "errorCode", "Error message");
        
        // 自定义校验逻辑
        YourModelClass model = (YourModelClass) target;
        // 进行自定义校验操作，根据需要添加更多的校验规则
        
        if (// 校验条件) {
            errors.rejectValue("fieldName", "errorCode", "Error message");
        }
    }
}

在自定义校验器类中，需要重写supports方法和validate方法。在supports方法中，指定该校验器支持验证的模型类，此处以YourModelClass为例。validate方法中，可以通过ValidationUtils类提供的方法进行基本的校验，也可以根据具体需求编写自定义的校验逻辑。

在控制器中使用自定义校验器：
接下来，在需要使用自定义校验器的控制器方法中，将自定义校验器注入，并在方法参数中使用@Validated注解进行标注。例如：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.validation.BindingResult;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class YourController {

    @Autowired
    private CustomValidator customValidator;

    @PostMapping("/your/path")
    public String yourMethod(@Validated @RequestBody YourModelClass model, BindingResult bindingResult) {
        customValidator.validate(model, bindingResult);
        if (bindingResult.hasErrors()) {
            // 处理校验失败的情况
            return "error";
        }
        // 处理校验成功的情况
        return "success";
    }
}

在控制器方法的参数中，使用@Validated注解标注需要进行校验的对象模型（即YourModelClass）。同时，还需将校验结果通过BindingResult对象传递回控制器中，在校验失败时，可以根据具体需求处理失败的情况。

配置Spring MVC处理器：
为了使自定义校验器生效，需要在Spring MVC配置中添加相应的处理器。例如，使用Java配置方式，可以在配置类中添加如下代码：

import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration
public class WebMvcConfig implements WebMvcConfigurer {

    @Autowired
    private CustomValidator customValidator;

    @Override
    public void addValidators(ValidatorRegistry registry) {
        registry.addValidator(customValidator);
    }
}

以上代码将自定义校验器添加到Spring MVC的ValidatorRegistry中，使其能够被Spring MVC框架自动识别并使用。

至此，自定义校验器的配置完成。在实际使用时，根据具体需求，可以根据字段的输入值进行各种自定义的校验操作，并返回相应的错误信息。

1年前 0条评论

fiy
Worktile&PingCode市场小伙伴
评论
Spring提供了多种方式来自定义校验。以下是五种常用的自定义校验方法：
1. 使用注解自定义校验规则：可以使用Spring的@Constraint注解来定义自定义的校验规则。首先需要创建一个自定义的校验注解类，使用@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 {};
}
```
1. 创建自定义校验逻辑的实现类：需要实现javax.validation.ConstraintValidator接口，并重写isValid方法来实现自定义的校验逻辑。在isValid方法中根据需要的校验规则进行校验，返回true或false。
```
public class CustomValidator implements ConstraintValidator<CustomValidation, String> {
    @Override
    public void initialize(CustomValidation constraintAnnotation) {
    }

    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        // 自定义的校验逻辑
        return false;
    }
}
```
1. 创建校验组：校验组是一种分组的方式，可以根据不同的场景使用不同的校验规则。在定义自定义的校验规则时，可以通过groups属性来指定该规则属于哪个校验组。在进行校验时，可以通过@Validated注解来指定要进行校验的校验组。
```
public interface GroupA {
}
public interface GroupB {
}

public class User {
    @CustomValidation(groups = GroupA.class)
    private String name;

    @CustomValidation(groups = GroupB.class)
    private String email;
}

@Service
@Validated
public class UserService {
    public void createUser(@Validated(GroupA.class) User user) {
        // 校验GroupA组的校验规则
    }

    public void updateUser(@Validated(GroupB.class) User user) {
        // 校验GroupB组的校验规则
    }
}
```
1. 使用自定义校验器工厂：Spring允许自定义校验器工厂来创建校验器实例。可以实现javax.validation.ValidatorFactory接口，并重写getValidator方法来返回自定义的校验器实例。
```
@Component
public class CustomValidatorFactory implements ValidatorFactory {
    @Override
    public Validator getValidator() {
        return new CustomValidator();
    }
}
```
然后在配置文件中配置自定义的校验器工厂：
```
spring:
  mvc:
    validation:
      custom:
        validator-factory: com.example.validation.CustomValidatorFactory
```
1. 使用自定义校验方法：Spring还允许在校验方法上使用自定义的校验逻辑。可以在校验方法上使用@Validated注解，并指定校验逻辑的实现类。在校验方法中，可以根据需要的校验规则调用校验逻辑，然后返回校验结果。
```
@Service
@Validated
public class UserService {
    public boolean validateUser(@CustomValidation String name) {
        // 调用自定义的校验逻辑，返回校验结果
    }
}
```
这些是Spring中自定义校验的五种方法，开发人员根据实际需求可以选择其中的一种或多种方式来进行校验。通过自定义校验，能够在业务逻辑中方便地实现数据校验和严格的输入校验。
1年前 0条评论

worktile

Worktile官方账号

Spring框架提供了一种灵活的方式来自定义校验器，用于校验请求参数、方法参数、实体对象等。下面是一种常见的自定义校验方式：

创建校验注解
首先，我们需要创建自定义的校验注解，例如@MyValid。可以通过@Target注解来指定注解的使用范围，比如可以应用在类、字段、方法等不同的地方。在注解中可以定义一些属性，用于传递校验参数。

@Target({ElementType.TYPE, ElementType.ANNOTATION_TYPE, ElementType.FIELD}) // 注解的使用范围
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = MyValidator.class) // 指定注解的校验器
public @interface MyValid {
    String message() default "Invalid value"; // 校验失败时的默认提示信息
    
    Class<?>[] groups() default {}; // 分组校验
    
    Class<? extends Payload>[] payload() default {}; // 载荷校验
    
    int min() default 0; // 自定义属性，最小值
    
    int max() default 100; // 自定义属性，最大值
}

创建校验器
接下来，需要创建自定义的校验器MyValidator，继承自ConstraintValidator，实现校验逻辑。

public class MyValidator implements ConstraintValidator<MyValid, Integer> {

    private int min;
    private int max;

    @Override
    public void initialize(MyValid annotation) {
        min = annotation.min(); // 获取最小值
        max = annotation.max(); // 获取最大值
    }

    @Override
    public boolean isValid(Integer value, ConstraintValidatorContext context) {
        if (value == null) { // null值直接通过校验
            return true;
        }
        return value >= min && value <= max; // 校验范围
    }
}

使用校验注解
在需要进行参数校验的地方，可以使用自定义的校验注解@MyValid标注在需要校验的参数上。

@PostMapping("/register")
public String register(@RequestParam @MyValid(min = 1, max = 100) Integer age) {
    // TODO: 处理注册逻辑
}

在上述示例中，@MyValid注解应用在age参数上，表示对该参数进行自定义的校验，校验的范围是1到100之间的整数。

校验结果处理
当参数校验失败时，Spring框架会将校验结果封装为BindingResult对象，并作为参数传递给调用方法。

@PostMapping("/register")
public String register(@RequestParam @MyValid(min = 1, max = 100) Integer age, BindingResult result) {
    if (result.hasErrors()) {
        List<ObjectError> errors = result.getAllErrors();
        // 处理校验错误
    }
    // TODO: 处理注册逻辑
}

在上述示例中，如果参数校验失败，BindingResult对象中会包含校验错误信息，可以通过result.getAllErrors()方法获取全部错误信息，并进行处理。

通过以上步骤，我们可以自定义校验注解，并在需要校验的参数上应用该注解，实现参数的自定义校验逻辑。

1年前 0条评论