1. 问题背景
某应用在启动完提供 JSF 服务后,短时间内出现了大量的空指针异常。
分析日志,发现是服务依赖的藏经阁配置数据未加载完成导致。即所谓的有损上线或者是直接发布,当****应用启动时,service 还没加载完,就开始对外提供服务,导致失败调用。
关键代码如下
数据的初始化加载是通过实现 CommandLineRunner 接口完成的
@Component
public class LoadSystemArgsListener implements CommandLineRunner {
@Resource
private CacheLoader cjgConfigCacheLoader;
@Override
public void run(String... args) {
// 加载藏经阁配置
cjgConfigCacheLoader.refresh();
}
}
复制代码
cjgConfigCacheLoader.refresh()方法内部会将数据加载到内存中
/** 藏经阁配置数据 key:租户 value:配置数据 */
public static Map<String, CjgRuleConfig> cjgRuleConfigMap = new HashMap<>();
复制代码
如果此时还未加载完数据,调用 cjgRuleConfigMap.get("301").getXX(),则会报空指针异常
总结根因:JSF Provider 发布早于服务依赖的初始化数据加载,导致失败调用
2. 问题解决
在解决此问题前,我们需要先回忆并熟悉下 Spring Boot 的启动过程、JSF 服务的发布过程
1)Spring Boot 的启动过程(版本 2.0.7.RELEASE)
run 方法,主要关注 refreshContext(context)刷新上下文
public ConfigurableApplicationContext run(String... args) {
// 创建 StopWatch 实例:用于计算启动时间
StopWatch stopWatch = new StopWatch();
stopWatch.start();
ConfigurableApplicationContext context = null;
Collection<SpringBootExceptionReporter> exceptionReporters = new ArrayList<>();
configureHeadlessProperty();
// 获取SpringApplicationRunListeners:这些监听器会在启动过程的各个阶段发送对应的事件
SpringApplicationRunListeners listeners = getRunListeners(args);
listeners.starting();
try {
ApplicationArguments applicationArguments = new DefaultApplicationArguments(
args);
// 创建并配置Environment:包括准备好对应的`Environment`,以及将`application.properties`或`application.yml`中的配置项加载到`Environment`中
ConfigurableEnvironment environment = prepareEnvironment(listeners,
applicationArguments);
configureIgnoreBeanInfo(environment);
// 打印Banner:如果 spring.main.banner-mode 不为 off,则打印 banner
Banner printedBanner = printBanner(environment);
// 创建应用上下文:根据用户的配置和classpath下的配置,创建合适的`ApplicationContext`
context = createApplicationContext();
exceptionReporters = getSpringFactoriesInstances(
SpringBootExceptionReporter.class,
new Class[] { ConfigurableApplicationContext.class }, context);
// 准备上下文:主要是将`Environment`、`ApplicationArguments`等关键属性设置到`ApplicationContext`中,以及加载`ApplicationListener`、`ApplicationRunner`、`CommandLineRunner`等。
prepareContext(context, environment, listeners, applicationArguments,
printedBanner);
// 刷新上下文:这是Spring IoC容器启动的关键,包括Bean的创建、依赖注入、初始化,发布事件等
refreshContext(context);
afterRefresh(context, applicationArguments);
stopWatch.stop();
// 打印启动信息:如果 spring.main.log-startup-info 为 true,则打印启动信息
if (this.logStartupInfo) {
new StartupInfoLogger(this.mainApplicationClass)
.logStarted(getApplicationLog(), stopWatch);
}
// 发布 ApplicationStartedEvent:通知所有的 SpringApplicationRunListeners 应用已经启动
listeners.started(context);
// 调用 Runner:调用所有的ApplicationRunner和CommandLineRunner
callRunners(context, applicationArguments);
}
catch (Throwable ex) {
handleRunFailure(context, ex, exceptionReporters, listeners);
throw new IllegalStateException(ex);
}
try {
// 运行中:通知所有的 SpringApplicationRunListeners 应用正在运行
listeners.running(context);
}
catch (Throwable ex) {
handleRunFailure(context, ex, exceptionReporters, null);
throw new IllegalStateException(ex);
}
return context;
}
复制代码
refreshContext(context)内部调用 refresh()方法,此方法主要关注 finishBeanFactoryInitialization(beanFactory) 实例化 Bean 早于 finishRefresh() 发生
public void refresh() throws BeansException, IllegalStateException {
synchronized (this.startupShutdownMonitor) {
// 准备刷新的上下文环境:设置启动日期,激活上下文,清除原有的属性源
prepareRefresh();
// 告诉子类启动 'refreshBeanFactory()' 方法,创建一个新的bean工厂。
ConfigurableListableBeanFactory beanFactory = obtainFreshBeanFactory();
// 为 BeanFactory 设置上下文特定的后处理器:主要用于支持@Autowired和@Value注解
prepareBeanFactory(beanFactory);
try {
// 为 BeanFactory 的处理提供在子类中的后处理器。
postProcessBeanFactory(beanFactory);
// 调用所有注册的 BeanFactoryPostProcessor Bean 的处理方法。
invokeBeanFactoryPostProcessors(beanFactory);
// 注册 BeanPostProcessor 的处理器,拦截 Bean 创建。
registerBeanPostProcessors(beanFactory);
// 为此上下文初始化消息源。
initMessageSource();
// 为此上下文初始化事件多播器。
initApplicationEventMulticaster();
// 在特定的上下文子类中刷新之前的进一步初始化。
onRefresh();
// 检查监听器 Bean 并注册它们:注册所有的ApplicationListenerbeans
registerListeners();
// 实例化所有剩余的(非延迟初始化)单例。
finishBeanFactoryInitialization(beanFactory);
// 完成刷新:发布ContextRefreshedEvent,启动所有Lifecyclebeans,初始化所有剩余的单例(lazy-init 单例和非延迟初始化的工厂 beans)。
finishRefresh();
}
...
}
复制代码
实例化 Bean 中,需熟悉 Bean 的生命周期(重要)
2)JSF Provider 的发布过程(版本 1.7.5-HOTFIX-T6)
类 com.jd.jsf.gd.config.spring.ProviderBean 调用方法 com.jd.jsf.gd.config.ProviderConfig#export 进行发布
JSF 源码地址:http://xingyun.jd.com/codingRoot/jsf/jsf-sdk
public class ProviderBean<T> extends ProviderConfig<T> implements InitializingBean, DisposableBean, ApplicationContextAware, ApplicationListener, BeanNameAware {
// 此处代码省略...
public void onApplicationEvent(ApplicationEvent event) {
if (event instanceof ContextRefreshedEvent && this.isDelay() && !this.exported && !CommonUtils.isUnitTestMode()) {
LOGGER.info("JSF export provider with beanName {} after spring context refreshed.", this.beanName);
if (this.delay < -1) {
Thread thread = new Thread(new Runnable() {
public void run() {
try {
Thread.sleep((long)(-ProviderBean.this.delay));
} catch (Throwable var2) {
}
ProviderBean.this.export();
}
});
thread.setDaemon(true);
thread.setName("DelayExportThread");
thread.start();
} else {
this.export();
}
}
}
private boolean isDelay() {
return this.supportedApplicationListener && this.delay < 0;
}
public void afterPropertiesSet() throws Exception {
// 此处代码省略...
if (!this.isDelay() && !CommonUtils.isUnitTestMode()) {
LOGGER.info("JSF export provider with beanName {} after properties set.", this.beanName);
this.export();
}
}
}
复制代码
public synchronized void export() throws InitErrorException {
if (this.delay > 0) {
Thread thread = new Thread(new Runnable() {
public void run() {
try {
Thread.sleep((long)ProviderConfig.this.delay);
} catch (Throwable var2) {
}
ProviderConfig.this.doExport();
}
});
thread.setDaemon(true);
thread.setName("DelayExportThread");
thread.start();
} else {
this.doExport();
}
}
复制代码
可以看出 Provider 发布有两个地方
Ⅰ、Bean 的初始化过程(delay>=0)
实现 InitializingBean 接口,重写 afterPropertiesSet 方法。这里会判断是否延迟发布,如果大于等于 0,则会此处进行发布。具体在 export 方法中,当 delay>0,则会延迟发布,如配置 5000,表示延迟 5 秒发布;当 delay=0,则立即发布。
Ⅱ、监听 ContextRefreshedEvent 事件触发(delay<0)
实现 ApplicationListener 接口,重写 onApplicationEvent 方法。属于事件 ContextRefreshedEvent,当 delay<-1,则会延迟发布,如配置-5000,表示延迟 5 秒发布;反之,则立即发布。
3)解决方案
场景 1:XML 方式自动发布 Provider(常用)
由上面的介绍,了解到执行顺序:1.Bean 初始化 > 2.ContextRefreshedEvent 事件触发 > 3.调用 ApplicationRunner 或 CommandLineRunner;
上面已经知道 Provider 发布处于 1、2 过程,需避免使用方式 3 进行数据的初始化。
前提建议:delay 默认配置为-1,可以不配置,或者配置负数。则 JSF Provider 发布则处于过程 2,即监听 ContextRefreshedEvent 事件触发
方式 1:Bean 的初始化过程中
解决方法:使用**@PostConstruct 注解、实现 InitializingBean 接口、配置 init-method 方法均可**
@Component
public class DataLoader {
@PostConstruct
@Scheduled(cron = "${cron.config}")
public void loadData() {
// 数据加载
System.out.println("数据加载工作");
}
}
复制代码
注意:该 Bean 如果依赖了其他 Bean,需确保依赖 Bean 已实例化,否则会报空指针异常。
方式 2:ContextRefreshedEvent 事件触发
ContextRefreshedEvent 事件是如何发布的
调用过程 AbstractApplicationContext#finishRefresh -> AbstractApplicationContext#publishEvent-> SimpleApplicationEventMulticaster#multicastEvent
public void multicastEvent(final ApplicationEvent event, @Nullable ResolvableType eventType) {
ResolvableType type = (eventType != null ? eventType : resolveDefaultEventType(event));
for (final ApplicationListener<?> listener : getApplicationListeners(event, type)) {
Executor executor = getTaskExecutor();
if (executor != null) {
executor.execute(() -> invokeListener(listener, event));
}
else {
invokeListener(listener, event);
}
}
}
复制代码
在 SimpleApplicationEventMulticaster 的 multicastEvent 方法中调用 invokeListener()进行事件发布,getTaskExecutor()默认值是 null(除自定义设置 Executor 对象),所有 ApplicationListener 实现类串行执行 onApplicationEvent 方法。
getApplicationListeners(event, type)获取所有的实现类,继续向下看内部会调用 AnnotationAwareOrderComparator.sort(allListeners)对所有 ApplicationListener 进行排序,allListeners 是待排序的对象列表。该方法将根据对象上的排序注解或接口来确定排序顺序,并返回一个按照指定顺序排序的对象列表。具体来说,排序的规则如下:
1.首先,根据对象上的 @Order 注解的值进行排序。@Order 注解的值越小,排序优先级越高。
2.如果对象上没有 @Order 注解,或者多个对象的 @Order 注解值相同,则根据对象是否实现了 Ordered 接口进行排序。实现了 Ordered 接口的对象,可以通过 getOrder() 方法返回一个排序值。
3.如果对象既没有 @Order 注解,也没有实现 Ordered 接口,则使用默认的排序值 LOWEST_PRECEDENCE(Integer.MAX_VALUE)。特别的:如果 BeanA 和 BeanB 排序值都是默认值,则保持原顺序,即 Bean 的加载顺序
总结:默认情况所有 ApplicationListener 实现类串行执行 onApplicationEvent 方法,而顺序取决于 AnnotationAwareOrderComparator.sort(allListeners),@Order 注解的值越小,排序优先级越高
解决方法:使用 @Order 注解保证执行顺序早于 ProviderBean
@Component
@Order(1)
public class DataLoader implements ApplicationListener<ContextRefreshedEvent> {
@Override
public void onApplicationEvent(ContextRefreshedEvent event) {
// 数据准备
System.out.println("初始化工作");
}
}
复制代码
此外带有 @SpringBootApplication 的启动类中实现也是可以的(在 Spring Boot 中默认使用基于注解的方式进行配置和管理 Bean,所以注解定义的 Bean 会在 XML 定义的 Bean 之前被加载)
@SpringBootApplication
public class DemoApplication implements ApplicationListener<ContextRefreshedEvent> {
public static void main(String[] args) {
SpringApplication.run(DemoApplication.class, args);
}
@Override
public void onApplicationEvent(ContextRefreshedEvent event) {
System.out.println("初始化工作");
}
}
复制代码
场景 2:API 方式发布 Provider(较少使用)
应用启动完成后,先做初始化动作,完成后再手动发布 Provider。这种就可以通过实现接口 ApplicationRunner 或接口 CommandLineRunner 去执行初始化。
@Component
public class DataLoader implements ApplicationRunner {
@Override
public void run(ApplicationArguments args) throws Exception {
// 数据准备
System.out.println("初始化工作");
// 发布provider
// 参考:https://cf.jd.com/pages/viewpage.action?pageId=296129902
}
}
复制代码
场景 3:XML 方式手动发布(不常用)
provider 的 dynamic 属性设置为 false
| 标签 | 属性 | 类型 | 是否必填 | 默认值 | 描述 || provider | dynamic | boolean | 否 | true | 是否动态注册 Provider,默认为 true,配置为 false 代表不主动发布,需要到管理端进行上线操作 |
3. 总结
RPC 服务(如 JSF、Dubbo)进行优雅上线,常用的两种方式:1、延迟发布 2、手动发动
如果你的服务需要一些初始化操作后才能对外提供服务,如初始化缓存(不限与藏经阁、ducc、mysql、甚至调用其他 jsf 服务)、redis 连接池等相关资源就位,可以参考本文中介绍的几种方式。
此文是笔者通过读取源码+本地验证得出的结论,如有错误遗漏或者更好的方案还烦请各位指出共同进步!
作者:京东零售 郭宏宇
来源:京东云开发者社区 转载请注明来源
评论