解決SpringBoot webSocket 資源無法加載、tomcat啟動報錯的問題

更新時間：2020年11月25日 10:58:59 作者：fyhju1

這篇文章主要介紹了解決SpringBoot webSocket 資源無法加載、tomcat啟動報錯的問題,本文給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下

問題描述：

1. 項目集成WebSocket，且打包發(fā)布tomcat時出現(xiàn)websocket is already in CLOSING or CLOSE state這樣的問題，建議參考“解決方法二”，但是“解決方法一”請要了解查看 ,因為解決方法二是在一的基礎上進行更正

2. 如果出現(xiàn)javax.websocket.server.ServerContainer not available這樣的錯誤，請參考“解決方法一”中步驟3

解決方法一：（常規(guī)解決、不推薦）

步驟1：在BootApplication中修改：

public static void main(String[] args) {
		SpringApplication springApplication = new SpringApplication(BootApplication.class);
		springApplication.addListeners(new ApplicationPidFileWriter());
		ConfigurableApplicationContext applicationContext = springApplication.run(args);
		WebSocketServer.setApplicationContext(applicationContext);

注：這里的WebSocketServer是指你自定義的websocket接受消息的服務類

步驟2：修改WebSocketServer

private static ManageUserMapper manageUserMapper;
 
 public static void setApplicationContext(ConfigurableApplicationContext   applicationContext) {
  WebSocketServer.manageUserMapper = applicationContext.getBean(ManageUserMapper.class);
 }

步驟3: 修改pom.xml

由于我們在開發(fā)過程中，如果按照以上步驟1、2進行修改，一般不會出現(xiàn)問題，

但是如果我們打包發(fā)布tomcat,就會出現(xiàn)：javax.websocket.server.ServerContainer not available這樣的錯誤，步驟3為常規(guī)解決一下問題方式

<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-web</artifactId>
			<!-- 去除內(nèi)嵌tomcat -->
			<exclusions>
				 <exclusion>
					<groupId>org.springframework.boot</groupId>
					<artifactId>spring-boot-starter-tomcat</artifactId>
				</exclusion>
			</exclusions>
		</dependency>

需要去除web-starter的tomcat，因為如果不去除會導致沖突,

如果出現(xiàn)這種問題，你還需要在websocketConfig中做如下修改：（websocket為自定義配置類）

/**
  * 服務器節(jié)點
  *
  * 如果使用獨立的servlet容器，而不是直接使用springboot的內(nèi)置容器，就不要注入ServerEndpointExporter，因為它將由容器自己提供和管理
  * @return
  */
 @Bean
 @Profile("dev")
 public ServerEndpointExporter serverEndpointExporter() {
  return new ServerEndpointExporter();
 }

在application.properties做如下配置

##prod:生產(chǎn)環(huán)境 dev:開發(fā)環(huán)境(WINDOWS)
spring.profiles.active=dev

這里加入了@Profile("dev") 這個注解。意思是在開發(fā)的過程中去調(diào)用

.記住如果開發(fā)過程中，記得一定要把pom.xml中的去除tomcat那句話給注釋掉，上線才需要去除

問題反思：（為什么不建議這么解決問題）

這種方式確實可以常規(guī)解決websocket打包tomcat不報錯問題，同時也解決了在資源無法加載的問題，但是這樣卻十分的麻煩，理由如下：

1. 繁瑣：生產(chǎn)環(huán)境和開發(fā)環(huán)境要一直切換是否注釋tomcat

2. 局限性大：我們在BootApplication中添加了websocketserver去訪問資源的語句，但是其他地方難道沒有需要調(diào)用的嗎，如果有，難道像這樣一直累計添加下去，每個server設置一下

核心思想是資源無法加載的問題，如果你有寫線程，且線程你也調(diào)用了數(shù)據(jù)庫資源，那么解決方法是一致，編寫一個公用的工具類解決

解決方法二：（推薦）

步驟1：新建一個工具類，getbeanTool

此工具類為之后加載資源的工具類，公用

@Component
public class GetBeanTool implements ApplicationContextAware{
	
	private static ApplicationContext applicationContext = null;
 
 @Override
 public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
  GetBeanTool.applicationContext = applicationContext;
 }
 
 public static Object getBeanByName(String beanName) {
  if (applicationContext == null){
   return null;
  }
  return applicationContext.getBean(beanName);
 }
 
 public static <T> T getBean(Class<T> type) {
  return applicationContext.getBean(type);
 }
 
}

步驟2：在線程、websocket等server中，加載資源

以WebSocketServer作為參考，如下修改：

 private ManageUserMapper manageUserMapper;
 
 public WebSocketServer() {
 	this.manageUserMapper=GetBeanTool.getBean(ManageUserMapper.class);
 }

這么做你就不用在BootApplication中添加語句，來讓你的server去調(diào)用資源了，一步到位，大家都能用，需要的時候直接通過getbeanTool去請求就行了

步驟3：解決tomcat開發(fā)環(huán)境，生產(chǎn)環(huán)境pom.xml中注釋和打開內(nèi)置tomcat的問題

這里需要修改BootApplication，如下修改：

@SpringBootApplication
@Configuration
public class BootApplication extends SpringBootServletInitializer {
 
	@Override
	protected SpringApplicationBuilder configure(
			SpringApplicationBuilder application) {
		return application.sources(BootApplication.class);
	}
 
 
	public static void main(String[] args) {
		SpringApplication.run(BootApplication.class, args);
	}
}

可以看到這里我繼承了SpringBootServletInitializer ，同時重寫了configure方法。采用這種寫法，如論是開發(fā)還是測試，你都不用管是否需要注釋內(nèi)置的tomcat了，是不是很方便，至于原理，這里不解釋，篇幅太長，自己去百度吧