Spring控制器层的方法参数——@Validated注解

        @Validated是Spring框架中的一个注解，用于在方法参数上启用数据校验。它是JSR 303（Java Bean Validation）标准的一个实现，这个标准允许开发者定义验证规则并应用于Java对象的属性。Spring使用Hibernate Validator作为默认的验证实现，但也可以配置为使用其他兼容的验证提供者。

1. 使用场景

        @Validated通常用于控制器层的方法参数，当接收到用户输入时，Spring会在调用方法前对参数进行验证，比如在之前写项目的时候，我们经常需要对方法中的参数进行一系列的判断：

这个写法的有点是灵活，但是比较繁琐，可能会忘记写，于是我们可以用 @Validated 来替代。

2. 基本用法

        将@Validated直接放在控制器类或者方法参数上，表示该类或方法的参数需要进行验证。
对于需要验证的参数，需要在对应的数据类（通常是一个Java Bean）的属性上使用JSR 303/JSR 349提供的验证注解，如@NotNull, @Size, @Email等。

如下代码：

首先pom.xml引入依赖包:

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

写一个接口，加上@validated注解： 

@PostMapping("testValidated")
public String testValidated(@RequestBody @Validated Test test) {    
    return JSONUtil.toJsonStr(test);
}

在Test中写上几个注解测试：

package org.example.entity;

import lombok.Data;
import org.hibernate.validator.constraints.Range;

import javax.validation.constraints.NotBlank;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Size;
import java.io.Serializable;

/**
 * @Author: stukk
 * @Description:
 * @DateTime: 2024-05-02 18:50
 **/
@Data
public class Test implements Serializable {
    private static final long serialVersionUID = 1L;
    @NotNull(message = "id不能为空")
    private Long id;
    @NotBlank(message = "name不能为空")
    private String name;

    @Range(min = 0, max = 100, message = "年龄范围0-100")
    private Integer age;


}

3. 异常处理

        如果验证失败，Spring会抛出MethodArgumentNotValidException。默认情况下，Spring MVC会自动将这个异常转换为HTTP 400 Bad Request响应，其中包括验证错误的详细信息。
为了自定义错误处理，可以使用@ExceptionHandler注解定义一个方法来捕获并处理这个异常。

package org.example.aop;

import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;


/**
 * 全局异常处理器
 *
 * @author stukk
 */
@RestControllerAdvice
public class GlobalExceptionHandler {
    @ExceptionHandler(RuntimeException.class)
    public Object runtimeExceptionHandler(RuntimeException e) {
        return e.getMessage();
    }

    @ExceptionHandler(MethodArgumentNotValidException.class)
    public Object methodArgumentNotValidExceptionHandler(MethodArgumentNotValidException e) {
        return e.getBindingResult().getFieldError().getDefaultMessage();
    }
}

我们来使用postman测试上面的接口吧：

这样我们就不需要在方法中手写校验代码嘞！

4. 常用注解

以下是常用的注解以及其解释：

空检查

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

 Booelan检查

•  @AssertTrue   验证 Boolean 对象是否为 true 
•  @AssertFalse 验证 Boolean 对象是否为 false 

 长度检查

•  @Size(min=, max=)    验证对象（Array,Collection,Map,String）长度是否在给定的范围之内 
•  @Length(min=, max=) 验证注解的元素值长度在min和max区间内

 日期检查

•  @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=) 验证注解的元素值在最小值和最大值之间
•  @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=) 地址校验