参数校验

项目使用 Hibernate Validator (opens new window)框架，对 RESTful API 接口进行参数的校验，以保证最终数据入库的正确性。例如说，用户注册时，会校验手机格式的正确性，密码非弱密码。
如果参数校验不通过，会抛出 ConstraintViolationException 异常，被全局的异常处理捕获，返回“请求参数不正确”的响应。示例如下：
> {
  "code": 400,
  "data": null,
  "msg": "请求参数不正确:密码不能为空"
}

## 1. 参数校验注解
Validator 内置了 20+ 个参数校验注解，整理成常用与不常用的注解。
### 1.1 常用注解

![](/media/202408/2024-08-27_092907_916606.png)

### 1.2 不常用注解

![](/media/202408/2024-08-27_092934_927478.png)
## 2. 参数校验使用
只需要三步，即可开启参数校验的功能。
〇 第零步，引入参数校验的 spring-boot-starter-validation (opens new window)依赖。一般不需要做，项目默认已经引入。
① 第一步，在需要参数校验的类上，添加 @Validated (opens new window)注解，例如说 Controller、Service 类。代码如下：

> // Controller 示例
@Validated
public class AuthController {}
// Service 示例，一般放在实现类上
@Service
@Validated
public class AdminAuthServiceImpl implements AdminAuthService {}

② 第二步（情况一）如果方法的参数是 Bean 类型，则在方法参数上添加 @Valid (opens new window)注解，并在 Bean 类上添加参数校验的注解。代码如下：
// Controller 示例
@Validated
public class AuthController {

@PostMapping("/login")
    public CommonResult<AuthLoginRespVO> login(@RequestBody @Valid AuthLoginReqVO reqVO) {}
    
}
// Service 示例，一般放在接口上
public interface AdminAuthService {
    
    String login(@Valid AuthLoginReqVO reqVO, String userIp, String userAgent);
}

// Bean 类的示例。一般建议添加参数注解到属性上。原因：采用 Lombok 后，很少使用 getter 方法
public class AuthLoginReqVO {

@NotEmpty(message = "登录账号不能为空")
    @Length(min = 4, max = 16, message = "账号长度为 4-16 位")
    @Pattern(regexp = "^[A-Za-z0-9]+$", message = "账号格式为数字以及字母")
    private String username;

@NotEmpty(message = "密码不能为空")
    @Length(min = 4, max = 16, message = "密码长度为 4-16 位")
    private String password;
    
}
② 第二步，新建 MobileValidator (opens new window)校验器。代码如下：
public class MobileValidator implements ConstraintValidator<Mobile, String> {

@Override
    public void initialize(Mobile annotation) {
    }

@Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        // 如果手机号为空，默认不校验，即校验通过
        if (StrUtil.isEmpty(value)) {
            return true;
        }
        // 校验手机
        return ValidationUtils.isMobile(value);
    }

③ 第三步，在需要手机格式校验的参数上添加 @Mobile 注解。示例代码如下：
public class AppAuthLoginReqVO {

@NotEmpty(message = "手机号不能为空")
    @Mobile // <=== here
    private String mobile;
}

## 4. 更多使用文档
更多关于 Validator 的使用，可以系统阅读 《芋道 Spring Boot 参数校验 Validation 入门 》 文章。
例如说，手动参数校验、分组校验、国际化 i18n 等等。

## 5. 时间传参
5.1 Query 时间传参
Query 时间传参，指的是 GET 请求、或者 POST 的 form-data 请求。
① 后端接收时间参数时，需要添加 SpringMVC 的 @DateTimeFormat 注解，并设置时间格式。例如说：
> // JobLogPageReqVO.java
@DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND)
private LocalDateTime beginTime;
// UserPageReqVO.java
@DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND)
private LocalDateTime[] createTime;

② 前端传递时间参数时，需要时间格式为 yyyy-MM-dd HH:mm:ss，和上面的 FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND 对应。例如说前端 yudao-ui-admin-vue3 项目：
views/infra/job/logger/index.vue 的 beginTime 或 endTime 参数

![](/media/202408/2024-08-27_093353_899057.png)

- views/system/user/index.vue 的 createTime 参数

![](/media/202408/2024-08-27_093430_893512.png)

### 5.2 Request Body 时间传参
Request Body 时间传参，指的是 Post、PUT 等请求，通过 JSON 格式。
① 后端接收时间参数时，需要添加 SpringMVC 的 @RequestBody 注解，使用 LocalDateTime 属性进行接收。例如说：

![](/media/202408/2024-08-27_093536_317915.png)

② 前端传递时间参数时，需要时间格式为 Long 时间戳。例如说：
views/system/tenant/TenantForm.vue 的 expireTime 参数

![](/media/202408/2024-08-27_093600_382711.png)

### 5.3 Response Body 时间响应
JSON 返回的时间，使用 LocalDateTime 定义属性，会被序列化为 Long 时间戳进行相应。
例如说 TenantRespVO 的 createTime 属性，效果如下图：

![](/media/202408/2024-08-27_093642_171940.png)

### 5.4 如何自定义 JSON 时间格式？
#### 5.4.1 为什么使用 Long 时间戳呢？
每个项目希望展示的时间格式可能不同，有希望 yyyy-MM-dd HH:mm:ss，也有希望 yyyy/MM/dd HH:mm:ss，又或者是其它。
而 Long 时间戳是比较标准的，没有任何“产品需求”的味道，所以使用它。 至于业务希望展示成什么样子，可以通过前端封装统一的 format 方法去实现，更加规范。
它是通过 LocalDateTime 自定义的 TimestampLocalDateTimeSerializer 和 TimestampLocalDateTimeDeserializer 实现，之后进行如下配置：

![](/media/202408/2024-08-27_093735_877002.png)
#### 5.4.1 全局配置时间格式
如果你想 JSON 全局配置成 yyyy-MM-dd HH:mm:ss 或其它时间格式，通过使用 Jackson 内置的 LocalDateTimeSerializer 和 LocalDateTimeDeserializer 即可，如下图所示：

![](/media/202408/2024-08-27_093807_567990.png)

#### 5.4.2 局部配置时间格式
如果只是部分 VO 的字段想自定义 yyyy-MM-dd HH:mm:ss 或其它时间格式，可通过 Jackson 内置的 @JsonFormat 注解，如下所示：
> // UserRespVO.java
@JsonSerialize(using = LocalDateTimeSerializer.class) // 序列化（响应）
@JsonDeserialize(using = LocalDateDeserializer.class) // 反序列化（请求）
@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
private LocalDateTime createTime;