回调和spring的LambdaSafe类

251 阅读4分钟

@TOC
在阅读spring boot源码时发现了WebServerFactoryCustomizerBeanPostProcessor类中有

1
2
3
4
LambdaSafe.callbacks(WebServerFactoryCustomizer.class, getCustomizers(), webServerFactory)
.withLogger(WebServerFactoryCustomizerBeanPostProcessor.class)
.invoke((customizer) -> customizer.customize(webServerFactory));

的用法。搜索了一下国内网站,发现没有相关资料,所以只能去spring官方网站上查阅文档学习一下。

我们知道一切皆可“类”化的java中没有函数指针,而函数指针可以用来实现编程中较为普遍使用的“回调”。所谓“回调“是和“调用”相反的过程,如果用类和消息来理解就是,类A调用类B的方法,可以认为是类A向类B发送了一个消息,这个过程被称为”调用”。对于类B来说,B 被动 接收了这个消息。但是如果类B的方法在处理这个消息的过程中,又需要类A才有的数据或者类A才有能力拿到的数据,这时候类B需要向类A发送一个消息(调用类A的方法),主动 请求获取数据。这时候类B就需要知道类A的方法如何调用,这个过程称为”回调”。

如果是c/c++,可以直接给类B传入一个类A方法的函数指针。但是java中不存在现成的“函数指针”可以使用,所以出现了几种类“函数指针”的形式。一种是比较常见的使用接口+方法的形式实现类函数指针的方式,这种接口被称为函数式接口,另一种是java 8中的新特性lambda表达式,本质上也是一种函数式接口。

Java中定义了一个@FunctionalInterface注解来修饰接口实现的”函数指针”,但是这个注解并不是必须的,只要满足函数式接口标准的接口都可以作为”函数指针”。如果一个接口不满足函数式接口标准,同时注解了@FunctionalInterface,那么编译器就会报错,这个注解相当于能够更好的方便编译器进行检查。现在我们以上面代码中涉及的函数式接口来举例。

1
2
3
4
5
6
@FunctionalInterface
public interface WebServerFactoryCustomizer<T extends WebServerFactory> {
void customize(T factory);
}

WebServerFactoryCustomizer是一个提供给用户用来定制WebServerFactory实例的接口。这个函数式接口的使用是在上面代码的invoke方法的lambda表达式中,主要是处理传入的WebServerFactory实例的bean,然后继承这个函数式接口就可以对这个实例为所欲为。
好了,基础介绍完了,终于到我们的主角LambdaSafe类了。spring 官方文档给的解释是

Utility that can be used to invoke lambdas in a safe way. Primarily designed to help support generically typed callbacks where class cast exceptions need to be dealt with due to class erasure.

。大意就是说LambdaSafe可以用来安全的运行lambda表达式,所谓的安全就是指可以支持处理在“回调”过程中因为类型擦除(java泛型中的概念)而需要抛出异常的情况。
那么实际上如何实现的呢?先看LambdaSafe.callbacks方法。在上面代码中,LambdaSafe.callbacks传入了WebServerFactoryCustomizer.class、getCustomizers()和需要被为所欲为的WebServerFactory实例。getCustomizers()的返回值会获取所有WebServerFactoryCustomizer函数式接口的实现类,可以理解获取了一堆函数指针。

1
2
3
4
5
6
7
8
9
10
11
12
private List<WebServerFactoryCustomizer<?>> customizers;
private Collection<WebServerFactoryCustomizer<?>> getCustomizers() {
if (this.customizers == null) {
// Look up does not include the parent context
this.customizers = new ArrayList<>(getWebServerFactoryCustomizerBeans());
this.customizers.sort(AnnotationAwareOrderComparator.INSTANCE);
this.customizers = Collections.unmodifiableList(this.customizers);
}
return this.customizers;
}

callbacks方法返回的是

1
2
3
4
5
6
public static <C, A> Callbacks<C, A>
callbacks(Class<C> callbackType,
Collection<? extends C> callbackInstances,
A argument,
Object... additionalArguments);

LambdaSafe中的内部类LambdaSafe.Callback<C,A> ,其中A和C是两个泛型,这里分别对应的是WebServerFactoryCustomizer.class和WebServerFactoryCustomizer.然后这个类有一个withLogger方法用来打印日志,这样在执行lambda表达式的过程中就能记录抛出的异常日志,并且日志头打印的是传入参数WebServerFactoryCustomizerBeanPostProcessor.class类(不会被擦除效果影响),最后这个withLogger方法返回的参数是SELF,代表LambdaSafe.Callback<C,A>自己。这样LambdaSafe.Callback<C,A>实例又调用了自己的invoke参数,执行了getCustomizers方法返回的所有WebServerFactoryCustomizer函数式接口的实现类的customize方法。
具体看下invoke的代码,也挺有意思的。

1
2
3
4
5
6
7
8
9
10
11
private final Collection<? extends C> callbackInstances;
public void invoke(Consumer<C> invoker) {
this.callbackInstances.forEach((callbackInstance) -> {
invoke(callbackInstance, () -> {
invoker.accept(callbackInstance);
return null;
});
});
}

Consumer也是一种函数式接口,这里用来代表(customizer) -> customizer.customize(webServerFactory)的lambda表达式。callbackInstances存储了上面说到的所有WebServerFactoryCustomizer函数式接口的实现类,这里边遍历边通过invoker.accept()方法执行每个函数式接口的customize方法。这样整个代码逻辑就完全了。