SpringBoot 使用 Validation 进行参数校验及统一校验异常返回

最新推荐文章于 2024-06-21 23:39:47 发布

知其_所以然

最新推荐文章于 2024-06-21 23:39:47 发布

阅读量1.3k

点赞数 31

本文链接：https://blog.csdn.net/zwl2220943286/article/details/137091355

版权

java技术同时被 2 个专栏收录

66 篇文章 0 订阅

订阅专栏

SpringBoot

9 篇文章 0 订阅

订阅专栏

1、简介

在 SpringBoot项目开发中，有一个观点是不要相信前端传入的任何参数，因为不知道用户是怎么操作后端接口的，所以在后端需要对参数进行校验，本文主要介绍在后端如何通过Validation进行参数校验，并且实现校验异常统一返回。

2、在项目中引入依赖

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-validation</artifactId>
</dependency>
<!--spring-boot-starter-validation本质是使用的Hibernate Validator，它并没有自己的实现-->

3、校验参数使用的注解

注解名称	使用说明
@Null	验证对象是否为null
@NotNull	验证对象是否不为null，无法校验长度为0的空字符串
@NotBlank	检查约束字符串是否为null，且被Trim后的长度是否大于0，只适用于字符串，会去掉前后空格
@NotEmpty	检查约束元素是否为NULL或者是EMPTY
@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对象是否符合正则表达式的规则
@Min	验证Number和String对象是否大等于指定的值
@Max	验证Number和String对象是否小等于指定的值
@DecimalMax	被标注的值必须不大于约束中指定的最大值，参数为通过BigDecimal定义的最大值的字符串表示，小数存在精度
@DecimalMin	被标注的值必须不小于约束中指定的最小值，参数为通过BigDecimal定义的最小值的字符串表示，小数存在精度
@Digits	验证Number和String的构成是否合法
@Digits(integer=,fraction=)	验证字符串是否符合指定格式的数字，integer指定整数精度，fraction指定小数精度
@Range(min=, max=)	验证注解的元素值在最小值和最大值之间
@Range(min=1,max=5, message="error")	验证注解的元素值在最小值1和最大值5之间，自定义错误信息为"error"
@Valid	写在方法参数前，递归地对该对象进行校验，如果关联对象是集合或数组，则对其中的元素进行递归校验；如果是一个map，则对其中的值部分进行校验（是否进行递归验证）
@CreditCardNumber	信用卡验证
@Email	验证是否是邮件地址，如果为null，不进行验证，算通过验证
@URL(protocol=,host=, port=,regexp=, flags=)	验证URL的格式是否正确，可以指定协议

4、具体使用

在日常开发中，我们使用DTO在Controller层进行参数传递，需要对Controller中方法参数进行校验，具体使用方式如下：

4.1、定义DTO对象

import com.fasterxml.jackson.annotation.JsonIgnore;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.hibernate.validator.constraints.Length;
import javax.validation.constraints.Email;
import javax.validation.constraints.Max;
import javax.validation.constraints.Min;
import javax.validation.constraints.NotBlank;
import javax.validation.constraints.AssertFalse;
@Data
@AllArgsConstructor
@NoArgsConstructor
public class UserDto {
    @NotBlank(message = "用户名不能为空")
    private String username;
    @NotBlank(message = "密码不能为空")
    @Length(min = 6, max = 20, message = "密码长度在6-20之间")
    private String password;
    @Min(value = 0, message = "年龄最小为0")
    @Max(value = 130, message = "年龄最大为130")
    private Integer age;
    @NotBlank(message = "邮箱不能为空")
    @Email(message = "邮箱格式不正确")
    private String email;
    @AssertFalse
    private Boolean admin;
    @Pattern(regexp = "^1(3|4|5|7|8)\d{9}$",message = "手机号码格式错误")
    @NotBlank(message = "手机号码不能为空")
    private String phone;
}

4.2、在Controller层使用

4.2.1、对于单个参数校验

另外对于单个参数的校验，没有用DTO对象来接收的参数也可以校验，先在controller类上添加@Validated，再在对应的参数前加校验注解，如下所示:

@RestController
@RequestMapping("/user")
@Validated
public class UserController {
    @PostMapping("/login")
    public Result login(@NotBlank(message = "name不能为空") String name) {
        return Result.ok(name);
    }
}

4.2.2、在DTO上添加校验

在Controller上进行校验，可以添加@Valid或者@Validated，当校验失败时接口就会返回500异常和相应的异常信息。

@PostMapping("/login")
public Result login(@RequestBody @Valid UserDto userDto) {
    return Result.ok(userDto);
}

5、校验异常统一处理

使用SpringBoot中全局异常功能，统一异常处理中添加BindException处理校验异常。

import org.beiming.enums.AppHttpCodeEnum;
import org.beiming.domain.vo.Result;
import lombok.extern.slf4j.Slf4j;
import org.springframework.validation.BindException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;

@RestControllerAdvice
@Slf4j
public class GlobalExceptionHandler {
    /* 添加校验参数异常处理 */
    @ExceptionHandler(BindException.class)
    public ResponseResult bindExceptionHandler(BindException e) {
        log.error("出现了异常! {}", e);
        return Result.error(AppHttpCodeEnum.SYSTEM_ERROR, e.getBindingResult().getAllErrors().get(0).getDefaultMessage());
    }
}