|
此版本仍在开发中，尚不被认为是稳定的。对于最新的稳定版本，请使用 Spring Data Neo4j 7.5.2！ |
基于元数据的映射
要充分利用 SDN 中的对象映射功能，您应该使用@Node注解。
尽管映射框架没有必要具有此注释（即使没有任何注释，您的 POJO 也会正确映射），但它允许类路径扫描程序查找并预处理您的域对象以提取必要的元数据。
如果不使用此注释，则应用程序在首次存储域对象时会略有性能受到影响，因为映射框架需要构建其内部元数据模型，以便它知道域对象的属性以及如何持久化它们。
映射注释概述
来自 SDN
-
@Node：在类级别应用，以指示此类是映射到数据库的候选者。 -
@Id：在字段级别应用以标记用于标识目的的字段。 -
@GeneratedValue：在现场级别与@Id以指定应如何生成唯一标识符。 -
@Property：在字段级别应用，以修改从属性到属性的映射。 -
@CompositeProperty：在字段级别应用于应作为复合读回的 Map 类型的属性。请参阅复合属性。 -
@Relationship：在字段级别应用以指定关系的详细信息。 -
@DynamicLabels：在字段级别应用，以指定动态标签的来源。 -
@RelationshipProperties：在类级别应用，以指示此类作为关系属性的目标。 -
@TargetNode：应用于用@RelationshipProperties从另一端的角度标记该关系的目标。
以下注解用于指定转换并确保与 OGM 向后兼容。
-
@DateLong -
@DateString -
@ConvertWith
有关这方面的更多信息，请参阅转化。
来自 Spring Data commons
-
@org.springframework.data.annotation.Id与@Id事实上，来自 SDN，@Id使用 Spring Data Common 的 Id 注释进行注释。 -
@CreatedBy：在字段级别应用以指示节点的创建者。 -
@CreatedDate：在字段级别应用，以指示节点的创建日期。 -
@LastModifiedBy：在字段级别应用，以指示对节点的最后更改的作者。 -
@LastModifiedDate：在字段级别应用，以指示节点的上次修改日期。 -
@PersistenceCreator：应用于一个构造函数，以在读取实体时将其标记为首选构造函数。 -
@Persistent：在类级别应用，以指示此类是映射到数据库的候选者。 -
@Version：在字段级别应用，用于乐观锁定，并在保存作时检查修改。 初始值为零，每次更新时都会自动增加。 -
@ReadOnlyProperty：在字段级别应用以将属性标记为只读。该属性将在数据库读取期间被水合， 但不受写入的影响。在关系上使用时，请注意，该集合中的任何相关实体都不会被持久化 如果没有其他关系。
查看 审计 有关审计支持的所有注释。
基本构建块：@Node
这@Node注释用于将类标记为托管域类，受制于映射上下文的类路径扫描。
要将 Object 映射到图中的节点，反之亦然，我们需要一个标签来标识要映射到和从中映射的类。
@Node有一个属性labels这允许您配置在读取和写入带注释的类的实例时要使用的一个或多个标签。
这value属性是labels.
如果未指定标签，则将使用简单类名作为主标签。
如果您想提供多个标签，您可以：
-
向
labels财产。 数组中的第一个元素将被视为主标签。 -
为
primaryLabel并将附加标签放入labels.
主标签应始终是反映域类的最具体标签。
对于通过存储库或 Neo4j 模板编写的带注释类的每个实例，将写入图中至少具有主标签的一个节点。 反之亦然，所有具有主标签的节点都将映射到带注释的类的实例。
关于类层次结构的说明
这@Node注释不是从超类型和接口继承的。
但是，您可以在每个继承级别单独注释域类。
这允许多态查询：您可以传入基类或中间类，并为节点检索正确的具体实例。
这仅支持用@Node.
在此类类上定义的标签将与具体实现的标签一起用作附加标签。
我们还支持域类层次结构中的接口，适用于某些场景：
public interface SomeInterface { (1)
String getName();
SomeInterface getRelated();
}
@Node("SomeInterface") (2)
public static class SomeInterfaceEntity implements SomeInterface {
@Id
@GeneratedValue
private Long id;
private final String name;
private SomeInterface related;
public SomeInterfaceEntity(String name) {
this.name = name;
}
@Override
public String getName() {
return name;
}
@Override
public SomeInterface getRelated() {
return related;
}
}| 1 | 只是简单的界面名称，就像您命名域名一样 |
| 2 | 由于我们需要同步主标签，因此我们将@Node在实现类上，其中
可能在另一个模块中。请注意，该值与接口名称完全相同
实现。无法重命名。 |
也可以使用不同的主标签而不是接口名称：
@Node("PrimaryLabelWN") (1)
public interface SomeInterface2 {
String getName();
SomeInterface2 getRelated();
}
public static class SomeInterfaceEntity2 implements SomeInterface2 {
// Overrides omitted for brevity
}| 1 | 将@Node接口上的注释 |
也可以使用接口的不同实现并具有多态域模型。 这样做时，至少需要两个标签：一个标签用于确定接口，一个标签用于确定具体类：
@Node("SomeInterface3") (1)
public interface SomeInterface3 {
String getName();
SomeInterface3 getRelated();
}
@Node("SomeInterface3a") (2)
public static class SomeInterfaceImpl3a implements SomeInterface3 {
// Overrides omitted for brevity
}
@Node("SomeInterface3b") (3)
public static class SomeInterfaceImpl3b implements SomeInterface3 {
// Overrides omitted for brevity
}
@Node
public static class ParentModel { (4)
@Id
@GeneratedValue
private Long id;
private SomeInterface3 related1; (5)
private SomeInterface3 related2;
}| 1 | 在此方案中，需要显式指定标识接口的标签 |
| 2 | 这适用于第一个... |
| 3 | 以及第二次实施 |
| 4 | 这是一个客户端或父模型，使用SomeInterface3透明地为两个关系 |
| 5 | 未指定具体类型 |
所需的数据结构如以下测试所示。OGM 也会写同样的内容：
Long id;
try (Session session = driver.session(bookmarkCapture.createSessionConfig()); Transaction transaction = session.beginTransaction()) {
id = transaction.run("" +
"CREATE (s:ParentModel{name:'s'}) " +
"CREATE (s)-[:RELATED_1]-> (:SomeInterface3:SomeInterface3b {name:'3b'}) " +
"CREATE (s)-[:RELATED_2]-> (:SomeInterface3:SomeInterface3a {name:'3a'}) " +
"RETURN id(s)")
.single().get(0).asLong();
transaction.commit();
}
Optional<Inheritance.ParentModel> optionalParentModel = transactionTemplate.execute(tx ->
template.findById(id, Inheritance.ParentModel.class));
assertThat(optionalParentModel).hasValueSatisfying(v -> {
assertThat(v.getName()).isEqualTo("s");
assertThat(v).extracting(Inheritance.ParentModel::getRelated1)
.isInstanceOf(Inheritance.SomeInterfaceImpl3b.class)
.extracting(Inheritance.SomeInterface3::getName)
.isEqualTo("3b");
assertThat(v).extracting(Inheritance.ParentModel::getRelated2)
.isInstanceOf(Inheritance.SomeInterfaceImpl3a.class)
.extracting(Inheritance.SomeInterface3::getName)
.isEqualTo("3a");
});| 接口无法定义标识符字段。 因此，它们不是存储库的有效实体类型。 |
动态或“运行时”托管标签
通过简单类名隐式定义的所有标签，或通过@Node注释是静态的。
它们无法在运行时更改。
如果您需要可以在运行时作的其他标签，您可以使用@DynamicLabels.@DynamicLabels是字段级别的注释，并标记类型为java.util.Collection<String>（一个List或Set） 作为动态标签的来源。
如果存在此注释，则所有标签都存在于节点上，并且不会通过@Node和类名，将在加载期间收集到该集合中。
在写入期间，节点的所有标签都将替换为静态定义的标签以及集合的内容。
如果让其他应用程序向节点添加其他标签，请不要使用@DynamicLabels.
如果@DynamicLabels存在于托管实体上，则生成的标签集将是写入数据库的“真相”。 |
识别实例：@Id
而@Node在类和具有特定标签的节点之间创建映射，我们还需要在该类（对象）的各个实例和节点的实例之间建立连接。
这是哪里@Id发挥作用。@Id将类的属性标记为对象的唯一标识符。
在最佳世界中，该唯一标识符是唯一的业务密钥，或者换句话说，是自然密钥。@Id可用于具有受支持简单类型的所有属性。
然而，天然钥匙很难找到。 例如，人名很少是唯一的，会随着时间的推移而变化，或者更糟的是，并不是每个人都有名字和姓氏。
因此，我们支持两种不同类型的代理密钥。
在类型String,long或Long,@Id可与@GeneratedValue.Long和long映射到 Neo4j 内部 ID。String映射到 Neo4j 5 以来可用的 elementId。
两者都不是节点或关系上的属性，通常对属性不可见，并允许 SDN 检索类的各个实例。
@GeneratedValue提供属性generatorClass.generatorClass可用于指定实现的类IdGenerator.
一IdGenerator是一个功能接口，其generateId采用主标签和实例来生成 Id。
我们支持UUIDStringGenerator作为一种开箱即用的实现。
您还可以从应用程序上下文中指定 Spring Bean@GeneratedValue通过generatorRef.
那个 bean 还需要实现IdGenerator，但可以利用上下文中的所有内容，包括 Neo4j 客户端或模板与数据库交互。
| 不要跳过处理和配置唯一 ID 中有关 ID 处理的重要说明 |
乐观锁定：@Version
Spring Data Neo4j 通过使用@Version注释Longtyped 字段。此属性将在更新期间自动递增，不得手动修改。
例如，如果不同线程中的两个事务想要修改具有 version 的同一对象x，第一个作将成功持久化到数据库。此时，版本字段将递增，因此它是x+1. 第二个作将失败，并显示OptimisticLockingFailureException因为它想用版本修改对象x数据库中不再存在。在这种情况下，需要重试作，从从数据库中重新获取具有当前版本的对象开始。
这@Version如果使用业务 ID，属性也是必需的。
Spring Data Neo4j 将检查此字段以确定该实体是新的还是之前已经持久化。
映射属性：@Property
的所有属性@Node-annotated 类将作为 Neo4j 节点和关系的属性持久化。
无需进一步配置，Java 或 Kotlin 类中的属性名称将用作 Neo4j 属性。
如果您正在使用现有的 Neo4j 模式，或者只是想根据您的需求调整映射，您将需要使用@Property.
这name用于指定数据库内属性的名称。
连接节点：@Relationship
这@Relationship注释可用于所有非简单类型的属性。
它适用于用@Node或其藏品和地图。
这type或value属性允许配置关系类型，direction允许指定方向。
SDN 中的默认方向是Relationship.Direction#OUTGOING.
我们支持动态关系。
动态关系表示为Map<String, AnnotatedDomainClass>或Map<Enum, AnnotatedDomainClass>.
在这种情况下，与其他域类的关系类型由 maps 键给出，不得通过@Relationship.
映射关系属性
Neo4j 不仅支持在节点上定义属性，还支持在关系上定义属性。
为了在模型中表达这些属性，SDN 提供了@RelationshipProperties应用于简单的 Java 类。
在 properties 类中，必须只有一个字段标记为@TargetNode以定义关系指向的实体。
或者，在INCOMING关系背景，来自。
关系属性类及其用法可能如下所示：
Roles@RelationshipProperties
public class Roles {
@RelationshipId
private Long id;
private final List<String> roles;
@TargetNode
private final PersonEntity person;
public Roles(PersonEntity person, List<String> roles) {
this.person = person;
this.roles = roles;
}
public List<String> getRoles() {
return roles;
}
@Override
public String toString() {
return "Roles{" +
"id=" + id +
'}' + this.hashCode();
}
}必须为生成的内部 ID （@RelationshipId），以便 SDN 可以在保存期间确定哪些关系可以安全地覆盖而不会丢失属性。如果 SDN 找不到用于存储内部节点 ID 的字段，则在启动期间将失败。
@Relationship(type = "ACTED_IN", direction = Direction.INCOMING) (1)
private List<Roles> actorsAndRoles = new ArrayList<>();一个完整的例子
将所有这些放在一起，我们可以创建一个简单的域。 我们使用不同角色的电影和人物：
MovieEntityimport java.util.ArrayList;
import java.util.List;
import org.springframework.data.neo4j.core.schema.Id;
import org.springframework.data.neo4j.core.schema.Node;
import org.springframework.data.neo4j.core.schema.Property;
import org.springframework.data.neo4j.core.schema.Relationship;
import org.springframework.data.neo4j.core.schema.Relationship.Direction;
@Node("Movie") (1)
public class MovieEntity {
@Id (2)
private final String title;
@Property("tagline") (3)
private final String description;
@Relationship(type = "ACTED_IN", direction = Direction.INCOMING) (4)
private List<Roles> actorsAndRoles = new ArrayList<>();
@Relationship(type = "DIRECTED", direction = Direction.INCOMING)
private List<PersonEntity> directors = new ArrayList<>();
public MovieEntity(String title, String description) { (5)
this.title = title;
this.description = description;
}
// Getters omitted for brevity
}| 1 | @Node用于将此类标记为托管实体。
它还用于配置 Neo4j 标签。
如果只使用 plain@Node. |
| 2 | 每个实体都必须有一个 ID。 我们使用电影名称作为唯一标识符。 |
| 3 | 这表明@Property作为对字段使用与图形属性不同的名称的一种方式。 |
| 4 | 这配置了与一个人的传入关系。 |
| 5 | 这是应用程序代码和 SDN 要使用的构造函数。 |
人们在这里被映射为两个角色，actors和directors.
域类是相同的：
PersonEntityimport org.springframework.data.neo4j.core.schema.Id;
import org.springframework.data.neo4j.core.schema.Node;
@Node("Person")
public class PersonEntity {
@Id private final String name;
private final Integer born;
public PersonEntity(Integer born, String name) {
this.born = born;
this.name = name;
}
public Integer getBorn() {
return born;
}
public String getName() {
return name;
}
}我们还没有双向模拟电影和人之间的关系。
为什么？
我们看到MovieEntity作为聚合根，拥有关系。
另一方面，我们希望能够从数据库中提取所有人，而无需选择与他们关联的所有电影。
在尝试从各个方向映射数据库中的每个关系之前，请考虑应用程序的用例。
虽然您可以这样做，但您最终可能会在对象图中重建图形数据库，这不是映射框架的目的。
如果您必须对圆形或双向域进行建模，并且不想获取整个图，
您可以使用投影定义要获取的数据的细粒度描述。 |