物件對映基礎

本節介紹 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 方法。如果需要這些方法，最好將其設為包保護（package protected），以便只有少量位於同一包中的型別可以呼叫它們。僅使用建構函式例項化比屬性填充快達 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），則它會保留這些引數缺失，以便 Kotlin 可以應用引數預設值。考慮以下對 name 應用引數預設值的類：

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

每當 name 引數不屬於結果集或其值為 null 時，name 將預設為 unknown。

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

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

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