实体回调
Spring Data 基础设施提供了钩子，用于在某些方法被调用前后修改实体。这些所谓的 EntityCallback 实例提供了一种便捷方式，以回调风格检查并可能修改实体。
一个 EntityCallback 看起来很像一个专门化的 ApplicationListener。某些 Spring Data 模块会发布特定存储的事件（例如 BeforeSaveEvent），允许修改给定的实体。在某些情况下，例如处理不可变类型时，这些事件可能会带来问题。此外，事件发布依赖于 ApplicationEventMulticaster。如果为其配置了异步 TaskExecutor，可能会导致不可预测的结果，因为事件处理可能被分派到另一个线程上。
实体回调为同步 API 和响应式 API 都提供了集成点，以保证在处理链中明确定义的检查点处按顺序执行，并返回可能被修改的实体或响应式包装类型。
实体回调通常按 API 类型区分。这种区分意味着同步 API 只考虑同步实体回调，而响应式实现只考虑响应式实体回调。
实体回调 API 是随 Spring Data Commons 2.2 引入的。它是应用实体修改的推荐方式。现有的特定存储 ApplicationEvents 仍会在调用可能已注册的 EntityCallback 实例之前发布。
实现实体回调
EntityCallback 通过其泛型类型参数直接关联到其领域类型。每个 Spring Data 模块通常都自带一组预定义的 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
}
BeforeSaveCallback的特定方法，在实体保存前调用。返回可能被修改的实例。即将持久化的实体。
若干特定存储的参数，例如实体要持久化到的 collection。
@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
}
BeforeSaveCallback的特定方法，在订阅时、实体保存前调用。发射出可能被修改的实例。即将持久化的实体。
若干特定存储的参数，例如实体要持久化到的 collection。
可选的实体回调参数由实现它的 Spring Data 模块定义，并从 EntityCallback.callback() 的调用处推断。
根据您的应用需求实现相应的接口，如下例所示：
class DefaultingEntityCallback implements BeforeSaveCallback<Person>, Ordered { 2
@Override
public Object onBeforeSave(Person entity, String collection) { 1
if("user".equals(collection)) {
return …;
}
return …;
}
@Override
public int getOrder() {
return 100; 2
}
}
根据您的需求实现回调。
如果同一领域类型存在多个实体回调，可以对其排序。排序遵循最低优先级。
注册实体回调
如果 EntityCallback Bean 注册在 ApplicationContext 中，特定存储的实现会自动拾取它们。大多数模板 API 已经实现了 ApplicationContextAware，因此可以访问 ApplicationContext。
以下示例展示了一组有效的实体回调注册：
@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 // ...
}
}
BeforeSaveCallback通过@Order注解指定顺序。BeforeSaveCallback通过实现Ordered接口指定顺序。使用 lambda 表达式的
BeforeSaveCallback。默认无序，最后调用。请注意，由 lambda 表达式实现的回调不暴露类型信息，因此用不可赋值的实体调用这些回调会影响回调的吞吐量。请使用class或enum来为回调 Bean 启用类型过滤。在单个实现类中组合多个实体回调接口。
特定存储的实体回调
Spring Data Elasticsearch 在其审计支持内部使用 EntityCallback API，并对以下回调做出响应：
表 1. 支持的实体回调
| 回调 | 方法 | 描述 | 顺序 |
|---|---|---|---|
| Reactive/BeforeConvertCallback | onBeforeConvert(T entity, IndexCoordinates index) | 在领域对象被转换为 org.springframework.data.elasticsearch.core.document.Document 之前调用。可以返回 entity 或一个修改后的实体，然后该实体将被转换。 | Ordered.LOWEST_PRECEDENCE |
| Reactive/AfterLoadCallback | onAfterLoad(Document document, Class<T> type, IndexCoordinates indexCoordinates) | 在 Elasticsearch 的结果被读取为 org.springframework.data.elasticsearch.core.document.Document 之后调用。 | Ordered.LOWEST_PRECEDENCE |
| Reactive/AfterConvertCallback | onAfterConvert(T entity, Document document, IndexCoordinates indexCoordinates) | 在从 Elasticsearch 读取结果数据、领域对象从 org.springframework.data.elasticsearch.core.document.Document 转换之后调用。 | Ordered.LOWEST_PRECEDENCE |
| Reactive/AuditingEntityCallback | onBeforeConvert(Object entity, IndexCoordinates index) | 将可审计实体标记为 created（新建）或 modified（修改） | 100 |
| Reactive/AfterSaveCallback | T onAfterSave(T entity, IndexCoordinates index) | 在领域对象保存之后调用。 | Ordered.LOWEST_PRECEDENCE |