项目（一）springboot多模块工程（10）JSR-303实现请求参数校验

依赖

  		<dependency>
            <groupId>org.hibernate.validator</groupId>
            <artifactId>hibernate-validator</artifactId>
        </dependency>

由于spring-boot-starter-web中已经包含该包，当在上级模块需要用到校验时，在spring-boot-starter-web所在pom中去掉该依赖。本工程将该依赖放到common模块中，在web模块中去掉该依赖。

		<dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
            <exclusions>
                <!--已经在common包中引入，这里去掉-->
                <exclusion>
                    <groupId>com.fasterxml.jackson.core</groupId>
                    <artifactId>jackson-databind</artifactId>
                </exclusion>
                <exclusion>
                    <groupId>org.hibernate.validator</groupId>
                    <artifactId>hibernate-validator</artifactId>
                </exclusion>
            </exclusions>
        </dependency>

常用注解

注解	说明
@Null	被注释的元素必须为 null
@NotNull	被注释的元素必须不为 null
@AssertTrue	被注释的元素必须为 true
@AssertFalse	被注释的元素必须为 false
@Min(value)	被注释的元素必须是一个数字，其值必须大于等于指定的最小值
@Max(value)	被注释的元素必须是一个数字，其值必须小于等于指定的最大值
@DecimalMin(value)	被注释的元素必须是一个数字，其值必须大于等于指定的最小值
@DecimalMax(value)	被注释的元素必须是一个数字，其值必须小于等于指定的最大值
@Size(max=, min=)	被注释的元素的大小必须在指定的范围内
@Digits (integer, fraction)	被注释的元素必须是一个数字，其值必须在可接受的范围内
@Past	被注释的元素必须是一个过去的日期
@Future	被注释的元素必须是一个将来的日期
@Pattern(regex=,flag=)	被注释的元素必须符合指定的正则表达式
@NotBlank(message =)	验证字符串非null，且长度必须大于0
@Email	被注释的元素必须是电子邮箱地址
@Length(min=,max=)	被注释的字符串的大小必须在指定的范围内
@NotEmpty	被注释的字符串的必须非空
@Range(min=,max=,message=)	被注释的元素必须在合适的范围内

使用

• 在实体中对相关的属性注解。

    /**
    * 账号
    */
    @NotNull
    @Length(min = 6,max = 20)
    private String account;
    /**
    * 密码
    */
    @NotNull
    @Length(min = 6,max = 20)
    private String password;
    /**
    * 电子邮件
    */
    @Email
    private String email;

• 在需要校验的地方加上@Valid注解。
  如下，在参数请求体，即以上增加了校验注解的用户实体上加上@Valid注解，即表示需进行校验。

    @PostMapping("/")
    public String postUser(@Valid  @RequestBody SysUser user) {
        // @RequestBody注解用来绑定通过http请求中application/json类型上传的数据
        sysUserService.save(user);
        return "success";
    }

• 测试
  请求该接口，注意设定参数值使校验返回失败。

curl -X POST "http://localhost:8080/sysUser/" -H "accept: */*" -H "Content-Type: application/json" -d "{ \"account\": \"\", \"avatar\": \"string\", \"birthday\": \"2020-06-18 12:00:00\", \"deptId\": 0, \"email\": \"ds\", \"id\": 0, \"name\": \"string\", \"password\": \"string\", \"phone\": \"string\", \"roleId\": \"string\", \"salt\": \"string\", \"sex\": \"string\", \"status\": \"string\", \"version\": 0}"

{
    "code": -1,
    "msg": "失败Validation failed for argument [0] in public java.lang.String com.chan.hen.controller.SysUserController.postUser(com.chan.hen.entity.SysUser) with 2 errors: [Field error in object 'sysUser' on field 'account': rejected value []; 
    codes [Length.sysUser.account,Length.account,Length.java.lang.String,Length]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [sysUser.account,account]; arguments []; 
    default message [account],20,6]; 
    default message [长度需要在6和20之间]] [Field error in object 'sysUser' on field 'email': rejected value [ds]; codes [Email.sysUser.email,Email.email,Email.java.lang.String,Email]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [sysUser.email,email]; arguments []; default message [email],[Ljavax.validation.constraints.Pattern$Flag;@6b9041bf,.*]; 
    default message [不是一个合法的电子邮件地址]] "
}

结语

本文仅介绍了参数校验的简单使用，下一步将实现自定义校验，并结合全局异常处理对参数校验失败进行统一管理。

代码地址

https://github.com/flashyunchen/hen.git