此版本仍在开发中，尚未被视为稳定版本。如需最新的稳定版本，请使用 Spring Data Neo4j 7.4.0！spring-doc.cn

Spring Data 对象映射基础知识

本节介绍了 Spring Data 对象映射、对象创建、字段和属性访问、可变性和不可变性的基础知识。spring-doc.cn

Spring Data 对象映射的核心职责是创建域对象的实例并将存储原生数据结构映射到这些实例上。 这意味着我们需要两个基本步骤：spring-doc.cn

  1. 使用公开的构造函数之一创建实例。spring-doc.cn

  2. 实例填充 实现所有公开的属性。spring-doc.cn

对象创建

Spring Data 会自动尝试检测用于具体化该类型对象的持久实体的构造函数。 解析算法的工作原理如下：spring-doc.cn

  1. 如果存在无参数构造函数，则将使用它。 其他构造函数将被忽略。spring-doc.cn

  2. 如果只有一个采用参数的构造函数，则将使用它。spring-doc.cn

  3. 如果有多个构造函数采用参数，则 Spring Data 要使用的构造函数必须用 Comments 进行注释。@PersistenceCreatorspring-doc.cn

值解析假定构造函数参数名称与实体的属性名称匹配，即解析将像要填充属性一样执行，包括映射中的所有自定义项（不同的数据存储列或字段名称等）。 这还需要类文件中可用的参数名称信息或构造函数上存在的 Comments。@ConstructorPropertiesspring-doc.cn

对象创建内部

为了避免反射的开销， Spring Data 对象创建默认使用在运行时生成的工厂类，该类将直接调用域类构造函数。 例如，对于此示例类型：spring-doc.cn

class Person {
  Person(String firstname, String lastname) { … }
}

我们将在运行时创建一个语义上等同于此的工厂类：spring-doc.cn

class PersonObjectInstantiator implements ObjectInstantiator {

  Object newInstance(Object... args) {
    return new Person((String) args[0], (String) args[1]);
  }
}

这为我们提供了比反射大约 10% 的性能提升。 要使 domain 类有资格进行此类优化，它需要遵守一组约束：spring-doc.cn

如果这些条件中的任何一个匹配，Spring Data 将通过反射回退到实体实例化。spring-doc.cn

物业人口

创建实体的实例后， Spring Data 将填充该类的所有剩余持久属性。 除非已由实体的构造函数填充（即通过其构造函数参数列表使用），否则将首先填充 identifier 属性以允许解析循环对象引用。 之后，将在实体实例上设置尚未由构造函数填充的所有非临时属性。 为此，我们使用以下算法：spring-doc.cn

  1. 如果该属性是不可变的，但公开了一个 wither 方法（见下文），我们使用 wither 创建一个具有新属性值的新实体实例。spring-doc.cn

  2. 如果定义了属性访问（即通过 getter 和 setter 进行访问），我们将调用 setter 方法。spring-doc.cn

  3. 默认情况下，我们直接设置 field 值。spring-doc.cn

属性人口内部

与我们在对象构造中的优化类似，我们也使用 Spring Data 运行时生成的访问器类来与实体实例进行交互。spring-doc.cn

class Person {

  private final Long id;
  private String firstname;
  private @AccessType(Type.PROPERTY) String lastname;

  Person() {
    this.id = null;
  }

  Person(Long id, String firstname, String lastname) {
    // Field assignments
  }

  Person withId(Long id) {
    return new Person(id, this.firstname, this.lastame);
  }

  void setLastname(String lastname) {
    this.lastname = lastname;
  }
}
示例 1.生成的 Property Accessor
class PersonPropertyAccessor implements PersistentPropertyAccessor {

  private static final MethodHandle firstname;              (2)

  private Person person;                                    (1)

  public void setProperty(PersistentProperty property, Object value) {

    String name = property.getName();

    if ("firstname".equals(name)) {
      firstname.invoke(person, (String) value);             (2)
    } else if ("id".equals(name)) {
      this.person = person.withId((Long) value);            (3)
    } else if ("lastname".equals(name)) {
      this.person.setLastname((String) value);              (4)
    }
  }
}
1 PropertyAccessor 保存基础对象的可变实例。 这是为了启用原本不可变属性的 mutation。
2 默认情况下， Spring Data 使用字段访问来读取和写入属性值。 根据字段的可见性规则， 用于与字段交互。privateMethodHandles
3 该类公开了一个用于设置标识符的方法，例如，当实例插入数据存储并生成标识符时。 调用 将创建一个新对象。 所有后续更改都将在新实例中发生，而前一个实例保持不变。withId(…)withId(…)Vertex
4 使用属性访问允许直接方法调用，而无需使用 .MethodHandles

与反射相比，这为我们提供了大约 25% 的性能提升。 要使 domain 类有资格进行此类优化，它需要遵守一组约束：spring-doc.cn

  • 类型不得驻留在 default 或 package 下。javaspring-doc.cn

  • 类型及其构造函数必须是publicspring-doc.cn

  • 属于内部类的类型必须是 。staticspring-doc.cn

  • 使用的 Java 运行时必须允许在原始 . Java 9 和更高版本有一定的限制。ClassLoaderspring-doc.cn

默认情况下， Spring Data 尝试使用生成的属性访问器，如果检测到限制，则回退到基于反射的属性访问器。spring-doc.cn

让我们看看以下实体：spring-doc.cn

示例 2.示例实体
class Person {

  private final @Id Long id;                                                (1)
  private final String firstname, lastname;                                 (2)
  private final LocalDate birthday;
  private final int age; (3)

  private String comment;                                                   (4)
  private @AccessType(Type.PROPERTY) String remarks;                        (5)

  static Person of(String firstname, String lastname, LocalDate birthday) { (6)

    return new Person(null, firstname, lastname, birthday,
      Period.between(birthday, LocalDate.now()).getYears());
  }

  Person(Long id, String firstname, String lastname, LocalDate birthday, int age) { (6)

    this.id = id;
    this.firstname = firstname;
    this.lastname = lastname;
    this.birthday = birthday;
    this.age = age;
  }

  Person withId(Long id) {                                                  (1)
    return new Person(id, this.firstname, this.lastname, this.birthday);
  }

  void setRemarks(String remarks) {                                         (5)
    this.remarks = remarks;
  }
}
1 identifier 属性是 final，但在构造函数中设置为 to。 该类公开了一个用于设置标识符的方法，例如，当实例插入数据存储并生成标识符时。 创建新实例时，原始实例保持不变。 相同的模式通常适用于存储管理的其他属性，但对于持久性操作，可能需要更改这些属性。nullwithId(…)Vertex
2 和 属性是可能通过 getter 公开的普通不可变属性。firstnamelastname
3 该属性是不可变的，但派生自该属性。 显示设计后，数据库值将胜过默认值，因为 Spring Data 使用唯一声明的构造函数。 即使意图是应该首选计算，此构造函数也必须将 as 参数 （可能会忽略它） ，否则属性 population 步骤将尝试设置 age 字段并失败，因为它是不可变的并且不存在 wither。agebirthdayage
4 属性 is mutable 是通过直接设置其字段来填充的。comment
5 这些属性是可变的，并通过直接设置字段或通过调用 setter 方法来填充remarkscomment
6 该类公开了用于创建对象的工厂方法和构造函数。 这里的核心思想是使用工厂方法而不是额外的构造函数，以避免通过 . 相反，属性的默认值是在工厂方法中处理的。@PersistenceCreator

一般建议

  • 尽量坚持使用不可变对象 — 不可变对象很容易创建，因为具体化对象只需调用其构造函数即可。 此外，这可以防止你的域对象被允许客户端代码操作对象状态的 setter 方法弄得乱七八糟。 如果需要这些，最好将它们设为包保护，以便它们只能由有限数量的共存类型调用。 仅构造函数具体化比属性填充快 30%。spring-doc.cn

  • 提供全参数构造函数 — 即使您不能或不想将实体建模为不可变值，提供将实体的所有属性（包括可变属性）作为参数的构造函数仍然具有价值，因为这允许对象映射跳过属性填充以获得最佳性能。spring-doc.cn

  • 使用工厂方法而不是重载的构造函数以避免@PersistenceCreator — 由于需要全参数构造函数才能获得最佳性能，我们通常希望公开更多特定于应用程序用例的构造函数，这些构造函数省略了自动生成的标识符等内容。 使用静态工厂方法来公开 all-args 构造函数的这些变体是一种既定模式。spring-doc.cn

  • 确保遵守允许使用生成的实例化器和属性访问器类的约束spring-doc.cn

  • 对于要生成的标识符，仍将 final 字段与 wither 方法结合使用spring-doc.cn

  • 使用 Lombok 避免样板代码 — 由于持久性操作通常需要一个采用所有参数的构造函数，因此它们的声明会变成将样板参数繁琐地重复到字段分配中，最好通过使用 Lombok 的 .@AllArgsConstructorspring-doc.cn

关于不可变映射的说明

尽管我们建议尽可能使用不可变映射和构造，但在映射方面存在一些限制。 给定一个双向关系，其中具有对 的构造函数引用和对 的引用，或者更复杂的情况。 Spring Data Neo4j 无法解决这种母鸡/蛋的情况。 在它的实例化过程中，它急切地需要一个完全实例化的 ，另一方面，它需要一个实例（准确地说，是同一个实例）。 SDN 通常允许此类模型，但如果从数据库返回的数据包含上述星座，则会在运行时引发 a 。 在这种情况下，您无法预见返回的数据是什么样子，因此更适合为关系使用可变字段。ABBAABAMappingExceptionspring-doc.cn

Kotlin 支持

Spring Data 调整了 Kotlin 的细节以允许对象创建和更改。spring-doc.cn

Kotlin 对象创建

支持实例化 Kotlin 类，默认情况下所有类都是不可变的，并且需要显式属性声明来定义可变属性。 请考虑以下类：dataVertexspring-doc.cn

data class Person(val id: String, val name: String)

上面的类编译为具有显式构造函数的典型类。 我们可以通过添加另一个构造函数来自定义这个类，并对其进行注释以指示构造函数首选项：@PersistenceCreatorspring-doc.cn

data class Person(var id: String, val name: String) {

    @PersistenceCreator
    constructor(id: String) : this(id, "unknown")
}

Kotlin 允许在未提供参数时使用默认值，从而支持参数可选性。 当Spring Data检测到具有参数 defaulting 的构造函数时，如果数据存储不提供值（或只是返回），则它不会保留这些参数，以便 Kotlin 可以应用参数 defaulting。 请考虑以下类，该类为nullnamespring-doc.cn

data class Person(var id: String, val name: String = "unknown")

每次参数不是结果的一部分或其值为 时，则默认为 。namenullnameunknownspring-doc.cn

Kotlin 数据类的属性填充

在 Kotlin 中，默认情况下，所有类都是不可变的，并且需要显式属性声明来定义可变属性。 请考虑以下类：dataVertexspring-doc.cn

data class Person(val id: String, val name: String)

这个类实际上是不可变的。 它允许创建新实例，因为 Kotlin 会生成一个方法来创建新的对象实例，从现有对象复制所有属性值，并将作为参数提供的属性值应用于该方法。copy(…)spring-doc.cn