如需最新的稳定版本,请使用 Spring Data Neo4j 7.4.0! |
Spring Data Neo4j 扩展
Spring Data Neo4j 存储库的可用扩展
Spring Data Neo4j 提供了几个可以添加到存储库中的扩展或 “mixin”。什么是 mixin?根据 Wikipedia 的说法,mixins 是一种语言概念,它允许程序员注入一些代码 放入一个类中。Mixin 编程是一种软件开发风格,其中功能单元是在类中创建的 然后与其他类混在一起。
Java 在语言层面上不支持这个概念,但我们确实通过几个接口和一个运行时来模拟它 这为 .
默认情况下添加的 Mixin 分别为 和 。这些接口是
在 Query by Example 中有详细说明。QueryByExampleExecutor
ReactiveQueryByExampleExecutor
提供的其他 mixin 包括:
-
QuerydslPredicateExecutor
-
CypherdslConditionExecutor
-
CypherdslStatementExecutor
-
ReactiveQuerydslPredicateExecutor
-
ReactiveCypherdslConditionExecutor
-
ReactiveCypherdslStatementExecutor
向生成的查询添加动态条件
和 都提供了相同的概念:SDN 生成查询,您
提供将添加的 “predicates” (Query DSL) 或 “conditions” (Cypher DSL)。我们推荐使用 Cypher DSL,因为它是
SDN 原生使用的内容。您甚至可能要考虑使用生成
为您提供一个静态元模型。QuerydslPredicateExecutor
CypherdslConditionExecutor
这是如何运作的?如上所述声明您的存储库,并添加以下接口之一:
interface QueryDSLPersonRepository extends
Neo4jRepository<Person, Long>, (1)
QuerydslPredicateExecutor<Person> { (2)
}
1 | 标准存储库声明 |
2 | 查询 DSL 混音 |
或
import org.springframework.data.neo4j.repository.Neo4jRepository;
import org.springframework.data.neo4j.repository.support.CypherdslConditionExecutor;
interface PersonRepository extends
Neo4jRepository<Person, Long>, (1)
CypherdslConditionExecutor<Person> { (2)
}
1 | 标准存储库声明 |
2 | Cypher DSL 混入 |
Cypher DSL 条件执行程序显示了示例用法:
Node person = Cypher.node("Person").named("person"); (1)
Property firstName = person.property("firstName"); (2)
Property lastName = person.property("lastName");
assertThat(
repository.findAll(
firstName.eq(Cypher.anonParameter("Helge"))
.or(lastName.eq(Cypher.parameter("someName", "B."))), (3)
lastName.descending() (4)
))
.extracting(Person::getFirstName)
.containsExactly("Helge", "Bela");
1 | 定义一个命名对象,以查询的根为目标Node |
2 | 从中派生一些属性 |
3 | 创建条件。匿名参数用于名字,命名参数用于
姓氏。这就是在这些片段中定义参数的方式,也是相对于 Query-DSL 的优势之一
mixin 无法做到这一点。
文本可以用 .or Cypher.literalOf |
4 | 定义 from 其中一个属性SortItem |
Query-DSL mixin 的代码看起来非常相似。Query-DSL mixin 的原因可能是 API 的熟悉度和 它也与其他商店合作。反对它的原因是您在 class path 上需要一个额外的库, 它缺少对遍历关系的支持,以及上述事实,即它不支持其 谓词(从技术上讲确实如此,但没有 API 方法可以将它们实际传递给正在执行的查询)。
对实体和投影使用(动态)Cypher-DSL 语句
添加相应的 mixin 与使用条件 excecutor 没有什么不同:
interface PersonRepository extends
Neo4jRepository<Person, Long>,
CypherdslStatementExecutor<Person> {
}
请在扩展 时使用 。ReactiveCypherdslStatementExecutor
ReactiveNeo4jRepository
带有 和 的几个重载。他们都采用 Cypher-DSL
语句分别将其持续定义为第一个参数,在投影方法的情况下,则为类型。CypherdslStatementExecutor
findOne
findAll
如果查询需要参数,则必须通过 Cypher-DSL 本身定义它们,并由它填充,如下面的清单所示:
static Statement whoHasFirstNameWithAddress(String name) { (1)
Node p = Cypher.node("Person").named("p"); (2)
Node a = Cypher.anyNode("a");
Relationship r = p.relationshipTo(a, "LIVES_AT");
return Cypher.match(r)
.where(p.property("firstName").isEqualTo(Cypher.anonParameter(name))) (3)
.returning(
p.getRequiredSymbolicName(),
Cypher.collect(r),
Cypher.collect(a)
)
.build();
}
@Test
void fineOneShouldWork(@Autowired PersonRepository repository) {
Optional<Person> result = repository.findOne(whoHasFirstNameWithAddress("Helge")); (4)
assertThat(result).hasValueSatisfying(namesOnly -> {
assertThat(namesOnly.getFirstName()).isEqualTo("Helge");
assertThat(namesOnly.getLastName()).isEqualTo("Schneider");
assertThat(namesOnly.getAddress()).extracting(Person.Address::getCity)
.isEqualTo("Mülheim an der Ruhr");
});
}
@Test
void fineOneProjectedShouldWork(@Autowired PersonRepository repository) {
Optional<NamesOnly> result = repository.findOne(
whoHasFirstNameWithAddress("Helge"),
NamesOnly.class (5)
);
assertThat(result).hasValueSatisfying(namesOnly -> {
assertThat(namesOnly.getFirstName()).isEqualTo("Helge");
assertThat(namesOnly.getLastName()).isEqualTo("Schneider");
assertThat(namesOnly.getFullName()).isEqualTo("Helge Schneider");
});
}
1 | 动态查询是在 helper 方法中以类型安全的方式构建的 |
2 | 我们已经在这里看到了这一点,其中我们还定义了一些保存模型的变量 |
3 | 我们定义了一个匿名参数,由实际值填充 ,该参数已传递给方法name |
4 | 从 helper 方法返回的语句用于查找实体 |
5 | 或者一个投影。 |
方法类似。
命令式 Cypher-DSL 语句执行程序还提供了一个返回分页结果的重载。findAll