實體回撥

Spring Data 基礎設施提供了鉤子,用於在呼叫特定方法之前和之後修改實體。這些被稱為 EntityCallback 的例項提供了一種方便的方式,以回撥方式檢查並可能修改實體。
EntityCallback 非常類似於一個專門的 ApplicationListener。一些 Spring Data 模組釋出特定於儲存的事件(例如 BeforeSaveEvent),允許修改給定的實體。在某些情況下,例如處理不可變型別時,這些事件可能會導致問題。此外,事件釋出依賴於 ApplicationEventMulticaster。如果使用非同步 TaskExecutor 進行配置,則可能導致不可預測的結果,因為事件處理可能被分派到執行緒中。

實體回撥提供了與同步和響應式 API 的整合點,以保證在處理鏈中明確定義的檢查點處的按序執行,並返回一個可能已修改的實體或一個響應式包裝型別。

實體回撥通常按 API 型別分離。這種分離意味著同步 API 只考慮同步實體回撥,而響應式實現只考慮響應式實體回撥。

實體回撥 API 是隨 Spring Data Commons 2.2 引入的。它是應用實體修改的推薦方式。現有的特定於儲存的 ApplicationEvents 仍在呼叫潛在註冊的 EntityCallback 例項之前釋出。

實現實體回撥

EntityCallback 透過其泛型型別引數直接與其領域型別相關聯。每個 Spring Data 模組通常都提供一套預定義的 EntityCallback 介面,涵蓋實體生命週期。

EntityCallback 的結構
@FunctionalInterface
public interface BeforeSaveCallback<T> extends EntityCallback<T> {

	/**
	 * Entity callback method invoked before a domain object is saved.
	 * Can return either the same or a modified instance.
	 *
	 * @return the domain object to be persisted.
	 */
	(1)
	T onBeforeSave(T entity, (2)
		String collection); (3)
}
1 BeforeSaveCallback 特定方法,在儲存實體之前呼叫。返回一個可能已修改的例項。
2 在持久化之前的實體。
3 一些特定於儲存的引數,例如實體被持久化到的集合
響應式 EntityCallback 的結構
@FunctionalInterface
public interface ReactiveBeforeSaveCallback<T> extends EntityCallback<T> {

	/**
	 * Entity callback method invoked on subscription, before a domain object is saved.
	 * The returned Publisher can emit either the same or a modified instance.
	 *
	 * @return Publisher emitting the domain object to be persisted.
	 */
	(1)
	Publisher<T> onBeforeSave(T entity, (2)
		String collection); (3)
}
1 BeforeSaveCallback 特定方法,在訂閱時呼叫,在儲存實體之前。發出一個可能已修改的例項。
2 在持久化之前的實體。
3 一些特定於儲存的引數,例如實體被持久化到的集合
可選的實體回撥引數由實現 Spring Data 模組定義,並從 EntityCallback.callback() 的呼叫位置推斷。

根據您的應用需求實現相應的介面,如下例所示:

BeforeSaveCallback 示例
class DefaultingEntityCallback implements BeforeSaveCallback<Person>, Ordered {      (2)

	@Override
	public Object onBeforeSave(Person entity, String collection) {                   (1)

		if(collection == "user") {
		    return // ...
		}

		return // ...
	}

	@Override
	public int getOrder() {
		return 100;                                                                  (2)
	}
}
1 根據您的需求實現回撥。
2 如果存在針對同一領域型別的多個實體回撥,則可能需要對其進行排序。排序遵循最低優先順序原則。

註冊實體回撥

如果 EntityCallback bean 在 ApplicationContext 中註冊,則特定於儲存的實現會將其拾取。大多數模板 API 都已實現 ApplicationContextAware,因此可以訪問 ApplicationContext

以下示例解釋了一系列有效的實體回撥註冊

EntityCallback Bean 註冊示例
@Order(1)                                                           (1)
@Component
class First implements BeforeSaveCallback<Person> {

	@Override
	public Person onBeforeSave(Person person) {
		return // ...
	}
}

@Component
class DefaultingEntityCallback implements BeforeSaveCallback<Person>,
                                                           Ordered { (2)

	@Override
	public Object onBeforeSave(Person entity, String collection) {
		// ...
	}

	@Override
	public int getOrder() {
		return 100;                                                  (2)
	}
}

@Configuration
public class EntityCallbackConfiguration {

    @Bean
    BeforeSaveCallback<Person> unorderedLambdaReceiverCallback() {   (3)
        return (BeforeSaveCallback<Person>) it -> // ...
    }
}

@Component
class UserCallbacks implements BeforeConvertCallback<User>,
                                        BeforeSaveCallback<User> {   (4)

	@Override
	public Person onBeforeConvert(User user) {
		return // ...
	}

	@Override
	public Person onBeforeSave(User user) {
		return // ...
	}
}
1 透過 @Order 註解接收其順序的 BeforeSaveCallback
2 透過實現 Ordered 介面接收其順序的 BeforeSaveCallback
3 使用 lambda 表示式的 BeforeSaveCallback。預設無序,並最後呼叫。請注意,透過 lambda 表示式實現的回撥不會暴露型別資訊,因此使用不可分配的實體呼叫這些回撥會影響回撥吞吐量。使用 classenum 來啟用回撥 bean 的型別過濾。
4 將多個實體回撥介面組合在單個實現類中。