物件對映基礎

本節涵蓋了 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 執行時必須允許在原始 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 會跳過超類屬性。也就是說，被覆蓋屬性的型別必須可以賦值給其超類屬性型別，才能註冊為覆蓋；否則，超類屬性被視為瞬態（transient）。我們通常建議使用不同的屬性名稱。

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），則 Spring Data 會使這些引數缺失，以便 Kotlin 可以應用引數預設值。考慮以下對 name 應用引數預設值的類：

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

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

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

Kotlin data classes 的屬性填充

在 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	一個帶有非空值型別的簡單值類。
2	使用 `EmailAddress` 值類定義屬性的資料類。

使用非原始值型別的非空屬性在編譯後的類中會被展平為值型別。可空原始值型別或可空值中值型別則用其包裝型別表示，這會影響值型別在資料庫中的表示方式。