异常源码分析—告诉你学习“源码”究竟有什么用！

vlambda
2020-11-20

异常源码分析—告诉你学习“源码”究竟有什么用！

回复”669“获取独家整理的精选资料集

回复”加群“加入全国服务端高端社群「后端圈」

一、引言

最近接了个相当于外包的项目，在他们项目中集成一个WebSocket的服务端，嗯功能其实不难，但是前方有坑。

本文主要来记录一下，如果没有了百度，在项目启动就抛异常、或者一些奇奇怪怪的问题，靠自己怎么去排查问题，同样有时候并不是所有的问题都能够通过搜索引擎来解决。

除了外力，那我们就只剩下：异常信息、源码、和本身经验。

项目框架用的是SpringBoot，然后集成WebSocket就行，在集成的过程中，其中有一步需要配置一个Bean。

@Component
public class WsConfig {
 
	@Bean
	public ServerEndpointExporter serverEndpointExporter() {
		ServerEndpointExporter serverEndpointExporter = new ServerEndpointExporter();
		return serverEndpointExporter;
	}

然后在项目启动的时候抛出了异常信息：

org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'serverEndpointExporter' defined in class path resource [org/springblade/modules/hol/config/WsConfig.class]: Invocation of init method failed; nested exception is java.lang.IllegalStateException: javax.websocket.server.ServerContainer not available
	at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.initializeBean(AbstractAutowireCapableBeanFactory.java:1769)
	at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.doCreateBean(AbstractAutowireCapableBeanFactory.java:592)
	at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.createBean(AbstractAutowireCapableBeanFactory.java:514)
	at org.springframework.beans.factory.support.AbstractBeanFactory.lambda$doGetBean$0(AbstractBeanFactory.java:321)
	at org.springframework.beans.factory.support.DefaultSingletonBeanRegistry.getSingleton(DefaultSingletonBeanRegistry.java:226)
	at org.springframework.beans.factory.support.AbstractBeanFactory.doGetBean(AbstractBeanFactory.java:319)
	at org.springframework.beans.factory.support.AbstractBeanFactory.getBean(AbstractBeanFactory.java:199)
	at org.springframework.beans.factory.support.DefaultListableBeanFactory.preInstantiateSingletons(DefaultListableBeanFactory.java:863)
	at org.springframework.context.support.AbstractApplicationContext.finishBeanFactoryInitialization(AbstractApplicationContext.java:878)
	at org.springframework.context.support.AbstractApplicationContext.refresh(AbstractApplicationContext.java:550)
	at org.springframework.boot.web.servlet.context.ServletWebServerApplicationContext.refresh(ServletWebServerApplicationContext.java:141)
	at org.springframework.boot.SpringApplication.refresh(SpringApplication.java:744)
	at org.springframework.boot.SpringApplication.refreshContext(SpringApplication.java:391)
	at org.springframework.boot.SpringApplication.run(SpringApplication.java:312)
	at org.springframework.boot.builder.SpringApplicationBuilder.run(SpringApplicationBuilder.java:140)
	at org.springblade.core.launch.BladeApplication.run(BladeApplication.java:50)
	at org.springblade.Application.main(Application.java:18)
Caused by: java.lang.IllegalStateException: javax.websocket.server.ServerContainer not available
	at org.springframework.util.Assert.state(Assert.java:73)
	at org.springframework.web.socket.server.standard.ServerEndpointExporter.afterPropertiesSet(ServerEndpointExporter.java:107)
	at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.invokeInitMethods(AbstractAutowireCapableBeanFactory.java:1828)
	at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.initializeBean(AbstractAutowireCapableBeanFactory.java:1765)
	... 16 common frames omitted

二、问题分析

Error creating bean with name 'serverEndpointExporter' defined in class path resource [org/springblade/modules/hol/config/WsConfig.class]: Invocation of init method failed; nested exception is java.lang.IllegalStateException: javax.websocket.server.ServerContainer not available

通过异常的第一行就能够得知，是在Spring创建“serverEndpointExporter”bean的时候抛出来的，是这个WsConfig类，原因是：ServerContainer这个对象不可使用。

抛出异常的类是：AbstractAutowireCapableBeanFactory.java:1769

分析到这里就能够得知，是在spring创建serverEndpointExporter的时候异常了，那么异常的原因是什么呢？，为什么ServerContainer不可用呢？接着分析

通过控制台点击到对应的源码信息如下：AbstractAutowireCapableBeanFactory.java:1769

	protected Object initializeBean(String beanName, Object bean, @Nullable RootBeanDefinition mbd) {
		if (System.getSecurityManager() != null) {
			AccessController.doPrivileged((PrivilegedAction<Object>) () -> {
				invokeAwareMethods(beanName, bean);
				return null;
			}, getAccessControlContext());
		}
		else {
			invokeAwareMethods(beanName, bean);
		}
 
		Object wrappedBean = bean;
		if (mbd == null || !mbd.isSynthetic()) {
			wrappedBean = applyBeanPostProcessorsBeforeInitialization(wrappedBean, beanName);
		}
 
		try {
			invokeInitMethods(beanName, wrappedBean, mbd);
		}
		catch (Throwable ex) {
			throw new BeanCreationException(
                    // 1769 这里就是1769行～～
					(mbd != null ? mbd.getResourceDescription() : null),
					beanName, "Invocation of init method failed", ex);
		}
		if (mbd == null || !mbd.isSynthetic()) {
			wrappedBean = applyBeanPostProcessorsAfterInitialization(wrappedBean, beanName);
		}
 
		return wrappedBean;
	}

通过查看源码，是在1796行的catch里面抛出的异常的，catch是捕捉到invokeInitMethods这个方法异常，然后才抛出来的，这样就可以开始进行Debug了。

既然是在创建serverEndpointExporter这个bean异常的，加一个筛选条件，beanName等于serverEndpointExporter，这样就能过滤创建的其他bean。

异常源码分析—告诉你学习“源码”究竟有什么用！

断点卡好了，接下来就Debug模式来启动项目，然后F5进到invokeInitMethods方法，单步往下执行。

异常源码分析—告诉你学习“源码”究竟有什么用！

最后执行到了 ((InitializingBean) bean).afterPropertiesSet(); 这行代码，bean对象是ServerEndpointExporter，调用了这个对象的afterPropertiesSet方法。

异常源码分析—告诉你学习“源码”究竟有什么用！

来到ServerEndpointExporter这个java类，其中就会有afterPropertiesSet方法，首先调用getServerContainer方法获取serverContainer对象。

很明显这里返回的肯定是null，null ！= null 结果肯定是false，最后就是这样调用state(false,javax.websocket.server.ServerContainer not available)

通过state源码得知，最后就会抛出这个异常：java.lang.IllegalStateException: javax.websocket.server.ServerContainer not available

异常源码分析—告诉你学习“源码”究竟有什么用！

三、解决问题

通过文章上述分析，可以确认是因为ServerEndpointExporter这个类中有一个对象叫做serverContainer，它为null了，所以才会异常。

接下来我们就需要去找，serverContainer这个对象是在哪里赋值的，找源码就只有两处赋值了，这就好办了。

public class ServerEndpointExporter extends WebApplicationObjectSupport
		implements InitializingBean, SmartInitializingSingleton {
 
	@Nullable
	private List<Class<?>> annotatedEndpointClasses;
 
	@Nullable
	private ServerContainer serverContainer;
 
 
	// 有一个Set方法可以为serverContainer赋值
	public void setServerContainer(@Nullable ServerContainer serverContainer) {
		this.serverContainer = serverContainer;
	}
 
	
	@Nullable
	protected ServerContainer getServerContainer() {
		return this.serverContainer;
	}
 
 
    // 有一个init方法可以为serverContainer赋值
	@Override
	protected void initServletContext(ServletContext servletContext) {
		if (this.serverContainer == null) {
			this.serverContainer =
					(ServerContainer) servletContext.getAttribute("javax.websocket.server.ServerContainer");
		}
	}
 
 
	@Override
	public void afterPropertiesSet() {
		Assert.state(getServerContainer() != null, "javax.websocket.server.ServerContainer not available");
	}	
 
}