自定义查询
Spring Data Neo4j，与所有其他 Spring Data 模块一样，允许您在存储库中指定自定义查询。如果您无法通过派生查询函数表达查找器逻辑，则这些查询非常有用。
由于 Spring Data Neo4j 在底层大量使用面向记录的方式，因此务必牢记这一点，不要为同一个“根节点”构建包含多个记录的结果集。
| 请参阅常见问题解答，了解从存储库中使用自定义查询的其他形式，尤其是如何将自定义查询与自定义映射一起使用： 自定义查询和自定义映射。 |
具有关系的查询
注意笛卡尔积
假设您有一个类似于 MATCH (m:Movie{title: 'The Matrix'})←[r:ACTED_IN]-(p:Person) return m,r,p 的查询，其结果如下所示
+------------------------------------------------------------------------------------------+
| m | r | p |
+------------------------------------------------------------------------------------------+
| (:Movie) | [:ACTED_IN {roles: ["Emil"]}] | (:Person {name: "Emil Eifrem"}) |
| (:Movie) | [:ACTED_IN {roles: ["Agent Smith"]}] | (:Person {name: "Hugo Weaving}) |
| (:Movie) | [:ACTED_IN {roles: ["Morpheus"]}] | (:Person {name: "Laurence Fishburne"}) |
| (:Movie) | [:ACTED_IN {roles: ["Trinity"]}] | (:Person {name: "Carrie-Anne Moss"}) |
| (:Movie) | [:ACTED_IN {roles: ["Neo"]}] | (:Person {name: "Keanu Reeves"}) |
+------------------------------------------------------------------------------------------+
映射结果很可能无法使用。如果将其映射到列表中，则将包含 Movie 的重复项，但这部电影只有一个关系。
获取每个根节点的一条记录
要获取正确的对象，需要在查询中收集关系和相关节点：MATCH (m:Movie{title: 'The Matrix'})←[r:ACTED_IN]-(p:Person) return m,collect(r),collect(p)
+------------------------------------------------------------------------+ | m | collect(r) | collect(p) | +------------------------------------------------------------------------+ | (:Movie) | [[:ACTED_IN], [:ACTED_IN], ...]| [(:Person), (:Person),...] | +------------------------------------------------------------------------+
使用此结果作为单条记录，Spring Data Neo4j 可以将所有相关节点正确添加到根节点。
深入图结构
上面的示例假设您只尝试获取相关节点的第一层。有时这还不够，图结构中可能还有更深的节点也应该成为映射实例的一部分。有两种方法可以实现这一点：数据库端或客户端端缩减。
为此，上面示例还应包含与初始 Movie 一起返回的 Persons 上的 Movies。
数据库端缩减
请记住，Spring Data Neo4j 只能正确处理基于记录的数据，因此一个实体实例的结果需要位于一条记录中。使用 Cypher 的路径 功能是获取图结构中所有分支的有效选项。
MATCH p=(m:Movie{title: 'The Matrix'})<-[:ACTED_IN]-(:Person)-[:ACTED_IN*..0]->(:Movie)
RETURN p;这将导致多条路径，这些路径不会合并到一条记录中。可以调用 collect(p)，但 Spring Data Neo4j 不理解映射过程中路径的概念。因此，需要提取结果中的节点和关系。
MATCH p=(m:Movie{title: 'The Matrix'})<-[:ACTED_IN]-(:Person)-[:ACTED_IN*..0]->(:Movie)
RETURN m, nodes(p), relationships(p);由于有多条路径从“黑客帝国”到另一部电影，因此结果仍然不是单条记录。此时，Cypher 的 reduce 函数 就派上用场了。
MATCH p=(m:Movie{title: 'The Matrix'})<-[:ACTED_IN]-(:Person)-[:ACTED_IN*..0]->(:Movie)
WITH collect(p) as paths, m
WITH m,
reduce(a=[], node in reduce(b=[], c in [aa in paths | nodes(aa)] | b + c) | case when node in a then a else a + node end) as nodes,
reduce(d=[], relationship in reduce(e=[], f in [dd in paths | relationships(dd)] | e + f) | case when relationship in d then d else d + relationship end) as relationships
RETURN m, relationships, nodes;reduce 函数允许我们展平来自不同路径的节点和关系。结果，我们将获得一个类似于 获取每个根节点的一条记录 的元组，但集合中包含关系类型或节点的混合。
客户端端缩减
如果缩减应在客户端端进行，则 Spring Data Neo4j 使您能够映射关系或节点的列表的列表。但仍然适用以下要求：返回的记录应包含所有信息，以便正确地水化生成的实体实例。
MATCH p=(m:Movie{title: 'The Matrix'})<-[:ACTED_IN]-(:Person)-[:ACTED_IN*..0]->(:Movie)
RETURN m, collect(nodes(p)), collect(relationships(p));额外的 collect 语句创建如下格式的列表
[[rel1, rel2], [rel3, rel4]]
在映射过程中，这些列表将转换为扁平列表。
决定是使用客户端端缩减还是数据库端缩减取决于将生成的数据量。使用 reduce 函数时，首先需要在数据库的内存中创建所有路径。另一方面，需要在客户端端合并的大量数据会导致客户端端的内存使用量更高。 |
使用路径填充和返回实体列表
给定一个如下所示的图结构
以及如 映射 所示的域模型（为简洁起见，已省略构造函数和访问器）
@Node
public class SomeEntity {
@Id
private final Long number;
private String name;
@Relationship(type = "SOME_RELATION_TO", direction = Relationship.Direction.OUTGOING)
private Set<SomeRelation> someRelationsOut = new HashSet<>();
}
@RelationshipProperties
public class SomeRelation {
@RelationshipId
private Long id;
private String someData;
@TargetNode
private SomeEntity targetPerson;
}如您所见，关系仅为传出关系。生成的查找器方法（包括 findById）将始终尝试匹配要映射的根节点。从那里开始，将映射所有相关对象。在应仅返回一个对象的查询中，将返回该根对象。在返回多个对象的查询中，将返回所有匹配的对象。当然，这些返回对象的传出和传入关系也会被填充。
假设以下 Cypher 查询
MATCH p = (leaf:SomeEntity {number: $a})-[:SOME_RELATION_TO*]-(:SomeEntity)
RETURN leaf, collect(nodes(p)), collect(relationships(p))它遵循来自每个根节点获取一条记录的建议，并且对于您想要在此处匹配的叶子节点非常有效。但是：这只在所有返回 0 或 1 个映射对象的情况中才适用。虽然该查询将像以前一样填充所有关系，但它不会返回所有 4 个对象。
可以通过返回整个路径来更改此行为。
MATCH p = (leaf:SomeEntity {number: $a})-[:SOME_RELATION_TO*]-(:SomeEntity)
RETURN p在这里，我们确实想利用路径p实际上返回 3 行包含所有 4 个节点路径的事实。所有 4 个节点都将被填充、链接在一起并返回。
自定义查询中的参数
这与在 Neo4j 浏览器或 Cypher-Shell 中发出的标准 Cypher 查询中的方式完全相同，使用$语法（从 Neo4j 4.0 开始，Cypher 参数的旧${foo}语法已从数据库中删除）。
public interface ARepository extends Neo4jRepository<AnAggregateRoot, String> {
@Query("MATCH (a:AnAggregateRoot {name: $name}) RETURN a") (1)
Optional<AnAggregateRoot> findByCustomQuery(String name);
}| 1 | 在这里，我们通过其名称引用参数。您也可以使用$0等代替。 |
您需要使用-parameters编译您的 Java 8+ 项目才能使命名参数在没有其他注释的情况下工作。Spring Boot Maven 和 Gradle 插件会自动为您执行此操作。如果由于任何原因这不可行，您可以添加@Param并显式指定名称，或者使用参数索引。 |
作为参数传递给用自定义查询注释的函数的映射实体（所有带有@Node的实体）将转换为嵌套映射。以下示例表示 Neo4j 参数的结构。
给定的是Movie、Vertex和Actor类，如电影模型中所示进行注释。
@Node
public final class Movie {
@Id
private final String title;
@Property("tagline")
private final String description;
@Relationship(value = "ACTED_IN", direction = Direction.INCOMING)
private final List<Actor> actors;
@Relationship(value = "DIRECTED", direction = Direction.INCOMING)
private final List<Person> directors;
}
@Node
public final class Person {
@Id @GeneratedValue
private final Long id;
private final String name;
private Integer born;
@Relationship("REVIEWED")
private List<Movie> reviewed = new ArrayList<>();
}
@RelationshipProperties
public final class Actor {
@RelationshipId
private final Long id;
@TargetNode
private final Person person;
private final List<String> roles;
}
interface MovieRepository extends Neo4jRepository<Movie, String> {
@Query("MATCH (m:Movie {title: $movie.__id__})\n"
+ "MATCH (m) <- [r:DIRECTED|REVIEWED|ACTED_IN] - (p:Person)\n"
+ "return m, collect(r), collect(p)")
Movie findByMovie(@Param("movie") Movie movie);
}将Movie的实例传递给上面的存储库方法，将生成以下 Neo4j 映射参数
{
"movie": {
"__labels__": [
"Movie"
],
"__id__": "The Da Vinci Code",
"__properties__": {
"ACTED_IN": [
{
"__properties__": {
"roles": [
"Sophie Neveu"
]
},
"__target__": {
"__labels__": [
"Person"
],
"__id__": 402,
"__properties__": {
"name": "Audrey Tautou",
"born": 1976
}
}
},
{
"__properties__": {
"roles": [
"Sir Leight Teabing"
]
},
"__target__": {
"__labels__": [
"Person"
],
"__id__": 401,
"__properties__": {
"name": "Ian McKellen",
"born": 1939
}
}
},
{
"__properties__": {
"roles": [
"Dr. Robert Langdon"
]
},
"__target__": {
"__labels__": [
"Person"
],
"__id__": 360,
"__properties__": {
"name": "Tom Hanks",
"born": 1956
}
}
},
{
"__properties__": {
"roles": [
"Silas"
]
},
"__target__": {
"__labels__": [
"Person"
],
"__id__": 403,
"__properties__": {
"name": "Paul Bettany",
"born": 1971
}
}
}
],
"DIRECTED": [
{
"__labels__": [
"Person"
],
"__id__": 404,
"__properties__": {
"name": "Ron Howard",
"born": 1954
}
}
],
"tagline": "Break The Codes",
"released": 2006
}
}
}节点由映射表示。映射始终包含id，它是映射的 id 属性。在labels下，所有标签（静态和动态）都可用。所有属性 - 和关系类型 - 都以这些映射中出现的方式出现，就像实体由 SDN 写入图时一样。值将具有正确的 Cypher 类型，不需要进一步转换。
所有关系都是映射列表。动态关系将相应地解析。一对一关系也将序列化为单例列表。因此，要访问人员之间的一对一映射，您可以将其编写为$person.__properties__.BEST_FRIEND[0].__target__.__id__。 |
如果一个实体与不同类型的其他节点具有相同类型的关系，它们都将出现在同一个列表中。如果您需要这样的映射并且还需要使用这些自定义参数，则必须相应地展开它。一种方法是相关子查询（需要 Neo4j 4.1+）。
自定义查询中的值表达式
自定义查询中的 Spring 表达式语言
Spring 表达式语言 (SpEL) 可用于:#{}内的自定义查询中。此处的冒号指的是一个参数，并且此类表达式应在参数有意义的地方使用。但是，当使用我们的字面量扩展时，您可以在标准 Cypher 不允许参数的地方使用 SpEL 表达式（例如标签或关系类型）。这是定义查询内文本块的标准 Spring Data 方式，该文本块会进行 SpEL 评估。
以下示例基本上定义了与上面相同的查询，但使用WHERE子句来避免更多的大括号。
public interface ARepository extends Neo4jRepository<AnAggregateRoot, String> {
@Query("MATCH (a:AnAggregateRoot) WHERE a.name = :#{#pt1 + #pt2} RETURN a")
Optional<AnAggregateRoot> findByCustomQueryWithSpEL(String pt1, String pt2);
}SpEL 块以:#{开头，然后按名称（#pt1）引用给定的String参数。不要将其与上面的 Cypher 语法混淆！SpEL 表达式将两个参数连接成一个值，该值最终传递给附录/neo4j-client.adoc#neo4j-client。SpEL 块以}结尾。
SpEL 还解决了另外两个问题。我们提供了两个扩展，允许将Sort对象传递到自定义查询中。还记得faq.adoc#custom-queries-with-page-and-slice-examples来自自定义查询吗？使用orderBy扩展，您可以将具有动态排序的Pageable传递到自定义查询中。
import org.springframework.data.domain.Pageable;
import org.springframework.data.domain.Sort;
import org.springframework.data.neo4j.repository.Neo4jRepository;
import org.springframework.data.neo4j.repository.query.Query;
public interface MyPersonRepository extends Neo4jRepository<Person, Long> {
@Query(""
+ "MATCH (n:Person) WHERE n.name = $name RETURN n "
+ ":#{orderBy(#pageable)} SKIP $skip LIMIT $limit" (1)
)
Slice<Person> findSliceByName(String name, Pageable pageable);
@Query(""
+ "MATCH (n:Person) WHERE n.name = $name RETURN n :#{orderBy(#sort)}" (2)
)
List<Person> findAllByName(String name, Sort sort);
}| 1 | Pageable在 SpEL 上下文中始终具有名称pageable。 |
| 2 | Sort在 SpEL 上下文中始终具有名称sort。 |
Spring 表达式语言扩展
字面量扩展
literal扩展可用于使自定义查询中的标签或关系类型“动态”。Cypher 中既不能参数化标签也不能参数化关系类型，因此必须给出字面量。
interface BaseClassRepository extends Neo4jRepository<Inheritance.BaseClass, Long> {
@Query("MATCH (n:`:#{literal(#label)}`) RETURN n") (1)
List<Inheritance.BaseClass> findByLabel(String label);
}| 1 | literal扩展将被评估参数的字面量值替换。 |
在这里，literal值已用于动态匹配标签。如果将SomeLabel作为参数传递给该方法，则将生成MATCH (n:。已添加引号以正确转义值。SDN 不会为您执行此操作，因为这可能不是您在所有情况下都想要的操作。SomeLabel) RETURN n
列表扩展
对于多个值，可以使用allOf和anyOf，它们将呈现所有值的&或|连接列表。
interface BaseClassRepository extends Neo4jRepository<Inheritance.BaseClass, Long> {
@Query("MATCH (n:`:#{allOf(#label)}`) RETURN n")
List<Inheritance.BaseClass> findByLabels(List<String> labels);
@Query("MATCH (n:`:#{anyOf(#label)}`) RETURN n")
List<Inheritance.BaseClass> findByLabels(List<String> labels);
}引用标签
您已经知道如何将节点映射到域对象。
@Node(primaryLabel = "Bike", labels = {"Gravel", "Easy Trail"})
public class BikeNode {
@Id String id;
String name;
}此节点具有几个标签，并且在自定义查询中一直重复它们可能会容易出错：您可能会忘记一个或拼写错误。我们提供以下表达式来缓解这种情况：#{#staticLabels}。请注意，此表达式不以冒号开头！您可以在用@Query注释的存储库方法上使用它。
#{#staticLabels}在行动中public interface BikeRepository extends Neo4jRepository<Bike, String> {
@Query("MATCH (n:#{#staticLabels}) WHERE n.id = $nameOrId OR n.name = $nameOrId RETURN n")
Optional<Bike> findByNameOrId(@Param("nameOrId") String nameOrId);
}此查询将解析为
MATCH (n:`Bike`:`Gravel`:`Easy Trail`) WHERE n.id = $nameOrId OR n.name = $nameOrId RETURN n请注意我们如何使用标准参数来表示nameOrId：在大多数情况下，无需在此处添加 SpEL 表达式来使事情复杂化。
