从SpringBoot 2.6.6升级到2.6.7改变了验证行为(javax. validate . constrain



刚刚从SpringBoot 2.6.6升级到2.6.7,但是尽管hibernate验证器的GAV没有改变(两个版本都使用org.hibernate.validator:hibernate-validator:6.2.3.Finaljakarta.validation:jakarta.validation-api:2.0.2),我注意到使用验证API的行为发生了变化。

我能够将其简化为简单的测试用例,以显示2.6.6和2.6.7之间的差异。

注意: 我理解它失败的原因并知道修复方法,但我不理解的是为什么只有在SpringBoot 2.6.7版本中Hibernate验证器工件没有在不同版本之间更改时才开始失败。

为了演示,下面是代码和测试用例:
  1. 首先是POM文件(使用SpringBoot 2.6.6):
<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.6.6</version>
<relativePath/>
</parent>
<groupId>org.example</groupId>
<artifactId>validator</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>demo</name>
<description>Demo project</description>
<properties>
<java.version>1.8</java.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-validation</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
  1. java接口和类:
package org.example.demo;
public interface WithNameOnCard {
String getNameOnCard();
void setNameOnCard(String nameOnCard);
}
package org.example.demo;
import lombok.Getter;
import lombok.Setter;
import javax.validation.constraints.NotBlank;
import javax.validation.constraints.NotNull;
@Getter
@Setter
public class MembershipCard implements WithNameOnCard {
@NotNull
@NotBlank
private String nameOnCard;
@NotNull
private String membershipNumber;
}
package org.example.demo;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class DemoApplication {
public static void main(String[] args) {
SpringApplication.run(DemoApplication.class, args);
}
}
  1. 最后,测试用例:
package org.example.demo;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.Test;
import javax.validation.ConstraintViolation;
import javax.validation.Validation;
import javax.validation.Validator;
import javax.validation.ValidatorFactory;
import java.util.Set;
public class ValidatorTest {
public static Validator validator;
@BeforeAll
public static void setUp() {
ValidatorFactory factory = Validation.buildDefaultValidatorFactory();
validator = factory.getValidator();
}
@Test
public void whenPropertiesEmptyThenFailValidation() {
MembershipCard membershipCard = new MembershipCard();
Set<ConstraintViolation<MembershipCard>> violations = validator.validate(membershipCard);
Assertions.assertTrue(violations.size() > 0);
}
@Test
public void whenPropertiesNotEmptyThenFailPasses() {
MembershipCard membershipCard = new MembershipCard();
membershipCard.setMembershipNumber("123456");
membershipCard.setNameOnCard("JOHN SMITH");
Set<ConstraintViolation<MembershipCard>> violations = validator.validate(membershipCard);
Assertions.assertEquals(0, violations.size());
}
}
  1. 运行测试,得到:
[INFO] -------------------------------------------------------
[INFO]  T E S T S
[INFO] -------------------------------------------------------
[INFO] Running org.example.demo.ValidatorTest
< ... snipped ... >
[INFO] Tests run: 2, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.196 s - in org.example.demo.ValidatorTest
  1. 现在更改POM文件,使其使用SpringBoot 2.6.7:
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.6.7</version>
<relativePath/>
</parent>
  1. 运行测试,得到:
INFO] Running org.example.demo.ValidatorTest
<... snipped ...>
[ERROR] Tests run: 2, Failures: 0, Errors: 2, Skipped: 0, Time elapsed: 0.17 s <<< FAILURE! - in org.example.demo.ValidatorTest
[ERROR] whenPropertiesEmptyThenFailValidation  Time elapsed: 0.026 s  <<< ERROR!
javax.validation.ConstraintDeclarationException: HV000151: A method overriding another method must not redefine the parameter constraint configuration, but method MembershipCard#setNameOnCard(String) redefines the configuration of WithNameOnCard#setNameOnCard(String).
at org.example.demo.ValidatorTest.whenPropertiesEmptyThenFailValidation(ValidatorTest.java:27)
[ERROR] whenPropertiesNotEmptyThenFailPasses  Time elapsed: 0.003 s  <<< ERROR!
javax.validation.ConstraintDeclarationException: HV000151: A method overriding another method must not redefine the parameter constraint configuration, but method MembershipCard#setNameOnCard(String) redefines the configuration of WithNameOnCard#setNameOnCard(String).
at org.example.demo.ValidatorTest.whenPropertiesNotEmptyThenFailPasses(ValidatorTest.java:37)
[ERROR] Errors: 
[ERROR]   ValidatorTest.whenPropertiesEmptyThenFailValidation:27 » ConstraintDeclaration
[ERROR]   ValidatorTest.whenPropertiesNotEmptyThenFailPasses:37 » ConstraintDeclaration ...
[INFO] 
[ERROR] Tests run: 3, Failures: 0, Errors: 2, Skipped: 0

注意:就像我上面提到的,我理解错误的原因,所以类和接口必须遵守Liskov替换原则。

修复错误的方法是:

  • WithNameOnCard接口移除setter方法setNameOnCard()。或
  • 将验证注解从实现类的字段移动到接口的getter方法。或
  • 仅将@NotNull注释从MembershipCard类的nameOnCard字段移动到NameOnCard接口的getNameOnCard()方法中,而将@NotBlank注释留在类的nameOncard字段上。(这最后一个修复实际上我不明白。@NotNull@NotBlank有什么独特之处会导致2.6.6和2.6.7之间的差异?)

我不明白为什么这个错误NOT当Hibernate验证器工件在2.6.6和2.6.7之间保持不变时,在SpringBoot 2.6.6中生成。

所以一定是别的东西引起了这种行为的变化,但我不能确定是什么。

Spring Boot 2.6.7升级了Lombok版本。较新的Lombok版本将字段注释传播到生成的setter方法。作为解决方法,您可以通过设置Maven属性来降级Lombok版本:

<lombok.version>1.18.22</lombok.version>

最新更新