文章

SpringBoot 实体类 校验(底部附测试代码)

🌰: Entity

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
@TableName("user")
@Data
public class User implements Serializable {

    private static final long serialVersionUID = 1L;

    /**
     * ID
     */
    @TableId(value = "id", type = IdType.AUTO)
    private Integer id;

    /**
     * 姓名
     */
    @NotBlank(message = "【姓名】不能为空")
    @Length(min = 2, max = 8, message = "【姓名】字符长度范围[2,8]")
    private String name;

    /**
     * 手机号
     */
    @Pattern(regexp = "(^1(3\\d|4[5-9]|5[0-35-9]|6[567]|7[0-8]|8\\d|9[0-35-9])\\d{8}$)", message = "【手机号】不符合规范")
    private String phone;
}

Controller

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
@RestController
@RequestMapping("/user")
public class UserController {

    @Autowired
    IUserService userService;

    @PostMapping("/add")
    public Response addUser(@Valid @RequestBody User user) {
        if (userService.addUser(user) == 1) {
            return Response.success("添加成功", user);
        }
        return Response.error("添加失败");
    }
}

GlobalExceptionHandler

1
2
3
4
5
6
7
8
9
10
11
12
13
14
@RestControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(value = Exception.class)
    public Response exceptionHandle(Exception e) {
        Response result;
		if (e instanceof MethodArgumentNotValidException){
            result = Response.error("参数错误:" + Objects.requireNonNull(((MethodArgumentNotValidException) e).getBindingResult().getFieldError()).getDefaultMessage());
        } else {
			result = Response.error("服务器内部错误");
		}
        return result;
    }
}

测试

依赖

包含 javax.validation.constraintsorg.hibernate.validator.constraints

1
2
3
4
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

javax.validation.constraints

常用注解

注解 针对类型 说明
@Null 对象 被注解的元素必须为 null
@NotNull 对象 被注解的元素必须不为 null
@AssertTrue 布尔 被注解的元素必须为 true
@AssertFalse 布尔 被注解的元素必须为 false
@Min(value) 数字 被注解的元素必须为数字,其值必须大于等于最小值
@Max(value) 数字 被注解的元素必须为数字,其值必须小于等于最小值
@Size(max,min) 集合、数组、字符串 被注解的元素(集合、数组大小,字符串长度)必须在指定范围
@Past 日期 被注解的元素必须为过去的一个时间
@Future 日期 被注解的元素必须为未来的一个时间
@Pattern 对象 被注解的元素必须符合指定的正则表达式

org.hibernate.validator.constraints

常用注解

注解 针对类型 说明
@NotBlank 字符串 校验字符串去掉前后空格后长度不为0
@NotEmpty 字符串、集合、数组 校验对象不为空(字符串长度不为0,集合、数组大小不为0)
@Length 字符串 校验字符串长度在指定范围
@Range 数字、字符串 校验对象(字符串长度,数字大小)在指定范围
@Email 字符串 校验字符串为邮箱地址
@URL 字符串 校验字符串为URL地址
@CreditCardNumber 字符串 校验字符串为信用卡号
@ScriptAssert 对象 被注解的元素指定校验的方法,来进行复杂的校验,返回 true 或 false

源码

springboot_valid

本文由作者按照 CC BY 4.0 进行授权