JSR-303校验 @Valid, @Validated

JSR-303数据校验
本文介绍JSR-303中@Valid与@Validated等注解的应用,涵盖空检查、Boolean检查、长度检查、日期检查、数值检查等方面,并提供了分组验证示例。

JSR-303校验 @Valid, @Validated

空检查
  • @Null 验证对象是否为null
  • @NotNull 验证对象是否不为null, 无法查检长度为0的字符串
  • @NotBlank 检查约束字符串是不是Null还有被Trim的长度是否大于0,只对字符串,且会去掉前后空格
  • @NotEmpty 检查约束元素是否为NULL或者是EMPTY.

==@NotNull是通过 null来判断

@NotEmpty是通过 .size()= =0和.length()= =0判断

@NotBlank是通过 .trim().length()= =0判断 按照实际的需求来使用

Booelan检查
  • @AssertTrue 验证 Boolean 对象是否为 true
  • @AssertFalse 验证 Boolean 对象是否为 false
长度检查
  • @Size(min=, max=) 验证对象(Array,Collection,Map,String)长度是否在给定的范围之内
  • @Length(min=, max=) Validates that the annotated string is between min and max included.
日期检查
  • @Past 验证 Date 和 Calendar 对象是否在当前时间之前
  • @Future 验证 Date 和 Calendar 对象是否在当前时间之后
  • @Pattern 验证 String 对象是否符合正则表达式的规则
数值检查

建议使用在Stirng,Integer类型,不建议使用在int类型上,因为表单值为“”时无法转换为int,但可以转换为Stirng为"",Integer为null

  • @Min 验证 Number 和 String 对象是否大等于指定的值

  • @Max 验证 Number 和 String 对象是否小等于指定的值

  • @DecimalMax 被标注的值必须不大于约束中指定的最大值. 这个约束的参数是一个通过BigDecimal定义的最大值的字符串表示.小数存在精度

  • @DecimalMin 被标注的值必须不小于约束中指定的最小值. 这个约束的参数是一个通过BigDecimal定义的最小值的字符串表示.小数存在精度

  • @Digits 验证 Number 和 String 的构成是否合法

  • @Digits(integer=,fraction=) 验证字符串是否是符合指定格式的数字,interger指定整数精度,fraction指定小数精度。

  • @Range(min=, max=) 检查数字是否介于min和max之间.

  • @Range(min=10000,max=50000,message=“range.bean.wage”)
    private BigDecimal wage;

  • @Valid 递归的对关联对象进行校验, 如果关联对象是个集合或者数组,那么对其中的元素进行递归校验,如果是一个map,则对其中的值部分进行校验.(是否进行递归验证)

  • @CreditCardNumber信用卡验证

  • @Email 验证是否是邮件地址,如果为null,不进行验证,算通过验证。

  • @ScriptAssert(lang= ,script=, alias=)

  • @URL(protocol=,host=, port=,regexp=, flags=)

简单举例
public class UserInfo {
   
    @NotBlank(message = "姓名不能为空")
    private String username;

    //    @NotEmpty(message = "密码不能为空")
    @Length(min = 6, max = 10, message = "密码长度只能在6-10之间")
    private String password;

    @Min(value = 18, message = "年龄最小为18")
    @Max(value = 60, message = "年龄最大为60")
    int age;

    @AssertTrue(message = "必须同意条款")
    boolean agree;
}
    @ResponseBody
    @GetMapping("validate")
    public Map<String, String> validate(@Valid UserInfo userInfo, BindingResult result){

        Map<String, String> map = new HashMap<String, String>();
        if (result.hasErrors()) {
            List<ObjectError> list  = result.getAllErrors();
            for (ObjectError error :
                    list) {
                FieldError fieldError = (FieldError)error;
                String defaultMessage = fieldError.getDefaultMessage();
                String field = fieldError.getField();
                map.put(field, defaultMessage);
            }
        }
        return map;
    }

在这里插入图片描述

@Validated

@Valid是javax.validation里的。

@Validated是@Valid 的一次封装,是Spring提供的校验机制使用。@Valid不提供分组功能

特殊用法:

  • 分组: 当一个实体类需要多种验证方式时,例:对于一个实体类的id来说,新增的时候是不需要的,对于更新时是必须的, 可以通过groups对验证进行分组
public interface AllFiled {
}

public interface First {
}

public interface Secend {
}

public class UserInfo {
    private Integer uid;

    @NotBlank(message = "姓名不能为空", groups = {First.class, AllFiled.class})
    private String username;

    @NotEmpty(message = "密码不能为空", groups = {AllFiled.class})
    @Length(min = 6, max = 10, message = "密码长度只能在6-10之间", groups = {AllFiled.class})
    private String password;

    //临时加的字段
    @Min(value = 18, message = "年龄最小为18", groups = {AllFiled.class})
    @Max(value = 60, message = "年龄最大为60", groups = {AllFiled.class})
    int age;

    //临时加的字段
    @AssertTrue(message = "必须同意条款", groups = {Secend.class, AllFiled.class})
    boolean agree;
}

    @ResponseBody
    @GetMapping("validate")
    public Map<String, String> validate(@Validated({AllFiled.class}) UserInfo userInfo, BindingResult result){

        Map<String, String> map = new HashMap<String, String>();
        if (result.hasErrors()) {
            List<ObjectError> list  = result.getAllErrors();
            for (ObjectError error :
                    list) {
                FieldError fieldError = (FieldError)error;
                String defaultMessage = fieldError.getDefaultMessage();
                String field = fieldError.getField();
                map.put(field, defaultMessage);
            }
        }
        return map;
    }
}

当@Validated分组为空时, 只会验证没有分组的属性, 如上面的uid;

当@Validated{First.class}时, 只会验证分组为First.class的字段, 对于其他分组字段和未分组字段都为空

### **JSR-303 校验详解** JSR-303(Java Specification Request 303)是 Java 的 **Bean Validation 标准**,定义了一套用于验证 Java Bean 属性的注解和 API。它允许开发者通过声明式注解(如 `@NotNull`、`@Size`)对对象字段进行校验,而无需手动编写校验逻辑。 --- ## **1. 核心概念** ### **1.1 核心注解** JSR-303 提供了一系列内置校验注解(位于 `javax.validation.constraints` 包): | 注解 | 作用 | |---------------------|----------------------------------------------------------------------| | `@NotNull` | 字段不能为 `null` | | `@Size(min, max)` | 字符串/集合长度必须在 `min` 和 `max` 之间 | | `@Min(value)` | 数字必须 ≥ `value` | | `@Max(value)` | 数字必须 ≤ `value` | | `@Pattern(regex)` | 字符串必须匹配正则表达式 | | `@Email` | 字符串必须是合法的邮箱格式 | | `@Past` / `@Future` | 日期必须在过去/未来 | ### **1.2 校验流程** 1. **注解声明**:在 DTO 类的字段或方法上添加校验注解。 ```java public class UserDTO { @NotBlank private String name; @Size(min = 6, max = 20) private String password; } ``` 2. **触发校验**:通过 `Validator` 或框架(如 Spring)自动触发。 - **手动校验**: ```java ValidatorFactory factory = Validation.buildDefaultValidatorFactory(); Validator validator = factory.getValidator(); Set<ConstraintViolation<UserDTO>> violations = validator.validate(userDTO); ``` - **Spring 自动校验**(配合 `@Valid`): ```java @PostMapping("/users") public ResponseEntity<?> createUser(@Valid @RequestBody UserDTO userDTO) { // 校验失败会抛出 MethodArgumentNotValidException } ``` 3. **错误处理**:校验失败时抛出 `ConstraintViolationException`(手动校验)或 `MethodArgumentNotValidException`(Spring)。 --- ## **2. 与 Spring 的集成** SpringJSR-303 提供了深度支持: ### **2.1 启用校验** - 添加依赖(Spring Boot 已默认集成): ```xml <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-validation</artifactId> </dependency> ``` - 在 Controller 方法参数前加 `@Valid` 或 `@Validated`: ```java public ResponseEntity<?> updateUser(@Valid @RequestBody UserDTO userDTO) ``` ### **2.2 错误消息定制** - 通过注解的 `message` 属性定义错误提示: ```java @NotBlank(message = "用户名不能") private String username; ``` - 国际化:在 `messages.properties` 中配置: ```properties NotBlank.userDTO.username=用户名不能 ``` ### **2.3 分组校验** 通过 `groups` 实现不同场景下的差异化校验: ```java public class UserDTO { @NotBlank(groups = Create.class) private String username; @NotBlank(groups = {Create.class, Update.class}) private String password; } // 在 Controller 中指定分组 public ResponseEntity<?> createUser(@Validated(UserDTO.Create.class) @RequestBody UserDTO userDTO) ``` --- ## **3. 扩展功能** ### **3.1 自定义校验注解** 1. 定义注解: ```java @Target({FIELD, METHOD}) @Retention(RUNTIME) @Constraint(validatedBy = PhoneNumberValidator.class) public @interface PhoneNumber { String message() default "手机号格式错误"; Class<?>[] groups() default {}; Class<? extends Payload>[] payload() default {}; } ``` 2. 实现校验逻辑: ```java public class PhoneNumberValidator implements ConstraintValidator<PhoneNumber, String> { @Override public boolean isValid(String phone, ConstraintValidatorContext context) { return phone != null && phone.matches("^1[3-9]\\d{9}$"); } } ``` ### **3.2 级联校验** 如果对象包含嵌套对象,使用 `@Valid` 触发递归校验: ```java public class OrderDTO { @Valid private UserDTO user; // 会校验 UserDTO 中的注解 } ``` --- ## **4. 与其他技术的对比** | 特性 | JSR-303 | 手动校验 | Hibernate Validator(实现) | |---------------------|---------------|----------------|-----------------------------| | **代码侵入性** | 低(注解驱动)| 高(硬编码) | 同 JSR-303 | | **复用性** | 高 | 低 | 高 | | **功能扩展** | 支持自定义 | 需自行实现 | 提供额外注解(如 `@URL`) | --- ## **5. 实际应用场景** - **REST API 参数校验**(如 Spring MVC 的 `@RequestBody`) - **数据库实体校验**(如 JPA 保存前的自动校验- **表单提交校验**(结合 Thymeleaf 前端显示错误)
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值