如何使用科特林在Quarkus中正确验证 REST 请求？

Question

我目前正在使用静态编程语言在Quarkus中创建一个应用程序。我正在尝试使用RestEasy、Panache和Hibernate创建一个简单的用户endpoint。我现在的挑战是异常处理没有正确完成。当请求无效时，我想向用户显示正确且可理解的消息。

这是我的创建用户 POST 请求的用户资源：

@POST
    @Transactional
    @Produces(MediaType.APPLICATION_JSON)
    @Consumes(MediaType.APPLICATION_JSON)
    fun createUser(@Valid user: User) : CreateUserResponse =
        try {
            userRepository.persist(user)
            CreateUserSuccess(user)
        } catch (e: Exception) {
            CreateUserFailure(e)
        }

这是我的用户实体：

@Entity
data class User (
    @Id
    @GeneratedValue(generator = "UUID")
    var id: UUID? = UUID.randomUUID(),

    @NotBlank
    var fullName: String,

    @Email
    @NotBlank(message = "email may not be blank")
    var email: String,

    @CreationTimestamp
    var createdAt: LocalDateTime? = null,

    @UpdateTimestamp
    var updatedAt: LocalDateTime? = null,
)

为了完整起见，这是我的用户存储库：

@ApplicationScoped
class UserRepository : PanacheRepository<User>

当我确定请求有效时，创建用户确实有效。但我也想确保在无效时有效地处理无效请求。这是我现在在点击创建用户终结点时得到的响应：

com.fasterxml.jackson.databind.exc.ValueInstantiationException: Cannot construct instance of
`com.fortuneapp.backend.application.domain.core.models.entities.User`, problem: Parameter specified as non-null is null:
method com.fortuneapp.backend.application.domain.core.models.entities.User.<init>, parameter email
at [Source: (io.quarkus.vertx.http.runtime.VertxInputStream); line: 3, column: 1]

我在这里错过了什么？

Answer 1

将您的字段设置为可空，初始化它们并将< code>@field:放在注释之前，这样就可以工作了。

@Entity
data class User (
    @Id
    @GeneratedValue(generator = "UUID")
    var id: UUID? = UUID.randomUUID(),

    @field:NotBlank
    var fullName: String = null,

    @field:Email
    @NotBlank(message = "email may not be blank")
    var email: String = null,

    ...

Answer 2

您在属性的可枚举性方面遇到了问题，因为您甚至很难定义var属性，其中一些属性不可为空？因此，由于您正在反序列化json消息，其余服务的输入，Jackson无法创建模型类用户的新实例，因为某些必填字段不存在。

这类似于当您试图创建一个新的对象，但没有在构造函数中提供所需的参数。

这里有一些与kotlin、Jax-RS和Hibernate-Panache一起工作的建议https://quarkus.io/guides/kotlin.

你正在尝试归档它完全可能，但是如果你想使用你的实体作为请求主体，你必须使所有字段为空，否则底层的Json序列化程序将无法创建你的模型的新实例来传递@Valid验证并生成约束冲突报告。

你有一些选择。

1. 您可以创建一个所有属性都可为 null 的 Data 类，这样就可以确保能够检查所有 javax 验证注释，因为请求将能够反序列化。然后，将此对象映射到模型实体类。您可以将此类视为 DTO，因为最后您将通过层边界移动数据，并将服务协定与实体模型实现中的分离，这往往很方便。
2. 尽管使用 javax.validation 约束注释非常方便，但您可以注入一个验证程序并检索约束冲突，并以比默认报告更易读的方式返回具有约束冲突的自定义数据类，默认报告在 resteasy 的反应式版本中不受Quarkus支持。

如果你有更多的疑问，我可以提供一个例子。