HibernateValidator学习笔记

最新推荐文章于 2024-08-05 08:51:23 发布
最新推荐文章于 2024-08-05 08:51:23 发布
阅读量628 收藏
点赞数
分类专栏： FrameTool 文章标签： Hibernate Validator
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/SIMBA1949/article/details/108612074
版权

HibernateValidator学习笔记

前言

版本说明

hibernate-validator=6.1.5.Final

相关链接：

  • HibernateValidator 官网：http://hibernate.org/validator/
  • HibernateValidator 官方文档：http://hibernate.org/validator/documentation/getting-started/
  • HibernateValidator maven 地址：https://mvnrepository.com/artifact/org.hibernate.validator/hibernate-validator

常用注解

注解中有个共同的属性 message，可以自定义错误信息

注解说明
@NotNull值不能为空
@Null值必须为空
@Pattern(regex=)字符串必须匹配正则表达式
@Size(min=, max=)集合元素的数量必须在min和max之间
@Email字符串必须是Email地址
@Length(min=,max=)检查字符串的长度
@NotBlank检查字符串不为null，并且长度大于0。
@Range(min=,max=)数字必须大于等于min，小于等于max
@SafeHtml字符串是安全的html
@URL字符串是合法的URL
@AssertFalse值必须是false；支持的数据类型：Boolean，boolean
@AssertTrue值必须是true；支持的数据类型：Boolean，boolean
@DecimalMax(value=, inclusive=)值必须小于等于(inclusive=true)/小于(inclusive=false) value 属性指定的值；
支持的数据类型：BigDecimal，BigInteger，CharSequence，byte，short，int，long和原始类型的相应的包装；
@DecimalMin(value=, inclusive=)值必须大于等于(inclusive=true)/大于(inclusive=false) value 属性指定的值；
支持的数据类型：BigDecimal，BigInteger，CharSequence，byte，short，int，long和原始类型的相应的包装；
@Digits(integer=, fraction=)数字格式检查，integer指定整数部分的最大长度，fraction指定小数部分的最大长度
支持的数据类型：``BigDecimal，BigInteger，CharSequence，byte，short，int，long`和原始类型的相应的包装；
@Future值必须是未来的日期
@FutureOrPresent检查日期是现在还是将来
@Past值必须是过去的日期
@PastOrPresent检查带注释的日期是过去还是现在
@Max(value=)值必须小于等于value指定的值。
@Min(value=)值必须大于等于value指定的值
@Negative检查元素是否严格为负。零值被视为无效。
支持的数据类型：BigDecimal，BigInteger，byte，short，int，long和原始类型的相应的包装
@NegativeOrZero检查元素是负数或者零。
@Positive检查元素是否严格为正。零值被视为无效。
@PositiveOrZero检查元素是正数还是零。

核心pom依赖

<!-- https://mvnrepository.com/artifact/org.hibernate.validator/hibernate-validator -->
<dependency>
    <groupId>org.hibernate.validator</groupId>
    <artifactId>hibernate-validator</artifactId>
    <version>6.1.5.Final</version>
</dependency>
<!-- https://mvnrepository.com/artifact/org.glassfish/jakarta.el -->
<dependency>
    <groupId>org.glassfish</groupId>
    <artifactId>jakarta.el</artifactId>
    <version>3.0.3</version>
</dependency>
<!-- https://mvnrepository.com/artifact/javax.el/javax.el-api -->
<dependency>
    <groupId>javax.el</groupId>
    <artifactId>javax.el-api</artifactId>
    <version>3.0.0</version>
</dependency>

校验 SpringMVC 入参校验

  1. 在实体类字段添加校验注解
  2. 在controller层添加@Valid 注解使之生效
package top.simba1949.controller;

import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import top.simba1949.common.Person;

import javax.validation.Valid;

/**
 * @Author Theodore
 * @Date 2019/12/2 17:50
 */
@Slf4j
@RestController
@RequestMapping("person")
public class PersonController {
    /**
     * 添加注解 @Valid，才能使实体类Person的校验注解生效
     * @param person
     * @return
     */
    @PostMapping
    public String insert(@Valid @RequestBody Person person){
        log.debug("person is {}", person);
        return "SUCCESS";
    }
}

校验非 SpringMVC 入参校验

pom.xml 依赖

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>top.simba1949</groupId>
    <artifactId>hibernate-validator-learn</artifactId>
    <version>1.0-SNAPSHOT</version>

    <dependencies>
        <!-- https://mvnrepository.com/artifact/org.hibernate.validator/hibernate-validator -->
        <dependency>
            <groupId>org.hibernate.validator</groupId>
            <artifactId>hibernate-validator</artifactId>
            <version>6.1.5.Final</version>
        </dependency>
        <!-- https://mvnrepository.com/artifact/org.glassfish/jakarta.el -->
        <dependency>
            <groupId>org.glassfish</groupId>
            <artifactId>jakarta.el</artifactId>
            <version>3.0.3</version>
        </dependency>
        <!-- https://mvnrepository.com/artifact/javax.el/javax.el-api -->
        <dependency>
            <groupId>javax.el</groupId>
            <artifactId>javax.el-api</artifactId>
            <version>3.0.0</version>
        </dependency>
        <!-- https://mvnrepository.com/artifact/org.projectlombok/lombok -->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.12</version>
            <scope>provided</scope>
        </dependency>
        <!-- https://mvnrepository.com/artifact/com.google.guava/guava -->
        <dependency>
            <groupId>com.google.guava</groupId>
            <artifactId>guava</artifactId>
            <version>29.0-jre</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <!--https://mvnrepository.com/artifact/org.apache.maven.plugins/maven-compiler-plugin-->
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.8.1</version>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                    <encoding>UTF-8</encoding>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

参数校验

User.java
package top.simba1949.model;

import lombok.Data;

import javax.validation.constraints.NotNull;
import javax.validation.constraints.Size;

/**
 * @author Anthony
 * @date 2020/9/15 20:04
 */
@Data
public class User {
    @NotNull(message = "id不能为空")
    private Integer id;
    @Size(min = 2, max = 8, message = "用户名必须在2~8个字符区间内")
    @NotNull(message = "用户名必须不能为空")
    private String username;
}
参数校验测试
package top.simba1949;

import top.simba1949.model.User;

import javax.validation.ConstraintViolation;
import javax.validation.Validation;
import javax.validation.Validator;
import javax.validation.ValidatorFactory;
import java.util.Set;

/**
 * @author Anthony
 * @date 2020/9/15 19:22
 */
public class Application {
    public static void main(String[] args) {
        User user = new User();
        user.setId(1);
        user.setUsername("123456789");
        // Validator从中检索对象ValidatorFactory。
        // 一个Validator 实例是线程安全的，可重复使用多次。
        // 因此，它可以安全地存储在静态字段中，并在测试方法中用于验证不同的实例。
        ValidatorFactory factory = Validation.buildDefaultValidatorFactory();
        Validator validator = factory.getValidator();
        Set<ConstraintViolation<User>> violationSet = validator.validate(user);

        if (!violationSet.isEmpty()){
            throw new RuntimeException(violationSet.iterator().next().getMessage());
        }
    }
}

分组校验

定义分组接口
package top.simba1949.model;

/**
 * @author Anthony
 * @date 2020/9/15 22:41
 */
public interface RoleInsert {
}

package top.simba1949.model;

/**
 * @author Anthony
 * @date 2020/9/15 22:41
 */
public interface RoleUpdate {
}
Role
package top.simba1949.model;

import lombok.Data;

import javax.validation.constraints.NotNull;
import java.time.LocalDateTime;

/**
 * @author Anthony
 * @date 2020/9/15 22:34
 */
@Data
public class Role {
    /**
     *  groups 定义分组
     */
    @NotNull(message = "id不能为空", groups = {RoleUpdate.class})
    private Integer id;
    @NotNull(message = "roleName不能为空", groups = {RoleInsert.class, RoleUpdate.class})
    private String roleName;
    @NotNull(message = "gmtCreate不能为空", groups = {RoleInsert.class})
    private LocalDateTime gmtCreate;
    @NotNull(message = "gmtModify不能为空", groups = {RoleUpdate.class})
    private LocalDateTime gmtModify;
}
参数校验测试
package top.simba1949;

import top.simba1949.model.*;

import javax.validation.ConstraintViolation;
import javax.validation.Validation;
import javax.validation.Validator;
import javax.validation.ValidatorFactory;
import java.time.LocalDateTime;
import java.util.Set;

/**
 * @author Anthony
 * @date 2020/9/15 19:22
 */
public class Application {
    public static void main(String[] args) {
        Role role = new Role();
        role.setId(1);
        role.setGmtModify(LocalDateTime.now());
        ValidatorFactory factory = Validation.buildDefaultValidatorFactory();
        Validator validator = factory.getValidator();
        // 分组校验
        Set<ConstraintViolation<Role>> violationSet = validator.validate(role, RoleUpdate.class);
        if (!violationSet.isEmpty()){
            throw new RuntimeException(violationSet.iterator().next().getMessage());
        }
    }
}

自定义约束校验

要创建自定义约束，需要执行以下三个步骤：

  1. 自定义注解并指定校验逻辑类
  2. 自定义校验逻辑类，实现 ConstraintValidator<A extends Annotation, T> 接口，填写具体的校验逻辑
  3. 和 HibernateValidator 原生注解一样使用即可
自定义注解并指定校验逻辑类
package top.simba1949;

import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * @author Anthony
 * @date 2020/9/15 22:54
 */
@Target(value = {ElementType.FIELD, ElementType.METHOD})
@Retention(value = RetentionPolicy.RUNTIME)
@Constraint(validatedBy = EmailConstraintValidator.class)
public @interface EmailValidation {
    // message()、groups()、payload() 必须存在

    String message() default "";

    Class<?>[] groups() default { };

    Class<? extends Payload>[] payload() default { };
}
自定义校验逻辑类
package top.simba1949;

import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;

/**
 * @author Anthony
 * @date 2020/9/15 22:55
 */
public class EmailConstraintValidator implements ConstraintValidator<EmailValidation, String> {
    /**
     * 初始化
     * @param constraintAnnotation
     */
    @Override
    public void initialize(EmailValidation constraintAnnotation) {
        System.out.println("init");
    }

    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        if (null == value || value.length() == 0){
            return false;
        }
        final String emailFormat = "\\w[-\\w.+]*@([A-Za-z0-9][-A-Za-z0-9]+\\.)+[A-Za-z]{2,14}";
        return value.matches(emailFormat);
    }
}
参数校验测试
package top.simba1949;

import top.simba1949.model.User;

import javax.validation.ConstraintViolation;
import javax.validation.Validation;
import java.util.Set;

/**
 * @author Anthony
 * @date 2020/9/15 19:22
 */
public class Application {
    public static void main(String[] args) {
        User user = new User();
        user.setId(1);
        user.setUsername("username");
        Set<ConstraintViolation<User>> violationSet = Validation.buildDefaultValidatorFactory().getValidator().validate(user);
        if (!violationSet.isEmpty()){
            throw new RuntimeException(violationSet.iterator().next().getMessage());
        }
    }
}
Simba1949
关注
专栏目录
Hibernate学习笔记 Hibernate Validator简介
乐百川
01-10 1万+
Hibernate项目中不仅有ORM一个框架，这里介绍的是它的另一个框架Validator，用来验证实体类是否满足需求。Validator实现了Java的一项标准Bean Validation。如果使用Maven，就需要在pom.xml中添加如下一段，Hibernate需要Java EL表达式，因此需要添加EL的依赖项。<dependency> <groupId>org.hibernate</
Hibernate-Validator
weixin_47872568的博客
01-12 530
Hibernate-Validator注解学习笔记
hibernate-Validator
03-28
hibernate必须JAR包(文件)下载 自己在网上找了好长时间,浪费自己好长时间,为了让更多想学hibernate的同学能够更快的找到jar包，我这里就和大家共享一下吧。 我们一起来学习hibernate吧 antlr-2.7.6.jar commons-collections-3.1.jar dom4j-1.6.1.jar hibernate3.jar
Hibernate Validator学习
liyuandong的博客
01-13 122
Hibernate Validator学习   在本章中,会详细的介绍如何使用Hibernate Validator 来对一个给定的实体模型进行验证.提要如下： 1.1. 定义约束 1.1.1. 字段级(field level) 约束 1.1.2. 属性级别约束 1.1.3. 类级别约束 1.1.4. 约束继承 1.1.5. 对象图 1.2. 校验约束 1.2.1. 获取一个Val...
Hibernate Validator 数据校验框架
最新发布
从基础到源码解析的学习记录
08-05 2336
JSR：Java Specification Requests的缩写，意思是Java规范提案是指向JCP(Java Community Process) 提出新增一个标准化技术规范的正式请求任何人都可以提交JSR，以向Java平台增添新的API和服务JSR已成为Java界的一个重要标准就是这个JSR规范之一Bean Validation是一个运行时的数据验证框架的标准JSR303是专家组成员向JCP提交的第1版Bean Validation，即针对bean数据校验提出的一个规范，
Hibernate-Validator(数据校验框架)
weixin_49866355的博客
11-22 4094
hibernate-validator是Hibernate项目中的一个数据校验框架
Hibernate字段验证的使用 @Valid
qq_36990033的博客
04-03 761
Hibernate字段验证的使用 @Valid wab开发前端传递过来的字段都需要进行校验，有时候一个bean下的属性太多，使用if挨个判断非常麻烦。hibernate有一个注解可以帮我们完成这个校验 一 、进行验证 首先在controller下接受参数的地方加入注解@Valid，和验证后接受信息的类BindingResult @PostMapping("/update") public IMOO...
Hibernate Validator
weixin_43163359的博客
08-19 238
Hibernate Validator介绍bean校验的注解常用注解demo 介绍 Hibernate Validator 是 Hibernate 提供的一个开源框架,使用注解方式非常方便的实现服务端的数据校验 官网 hibernate Validator 是 Bean Validation 的参考实现 。 Hibernate Validator 提供了 JSR 303 规范中所有内置 const...
Hibernate学习笔记
Bazinga的博客
08-23 2442
目录 目录 1. 学习网址 2. 简介 2.1. ORM 2.2. 创始人 2.3. 用途 2.4. 优缺点 3. 对象关系映射 3.1. 对象-关系映射模式 3.2. 常用的O/R映射框架 4. 基础配置 4.1. 依赖包配置（Maven） 4.2. 日志环境 4.3. JUnit环境 5. Annotation 5.1. 实体类-表 映射 5.2. 属性-字段 映...
J2EE系列之Hibernate4学习笔记（十八）--hibernate高级配置（配置日志框架log4j）
feidie436的专栏
05-25 702
hibernate自带的是简单的日志框架。我们这里要引入一个功能强大的日志框架log4j。百度百科关于log4j的介绍非常好，一下的大部分内容拷贝百度百科。 一、log4j简介（百度百科） Log4j是Apache的一个开源项目，通过使用Log4j，我们可以控制日志信息输送的目的地是控制台、文件、GUI组件，甚至是套接口服务器、NT的事件记录器、UNIX Syslog守护进程等；我们也可以控制
springmvc学习笔记.zip
08-10
这个“springmvc学习笔记.zip”文件很可能包含了关于如何理解和使用SpringMVC的详细教程或个人学习记录。以下是一些核心知识点的详细说明： 1. **MVC架构**：MVC是一种设计模式，将应用程序分为三个主要组件：模型...
hibernate-validator-5.1.0.zip
04-20
JSR303 hibernate-validator-5.1.0.zip 进行数据格式；数据校验
hibernate_validator_官方文档中文&英文版
06-03
直接从这里下稍慢点：http://docs.jboss.org/hibernate/validator/4.2/reference/zh-CN
JAVA中通过Hibernate-Validation进行参数验证
chepi7680的博客
07-29 203
在开发JAVA服务器端代码时，我们会遇到对外部传来的参数合法性进行验证，而hibernate-validator提供了一些常用的参数校验注解，我们可以拿来使用。 1.maven中引入hibernate-validator对应的jar： <dependency> <gr...
Hibernate Validator笔记
鱼获飞的博客
01-25 375
Hibernate Validator是Hibernate提供的一个开源框架，使用注解方式非常方便的实现服务端的数据校验。 hibernate Validator 是 Bean Validation 的参考实现 。 Hibernate Validator 提供了 JSR 303 规范中所有内置 constraint（约束） 的实现，除此之外还有一些附加的 constraint。 在日常开发中，Hi...
后端校验（hibernate-validator）
m0_54189068的博客
01-28 1599
hibernate-validator 是 Java 中常用的后端校验框架
Java——》Hibernate Validator 参数验证
小仙~
05-24 414
参考： 总结——》【Java】 场景：使用Hibernate Validator 进行参数验证。 Hibernate Validator有2种验证模式： 普通模式 快速失败返回模式，failFast：true import com.eju.houseparent.common.model.BusinessException; import lombok.Data; import lombok.experimental.Accessors; import org.hibernate.valida.
Hibernate-Validator的使用（一）
特别享受思考问题的过程
12-25 2137
key用{}括起来}这里定义两个文件ValidationMessages_zh_CN.properties和ValidationMessages_en_US.properties来做测试。二者均放在resource目录下ValidationMessages_en_US.properties的内容userName.invalid= userName ${validatedValue} is invalid。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

Simba1949

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值