# 单元测试 Bean 验证和自定义验证器 ## 概述该技能提供了使用 JUnit 5 进行单元测试 Jakarta Bean Validation 注释和自定义验证器实现的模式。它涵盖了测试内置约束（@NotNull、@Email、@Min、@Max）、创建自定义验证器、跨字段验证、验证组和参数化测试场景。 ## 何时使用此技能在以下情况下使用此技能： * 测试 Jakarta Bean 验证（@NotNull、@Email、@Min 等） * 测试自定义@Constraint验证器 * 验证约束违反错误消息 * 测试跨域验证逻辑 * 想要在没有 Spring 上下文的情况下进行快速验证测试 * 测试复杂的验证场景和边缘情况 ## 说明 1. **添加验证依赖项**：在测试类路径中包含 jakarta.validation-api 和 hibernate-validator 2. **创建一个Validator实例** : 在@BeforeEach中使用 `Validation.buildDefaultValidatorFactory().getValidator()` 3. **测试有效场景** ：始终测试有效对象是否通过验证且没有违规 4. **单独测试每个约束**：为各个验证规则创建重点测试 5. **提取违规详细信息**：使用断言来验证属性路径、消息和无效值 6. **测试自定义验证器**：为每个自定义约束实现编写专用测试 7. **使用参数化测试**：应用@ParameterizedTest有效测试多个无效输入 8. **测试验证组** ：根据验证组验证条件验证 ## 示例 ## 设置：Bean 验证 ### Maven <依赖关系> jakarta.validation jakarta.validation-api <依赖关系> org.hibernate.validator hibernate-validator <范围>测试 <依赖关系> org.junit.jupiter junit-jupiter <范围>测试 <依赖关系> org.assertj assertj-core <范围>测试 ### 摇篮依赖项{ 实现（“jakarta.validation：jakarta.validation-api”） testImplementation("org.hibernate.validator:hibernate-validator") testImplementation("org.junit.jupiter:junit-jupiter") testImplementation("org.assertj:assertj-core") } ## 基本模式：测试验证约束 ### 设置验证器导入 jakarta.validation.Validator; 导入 jakarta.validation.ValidatorFactory; 导入 jakarta.validation.Validation; 导入 jakarta.validation.ConstraintViolation; 导入 org.junit.jupiter.api.BeforeEach; 导入 org.junit.jupiter.api.Test; 导入静态 org.assertj.core.api.Assertions.*; 类用户验证测试{ 私有验证器验证器； @BeforeEach 无效设置（）{ ValidatorFactory 工厂 = Validation.buildDefaultValidatorFactory(); 验证器=工厂.getValidator(); } @测试无效shouldPassValidationWithValidUser() { 用户 user = new User("Alice", "alice@example.com", 25); Set>violations = validator.validate(user); assertThat(违规).isEmpty(); } @测试无效shouldFailValidationWhenNameIsNull（）{ 用户 user = new User(null, "alice@example.com", 25); Set>violations = validator.validate(user); 断言（违规） .hasSize(1) .extracting(ConstraintViolation::getMessage) .contains("不能为空"); } } ## 测试单独的约束注释 ### 测试@NotNull、@NotBlank、@Email 类 UserDtoTest { 私有验证器验证器； @BeforeEach 无效设置（）{ 验证器 = Validation.buildDefaultValidatorFactory().getValidator(); } @测试无效shouldFailWhenEmailIsInvalid（）{ UserDto dto = new UserDto("Alice", "无效电子邮件"); 设置>违规= validator.validate(dto); 断言（违规） .extracting(ConstraintViolation::getPropertyPath) .extracting(路径::toString) .contains("电子邮件"); 断言（违规） .extracting(ConstraintViolation::getMessage) .contains("必须是有效的电子邮件地址"); } @测试无效shouldFailWhenNameIsBlank（）{ UserDto dto = new UserDto(" ", "alice@example.com"); 设置>违规= validator.validate(dto); 断言（违规） .extracting(ConstraintViolation::getPropertyPath) .extracting(路径::toString) .contains("名称"); } @测试无效shouldFailWhenAgeIsNegative（）{ UserDto dto = new UserDto("Alice", "alice@example.com", -5); 设置>违规= validator.validate(dto); 断言（违规） .extracting(ConstraintViolation::getMessage) .contains("必须大于或等于0"); } @测试无效shouldPassWhenAllConstraintsSatisfied（）{ UserDto dto = new UserDto("Alice", "alice@example.com", 25); 设置>违规= validator.validate(dto); assertThat(违规).isEmpty(); } } ## 测试@Min、@Max、@Size 约束类 ProductDtoTest { 私有验证器验证器； @BeforeEach 无效设置（）{ 验证器 = Validation.buildDefaultValidatorFactory().getValidator(); } @测试无效shouldFailWhenPriceIsBelowMinimum（）{ ProductDto 产品 = new ProductDto("笔记本电脑", -100.0); 设置>违规= validator.validate(product); 断言（违规） .extracting(ConstraintViolation::getMessage) .contains("必须大于0"); } @测试无效 shouldFailWhenQuantityExceedsMaximum() { ProductDto 产品 = new ProductDto("笔记本电脑", 1000.0, 999999); 设置>违规= validator.validate(product); 断言（违规） .extracting(ConstraintViolation::getMessage) .contains("必须小于或等于10000"); } @测试无效shouldFailWhenDescriptionTooLong() { 字符串 longDescription = "x".repeat(1001); ProductDto 产品 = new ProductDto("笔记本电脑", 1000.0, longDescription); 设置>违规= validator.validate(product); 断言（违规） .extracting(ConstraintViolation::getMessage) .contains("大小必须在 0 到 1000 之间"); } } ## 测试自定义验证器 ### 创建并测试自定义约束 // 自定义约束注解 @Target(ElementType.FIELD) @Retention(RetentionPolicy.RUNTIME) @Constraint(validatedBy = PhoneNumberValidator.class) 公共@interface ValidPhoneNumber { String message() 默认“电话号码格式无效”； Class[] groups() 默认 {}; 类[] Payload() 默认 {}; } // 自定义验证器实现公共类 PhoneNumberValidator 实现 ConstraintValidator { private static Final String PHONE_PATTERN = "^\\d{3}-\\d{3}-\\d{4}$"; @覆盖公共布尔 isValid（字符串值，ConstraintValidatorContext 上下文）{ 如果（值== null）返回true； // 由@NotNull处理的空值返回值.matches(PHONE_PATTERN); } } // 自定义验证器的单元测试类 PhoneNumberValidatorTest { 私有验证器验证器； @BeforeEach 无效设置（）{ 验证器 = Validation.buildDefaultValidatorFactory().getValidator(); } @测试无效shouldAcceptValidPhoneNumber（）{ 联系人 contact = new Contact("Alice", "555-123-4567"); Set>violations = validator.validate(contact); assertThat(违规).isEmpty(); } @测试无效shouldRejectInvalidPhoneNumberFormat（）{ 联系人 contact = new Contact("Alice", "5551234567"); // 没有破折号 Set>violations = validator.validate(contact); 断言（违规） .extracting(ConstraintViolation::getMessage) .contains("电话号码格式无效"); } @测试无效shouldRejectPhoneNumberWithLetters（）{ 联系人 contact = new Contact("Alice", "ABC-DEF-GHIJ"); Set>violations = validator.validate(contact); assertThat(违规).isNotEmpty(); } @测试无效shouldAllowNullPhoneNumber（）{ 联系人 contact = new Contact("Alice", null); Set>violations = validator.validate(contact); assertThat(违规).isEmpty(); } } ## 测试跨域验证 ### 自定义多字段约束 // 跨字段验证的自定义约束 @Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) @Constraint(validatedBy = PasswordMatchValidator.class) 公共@interface密码匹配{ String message() 默认“密码不匹配”； Class[] groups() 默认 {}; 类[] Payload() 默认 {}; } // 验证器实现公共类PasswordMatchValidator实现ConstraintValidator { @覆盖公共布尔 isValid（ChangePasswordRequest 值，ConstraintValidatorContext 上下文）{ 如果（值== null）返回true；返回 value.getNewPassword().equals(value.getConfirmPassword()); } } // 单元测试类密码验证测试{ 私有验证器验证器； @BeforeEach 无效设置（）{ 验证器 = Validation.buildDefaultValidatorFactory().getValidator(); } @测试无效shouldPassWhenPasswordsMatch（）{ ChangePasswordRequest 请求 = new ChangePasswordRequest("oldPass", "newPass123", "newPass123"); 设置>violations = validator.validate(request); assertThat(违规).isEmpty(); } @测试无效shouldFailWhenPasswordsDoNotMatch（）{ ChangePasswordRequest request = new ChangePasswordRequest("oldPass", "newPass123", " differentPass"); 设置>violations = validator.validate(request); 断言（违规） .extracting(ConstraintViolation::getMessage) .contains("密码不匹配"); } } ## 测试验证组 ### 条件验证 @Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) 公共接口 CreateValidation {} @Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) 公共接口更新验证{} 类 UserDto { @NotNull(groups = {CreateValidation.class}) 私有字符串名称； @Min(值 = 1, groups = {CreateValidation.class, UpdateValidation.class}) 私有整数年龄； } 类 ValidationGroupsTest { 私有验证器验证器； @BeforeEach 无效设置（）{ 验证器 = Validation.buildDefaultValidatorFactory().getValidator(); } @测试无效shouldRequireNameOnlyDuringCreation() { UserDto 用户 = new UserDto(null, 25); Set>violations = validator.validate(user, CreateValidation.class); 断言（违规） .extracting(ConstraintViolation::getPropertyPath) .extracting(路径::toString) .contains("名称"); } @测试无效shouldAllowNullNameDuringUpdate（）{ UserDto 用户 = new UserDto(null, 25); Set>violations = validator.validate(user, UpdateValidation.class); assertThat(违规).isEmpty(); } } ## 测试参数化验证场景导入 org.junit.jupiter.params.ParameterizedTest; 导入 org.junit.jupiter.params.provider.ValueSource; 类电子邮件验证测试{ 私有验证器验证器； @BeforeEach 无效设置（）{ 验证器 = Validation.buildDefaultValidatorFactory().getValidator(); } @参数化测试 @ValueSource(字符串 = { “用户@example.com”， “john.doe+tag@example.co.uk”， “admin123@subdomain.example.com” }) 无效shouldAcceptValidEmails（字符串电子邮件）{ UserDto user = new UserDto("Alice", email); 设置>违规= validator.validate(user); assertThat(违规).isEmpty(); } @参数化测试 @ValueSource(字符串 = { “无效的电子邮件”， “用户@”， “@example.com”， “用户名@example.com” }) 无效shouldRejectInvalidEmails（字符串电子邮件）{ UserDto user = new UserDto("Alice", email); 设置>违规= validator.validate(user); assertThat(违规).isNotEmpty(); } } ## 最佳实践 * **在测试服务/控制器层之前在单元测试级别进行验证** * **针对每个约束测试有效和无效的情况** * **使用自定义验证器**用于特定于业务的验证规则 * **测试错误消息**以确保它们是用户友好的 * **测试边缘情况**：null、空字符串、仅空白字符串 * **使用验证组**进行条件验证规则 * **保持验证器逻辑简单** \- 复杂的验证属于服务测试 ## 常见陷阱 * 忘记测试空值 * 不提取违规详细信息（消息、属性、约束类型） * 在服务/控制器级别测试验证而不是单元测试 * 创建过于复杂的自定义验证器 * 未在错误消息中记录约束目的 ## 限制和警告 * **约束默认忽略 null** ：除了@NotNull，大多数约束都会忽略 null 值；与@NotNull 结合用于必填字段 * **验证器是线程安全的**：验证器实例可以在测试之间共享，但如果需要，可以创建新的隔离实例 * **消息本地化** ：如果您的应用程序支持国际化，请使用不同的语言环境进行测试 * **级联验证** : 在嵌套对象上使用@Valid来启用级联验证 * **性能考虑** ：验证有开销；不要在关键路径中过度验证 * **自定义验证器必须是无状态的**：验证器实现不应在调用之间维护状态 * **隔离测试** ：验证测试不应依赖于 Spring 上下文或数据库 ## 故障排除 **未找到 ValidatorFactory** ：确保 `jakarta.validation-api` 和 `hibernate-validator` 位于类路径上。 **未调用自定义验证器**：验证是否正确指定了“@Constraint(validatedBy = YourValidator.class)”。 **Null 处理混乱** ：默认情况下，`@NotNull` 检查 null，其他约束忽略 null（将 `@NotNull` 与其他约束一起用于强制字段）。 ## 参考文献 * [Jakarta Bean 验证规范]() * [Hibernate 验证器文档]() * [自定义约束]()

单元测试 Bean 验证

包含技能