Hibernate Validator校验

最新推荐文章于 2022-01-15 21:31:47 发布
最新推荐文章于 2022-01-15 21:31:47 发布
阅读量87 收藏
点赞数
文章标签： java runtime python
原文链接：https://my.oschina.net/shadowolf/blog/1934934
版权

2019独角兽企业重金招聘Python工程师标准>>> hot3.png

1. 参数校验

  • 官网地址

  • spring-boot-starter-web包里面有hibernate-validator包，不需要引用hibernate validator依赖。

2. hibernate validator校验demo

1. 导入包
import org.hibernate.validator.constraints.NotBlank;

import javax.validation.constraints.AssertFalse;
import javax.validation.constraints.Pattern;
2. demo
@Getter
@Setter
@NoArgsConstructor
public class DemoModel {
    @NotBlank(message="用户名不能为空")
    private String userName;

    @NotBlank(message="年龄不能为空")
    @Pattern(regexp="^[0-9]{1,2}$",message="年龄不正确")
    private String age;

    @AssertFalse(message = "必须为false")
    private Boolean isFalse;
    /**
     * 如果是空，则不校验，如果不为空，则校验
     */
    @Pattern(regexp="^[0-9]{4}-[0-9]{2}-[0-9]{2}$",message="出生日期格式不正确")
    private String birthday;
}
3. 结果返回
@RequestMapping("/demo2")
public void demo2(@RequestBody @Valid DemoModel demo, BindingResult result){
    if(result.hasErrors()){
        for (ObjectError error : result.getAllErrors()) {
            System.out.println(error.getDefaultMessage());
        }
    }
}
4. 传入参数
{"userName":"dd","age":120,"isFalse":true,"birthday":"21010-21-12"}
5. 输出结果
出生日期格式不正确
必须为false
年龄不正确

3. hibernate的校验模式

1. 普通模式(默认为该模式)
  • 会校验所有属性，然后返回所有的验证失败信息。
2. 快速失败返回模式
  • 只要有一个校验失败则返回。
3. 设置方式
// failFast: true 快速失败返回模式，false 普通模式
ValidatorFactory validatorFactory = Validation.byProvider( HibernateValidator.class )
        .configure()
        .failFast( true )
        .buildValidatorFactory();
Validator validator = validatorFactory.getValidator();

// hibernate.validator.fail_fast: true 快速失败返回模式，false 普通模式
ValidatorFactory validatorFactory = Validation.byProvider( HibernateValidator.class )
        .configure()
        .addProperty( "hibernate.validator.fail_fast", "true" )
        .buildValidatorFactory();
Validator validator = validatorFactory.getValidator();

4. hibernate的校验

  • 配置hibernate Validator为快速返回模式：

    @Configuration
public class ValidatorConfiguration {
    @Bean
    public Validator validator(){
        ValidatorFactory validatorFactory = Validation.byProvider( HibernateValidator.class )
                .configure()
                .addProperty( "hibernate.validator.fail_fast", "true" )
                .buildValidatorFactory();
        Validator validator = validatorFactory.getValidator();

        return validator;
    }
}
1. 请求参数校验
  • 验证请求参数时，在 @RequestBody DemoModel demo 之间加注解 @Valid，然后在后面加 BindindResult 即可；多个参数，可以添加多个 @Valid 和 BindindResult。
public void test()(@RequestBody @Valid DemoModel demo, BindingResult result)
public void test()(@RequestBody @Valid DemoModel demo, BindingResult result,@RequestBody @Valid DemoModel demo2, BindingResult result2)

@RequestMapping("/demo2")
public void demo2(@RequestBody @Valid DemoModel demo, BindingResult result){
    if(result.hasErrors()){
        for (ObjectError error : result.getAllErrors()) {
            System.out.println(error.getDefaultMessage());
        }
    }
}
2. GET参数校验(@RequestParam参数校验)

  1. controller

    @RequestMapping(value = "/demo3", method = RequestMethod.GET)
public void demo3(@RequestParam(name = "grade", required = true) int grade,@RequestParam(name = "classroom", required = true) int classroom) {
    System.out.println(grade + "," + classroom);
}
    • 使用 @Valid 注解对 RequestParam 对应的参数时无效的，需要使用 @Validated 注解来使验证生效。

  2. MethodValidationPostProcessor 的 Bean

    @Bean
public MethodValidationPostProcessor methodValidationPostProcessor() {
    /**默认是普通模式，会返回所有的验证不通过信息集合*/
    return new MethodValidationPostProcessor();
}

  3. 或者可对 MethodValidationPostProcessor 进行设置 Validator

    • 此时不是使用 Validator 进行验证，Validator 的配置不起作用
    @Bean
public MethodValidationPostProcessor methodValidationPostProcessor() {
    MethodValidationPostProcessor postProcessor = new MethodValidationPostProcessor();
    /**设置validator模式为快速失败返回*/
    postProcessor.setValidator(validator());
    return postProcessor;
}

@Bean
public Validator validator(){
    ValidatorFactory validatorFactory = Validation.byProvider( HibernateValidator.class )
            .configure()
            .addProperty( "hibernate.validator.fail_fast", "true" )
            .buildValidatorFactory();
    Validator validator = validatorFactory.getValidator();

    return validator;
}

  4. 方法所在的Controller上加注解 @Validated

    @RequestMapping("/validation")
@RestController
@Validated
public class ValidationController {
    /**如果只有少数对象，直接把参数写到Controller层，然后在Controller层进行验证就可以了。*/
    @RequestMapping(value = "/demo3", method = RequestMethod.GET)
    public void demo3(@Range(min = 1, max = 9, message = "年级只能从1-9")
                      @RequestParam(name = "grade", required = true)
                      int grade,
                      @Min(value = 1, message = "班级最小只能1")
                      @Max(value = 99, message = "班级最大只能99")
                      @RequestParam(name = "classroom", required = true)
                      int classroom) {
        System.out.println(grade + "," + classroom);
    }
}

  5. 返回验证信息提示

    • 验证不通过，抛出来 ConstraintViolationException 异常，使用统一捕获异常处理
    @ControllerAdvice
@Component
public class GlobalExceptionHandler {

    @ExceptionHandler
    @ResponseBody
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    public String handle(ValidationException exception) {
        if(exception instanceof ConstraintViolationException){
            ConstraintViolationException exs = (ConstraintViolationException) exception;

            Set<ConstraintViolation<?>> violations = exs.getConstraintViolations();
            for (ConstraintViolation<?> item : violations) {
　　　　　　　　　　/**打印验证不通过的信息*/
                System.out.println(item.getMessage());
            }
        }
        return "bad request, " ;
    }
}

  6. 验证

    http://localhost:8080/validation/demo3?grade=18&classroom=888
3. model校验

  1. model

    @Data
public class Demo2 {
    @Length(min = 5, max = 17, message = "length长度在[5,17]之间")
    private String length;

    /**@Size不能验证Integer，适用于String, Collection, Map and arrays*/
    @Size(min = 1, max = 3, message = "size在[1,3]之间")
    private String age;

    @Range(min = 150, max = 250, message = "range在[150,250]之间")
    private int high;

    @Size(min = 3,max = 5,message = "list的Size在[3,5]")
    private List<String> list;
}

  2. 校验

    @Autowired
private Validator validator;

@RequestMapping("/demo3")
public void demo3(){
    Demo2 demo2 = new Demo2();
    demo2.setAge("111");
    demo2.setHigh(150);
    demo2.setLength("ABCDE");
    demo2.setList(new ArrayList<String>(){{add("111");add("222");add("333");}});
    Set<ConstraintViolation<Demo2>> violationSet = validator.validate(demo2);
    for (ConstraintViolation<Demo2> model : violationSet) {
        System.out.println(model.getMessage());
    }
}
4. 对象级联校验
  • 对象内部包含另一个对象作为属性，属性上加 @Valid，可以验证作为属性的对象内部的验证

  1. demo

    @Data
public class Demo2 {
    @Size(min = 3,max = 5,message = "list的Size在[3,5]")
    private List<String> list;

    @NotNull
    @Valid
    private Demo3 demo3;
}

@Data
public class Demo3 {
    @Length(min = 5, max = 17, message = "length长度在[5,17]之间")
    private String extField;
}

  2. 校验

    /**前面配置了快速失败返回的Bean*/
@Autowired
private Validator validator;

@RequestMapping("/demo3")
public void demo3(){
    Demo2 demo2 = new Demo2();
    demo2.setList(new ArrayList<String>(){{add("111");add("222");add("333");}});

    Demo3 demo3 = new Demo3();
    demo3.setExtField("22");
    demo2.setDemo3(demo3);
    Set<ConstraintViolation<Demo2>> violationSet = validator.validate(demo2);
    for (ConstraintViolation<Demo2> model : violationSet) {
        System.out.println(model.getMessage());
    }
}
5. 分组校验

  1. 校验接口

    public interface GroupA {
}

public interface GroupB {
}

  2. demo

    @Data
public class Person {
    @NotBlank
    @Range(min = 1,max = Integer.MAX_VALUE,message = "必须大于0",groups = {GroupA.class})
    /**用户id*/
    private Integer userId;
    @NotBlank
    @Length(min = 4,max = 20,message = "必须在[4,20]",groups = {GroupB.class})
    /**用户名*/
    private String userName;
    @NotBlank
    @Range(min = 0,max = 100,message = "年龄必须在[0,100]",groups={Default.class})
    /**年龄*/
    private Integer age;
    @Range(min = 0,max = 2,message = "性别必须在[0,2]",groups = {GroupB.class})
    /**性别 0：未知；1：男；2：女*/
    private Integer sex;
}
    • GroupA校验字段userId
    • GroupB校验字段userName、sex
    • Default校验字段age(Default使Validator自带的默认分组)

  3. 验证

    • 只验证GroupA和GroupB的分组，以下示例代码
    @RequestMapping("/demo5")
public void demo5(){
    Person p = new Person();
    /**GroupA验证不通过*/
    p.setUserId(-12);
    /**GroupA验证通过*/
    //p.setUserId(12);
    p.setUserName("a");
    p.setAge(110);
    p.setSex(5);
    Set<ConstraintViolation<Person>> validate = validator.validate(p, GroupA.class, GroupB.class);
    for (ConstraintViolation<Person> item : validate) {
        System.out.println(item);
    }
}

    @RequestMapping("/demo6")
public void demo6(@Validated({GroupA.class, GroupB.class}) Person p, BindingResult result){
    if(result.hasErrors()){
        List<ObjectError> allErrors = result.getAllErrors();
        for (ObjectError error : allErrors) {
            System.out.println(error);
        }
    }
}

  4. 组序列

    • 指定组的验证顺序，前面组验证不通过，后面组不验证
    // GroupA > GroupB > Default
@GroupSequence({GroupA.class, GroupB.class, Default.class})
public interface GroupOrder {
}

5. 自定义校验器

1. 大小写校验器
public enum CaseMode {
    UPPER,
    LOWER;
}


@Target( { ElementType.METHOD, ElementType.FIELD, ElementType.ANNOTATION_TYPE })
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = CheckCaseValidator.class)
@Documented
public @interface CheckCase {
    String message() default "";

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

    Class<? extends Payload>[] payload() default {};

    CaseMode value();
}


public class CheckCaseValidator implements ConstraintValidator<CheckCase, String> {
    private CaseMode caseMode;
    public void initialize(CheckCase checkCase) {
        this.caseMode = checkCase.value();
    }

    public boolean isValid(String s, ConstraintValidatorContext constraintValidatorContext) {
        if (s == null) {
            return true;
        }

        if (caseMode == CaseMode.UPPER) {
            return s.equals(s.toUpperCase());
        } else {
            return s.equals(s.toLowerCase());
        }
    }
}
2. Demo
public class Demo{
    @CheckCase(value = CaseMode.LOWER,message = "userName必须是小写")
    private String userName;

    public String getUserName() {
        return userName;
    }

    public void setUserName(String userName) {
        this.userName = userName;
    }
}
3. Validator配置
@Bean
public Validator validator(){
    ValidatorFactory validatorFactory = Validation.byProvider( HibernateValidator.class )
            .configure()
            .addProperty( "hibernate.validator.fail_fast", "true" )
            .buildValidatorFactory();
    Validator validator = validatorFactory.getValidator();

    return validator;
}
4. 校验测试
@RequestMapping("/demo4")
public void demo4(){
    Demo demo = new Demo();
    demo.setUserName("userName");
    Set<ConstraintViolation<Demo>> validate = validator.validate(demo);
    for (ConstraintViolation<Demo> dem : validate) {
        System.out.println(dem.getMessage());
    }
}

6. 常见的注解

No.注解解释
01@Null检查该字段为空
02@NotNull不能为 null
03@NotBlank不能为空，检查时会将空格忽略
04@NotEmpty不能为空，这里的空是指空字符串
05@AssertTrue用于boolwan字段，只能为true
06@AssertFalse用于boolwan字段，只能为false
07@CreditCardNumber对信用卡进行一个大致的校验
08@DecimalMin(value)数值类型，只能小于或等于value
09@DecimalMax(value)数值类型，只能大于或等于value
10@Digits(integer=2,fraction=20)限制必须为一个小数，整数部分位数不能超过integer，小数部分位数不能超过fraction
11@Email检查是否是一个有效的email地址
12@Past检查该字段的日期是否属于过去的日期
13@Future检查该字段的日期是否属于将来的日期
14@Length(min=,max=)检查该字段的长度是否在min和max之间，只能用于字符串
15@Size(min=,max=)检查该字段的size是否在min和max之间，可以是字符串、数组、集合、map等
16@Min(value)小于等于value
17@Max(value)大于等于value
18@URL(protocol=,host,port) 检查是否是一个有效的URL，如果提供来protocol，host等，则该url还需满足提供的条件
19@Valid该注解只要用于字段为一个包含其他对象的集合或map或数组的字段，或该字段直接为一个其他对象的引用(这样在检查当前对象的同时也会检查该字段所引用的对象)

7. 参考文档

参考文档

转载于:https://my.oschina.net/shadowolf/blog/1934934

weixin_34302561
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Hibernate-validator校验框架
牛奋lch
07-27 3万+
该验证框架是在Hibernate-validator的基础上进行封装而成，方便后台的接口验证
SpringBoot使用Hibernate Validator校验参数
Phycholee
07-13 3237
Hibernate Validator后端开发中，常常需要对入参进行非空、非法格式校验，以确保数据的安全性和准确性。一般会在Controller层进行校验，此类代码臃肿且规律，在参数多的情况下简直是灾难，严重影响代码的整洁度。如下代码所示：@PostMapping("") public JsonData save(Activity activity){ if (StringUtils.is...
springboot使用hibernate validator校验
架构师的成长之路的博客
03-01 2575
springboot使用hibernate validator校验一、参数校验在开发中经常需要写一些字段校验的代码，比如字段非空，字段长度限制，邮箱格式验证等等，写这些与业务逻辑关系不大的代码个人感觉有两个麻烦验证代码繁琐，重复劳动方法内代码显得冗长每次要看哪些参数验证是否完整，需要去翻阅验证逻辑代码hibernate validator（官方文档）提供了一套比较完善、便捷的验证实现方式。spri...
Java——》Hibernate Validator 参数验证
小仙~
05-24 371
参考： 总结——》【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.
开发服务端校验组件——validator
m0_52322439的博客
07-28 510
hibernate-validator介绍 早期的网站，用户输入一个邮箱地址，需要将邮箱地址发送到服务端，服务端进行校验，校验成功后，给前端一个响应。 有了JavaScript后，校验工作可以放在前端去执行。那么为什么还需要服务端校验呢？ 因为前端传来的数据不可信。前端很容易获取到后端的接口，如果有人直接调用接口，就可能会出现非法数据，所以服务端也要数据校验。 总的来说： 前端校验：主要是提高用户体验 后端校验：主要是保证数据安全可靠 校验参数基本上是一个体力活，而且冗余代码繁多，
SpringBoot 使用hibernate validator校验
08-26
SpringBoot 使用 Hibernate Validator 校验 Hibernate Validator 是 Java 中的一个验证框架，提供了许多有用的 注解来验证对象的属性。SpringBoot 项目中可以使用 Hibernate Validator 来实现数据验证。本文将详细...
springboot使用hibernate validator校验方式
08-28
ValidatorFactory validatorFactory = Validation.byProvider( HibernateValidator.class ) .configure() .failFast( true ) .buildValidatorFactory(); Validator validator = validatorFactory.getValidator()...
hibernate validator 校验器
09-28
挺不错的Web开发权威指南,原版的Web开发权威指南还是蛮不错的一本书! 推荐大家可以看下
Hibernate Validator校验框架
12-10
Hibernate Validator 提供了一种标准的方式来校验对象的属性，使得在不同层之间可以共享验证逻辑，减少了代码重复，提高了代码质量。 1.1 背景 在软件开发中，数据验证是一个至关重要的环节，它确保了数据的准确性...
Hibernate Validator校验参数疑点难点方法详解.docx
07-02
总之，通过使用Hibernate Validator，我们可以轻松地在Java应用中实现强大的数据校验功能，提高代码的健壮性和用户体验。同时，由于其注解驱动的特性，使得代码更易于理解和维护。结合Spring Boot，开发者可以快速地...
hibernate validation
pope9995的专栏
04-10 1112
控制hibernate validation校验顺序 public class UserVo { /** * 单体查询校验分组 */ @GroupSequence({Default.class, Extended.class}) public interface QueryValidatorGroup { public interface Default { } public interface Ext
SpringBoot整合Hibernate Validator实现参数校验功能
mqfdyx的博客
10-11 442
开发eclipse Findbugs扩展插件前置条件新的改变功能快捷键合理的创建标题，有助于目录的生成如何改变文本的样式插入链接与图片如何插入一段漂亮的代码片生成一个适合你的列表创建一个表格设定内容居中、居左、居右SmartyPants创建一个自定义列表如何创建一个注脚注释也是必不可少的KaTeX数学公式新的甘特图功能，丰富你的文章UML 图表FLowchart流程图导出与导入导出导入 前置条件 新的改变 我们对Markdown编辑器进行了一些功能拓展与语法支持，除了标准的Markdown编辑器功能，我们增
java hibernate 校验_Hibernate Validator校验
weixin_33603105的博客
03-02 998
1. 参数校验spring-boot-starter-web包里面有hibernate-validator包，不需要引用hibernate validator依赖。2. hibernate validator校验demo1. 导入包import org.hibernate.validator.constraints.NotBlank;import javax.validation.constrai...
Springboot2.x中的hibernate-validator（1）GET请求
weixin_36142042的博客
03-18 835
1、自动配置 springboot中早已默认集成hibernate-validator，首先看下自动配置是如何配置validator的。 ValidationAutoConfiguration @Configuration( proxyBeanMethods = false ) @ConditionalOnClass({ExecutableValidator.class}) @Condit...
Hibernate Validation校验注解详解
不清不慎的博客
04-10 5319
在前后端传递数据的时候，往往后端需要校验传递数据的格式，比如用户名的格式，密码是否为空。我们可以在service层编写代码判断，但是当我们在多处需要校验传递来的数据的时候，就会出现大量重复的代码，一旦出错，就需要多处修改，非常麻烦，而且这样我们的软件将会非常槽糕。这时，我们可以用Hibernate Validation的注解来进行校验，十分的方便简洁，Hibernate Validation是Sp...
spring boot 使用 hibernate validator验证框架
隔壁阿源的博客
11-09 319
之前写小项目时，遇到前后端交互数据，每次都要对每个字段进行格式验证，而且验证的步骤和代码大都是千篇一律。今天接触到了hibernate validator验证框架，今后就能摆脱这种烦人的情况了。 hibernate validator的依赖在spring-boot-starter-web中，所以无需另外引入依赖。 类属性验证示例代码 public class DemoModel { @N...
Hibernate-Validator的学习
qq_461491877的博客
01-15 3953
hibernate-validator的学习 1.hibernate-validator介绍 早期的网站，用户输入一个邮箱地址，需要将邮箱地址发送到服务端，服务端进行校验，校验成功后，给前端一个响应。 有了JavaScript后，校验工作可以放在前端去执行。那么为什么还需要服务端校验呢？ 因为前端传来的数据不可信。前端很容易获取到后端的接口，如果有人直接调用接口，就可能会出现非法数据，所以服务端也要数据校验。 总的来说： 前端校验：主要是提高用户体验 后端校验：主要是保证数据安全可靠 校验参数基本上
hibernate-validator校验
最新发布
09-23
同时，Hibernate Validator还支持自定义校验注释，可以根据业务需求来定义新的注释，并实现相应的校验逻辑。 Hibernate Validator不仅可以对单个属性进行校验，还支持对整个JavaBean进行校验。例如，可以在JavaBean...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值