javax.validation.constraints 的注释不起作用

Question

使用来自 javax.validation.constraints 的注释（如 @Size、@NotNull 等）需要什么配置？这是我的代码：

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

public class Person {
      @NotNull
      private String id;

      @Size(max = 3)
      private String name;

      private int age;

      public Person(String id, String name, int age) {
        this.id = id;
        this.name = name;
        this.age = age;
      }
}

当我尝试在另一个类中使用它时，验证不起作用（即创建对象时没有错误）：

Person P = new Person(null, "Richard3", 8229));

为什么这不对 id 和 name 应用约束？我还需要做什么？

Answer 1

要使 JSR-303 bean 验证在 Spring 中工作，您需要做一些事情：

1. 注解的 MVC 命名空间配置：
2. JSR-303 规范 JAR：validation -api-1.0.0.GA.jar （看起来你已经有了）
3. 规范的实现，例如 Hibernate Validation，这似乎是最常用的示例： hibernate-validator-4.1.0.Final.jar
4. 在要验证的 bean 中，验证注释，来自规范 JAR 或来自实现 JAR（您已经完成）
5. 在您想要的处理程序中要进行验证，请使用 @Valid 注释要验证的对象，然后在方法签名中包含 BindingResult 以捕获错误。

例子：

@RequestMapping("handler.do")
public String myHandler(@Valid @ModelAttribute("form") SomeFormBean myForm, BindingResult result, Model model) {
    if(result.hasErrors()) {
      ...your error handling...
    } else {
      ...your non-error handling....
    }
}

Answer 2

您应该使用 Validator 来检查您的类是否有效。

Person person = ....;
ValidatorFactory factory = Validation.buildDefaultValidatorFactory();
validator = factory.getValidator();
Set<ConstraintViolation<Person>> violations = validator.validate(person);

然后，迭代违规集合，就可以找到违规行为。

Answer 3

几年后我来到这里，多亏了 atrain 的 上面的评论。就我而言，我在接收用 @Size 注释的对象（在我的例子中为 POJO）的 API 中缺少 @Valid 。它解决了这个问题。

我不需要需要向用@Size注释的变量添加任何额外的注释，例如@Valid或@NotBlank code>，就是变量中的约束以及我在 API 中提到的内容...

Pojo 类：

...
@Size(min = MIN_LENGTH, max = MAX_LENGTH);
private String exampleVar;
...

API 类：

...
public void exampleApiCall(@RequestBody @Valid PojoObject pojoObject){
  ...
}

谢谢并欢呼

Answer 4

就我而言，我使用的是 Spring Boot 版本 2.3.0。当我将 Maven 依赖项更改为使用 2.1.3 时，它起作用了。

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.1.3.RELEASE</version>
    <relativePath /> <!-- lookup parent from repository -->
</parent>
<dependencies>
    <dependency>
        <groupId>javax.validation</groupId>
        <artifactId>validation-api</artifactId>
    </dependency>
</dependencies>

Answer 5

如果您想验证实体，则必须调用实体上的验证器。然后您将得到一组 ConstraintViolationException，它基本上显示实体的哪个字段存在约束违规以及到底是什么。也许您还可以共享一些您希望验证实体的代码。

一种常用的技术是在事务期间使用多个数据修改时在 @PrePersist 中进行验证并回滚事务，或者在收到验证异常时执行其他操作。

你的代码应该是这样的：

@PrePersist
public void prePersist(SomeEntity someEntity){
    Validator validator = Validation.buildDefaultValidatorFactory.getValidator();
    Set<ConstraintViolation<SomeEntity>> = validator.validate(someEntity);
    //do stuff with them, like notify client what was the wrong field, log them, or, if empty, be happy
}

Answer 6

您也可以简单地将 @NonNull 与 lombok 库 一起使用，至少对于 @NotNull场景。更多详细信息：https://projectlombok.org/api/lombok/NonNull.html

Answer 7

就我而言，原因是 hibernate-validator 版本。
可能新版本不再支持某些内容。

我改变了：

<dependency>
    <groupId>org.hibernate</groupId>
    <artifactId>hibernate-validator</artifactId>
    <version>${hibernate-validator.version}</version>
</dependency>

我将版本从7.0.1.Final降级到6.0.2.Final，这对我有帮助。

Answer 8

在版本 2.3.0 之后，“spring-boot-strarter-test”（包括 NotNull/NotBlank/etc）现在是“sprnig boot-strarter-validation”

只需将其从 ....-test 更改为 ...-validation 就可以了。

如果不将您使用的版本降级到 2.1.3 也可以解决该问题。

Answer 9

我也面临同样的问题。 Javax 注释（@NotNull、@Valid）未执行任何验证。他们的存在并没有带来任何影响。

我必须使用“springboot-starter-validation”依赖项才能使 javax 验证有效。
这里是相关的依赖配置。另外，不要错过在要验证的对象上添加 @Valid 注释。

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.5.2</version>
    <relativePath/> <!-- lookup parent from repository -->
</parent>
.....
.....
<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-validation</artifactId>
    </dependency>

    <dependency>
        <groupId>javax.validation</groupId>
        <artifactId>validation-api</artifactId>
    </dependency>

    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>
 <dependencies>

Answer 10

您需要将@Valid添加到每个成员变量，这也是一个包含验证约束的对象。

Answer 11

最近我也遇到了同样的情况。我将 hibernate-validator 升级到了 7.x 版本，但后来我注意到这个 release注意

Hibernate Validator 7.0 是 Jakarta Bean Validation 3.0 的参考实现。
主要变化是所有依赖项都使用 javax.软件包现在使用 jakarta.* 软件包。
仅当您要迁移到 Jakarta EE 9 时，才建议升级到 Hibernate Validator 7。

我的项目应该以 java 8 为目标，因此保留 javax.validation 而不是切换到 jakarta.validation ，我不得不降级到

<dependency>
  <groupId>org.hibernate.validator</groupId>
  <artifactId>hibernate-validator</artifactId>
  <version>6.0.2.Final</version>
</dependency>

Answer 12

默认情况下，Spring 中的 javax 验证适用于 Rest 控制器方法输入变量。但为了其他地方使用相同的方法，我们必须使用 @Validated 类级别注释来注释包含 @Valid 注释的类。

我在使用 kafka 侦听器时遇到了同样的问题，之后我用 @Validated 对其进行了注释，它开始工作。

@Component
@Log4j2
@Validated
public class KafkaMessageListeners {

    @KafkaListener(topics = "message_reprocessor", errorHandler = "validationErrorHandler")
    public void processMessage(@Payload @Valid CustomPojo payload,
                               @Header(KafkaHeaders.OFFSET) List<Long> offsets, Acknowledgment acknowledgment) {

    }

}

Answer 13

如果您使用的是 Maven，只需在 pom.xml 的 tag 下添加以下内容即可。

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

对于 Gradle，您可以执行以下操作。

dependencies {
  ...
  implementation 'org.springframework.boot:spring-boot-starter-validation'
}

Answer 14

就我而言，我有一个未调用的自定义类级约束。

@CustomValidation // not called
public class MyClass {
    @Lob
    @Column(nullable = false)
    private String name;
}

一旦我向我的类添加了字段级约束（无论是自定义还是标准），类级约束就开始起作用。

@CustomValidation // now it works. super.
public class MyClass {
    @Lob
    @Column(nullable = false)
    @NotBlank // adding this made @CustomValidation start working
    private String name;
}

对我来说似乎是错误的行为，但我想很容易解决

Answer 15

因此，服务接口上的 @Valid 仅适用于该对象。如果您在 ServiceRequest 对象的层次结构中有更多验证，那么您可能需要显式触发验证。这就是我的做法：

public class ServiceRequestValidator {

      private static Validator validator;

      @PostConstruct
      public void init(){
         validator = Validation.buildDefaultValidatorFactory().getValidator();
      }

      public static <T> void validate(T t){
        Set<ConstraintViolation<T>> errors = validator.validate(t);
        if(CollectionUtils.isNotEmpty(errors)){
          throw new ConstraintViolationException(errors);
        }
     }

}

如果要触发该对象的验证，则需要在对象级别具有以下注释。

@Valid
@NotNull

Answer 16

对于方法参数，您可以使用 Objects.requireNonNull() ，如下所示：
测试（字符串str）{
Objects.requireNonNull(str);
}
但这仅在运行时检查，如果为 null，则抛出 NPE。这就像先决条件检查。但这可能就是您正在寻找的。

Answer 17

atrain 给出了很好的答案，
但也许捕获异常的更好解决方案是利用自己的 HandlerExceptionResolver
并捕获

@Override
public ModelAndView resolveException(
    HttpServletRequest aReq, 
    HttpServletResponse aRes,
    Object aHandler, 
    Exception anExc
){
    // ....
    if(anExc instanceof MethodArgumentNotValidException) // do your handle     error here
}

然后您就可以使您的处理程序尽可能保持干净。
您不再需要 myHandlerMethod 中的 BindingResult、Model 和 SomeFormBean。

Answer 18

我最近在非常相似的情况下遇到了这个问题：
满足列出的最高评价答案的所有要求，但仍然得到错误的结果。

所以我查看了我的依赖项，发现我缺少其中一些。我通过添加缺少的依赖项来纠正它。

我正在使用 hibernate，所需的依赖项是：

*在“Spring & Hibernate 初学者”课程中拍摄的快照 @ Udemy

Answer 19

如果您使用 lombok，则可以使用 @NonNull 注释。
或者只需在 pom.xml 文件中添加 javax.validation 依赖项。

Answer 20

对于那些无法通过 Hibernate 验证依赖项执行服务器端验证的人。
只需删除 Hibernate 验证器 +javax 验证依赖项并添加 spring-boot-starter 验证即可。它内部提供了 Hibernate Validator，它对我来说工作得很好。

致谢：- 来自 youtube 的评论。

Answer 21

我遇到了同样的问题，但我得到了解决方案，

您的servlet配置xml文件即{servlet-name}-servlet.xml文件

应该像

    <?xml version="1.0" encoding="UTF-8"?>
    
    <beans xmlns="http://www.springframework.org/schema/beans"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
        xmlns:context="http://www.springframework.org/schema/context"
        xmlns:mvc="http://www.springframework.org/schema/mvc"
        xsi:schemaLocation="
            http://www.springframework.org/schema/beans
            http://www.springframework.org/schema/beans/spring-beans.xsd
            http://www.springframework.org/schema/context
            http://www.springframework.org/schema/context/spring-context.xsd
            http://www.springframework.org/schema/mvc
            http://www.springframework.org/schema/mvc/spring-mvc.xsd">
    
       <context:component-scan base-package = "spring.tutorial.controller" />
       
->>>  Step 4: Add support for conversion, formatting and validation support
       
        <mvc:annotation-driven/>        
    
       <bean class = "org.springframework.web.servlet.view.InternalResourceViewResolver">
          <property name = "prefix" value = "/WEB-INF/views/" />
          <property name = "suffix" value = ".jsp" />
       </bean>
    
    </beans>

第4步一样重要

Answer 22

就我而言，当切换到 Spring 3 时。注释应该来自 jakarta。例如
反而
导入 javax.validation.constraints.Size;
导入 jakarta.validation.constraints.Size;

Answer 23

就我而言，我删除了这些行

1-import javax.validation.constraints.NotNull;

2-导入javax.validation.constraints.Size；

3- @NotNull

4- @Size(最大 = 3)