物件對映基礎知識

本節涵蓋 Spring Data 物件對映、物件建立、欄位和屬性訪問、可變性和不可變性的基礎知識。請注意，本節僅適用於不使用底層資料儲存（如 JPA）物件對映的 Spring Data 模組。此外，請務必查閱特定儲存的部分，瞭解特定於儲存的物件對映，例如索引、自定義列或欄位名稱等。

Spring Data 物件對映的核心職責是建立域物件例項並將儲存原生的資料結構對映到這些例項上。這意味著我們需要兩個基本步驟：

使用暴露的其中一個建構函式建立例項。
填充例項以具體化所有暴露的屬性。

物件建立

Spring Data 會自動嘗試檢測持久化實體要用於具體化該型別物件的建構函式。解析演算法如下：

如果存在一個用 @PersistenceCreator 註解的靜態工廠方法，則使用該方法。
如果只有一個建構函式，則使用該建構函式。
如果存在多個建構函式，且只有一個用 @PersistenceCreator 註解，則使用該建構函式。
如果型別是 Java Record，則使用規範建構函式。
如果存在一個無參建構函式，則使用該建構函式。其他建構函式將被忽略。

值解析假定建構函式/工廠方法的引數名稱與實體的屬性名稱匹配，也就是說，解析將按照屬性要填充的方式進行，包括對映中的所有自定義項（不同的資料儲存列或欄位名稱等）。這還需要類檔案中提供引數名稱資訊，或者建構函式上存在 @ConstructorProperties 註解。

可以使用 Spring Framework 的 @Value 註解並結合特定儲存的 SpEL 表示式來定製值解析。更多詳情請參閱特定儲存對映的部分。

物件建立內部機制

為了避免反射的開銷，Spring Data 物件建立預設使用在執行時生成的工廠類，該類將直接呼叫域類的建構函式。例如，對於此示例型別

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

我們將在執行時建立一個在語義上等同於此的工廠類

class PersonObjectInstantiator implements ObjectInstantiator {

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

這比反射提供了大約 10% 的效能提升。域類要符合此最佳化條件，需要滿足一組約束：

它不能是私有類
它不能是非靜態內部類
它不能是 CGLib 代理類
Spring Data 將使用的建構函式不能是私有的

如果符合這些條件中的任何一項，Spring Data 將回退到透過反射例項化實體。

屬性填充

一旦實體例項建立完成，Spring Data 將填充該類的所有剩餘持久化屬性。除非實體的建構函式已經填充（即透過其建構函式引數列表消費），否則首先填充識別符號屬性，以允許解析迴圈物件引用。之後，所有未被建構函式填充的非瞬態屬性將被設定到實體例項上。為此，我們使用以下演算法：

如果屬性是不可變的但暴露了一個 with… 方法（見下文），我們使用 with… 方法建立一個具有新屬性值的新實體例項。
如果定義了屬性訪問（即透過 getter 和 setter 訪問），我們將呼叫 setter 方法。
如果屬性是可變的，我們直接設定欄位。
如果屬性是不可變的，我們使用持久化操作使用的建構函式（見物件建立）來建立例項的副本。
預設情況下，我們直接設定欄位值。

屬性填充內部機制

與我們在物件構造中的最佳化類似，我們也使用 Spring Data 執行時生成的訪問器類來與實體例項互動。

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;
  }
}

生成的屬性訪問器

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 持有底層物件的可變例項。這是為了使原本不可變的屬效能夠進行修改。
2	預設情況下，Spring Data 使用欄位訪問來讀寫屬性值。根據 `private` 欄位的可見性規則，使用 `MethodHandles` 來與欄位互動。
3	該類暴露了一個 `withId(…)` 方法，用於設定識別符號，例如當例項插入資料儲存並生成了識別符號時。呼叫 `withId(…)` 會建立一個新的 `Person` 物件。所有後續修改都將發生在新的例項中，而不會觸及之前的例項。
4	使用屬性訪問允許直接呼叫方法，而無需使用 `MethodHandles`。

這比反射提供了大約 25% 的效能提升。域類要符合此最佳化條件，需要滿足一組約束：

型別不得位於預設包或 java 包下。
型別及其建構函式必須是 public 的
作為內部類的型別必須是 static 的。
所使用的 Java Runtime 必須允許在原始的 ClassLoader 中宣告類。Java 9 及更高版本施加了一些限制。

預設情況下，Spring Data 嘗試使用生成的屬性訪問器，如果檢測到限制，則回退到基於反射的訪問器。

讓我們看一下以下實體

一個示例實體

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, this.age);
  }

  void setRemarks(String remarks) {                                         (5)
    this.remarks = remarks;
  }
}

1	識別符號屬性是 final 的，但在建構函式中設定為 `null`。該類暴露了一個 `withId(…)` 方法，用於設定識別符號，例如當例項插入資料儲存並生成了識別符號時。原始的 `Person` 例項保持不變，因為建立了一個新例項。對於其他由儲存管理但可能需要在持久化操作中更改的屬性，通常應用相同的模式。wither 方法是可選的，因為持久化建構函式（見 6）實際上是一個複製建構函式，設定該屬性將被轉換為建立一個應用了新識別符號值的新例項。
2	`firstname` 和 `lastname` 屬性是普通的不可變屬性，可能透過 getter 暴露。
3	`age` 屬性是一個不可變的屬性，但它是從 `birthday` 屬性派生出來的。透過所示設計，資料庫值將優先於預設值，因為 Spring Data 使用唯一宣告的建構函式。即使期望優先使用計算結果，重要的是此建構函式也接受 `age` 作為引數（可能會忽略它），否則屬性填充步驟將嘗試設定 age 欄位，並且由於它是不可變的且沒有 `with…` 方法而失敗。
4	`comment` 屬性是可變的，透過直接設定其欄位來填充。
5	`remarks` 屬性是可變的，透過呼叫 setter 方法來填充。
6	該類暴露了一個工廠方法和一個建構函式用於物件建立。這裡的核心思想是使用工廠方法而不是額外的建構函式，以避免透過 `@PersistenceCreator` 進行建構函式消歧。相反，屬性的預設值處理在工廠方法中進行。如果你希望 Spring Data 使用工廠方法進行物件例項化，請用 `@PersistenceCreator` 對其進行註解。

一般建議

儘量堅持使用不可變物件 — 不可變物件建立起來很直接，因為例項化物件只需要呼叫其建構函式即可。此外，這可以避免你的域物件充斥著允許客戶端程式碼操作物件狀態的 setter 方法。如果你需要這些方法，最好將它們設定為包保護，以便只有有限數量的同位置型別可以呼叫它們。僅使用建構函式例項化比屬性填充快達 30%。
提供一個全引數建構函式 — 即使你不能或不想將實體建模為不可變值，提供一個接受實體所有屬性作為引數的建構函式（包括可變屬性）仍然有價值，因為這允許物件對映跳過屬性填充，從而獲得最佳效能。
使用工廠方法而不是過載建構函式來避免 @PersistenceCreator — 由於最佳效能需要全引數建構函式，我們通常希望暴露更多特定於應用程式用例的建構函式，這些建構函式可以省略自動生成的識別符號等。使用靜態工廠方法來暴露全引數建構函式的這些變體是一個既定的模式。
確保你遵守允許使用生成的例項化器和屬性訪問器類的約束 —
對於需要生成的識別符號，仍然使用 final 欄位並結合全引數持久化建構函式（首選）或 with… 方法 —
使用 Lombok 避免模板程式碼 — 由於持久化操作通常需要一個接受所有引數的建構函式，它們的宣告會成為引數到欄位賦值的繁瑣重複模板程式碼，最好透過使用 Lombok 的 @AllArgsConstructor 來避免。

覆蓋屬性

Java 允許靈活設計域類，子類可以定義一個在其超類中已宣告同名屬性的屬性。考慮以下示例：

public class SuperType {

   private CharSequence field;

   public SuperType(CharSequence field) {
      this.field = field;
   }

   public CharSequence getField() {
      return this.field;
   }

   public void setField(CharSequence field) {
      this.field = field;
   }
}

public class SubType extends SuperType {

   private String field;

   public SubType(String field) {
      super(field);
      this.field = field;
   }

   @Override
   public String getField() {
      return this.field;
   }

   public void setField(String field) {
      this.field = field;

      // optional
      super.setField(field);
   }
}

這兩個類都使用可賦值型別定義了一個 field。然而，SubType 遮蔽了 SuperType.field。根據類設計，使用建構函式可能是設定 SuperType.field 的唯一預設方法。或者，在 setter 中呼叫 super.setField(…) 可以設定 SuperType 中的 field。所有這些機制在一定程度上造成了衝突，因為這些屬性共享相同的名稱，但可能代表兩個不同的值。如果型別不可賦值，Spring Data 會跳過超類屬性。也就是說，被覆蓋屬性的型別必須可以賦值給其超類屬性型別才能註冊為覆蓋，否則超類屬性被視為瞬態的。我們通常建議使用不同的屬性名稱。

Spring Data 模組通常支援持有不同值的被覆蓋屬性。從程式設計模型角度來看，有幾點需要考慮：

哪些屬性應該被持久化（預設為所有宣告的屬性）？你可以透過用 @Transient 註解來排除屬性。
如何在你的資料儲存中表示屬性？為不同的值使用相同的欄位/列名稱通常會導致資料損壞，因此你應該至少為其中一個屬性使用顯式的欄位/列名稱進行註解。
不能使用 @AccessType(PROPERTY)，因為在不進一步假定 setter 實現的情況下，通常無法設定超類屬性。

Kotlin 支援

Spring Data 適應 Kotlin 的特性以允許物件建立和修改。

Kotlin 物件建立

支援例項化 Kotlin 類，所有類預設都是不可變的，需要顯式宣告屬性來定義可變屬性。

Spring Data 會自動嘗試檢測持久化實體要用於具體化該型別物件的建構函式。解析演算法如下：

如果存在一個用 @PersistenceCreator 註解的建構函式，則使用該建構函式。
如果型別是 Kotlin data class，則使用主建構函式。
如果存在一個用 @PersistenceCreator 註解的靜態工廠方法，則使用該方法。
如果只有一個建構函式，則使用該建構函式。
如果存在多個建構函式，且只有一個用 @PersistenceCreator 註解，則使用該建構函式。
如果型別是 Java Record，則使用規範建構函式。
如果存在一個無參建構函式，則使用該建構函式。其他建構函式將被忽略。

考慮以下 data 類 Person：

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

上述類會編譯成一個帶有顯式建構函式的典型類。我們可以透過新增另一個建構函式並用 @PersistenceCreator 註解它來定製此類的建構函式偏好：

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

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

Kotlin 透過允許在未提供引數時使用預設值來支援引數的可選性。當 Spring Data 檢測到帶有引數預設值的建構函式時，如果資料儲存未提供值（或僅返回 null），它將使這些引數缺失，以便 Kotlin 可以應用引數預設值。考慮以下對 name 應用引數預設值的類：

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

每當 name 引數不是結果的一部分或其值為 null 時，name 將預設為 unknown。

Spring Data 不支援委託屬性。對映元資料會過濾掉 Kotlin Data 類中的委託屬性。在所有其他情況下，你可以透過使用 @Transient 註解屬性來排除委託屬性的合成欄位。

Kotlin data class 的屬性填充

在 Kotlin 中，所有類預設都是不可變的，需要顯式宣告屬性來定義可變屬性。考慮以下 data 類 Person：

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

這個類實際上是不可變的。它允許建立新例項，因為 Kotlin 生成了一個 copy(…) 方法，該方法建立新的物件例項，複製現有物件的所有屬性值，並將作為方法引數提供的屬性值應用到新例項上。

Kotlin 覆蓋屬性

Kotlin 允許宣告屬性覆蓋來更改子類中的屬性。

open class SuperType(open var field: Int)

class SubType(override var field: Int = 1) :
	SuperType(field) {
}

這樣的安排產生了兩個同名 field 的屬性。Kotlin 為每個類中的每個屬性生成屬性訪問器（getter 和 setter）。實際上，程式碼如下所示：

public class SuperType {

   private int field;

   public SuperType(int field) {
      this.field = field;
   }

   public int getField() {
      return this.field;
   }

   public void setField(int field) {
      this.field = field;
   }
}

public final class SubType extends SuperType {

   private int field;

   public SubType(int field) {
      super(field);
      this.field = field;
   }

   public int getField() {
      return this.field;
   }

   public void setField(int field) {
      this.field = field;
   }
}

SubType 上的 getter 和 setter 只設置 SubType.field 而不設定 SuperType.field。在這種安排下，使用建構函式是設定 SuperType.field 的唯一預設方法。在 SubType 中新增一個方法透過 this.SuperType.field = … 設定 SuperType.field 是可能的，但這超出了支援的慣例。屬性覆蓋在一定程度上造成了衝突，因為這些屬性共享相同的名稱，但可能代表兩個不同的值。我們通常建議使用不同的屬性名稱。

Spring Data 模組通常支援持有不同值的被覆蓋屬性。從程式設計模型角度來看，有幾點需要考慮：

哪些屬性應該被持久化（預設為所有宣告的屬性）？你可以透過用 @Transient 註解來排除屬性。
如何在你的資料儲存中表示屬性？為不同的值使用相同的欄位/列名稱通常會導致資料損壞，因此你應該至少為其中一個屬性使用顯式的欄位/列名稱進行註解。
不能使用 @AccessType(PROPERTY)，因為超類屬性無法設定。

Kotlin 值類

Kotlin 值類旨在構建更具表達力的領域模型，以明確底層概念。Spring Data 可以讀寫使用值類定義屬性的型別。

考慮以下領域模型：

@JvmInline
value class EmailAddress(val theAddress: String)                                    (1)

data class Contact(val id: String, val name:String, val emailAddress: EmailAddress) (2)

1	一個帶有非 null 值型別的簡單值類。
2	使用 `EmailAddress` 值類定義屬性的資料類。

使用非基本值型別的非 null 屬性在編譯後的類中被展平為值型別。可 null 的基本值型別或可 null 的值中值型別用它們的包裝型別表示，這影響了值型別在資料庫中的表示方式。