如需最新的稳定版本,请使用 Spring Data Neo4j 7.4.0! |
Spring Data Neo4j 投影
如上所述,投影有两种类型:接口投影和基于 DTO 的投影。 在 Spring Data Neo4j 中,两种类型的投影都直接影响要传输的属性和关系 通过电线。 因此,如果您处理的节点和实体包含 许多属性,这些属性可能并非在应用程序的所有使用场景中都是必需的。
对于基于接口和 DTO 的投影,Spring Data Neo4j 将使用存储库的域类型来构建
查询。将考虑可能更改查询的所有属性上的所有注释。
domain type 是通过存储库声明定义的类型
(给定一个声明,例如 domain type 将是 )。interface TestRepository extends CrudRepository<TestEntity, Long>
TestEntity
基于接口的投影将始终是底层域类型的动态代理。定义的访问器的名称
在此类接口 (如 ) 上,必须解析为投影实体上存在的属性 (此处: )。
这些属性在域类型上是否具有访问器并不重要,只要它们可以通过
通用的 Spring Data 基础架构。后者已经得到保证,因为域类型不会是
第一名。getName
name
当与自定义查询一起使用时,基于 DTO 的投影在某种程度上更加灵活。虽然标准查询派生自 原始域类型,因此只能使用在那里定义的属性和关系,自定义查询 可以添加其他属性。
规则如下:首先,域类型的属性用于填充 DTO。如果 DTO 声明
其他属性 - 通过访问器或字段 - Spring Data Neo4j 在结果记录中查找匹配的属性。
属性必须按名称完全匹配,并且可以是简单类型(如 )
或已知的持久实体。这些集合受支持,但地图不支持。org.springframework.data.neo4j.core.convert.Neo4jSimpleTypes
多级投影
Spring Data Neo4j 还支持多级投影。
interface ProjectionWithNestedProjection {
String getName();
List<Subprojection1> getLevel1();
interface Subprojection1 {
String getName();
List<Subprojection2> getLevel2();
}
interface Subprojection2 {
String getName();
}
}
即使可以对循环投影进行建模或指向将创建循环的实体, Projection Logic 不会遵循这些周期,而只会创建无周期的查询。
多级投影受其应投影的实体的约束。 在这种情况下,属于实体类别,如果应用预测,则需要得到尊重。RelationshipProperties
投影的数据操作
如果您已将投影作为 DTO 获取,则可以修改其值。 但是,如果您使用的是基于接口的投影,则不能只更新接口。 可以使用的典型模式是在域实体类中提供一种方法,该方法使用接口并使用从接口复制的值创建域实体。 这样,您就可以更新实体,并使用投影蓝图/掩码再次保留它,如下一节所述。
投影的持久性
与通过投影检索数据类似,它们也可以用作持久性的蓝图。
它提供了一个 Fluent API 来将这些投影应用于保存操作。Neo4jTemplate
您可以保存给定域类的投影
Projection projection = neo4jTemplate.save(DomainClass.class).one(projectionValue);
或者,您可以保存 domain 对象,但只考虑 projection 中定义的字段。
Projection projection = neo4jTemplate.saveAs(domainObject, Projection.class);
在这两种情况下,也可用于基于集合的操作,只有字段和关系 定义将更新。
为了防止删除数据(例如删除关系), 您应该始终至少加载所有稍后应保留的数据。 |
完整示例
给定以下实体、投影和相应的存储库:
@Node
class TestEntity {
@Id @GeneratedValue private Long id;
private String name;
@Property("a_property") (1)
private String aProperty;
}
1 | 此属性在 Graph 中具有不同的名称 |
TestEntity
@Node
class ExtendedTestEntity extends TestEntity {
private String otherAttribute;
}
TestEntity
interface TestEntityInterfaceProjection {
String getName();
}
TestEntity
class TestEntityDTOProjection {
private String name;
private Long numberOfRelations; (1)
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public Long getNumberOfRelations() {
return numberOfRelations;
}
public void setNumberOfRelations(Long numberOfRelations) {
this.numberOfRelations = numberOfRelations;
}
}
1 | 此属性在投影的实体上不存在 |
的存储库如下所示,其行为与清单中所述相同。TestEntity
TestEntity
interface TestRepository extends CrudRepository<TestEntity, Long> { (1)
List<TestEntity> findAll(); (2)
List<ExtendedTestEntity> findAllExtendedEntities(); (3)
List<TestEntityInterfaceProjection> findAllInterfaceProjectionsBy(); (4)
List<TestEntityDTOProjection> findAllDTOProjectionsBy(); (5)
@Query("MATCH (t:TestEntity) - [r:RELATED_TO] -> () RETURN t, COUNT(r) AS numberOfRelations") (6)
List<TestEntityDTOProjection> findAllDTOProjectionsWithCustomQuery();
}
1 | 存储库的域类型为TestEntity |
2 | 返回一个或多个的方法将只返回它的实例,因为它与域类型匹配TestEntity |
3 | 返回扩展域类型的类的一个或多个实例的方法将只返回实例 扩展类。所讨论方法的域类型将是扩展类,该类 仍然满足存储库本身的域类型 |
4 | 该方法返回一个接口投影,因此该方法的返回类型不同
从存储库的 domain type (域类型)。接口只能访问域类型中定义的属性。
需要后缀才能使 SDN 不查找在By InterfaceProjections TestEntity |
5 | 此方法返回 DTO 投影。执行该命令将导致 SDN 发出警告,因为 DTO 将其定义为 additional 属性,该属性不在域类型的协定中。
innotated 属性 in 将在查询中正确转换为 。
如上所述,返回类型与存储库的域类型不同。
需要后缀才能使 SDN 不查找在numberOfRelations aProperty TestEntity a_property By DTOProjections TestEntity |
6 | 此方法还返回 DTO 投影。但是,不会发出警告,因为查询包含配件 值 |