欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页

Springboot使用Hibernate Validator进行注解式Java实体类校验

程序员文章站 2022-04-14 09:09:28
...

Hibernate Validator是Hibernate提供的一个开源框架,使用注解方式非常方便的实现服务端的数据校验。其官网地址是:http://hibernate.org/validator/,hibernate Validator 是 Bean Validation 的参考实现 。Hibernate Validator 提供了 JSR 303 规范中所有内置 constraint(约束) 的实现,除此之外还有一些附加的 constraint。在日常开发中,Hibernate Validator经常用来验证bean的字段,基于注解,方便快捷高效。

第一步:向你正在开发的项目导入pom依赖

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

第二步:向你在entity的部分属性上添加注解:(以下为示例)

@Data
@Table(name = "BMW_User")
public class User implements Serializable {
    private static final long serialVersionUID = 6524022019082360778L;
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    @Length(min = 3, max = 15, message = "用户名只能在3~15位之间")
    private String user_Name; 
    @JsonIgnore//此注解将属性值不做返回
    @Length(min = 8, max = 16, message = "用户密码只能在8~16位之间")
    private String Pass_Word; 
    //进行手机号的检测,编写正则表达式,可自行百度
    @Pattern(regexp = "^1[35678]\\d{9}$", message = "手机号格式不正确")
    private String phone; 
    private Date created; 
    @JsonIgnore//此注解将属性值不做返回
    private String salt; 
}

第三步:controller上进行控制
在controller中只需要判断检测的entity添加 @Valid注解即可。(以下为示例)

@PostMapping("register")
public ResponseEntity<Void> register(
         @Valid User user,//判断检测传入的信息是否合规
         @RequestParam(value="code",defaultValue = "5"(默认值),defaultValue = "false"(是否必填))
          String code){}

第四步:调用接口进行测试即可
附编辑常用注解如下所示

Constraint 详细信息
@Valid 被注释的元素是一个对象,需要检查此对象的所有字段值
@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(value) 被注释的元素必须符合指定的正则表达式
@Email 被注释的元素必须是电子邮箱地址
@Length 被注释的字符串的大小必须在指定的范围内
@NotEmpty 被注释的字符串的必须非空
@Range 被注释的元素必须在合适的范围内
@NotBlank 被注释的字符串的必须非空
@URL(protocol=,host=, port=,regexp=, flags=) 被注释的字符串必须是一个有效的url
@CreditCardNumber 被注释的字符串必须通过Luhn校验算法,银行卡,信用卡等号码一般都用Luhn计算合法性

祝君日进斗金,事业有成!