SpringCloud参数校验

SpringCloud参数校验
 最后更新于 2024年10月02日 22:58:23

方法参数校验

罗列参数

@GetMapping("/update")
@ResponseBody
public void update(
        @Size(min = 1,max = 10,message = "姓名长度必须为1到10") @RequestParam("name") String name,
        @Min(value = 10,message = "年龄最小为10") @Max(value = 100,message = "年龄最大为100")
@RequestParam("age") Integer age) {
    ...
}

DTO封装

import lombok.Data;

@Data
public class UserDto {
    @Size(min = 1, max = 10, message = "姓名长度必须为1到10")
    private String name;

    @Min(value = 10, message = "年龄最小为10")
    @Max(value = 100, message = "年龄最大为100")
    private Integer age;
}

@PostMapping("/update")
@ResponseBody
public void update(@Valid @RequestBody UserDto user) {
}

装饰器使用

使用场景

@RequestParam 适用 Get 请求且 content-type: application/x-www-form-urlencoded

@RequestBody 适用 post 请求 content-type 为非 application/x-www-form-urlencoded

1、入参为 @RequestParam@RequestBody 时,不用加 @valid@validated

2、参数中有 @NotNull 时要在方法上加 @valid@validated,或者在类上加 @Validated@valid不能作用于类上),这样@NotNull才能起作用。

3、参数为实体对象时,需要在方法上加 @Valid@Validated 或者在参数前加 @Valid@Validated,或者在类上加 @Validated

4、@valid 作用于属性上有嵌套验证作用

@GetMapping("/exam-info")
public Boolean getInfo(@Valid User user){.....}

@GetMapping("/exam-info")
public Boolean getInfo(@Validated User user){.....}

public class User {
  @Valid
  @NotNull("car不能为空")
  private Car car;
}

public class Car {
  @NotNull("id不能为空")
  private Integer id;
}

自定义校验规则

自定义校验规则需要实现一个装饰器和一个校验类

自定义注解校验

// 装饰器
import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.*;

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.PARAMETER,ElementType.FIELD})
@Constraint(validatedBy = FlagValidatorClass.class)
public @interface FlagValidator {
    // flag的有效值,多个使用,隔开
    String values();

    // flag无效时的提示内容
    String message() default "flag必须是预定义的那几个值,不能随便写";

    Class<?>[] groups() default {};

    Class<? extends Payload>[] payload() default {};
}
// 校验规则
import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;

public class FlagValidatorClass implements ConstraintValidator<FlagValidator,Object> {
    /**
     * FlagValidator注解规定的那些有效值
     */
    private String values;

    @Override
    public void initialize(FlagValidator flagValidator) {
        this.values = flagValidator.values();
    }

    /**
     * 用户输入的值,必须是FlagValidator注解规定的那些值其中之一。
     * 否则,校验不通过。
     * @param value 用户输入的值,如从前端传入的某个值
     */
    @Override
    public boolean isValid(Object value, ConstraintValidatorContext constraintValidatorContext) {
        // 切割获取值
        String[] value_array = values.split(",");
        Boolean isFlag = false;

        for (int i = 0; i < value_array.length; i++){
            // 存在一致就跳出循环
            if (value_array[i] .equals(value)){
                isFlag = true; break;
            }
        }

        return isFlag;
    }
}
public class UserDto {
    // 前端传入的flag值必须是1或2或3,否则校验失败
    @FlagValidator(values = "1,2,3")
    private String flag;
}

分组校验

建立了两个分组,名称分别为 Default、Update。POST 方法提交时使用 Defaut 分组的校验规则,PUT 方法提交时同时使用两个分组规则。

import org.hibernate.validator.constraints.Length;
import javax.validation.constraints.Min;
import javax.validation.constraints.NotNull;

public class Resume {
    public interface Default {
    }

    public interface Update {
    }

    @NotNull(message = "id不能为空", groups = Update.class)
    private Long id;

    @NotNull(message = "名字不能为空", groups = Default.class)
    @Length(min = 4, max = 10, message = "name 长度必须在 {min} - {max} 之间", groups = Default.class)
    private String name;

    @NotNull(message = "年龄不能为空", groups = Default.class)
    @Min(value = 18, message = "年龄不能小于18岁", groups = Default.class)
    private Integer age;
}
/**
 * 使用Defaul分组进行验证
 * @param resume
 * @return
 */
@PostMapping("/validate5")
public String addUser(@Validated(value = Resume.Default.class) @RequestBody Resume resume) {
}

/**
 * 使用Default、Update分组进行验证
 * @param resume
 * @return
 */
@PutMapping("/validate6")
public String updateUser(@Validated(value = {Resume.Update.class, Resume.Default.class}) @RequestBody Resume resume) {}

约束

约束注解说明
@AssertFalse被注释的元素必须为 false
@AssertTrue被注释的元素必须为 true
@DecimalMax(value)被注释的元素必须是一个数字,其值必须小于等于指定的最大值
@DecimalMin(value)被注释的元素必须是一个数字,其值必须大于等于指定的最小值
@Digits (integer, fraction)被注释的元素必须是一个数字,其值必须在可接受的范围内
@Null被注释的元素必须为 null
@NotNull被注释的元素必须不为 null
@Min(value)被注释的元素必须是一个数字,其值必须大于等于指定的最小值
@Max(value)被注释的元素必须是一个数字,其值必须小于等于指定的最大值
@Size(max, min)被注释的元素的大小必须在指定的范围内
@Past被注释的元素必须是一个过去的日期
@Future被注释的元素必须是一个将来的日期
@Pattern(value)被注释的元素必须符合指定的正则表达式
@Email被注释的元素必须是电子邮箱地址
@Length被注释的字符串的大小必须在指定的范围内
@NotBlank被注释的字符串的必须非空
@NotEmpty被注释的字符串、集合、Map、数组必须非空
@Range被注释的元素必须在合适的范围内
@SafeHtml被注释的元素必须是安全 Html
@URL被注释的元素必须是有效 URL