【SpringBoot web-1】web项目数据校验

我就是我 2023-10-19 00:23 57阅读 0赞

#### web项目之数据校验 ####

*  数据校验

## 数据校验 ##

在web开发中，数据校验是非常重要的，后端程序必须通过严格的校验来确保前端传入或者数据层获取的各项参数从语义上来讲是正确的。  
JSR 是一个规范文档，指定了一整套 API，通过标注给对象属性添加约束。而Hibernate Validator 是 JSR 规范的具体实现，Hibernate Validator 提供了 JSR 规范中所有内置约束注解的实现，以及一些附加的约束注解，除此之外用户还可以自定义约束注解。  
使用 Hibernate Validator 校验数据，需要定义一个接收的数据模型，使用注解的形式描述字段校验的规则，我们以 Student 对象为例为大家演示如何使用。

首先在 WebController 添加一个保存的方法 saveStudent，参数为 Student。

@RequestMapping("/saveStudent")
    public void saveUser(@Valid Student student,BindingResult result) {
        
        System.out.println("student:" + student);
        if(result.hasErrors()) {
        
            List<ObjectError> list = result.getAllErrors();
            for (ObjectError error : list) {
        
                System.out.println(error.getCode()+ "-" + error.getDefaultMessage());
            }
        }
    }

1.  @Valid 参数前面添加 @Valid 注解，代表此对象使用了参数校验；
2.  BindingResult参数校验的结果会存储在此对象中，可以根据属性判断是否校验通过，校验不通过可以将错误信息打印出来。

接下来在 User 中给需要校验的参数添加对应的注解，对不同的属性，按照规则添加不同的校验内容。

public class Student {
        
        @NotEmpty(message="姓名不能为空")
        private String name;
        @Max(value = 100, message = "年龄不能大于100岁")
        @Min(value= 18 ,message= "必须年满18岁！" )
        private int age;
        @NotEmpty(message="密码不能为空")
        @Length(min=6,message="密码长度不能小于6位")
        private String password;
        //...
    }

其中，message=“密码不能为空”，为自定义返回的错误信息。  
使用 MockMvc 进行一个测试：

@Test
    public void saveStudents() throws Exception {
        
        mockMvc.perform(MockMvcRequestBuilders.post("/saveStudent")
                .param("name","")
                .param("age","101")
                .param("password","test")
        );
    }

结果返回：

user:name=,age=666,pass=test
    Max-年龄不能大于100岁
    Length-密码长度不能小于6位
    NotEmpty-姓名不能为空

结果显示均已经触发了校验规则，返回了错误信息，在实际使用过程中可以对错误信息进行封装，最后返回到前端进行展示。  
**常见校验：**

<table> 
 <thead> 
  <tr> 
   <th>注解</th> 
   <th>应用</th> 
   <th>检查项</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>@Length(min=, max=)</td> 
   <td>String</td> 
   <td>检查字符串长度是否符合范围</td> 
  </tr> 
  <tr> 
   <td>@Max(value=)</td> 
   <td>以 numeric 或者 string 类型来表示一个数字</td> 
   <td>检查值是否小于或等于最大值</td> 
  </tr> 
  <tr> 
   <td>@Min(value=)</td> 
   <td>以 numeric 或者 string 类型来表示一个数字</td> 
   <td>检查值是否大于或等于最小值</td> 
  </tr> 
  <tr> 
   <td>@NotNull</td> 
   <td>属性</td> 
   <td>检查值是否非空（not null）</td> 
  </tr> 
  <tr> 
   <td>@Past</td> 
   <td>date 或 calendar</td> 
   <td>检查日期是否是过去时</td> 
  </tr> 
  <tr> 
   <td>@Future</td> 
   <td>date 或 calendar</td> 
   <td>检查日期是否是将来时</td> 
  </tr> 
  <tr> 
   <td>@Pattern(regex=“regexp”, flag=)</td> 
   <td>String</td> 
   <td>检查属性是否与给定匹配标志的正则表达式相匹配</td> 
  </tr> 
  <tr> 
   <td>@Range(min=, max=)</td> 
   <td>以 numeric 或者 String 类型来表示一个数字</td> 
   <td>检查值是否在最小和最大值之间（包括临界值）</td> 
  </tr> 
  <tr> 
   <td>@Size(min=, max=)</td> 
   <td>array，collection，map</td> 
   <td>检查元素大小是否在最小和最大值之间（包括临界值）</td> 
  </tr> 
  <tr> 
   <td>@AssertFalse</td> 
   <td>属性</td> 
   <td>检查方法的演算结果是否为 false（对以代码方式而不是注解表示的约束很有用）</td> 
  </tr> 
  <tr> 
   <td>@AssertTrue</td> 
   <td>属性</td> 
   <td>检查方法的演算结果是否为 true（对以代码方式而不是注解表示的约束很有用）</td> 
  </tr> 
  <tr> 
   <td>@Valid</td> 
   <td>属性（object）</td> 
   <td>对关联对象递归进行验证。如果对象是集合或数组，就递归地验证其元素；如果对象是 Map，则递归验证其值元素</td> 
  </tr> 
  <tr> 
   <td>@Email</td> 
   <td>String</td> 
   <td>检查字符串是否符合有效的 email 地址规范</td> 
  </tr> 
 </tbody> 
</table>