hibernate-validate数据校验

ゝ一纸荒年。 2022-12-05 12:12 216阅读 0赞

## hibernate-validate ##

刚才虽然实现了注册，但是服务端并没有进行数据校验，而前端的校验是很容易被有心人绕过的。所以我们必须在后台添加数据校验功能：

我们这里会使用Hibernate-Validator框架完成数据校验：

而SpringBoot的web启动器中已经集成了相关依赖：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTQ3NDg1MDQ_size_16_color_FFFFFF_t_70][]

### 6.5.1.什么是Hibernate Validator ###

Hibernate Validator是Hibernate提供的一个开源框架，使用注解方式非常方便的实现服务端的数据校验。

官网：[http://hibernate.org/validator/][http_hibernate.org_validator]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTQ3NDg1MDQ_size_16_color_FFFFFF_t_70 1][]

**hibernate Validator** 是 Bean Validation 的参考实现 。

Hibernate Validator 提供了 JSR 303 规范中所有内置 constraint（约束） 的实现，除此之外还有一些附加的 constraint。

在日常开发中，Hibernate Validator经常用来验证bean的字段，基于注解，方便快捷高效。

### 6.5.2.Bean校验的注解 ###

常用注解如下：

<table> 
 <thead> 
 <tr> 
 <th>Constraint</th> 
 <th>详细信息</th> 
 </tr> 
 </thead> 
 <tbody> 
 <tr> 
 <td>@Valid</td> 
 <td>被注释的元素是一个对象，需要检查此对象的所有字段值</td> 
 </tr> 
 <tr> 
 <td>@Null</td> 
 <td>被注释的元素必须为 null</td> 
 </tr> 
 <tr> 
 <td>@NotNull</td> 
 <td>被注释的元素必须不为 null</td> 
 </tr> 
 <tr> 
 <td>@AssertTrue</td> 
 <td>被注释的元素必须为 true</td> 
 </tr> 
 <tr> 
 <td>@AssertFalse</td> 
 <td>被注释的元素必须为 false</td> 
 </tr> 
 <tr> 
 <td>@Min(value)</td> 
 <td>被注释的元素必须是一个数字，其值必须大于等于指定的最小值</td> 
 </tr> 
 <tr> 
 <td>@Max(value)</td> 
 <td>被注释的元素必须是一个数字，其值必须小于等于指定的最大值</td> 
 </tr> 
 <tr> 
 <td>@DecimalMin(value)</td> 
 <td>被注释的元素必须是一个数字，其值必须大于等于指定的最小值</td> 
 </tr> 
 <tr> 
 <td>@DecimalMax(value)</td> 
 <td>被注释的元素必须是一个数字，其值必须小于等于指定的最大值</td> 
 </tr> 
 <tr> 
 <td>@Size(max, min)</td> 
 <td>被注释的元素的大小必须在指定的范围内</td> 
 </tr> 
 <tr> 
 <td>@Digits (integer, fraction)</td> 
 <td>被注释的元素必须是一个数字，其值必须在可接受的范围内</td> 
 </tr> 
 <tr> 
 <td>@Past</td> 
 <td>被注释的元素必须是一个过去的日期</td> 
 </tr> 
 <tr> 
 <td>@Future</td> 
 <td>被注释的元素必须是一个将来的日期</td> 
 </tr> 
 <tr> 
 <td>@Pattern(value)</td> 
 <td>被注释的元素必须符合指定的正则表达式</td> 
 </tr> 
 <tr> 
 <td>@Email</td> 
 <td>被注释的元素必须是电子邮箱地址</td> 
 </tr> 
 <tr> 
 <td>@Length</td> 
 <td>被注释的字符串的大小必须在指定的范围内</td> 
 </tr> 
 <tr> 
 <td>@NotEmpty</td> 
 <td>被注释的字符串的必须非空</td> 
 </tr> 
 <tr> 
 <td>@Range</td> 
 <td>被注释的元素必须在合适的范围内</td> 
 </tr> 
 <tr> 
 <td>@NotBlank</td> 
 <td>被注释的字符串的必须非空</td> 
 </tr> 
 <tr> 
 <td>@URL(protocol=,host=, port=,regexp=, flags=)</td> 
 <td>被注释的字符串必须是一个有效的url</td> 
 </tr> 
 <tr> 
 <td>@CreditCardNumber</td> 
 <td>被注释的字符串必须通过Luhn校验算法，银行卡，信用卡等号码一般都用Luhn计算合法性</td> 
 </tr> 
 </tbody> 
</table>

### 6.5.3.给User添加校验 ###

我们在`leyou-user-interface`中添加Hibernate-Validator依赖：

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

我们在User对象的部分属性上添加注解：

@Table(name = "tb_user")
    public class User {
        @Id
        @GeneratedValue(strategy = GenerationType.IDENTITY)
        private Long id;
        @Length(min = 4, max = 30, message = "用户名只能在4~30位之间")
        private String username;// 用户名
    
        @JsonIgnore
        @Length(min = 4, max = 30, message = "密码只能在4~30位之间")
        private String password;// 密码
    
        @Pattern(regexp = "^1[35678]\\d{9}$", message = "手机号格式不正确")
        private String phone;// 电话
    
        private Date created;// 创建时间
    
        @JsonIgnore
        private String salt;// 密码的盐值
    }

### 6.5.4.在controller上进行控制 ###

在controller中改造register方法，只需要给User添加 @Valid注解即可。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTQ3NDg1MDQ_size_16_color_FFFFFF_t_70 2][]

### 6.5.5.测试 ###

我们故意填错：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTQ3NDg1MDQ_size_16_color_FFFFFF_t_70 3][]

然后SpringMVC会自动返回错误信息：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTQ3NDg1MDQ_size_16_color_FFFFFF_t_70 4][]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTQ3NDg1MDQ_size_16_color_FFFFFF_t_70]: /images/20221123/5f303cbe69da44188389df00b7fa711b.png
[http_hibernate.org_validator]: http://hibernate.org/validator/
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTQ3NDg1MDQ_size_16_color_FFFFFF_t_70 1]: /images/20221123/b427a2c1d31c4df392d0489c83bca88a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTQ3NDg1MDQ_size_16_color_FFFFFF_t_70 2]: /images/20221123/016bb59baae64aa794a155f531965945.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTQ3NDg1MDQ_size_16_color_FFFFFF_t_70 3]: /images/20221123/cdd35ab1293b465c86f3ccbf681f7c5d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTQ3NDg1MDQ_size_16_color_FFFFFF_t_70 4]: /images/20221123/677beba47f1342daa625bc4c68b4af60.png