当前位置:

首页 > 编程开发 > Spring Boot整合Hibernate验证器指南

Spring Boot整合Hibernate验证器指南

SpringBoot整合Hibernate验证器通过添加依赖、定义校验规则、在Controller中使用@Valid注解、可选全局异常处理、自定义注解、分组校验、嵌套对象校验、错误信息国际化、快速失败模式配置等步骤实现数据校验。1.添加spring-boot-starter-validation依赖;2.在实体类或DTO中使用@NotBlank、@Size等注解定义规则;3.Controller中用@Valid触发校验并用BindingResult获取结果;4.可创建全局异常处理器捕获MethodArgu

Spring Boot整合Hibernate验证器通过添加依赖、定义校验规则、在Controller中使用@Valid注解、可选全局异常处理、自定义注解、分组校验、嵌套对象校验、错误信息国际化、快速失败模式配置等步骤实现数据校验。1. 添加spring-boot-starter-validation依赖;2. 在实体类或DTO中使用@NotBlank、@Size等注解定义规则;3. Controller中用@Valid触发校验并用BindingResult获取结果;4. 可创建全局异常处理器捕获MethodArgumentNotValidException;5. 自定义注解需创建注解和校验器类并实现ConstraintValidator接口;6. 分组校验通过定义分组接口并在注解中指定groups属性;7. 嵌套对象需在属性上加@Valid启用校验;8. 国际化通过ValidationMessages.properties文件配置;9. 快速失败模式通过配置ValidatorFactory的failFast(true)实现;常见问题包括EL依赖缺失、注解未生效、自定义注解无法注入Bean等,需分别添加依赖、检查注解使用、注册校验器为Bean等方式解决。

Spring Boot整合Hibernate验证器教程

Spring Boot整合Hibernate验证器,主要是为了在你的应用中实现更方便、更强大的数据校验。它利用了Hibernate Validator,这是一个Bean Validation(JSR 380)的参考实现,可以让你通过注解的方式,轻松地对Java Bean的属性进行各种约束校验。

Spring Boot整合Hibernate验证器教程

解决方案:

  1. 添加依赖: 首先,需要在你的pom.xml文件中加入相应的依赖。Spring Boot通常会自动包含spring-boot-starter-validation,但如果没包含,手动添加一下:

    Spring Boot整合Hibernate验证器教程
    
        org.springframework.boot
        spring-boot-starter-validation
    

    如果你的项目没有使用Spring Boot,你需要手动添加Hibernate Validator和Bean Validation API的依赖。

  2. 定义校验规则: 在你的实体类(Entity)或者DTO(Data Transfer Object)的属性上,使用注解来定义校验规则。例如:

    Spring Boot整合Hibernate验证器教程
    import javax.validation.constraints.NotBlank;
    import javax.validation.constraints.Size;
    
    public class User {
    
        @NotBlank(message = "用户名不能为空")
        @Size(min = 3, max = 20, message = "用户名长度必须在3到20之间")
        private String username;
    
        @NotBlank(message = "密码不能为空")
        private String password;
    
        // Getters and setters
    }

    这里使用了@NotBlank@Size注解,分别表示该属性不能为空,且长度必须在3到20之间。message属性可以自定义错误提示信息。

  3. 在Controller中使用: 在你的Controller中,使用@Valid注解来触发校验。同时,需要使用BindingResult来获取校验结果。

    import org.springframework.validation.BindingResult;
    import org.springframework.web.bind.annotation.PostMapping;
    import org.springframework.web.bind.annotation.RequestBody;
    import org.springframework.web.bind.annotation.RestController;
    
    import javax.validation.Valid;
    
    @RestController
    public class UserController {
    
        @PostMapping("/users")
        public String createUser(@Valid @RequestBody User user, BindingResult result) {
            if (result.hasErrors()) {
                // 处理校验失败的情况
                return "校验失败:" + result.getAllErrors().get(0).getDefaultMessage(); // 简化处理,只返回第一个错误信息
            }
    
            // 处理创建用户的逻辑
            return "用户创建成功";
        }
    }

    @Valid注解告诉Spring MVC要对User对象进行校验。BindingResult对象包含了校验的结果,可以通过hasErrors()方法判断是否有错误,并通过getAllErrors()方法获取所有的错误信息。

  4. 全局异常处理(可选): 为了更优雅地处理校验失败的情况,可以配置全局异常处理。创建一个全局异常处理器,捕获MethodArgumentNotValidException异常,该异常会在@Valid校验失败时抛出。

    import org.springframework.http.HttpStatus;
    import org.springframework.http.ResponseEntity;
    import org.springframework.web.bind.MethodArgumentNotValidException;
    import org.springframework.web.bind.annotation.ControllerAdvice;
    import org.springframework.web.bind.annotation.ExceptionHandler;
    
    import java.util.HashMap;
    import java.util.Map;
    
    @ControllerAdvice
    public class GlobalExceptionHandler {
    
        @ExceptionHandler(MethodArgumentNotValidException.class)
        public ResponseEntity handleValidationExceptions(MethodArgumentNotValidException ex) {
            Map errors = new HashMap<>();
            ex.getBindingResult().getFieldErrors().forEach(error -> {
                errors.put(error.getField(), error.getDefaultMessage());
            });
            return new ResponseEntity<>(errors, HttpStatus.BAD_REQUEST);
        }
    }

    这样,当校验失败时,会返回一个包含所有错误信息的JSON响应,方便前端处理。

    如何自定义Hibernate Validator的校验注解?

    自定义校验注解是Hibernate Validator的强大之处。有时候内置的注解无法满足需求,比如需要校验身份证号码的格式,或者校验某个字段是否在指定的枚举值范围内。

    1. 创建注解: 首先,需要创建一个自定义的注解。这个注解需要使用@Constraint注解来指定一个校验器,使用@Target注解来指定注解可以使用的位置(例如字段、方法等),使用@Retention注解来指定注解的生命周期。

      import javax.validation.Constraint;
      import javax.validation.Payload;
      import java.lang.annotation.*;
      
      @Documented
      @Constraint(validatedBy = {MyCustomValidator.class}) // 指定校验器
      @Target({ElementType.METHOD, ElementType.FIELD}) // 指定注解可以使用的位置
      @Retention(RetentionPolicy.RUNTIME) // 指定注解的生命周期
      public @interface MyCustomAnnotation {
      
          String message() default "自定义校验失败"; // 默认的错误提示信息
      
          Class[] groups() default {};
      
          Class[] payload() default {};
      }
    2. 创建校验器: 接下来,需要创建一个校验器类,实现ConstraintValidator接口。这个接口有两个泛型参数,第一个是自定义注解的类型,第二个是被校验的属性的类型。

      import javax.validation.ConstraintValidator;
      import javax.validation.ConstraintValidatorContext;
      
      public class MyCustomValidator implements ConstraintValidator {
      
          @Override
          public void initialize(MyCustomAnnotation constraintAnnotation) {
              // 初始化方法,可以获取注解的属性
          }
      
          @Override
          public boolean isValid(String value, ConstraintValidatorContext context) {
              // 实现校验逻辑
              if (value == null) {
                  return true; // 允许为空
              }
              return value.startsWith("custom"); // 假设校验规则是必须以"custom"开头
          }
      }

      initialize方法用于初始化校验器,可以获取注解的属性。isValid方法用于实现校验逻辑,返回true表示校验通过,返回false表示校验失败。

    3. 使用自定义注解: 现在,就可以在实体类的属性上使用自定义注解了。

      public class User {
      
          @MyCustomAnnotation(message = "用户名必须以custom开头")
          private String username;
      
          // Getters and setters
      }

    如何在Spring Boot中启用分组校验?

    分组校验允许你根据不同的场景,使用不同的校验规则。例如,在创建用户时需要校验密码,而在更新用户时不需要校验密码。

    1. 定义分组接口: 首先,需要定义一些分组接口。这些接口不需要包含任何方法,只需要作为标识即可。

      public interface CreateUser {
      }
      
      public interface UpdateUser {
      }
    2. 在注解中指定分组: 在校验注解中,使用groups属性来指定分组。

      import javax.validation.constraints.NotBlank;
      
      public class User {
      
          @NotBlank(message = "用户名不能为空", groups = {CreateUser.class})
          private String username;
      
          @NotBlank(message = "密码不能为空", groups = {CreateUser.class})
          private String password;
      
          // Getters and setters
      }

      这里指定usernamepassword属性在CreateUser分组中不能为空。

    3. 在Controller中使用: 在Controller中,使用@Validated注解来指定要使用的分组。

      import org.springframework.validation.annotation.Validated;
      import org.springframework.web.bind.annotation.PostMapping;
      import org.springframework.web.bind.annotation.RequestBody;
      import org.springframework.web.bind.annotation.RestController;
      
      @RestController
      public class UserController {
      
          @PostMapping("/users")
          public String createUser(@Validated(CreateUser.class) @RequestBody User user) {
              // 处理创建用户的逻辑
              return "用户创建成功";
          }
      
          @PostMapping("/users/{id}")
          public String updateUser(@Validated(UpdateUser.class) @RequestBody User user) {
              // 处理更新用户的逻辑
              return "用户更新成功";
          }
      }

      注意,这里使用了@Validated注解,而不是@Valid注解。@Validated注解是Spring提供的,用于支持分组校验。

    如何处理嵌套对象的校验?

    有时候,一个实体类包含另一个实体类作为属性,需要对嵌套对象进行校验。

    1. 使用@Valid注解: 在包含嵌套对象的属性上,使用@Valid注解。

      import javax.validation.Valid;
      import javax.validation.constraints.NotBlank;
      
      public class Address {
      
          @NotBlank(message = "城市不能为空")
          private String city;
      
          // Getters and setters
      }
      
      public class User {
      
          @NotBlank(message = "用户名不能为空")
          private String username;
      
          @Valid // 启用嵌套校验
          private Address address;
      
          // Getters and setters
      }

      这里在User类的address属性上使用了@Valid注解,表示需要对Address对象进行校验。

    2. 在Controller中使用: 在Controller中,和普通对象一样,使用@Valid注解来触发校验。

      import org.springframework.validation.BindingResult;
      import org.springframework.web.bind.annotation.PostMapping;
      import org.springframework.web.bind.annotation.RequestBody;
      import org.springframework.web.bind.annotation.RestController;
      
      import javax.validation.Valid;
      
      @RestController
      public class UserController {
      
          @PostMapping("/users")
          public String createUser(@Valid @RequestBody User user, BindingResult result) {
              if (result.hasErrors()) {
                  // 处理校验失败的情况
                  return "校验失败:" + result.getAllErrors().get(0).getDefaultMessage();
              }
      
              // 处理创建用户的逻辑
              return "用户创建成功";
          }
      }

      这样,当校验User对象时,会自动校验其address属性对应的Address对象。

    校验错误信息国际化

    为了支持多语言,需要将校验错误信息进行国际化。

    1. 创建ValidationMessages.properties文件:src/main/resources目录下,创建一个ValidationMessages.properties文件,用于存放默认的错误提示信息。

      NotBlank.user.username=用户名不能为空
      Size.user.username=用户名长度必须在{min}到{max}之间

      这里的NotBlank.user.usernameSize.user.username分别对应NotBlankSize注解的错误提示信息。user.username是实体类名和属性名的组合,可以自定义。

    2. 在注解中使用{}占位符: 在校验注解中,使用{}占位符来引用ValidationMessages.properties文件中的错误提示信息。

      import javax.validation.constraints.NotBlank;
      import javax.validation.constraints.Size;
      
      public class User {
      
          @NotBlank(message = "{NotBlank.user.username}")
          @Size(min = 3, max = 20, message = "{Size.user.username}")
          private String username;
      
          // Getters and setters
      }
    3. 支持多语言: 创建不同语言的ValidationMessages.properties文件,例如ValidationMessages_zh_CN.propertiesValidationMessages_en_US.properties,用于存放不同语言的错误提示信息。

      # ValidationMessages_zh_CN.properties
      NotBlank.user.username=用户名不能为空
      Size.user.username=用户名长度必须在{min}到{max}之间
      
      # ValidationMessages_en_US.properties
      NotBlank.user.username=Username cannot be blank
      Size.user.username=Username length must be between {min} and {max}

      Spring Boot会自动根据请求的Accept-Language头来选择合适的语言文件。

    校验器快速失败模式

    默认情况下,Hibernate Validator会校验所有的属性,然后返回所有的错误信息。如果希望在遇到第一个错误时就停止校验,可以使用快速失败模式。

    1. 配置ValidatorFactory: 创建一个ValidatorFactory,并配置其为快速失败模式。

      import org.hibernate.validator.HibernateValidator;
      import org.springframework.context.annotation.Bean;
      import org.springframework.context.annotation.Configuration;
      import org.springframework.validation.beanvalidation.MethodValidationPostProcessor;
      
      import javax.validation.Validation;
      import javax.validation.Validator;
      import javax.validation.ValidatorFactory;
      
      @Configuration
      public class ValidationConfig {
      
          @Bean
          public MethodValidationPostProcessor methodValidationPostProcessor() {
              return new MethodValidationPostProcessor();
          }
      
          @Bean
          public Validator validator() {
              ValidatorFactory validatorFactory = Validation.byProvider(HibernateValidator.class)
                      .configure()
                      .failFast(true) // 开启快速失败模式
                      .buildValidatorFactory();
              return validatorFactory.getValidator();
          }
      }

      这里通过failFast(true)开启了快速失败模式。

    2. 使用Validator: 在需要校验的地方,注入Validator对象,并使用其validate方法进行校验。

      import org.springframework.beans.factory.annotation.Autowired;
      import org.springframework.stereotype.Service;
      
      import javax.validation.ConstraintViolation;
      import javax.validation.Validator;
      import java.util.Set;
      
      @Service
      public class UserService {
      
          @Autowired
          private Validator validator;
      
          public void createUser(User user) {
              Set> violations = validator.validate(user);
              if (!violations.isEmpty()) {
                  // 处理校验失败的情况
                  throw new IllegalArgumentException(violations.iterator().next().getMessage()); // 只返回第一个错误信息
              }
      
              // 处理创建用户的逻辑
          }
      }

      这样,当校验User对象时,遇到第一个错误就会停止校验,并抛出异常。

    常见错误与解决方案

    1. javax.validation.ValidationException: HV000183: Unable to load 'javax.el.ExpressionFactory'. Check that you have the EL dependencies on the classpath

      这个错误通常是由于缺少EL(Expression Language)依赖导致的。需要在pom.xml文件中添加EL依赖:

      
          org.glassfish
          javax.el
          3.0.1-b09
      
    2. 校验注解不生效

      • 确认已经添加了spring-boot-starter-validation依赖。
      • 确认已经在Controller中使用了@Valid@Validated注解。
      • 确认实体类的属性上使用了正确的校验注解。
      • 如果使用了自定义校验注解,确认校验器类实现了ConstraintValidator接口,并且isValid方法返回了正确的校验结果。
    3. 自定义校验注解无法获取Spring Bean

      如果需要在自定义校验器中使用Spring Bean,可以使用@Autowired注解来注入。但是,需要将校验器类注册为Spring Bean。

      import org.springframework.beans.factory.annotation.Autowired;
      import org.springframework.stereotype.Component;
      
      import javax.validation.ConstraintValidator;
      import javax.validation.ConstraintValidatorContext;
      
      @Component // 注册为Spring Bean
      public class MyCustomValidator implements ConstraintValidator {
      
          @Autowired
          private MyService myService;
      
          @Override
          public void initialize(MyCustomAnnotation constraintAnnotation) {
              // 初始化方法,可以获取注解的属性
          }
      
          @Override
          public boolean isValid(String value, ConstraintValidatorContext context) {
              // 实现校验逻辑
              if (value == null) {
                  return true; // 允许为空
              }
              return myService.isValid(value); // 使用Spring Bean进行校验
          }
      }

      这样,就可以在校验器中使用MyService Spring Bean了。

    希望这些内容能够帮助你更好地理解和使用Spring Boot整合Hibernate验证器。

    本文内容来源于互联网,如有侵权请联系删除。
    作者最新文章
    编程开发
    相关文章 更多
    using namespace 使用中遇到的问题怎么解决
    using namespace 使用中遇到的问题怎么解决

    命名空间的基本概念与常见引入问题在C++等编程语言中,命名空间(namespace)是一种将代码标识符(如变量、函数、类名)封装在特定名称下的机制,其主要目的是避免命名冲突,尤其是在大型项目或使用多个第三方库时。使用“using namespace”指令可以将指定命名空间中的所有名称引入当前作用域,

    c语言函数递归 实操经验总结:这些技巧很实用
    c语言函数递归 实操经验总结:这些技巧很实用

    理解递归的基本原理在C语言中,递归是一种函数调用自身的编程技术。要掌握它,首先需要理解其核心思想:将一个复杂的大问题,分解为一个或几个与原问题相似但规模更小的子问题,直到子问题足够简单,可以直接求解。这个过程通常包含两个关键部分:递归出口和递归体。递归出口定义了问题何时不再继续分解,即最简单、可直接

    c语言函数递归 怎么选?常见方案对比分析
    c语言函数递归 怎么选?常见方案对比分析

    递归函数的基本概念与适用场景在C语言编程中,递归是一种函数调用自身的编程技巧。它并非适用于所有问题,但在处理某些具有自相似结构的问题时,能提供极其清晰和优雅的解决方案。递归的核心思想是将一个大规模问题分解为一个或多个同类型但规模更小的子问题,直到子问题简单到可以直接求解。典型的适用场景包括树形结构的

    Objective-C 内存管理入门:从 alloc 到 dealloc 的生命周期详解
    Objective-C 内存管理入门:从 alloc 到 dealloc 的生命周期详解

    理解内存管理的基石在Objective-C的编程世界中,内存管理是开发者必须掌握的核心技能之一。它直接关系到应用的性能、稳定性与资源利用效率。与一些采用自动垃圾回收机制的语言不同,Objective-C在很长一段时间里,依赖一套基于引用计数的、需要开发者部分介入的管理规则。这套规则的核心思想是明确的

    如何正确使用 dealloc 以避免 iOS 应用中的内存泄漏
    如何正确使用 dealloc 以避免 iOS 应用中的内存泄漏

    理解 dealloc 的角色与时机在 iOS 应用开发中,内存管理是保障应用性能与稳定性的基石。dealloc 方法是 Objective-C 中对象生命周期结束时的关键回调,它标志着对象即将被系统回收内存。正确理解其触发时机至关重要:当一个对象的引用计数降为零时,运行时系统会自动调用该对象的 de

    深入理解 Objective-C 中的 dealloc 方法:内存管理核心机制
    深入理解 Objective-C 中的 dealloc 方法:内存管理核心机制

    内存管理的基石在Objective-C的世界里,内存管理是开发者必须掌握的核心技能之一。作为一门在手动引用计数(MRC)时代诞生的语言,Objective-C要求程序员对对象的生命周期有清晰的认识。dealloc方法正是这一生命周期中至关重要的终点站。它是一个实例方法,当对象的引用计数降为零时,系统

    理解 native2ascii:Java 国际化开发中的字符编码工具
    理解 native2ascii:Java 国际化开发中的字符编码工具

    native2ascii 工具的基本定位在Ja va应用程序的国际化与本地化开发过程中,处理非拉丁字符集是一个常见且关键的环节。Ja va内部使用Unicode字符集来统一表示全球各种语言的文字,但其属性文件(.properties)在历史上要求使用ASCII编码,或者更准确地说,要求非ASCII字

    如何使用 native2ascii 转换中文字符为 Unicode 转义序列
    如何使用 native2ascii 转换中文字符为 Unicode 转义序列

    理解 native2ascii 工具的基本用途在软件开发,特别是涉及国际化处理的场景中,开发者常常需要处理不同编码的文本资源。native2ascii 是 Ja va 开发工具包(JDK)中提供的一个命令行实用程序,其主要功能是将包含本地字符编码(非ASCII字符)的文件,转换为包含 Unicode

    Java native2ascii 命令详解:解决属性文件乱码问题
    Java native2ascii 命令详解:解决属性文件乱码问题

    native2ascii 命令的由来与作用在Ja va开发中,处理国际化资源文件是一个常见需求。资源文件通常以.properties格式存储,用于支持多语言界面。然而,Ja va属性文件默认采用ISO-8859-1字符集编码,这导致了一个直接的问题:当文件中包含非拉丁字符(如中文、日文、韩文等)时,

    一个 memwatch 实战案例:定位野指针问题
    一个 memwatch 实战案例:定位野指针问题

    内存监控工具的价值与挑战在软件开发,尤其是使用C/C++这类手动管理内存的语言时,内存错误是程序员最常遭遇的难题之一。其中,野指针问题因其隐蔽性和破坏性,往往成为最难定位的“幽灵”缺陷。它可能潜伏在代码中,在特定条件下才被触发,导致程序崩溃、数据损坏或难以预测的行为。传统的调试手段,如打印日志或使用

    查看更多
    精品专题 更多
    装机必备
    装机必备

    正软商城装机必备专区,精选办公、浏览器、安全防护、影音播放、压缩解压、设计创作和系统工具等电脑常用正版软件,帮助用户快速完成新电脑软件配置。

    Windows
    Windows

    正软商城Windows软件专区,汇集适用于Windows电脑的办公、设计、安全防护、影音播放、开发工具和系统优化软件,提供软件介绍、系统要求、正版授权及购买下载服务。

    macOS软件
    macOS软件

    正软商城macOS软件专区,精选适用于Mac电脑的办公、设计、影音、效率、开发和系统工具,提供软件功能介绍、macOS兼容版本、正版授权及购买下载服务。

    Mac软件 更多
    灵活计算器
    灵活计算器
    macOS/iOS/Android

    灵活计算器是一款笔记式算数应用,支持实时计算、动态关联和云端同步功能。记录、整理和输出之间的过渡会更自然,适合长期写作、做笔记或持续沉淀个人内容。

    赤友清理大师
    赤友清理大师
    macOS

    赤友清理大师是一款为 Mac 设计的智能清理优化工具,可精准扫描垃圾、大文件、重复文件等,释放磁盘空间。做扫描整理、文字提取和表格转换时,它能把识别后的处理步骤接得更顺,资料录入这类场景会省下不少时间。

    极度公式
    极度公式
    Windows/macOS/Linux

    极度公式是一款跨平台专业LaTeX公式识别编辑软件,支持OCR公式识别和多平台编辑。和使用说明,避免使用,享受完整功能与稳定支持。做扫描整理、文字提取和表格转换时,它能把识别后的处理步骤接得更顺,资料录入这类场景会省下不少时间。

    WINDOWS 更多
    Windows 10
    Windows 10
    Windows

    Windows 10 是一款微软推出的经典操作系统,拥有硬件兼容性与多任务处理能力。它更偏向把系统状态查看和常用调节动作放在一起,适合需要持续观察和微调设备状态的场景。

    极度公式
    极度公式
    Windows/macOS/Linux

    极度公式是一款跨平台专业LaTeX公式识别编辑软件,支持OCR公式识别和多平台编辑。和使用说明,避免使用,享受完整功能与稳定支持。做扫描整理、文字提取和表格转换时,它能把识别后的处理步骤接得更顺,资料录入这类场景会省下不少时间。

    密码键盘
    密码键盘
    Windows/macOS/iOS/Android

    密码键盘是一款兼具安全性与便捷性的高效密码管理器。日常使用里的持续防护和信息管理会更突出,适合把安全控制放进长期使用流程中的场景。

    网站备案号:苏ICP备2026018738号-1 联系邮箱:bd@zhengruan.com 网站地图

    Copyright ©2018-2026