未调用自定义Spring注释

Question

在我的Spring Boot项目中，我创建了一个自定义注释，其中validator扩展了ConstraintValidator，以验证RequestBody中的一些字段。注释对于非嵌套字段可以很好地工作，但对于嵌套字段不调用验证器。

我的注释如下所示：

@Target(AnnotationTarget.FIELD)
@Retention(AnnotationRetention.RUNTIME)
@Constraint(validatedBy = [CustomValidator::class])
@Suppress("unused")
@MustBeDocumented
annotation class CustomValidation(
    val message: String = "validation failed",
    val groups: Array<KClass<*>> = [],
    val payload: Array<KClass<out Payload>> = []
)

我的验证类：

@Component
class CustomValidator : ConstraintValidator<CustomValidation, String> {

    override fun isValid(field: String?, context: ConstraintValidatorContext?): Boolean {
        if (field != "example") {
            return false
        }
        return true
    }
}

它在这样的情况下工作正常：

data class MyRequest(
// validator works perfectly here
    @JsonProperty("example") @CustomValidation val example: String? = null,
    @JsonProperty("locale") val locale: String? = null
)

但是当放在嵌套对象上时，不会调用验证器：

data class MyRequest(
    @JsonProperty("nested") val nested: NestedClass? = null,
    @JsonProperty("locale") val locale: String? = null
)

data class NestedClass(
// validator not called in that case
@JsonProperty("example") @CustomValidation val example: String? = null
)

MyRequest类在我的RestController中的用法：

@PostMapping("/endpoint")
    fun doSomething(
        @Valid @RequestBody myRequest: MyRequest,
        @RequestHeader(value = "token") token: String
    ): ResponseEntity<MyResponse> = ResponseEntity.ok(myService.getData(myRequest))

关于如何解决这个问题有什么想法吗？我已经尝试在嵌套字段中放置@Valid注释，但仍然不起作用

Answer 1

通常为了在嵌套类中进行验证，您需要使用@Valid用相同的嵌套类类型注释父类的字段。

在这里，要在NestedClass类上进行验证，您需要将@Valid添加到MyRequest类的嵌套字段中。由于它是构造函数的一部分，因此应该使用注释使用站点目标完成，如下所示：

data class MyRequest(
    @field:Valid @JsonProperty("nested") val nested: NestedClass? = null,
    @JsonProperty("locale") val locale: String? = null
)

您的@CustomValidation注释在不使用use站点目标的情况下工作的原因是因为它只有一个由@Target（AnnotationTarget. FIELD）定义的目标，而@Valid注释有多个可能的目标，即@Target（value={METHOD， FIELD， CONSTRUCTOR， PARAMETER}），因此您需要有use站点目标来告诉编译器正确的目标。