物件對映基礎

本節介紹 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 class 的委託屬性。在所有其他情況下，您可以透過使用 @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 Value Class

Kotlin Value Class 的設計旨在實現更富有表現力的領域模型，使底層概念更加明確。Spring Data 可以讀寫使用 Value Class 定義屬性的型別。

考慮以下領域模型

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

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

1	一個簡單的值類，包含一個非空值型別。
2	Data class 定義了一個使用 `EmailAddress` 值類的屬性。

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