使用 Spring Data JPA“通过示例查询”的 Kotlin 模式

Question

Spring Data JPA 引入了一个不错的功能，"query by example" (QBE)。您可以通过构造实体的实例来表达您的搜索条件。

您不必编写 JPQL。它比repository query derivation 使用更少的“魔法”。语法很好。它可以防止琐碎的存储库代码爆炸。它可以很好地经受重构。

但有一个问题：QBE 仅在您可以部分构造一个对象时才有效。

这是我的实体：

@Entity
@Table(name="product")
data class Product(
        @Id val id: String,
        val city: String,
        val shopName: String,
        val productName: String,
        val productVersion: Short
)

这是我的存储库（空！这是 QBE 的一个好东西）：

@Repository
interface ProductRepository : JpaRepository<Product, String>

以下是获取List<Product> 的方法——在某个城市的某个商店出售的所有产品：

productRepository.findAll(Example.of(Product(city = "London", shopName="OkayTea")))

或者至少，这是我想要做的。有问题。 不可能构造这个对象：

Product(city = "London", shopName="OkayTea")

这是因为Product 的构造函数要求所有 定义它的字段。确实：这就是我大部分时间想要的。

Java 中通常的折衷方案是：使用无参数构造函数构造实体，使所有内容可变，不保证完整性。

有没有很好的 Kotlin 模式来解决这个问题：

• 一般要求所有参数都在构造时实例化
• 提供还一些机制来生成部分构造的实例以与示例 API 一起使用

诚然，这些看起来完全是相互矛盾的目标。但也许还有另一种方法可以解决这个问题？

例如：也许我们可以制作一个模拟/代理对象，它看起来是一个产品，但没有相同的构造约束？

Answer 1

您可以使用带有非空字段的 kotlin 数据类进行示例查询，但它看起来不如 java 代码。

val matcher = ExampleMatcher.matching()
    .withMatcher("city", ExampleMatcher.GenericPropertyMatcher().exact())
    .withMatcher("shopName", ExampleMatcher.GenericPropertyMatcher().exact())
    .withIgnorePaths("id", "productName", "productVersion")

val product = Product(
    id = "",
    city = "London",
    shopName = "OkayTea",
    productName = "",
    productVersion = 0
)

productRepository.findAll(Example.of(product, matcher))

如果您将它用于集成测试，并且您不想使用仅在所述测试中使用的方法污染您的Repository 接口，并且 您在数据库实体类中有很多字段，您可以创建一个扩展函数来提取将在查询中忽略的字段。

private fun <T : Any> KClass<T>.ignoredProperties(vararg exclusions: String): Array<String> {
    return declaredMemberProperties
        .filterNot { exclusions.contains(it.name) }
        .map { it.name }
        .toTypedArray()
}

并像这样使用它：

val ignoredFields = Product::class.ignoredProperties("city", "shopName")

val matcher = ExampleMatcher.matching()
    .withMatcher("city", ExampleMatcher.GenericPropertyMatcher().exact())
    .withMatcher("shopName", ExampleMatcher.GenericPropertyMatcher().exact())
    .withIgnorePaths(*ignoredFields)

Answer 2

因为主构造函数的参数不是可选的，也不能为空。您可以使参数为空并为每个参数设置一个默认值null，例如：

@Entity
@Table(name = "product")
data class Product(
        @Id val id: String? = null,
        val city: String? = null,
        val shopName: String? = null,
        val productName: String? = null,
        val productVersion: Short? = null
)

但是，您必须使用安全调用?. 操作Product 属性，例如：

val product = Product()

//                   safe-call ---v
val cityToLowerCase = product.city?.toLowerCase()