Springboot下使用WebSocket

一、背景

公司项目从servlet版本开始慢慢转变成使用springboot，手头上的项目使用到了websocket技术，然而，在加入统一认证之后，websocket不起作用，始终报错404，最终纠结一番才发现因为Nginx转发的问题。

二、实现

1、依赖引入
  要使用 websocket 关键是@ServerEndpoint这个注解，该注解是 javaee 标准中的注解,tomcat7 及以上已经实现了,如果使用传统方法将 war 包部署到 tomcat 中，只需要引入如下 javaee 标准依赖即可：

<dependency>
  <groupId>javax</groupId>
  <artifactId>javaee-api</artifactId>
  <version>7.0</version>
  <scope>provided</scope>
</dependency>

如使用 springboot 内置容器,无需引入，springboot 已经做了包含。我们只需引入如下依赖即可：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-websocket</artifactId>
</dependency>

2、Bean注入
  首先注入一个ServerEndpointExporterBean,该 Bean 会自动注册使用@ServerEndpoint 注解申明的 websocket endpoint。代码如下：

@Configuration
@ConditionalOnWebApplication
public class WebSocketConfig {
    //使用boot内置tomcat时需要注入此bean
    @Bean
    public ServerEndpointExporter serverEndpointExporter() {
        return new ServerEndpointExporter();
    }
}

3、建立SigarSocketServlet.java类，在该类中处理 websocket 逻辑

@ServerEndpoint("/sigar")
@Component
public class SigarSocketServlet {
	
	private static Logger logger = Logger.getLogger(SigarSocketServlet.class);
	//与某个客户端的连接会话，需要通过它来给客户端发送数据
	Set<Session> session_list =null;
	
	//静态变量，用来记录当前在线连接数。应该把它设计成线程安全的。
	private static int onlineCount = 0;

	//concurrent包的线程安全Set，用来存放每个客户端对应的MyWebSocket对象。若要实现服务端与单一客户端通信的话，可以使用Map来存放，其中Key可以为用户标识
	private static CopyOnWriteArraySet<SigarSocketServlet> webSocketSet = new CopyOnWriteArraySet<SigarSocketServlet>();
	//与某个客户端的连接会话，需要通过它来给客户端发送数据
	private Session session;
	
   /**
	* 收到客户端消息后调用的方法
	* @param message 客户端发送过来的消息
	* @param session 可选的参数
	*/
	@OnMessage
    public void onMessage(String message, Session session) 
    	throws IOException, InterruptedException {
        session_list =session.getOpenSessions();
        
        List<Map<String, String>> datas = new ArrayList<Map<String,String>>();       
        //本机
        Sigar sigar = new Sigar();
        try {
        	Map<String, String> map =new LinkedHashMap<String, String>();
            CpuPerc cpuCerc = sigar.getCpuPerc();
            
            map.put("cpuname", sigar.getCpuInfoList()[0].getModel());
            map.put("percent", String.valueOf(cpuCerc.getCombined() * 100));
            Mem mem = sigar.getMem();
            map.put("server","本机");
            map.put("used",String.valueOf(mem.getUsed() / 1024 / 1024));
            datas.add(map);     
        } catch (Exception e) {e.printStackTrace();}
		     
        Map<String, Object> data = new HashMap<String, Object>();
    	data.put("online", getOnlineCount());
    	data.put("info", datas);
    	
      //群发消息
  		for(SigarSocketServlet item: webSocketSet){
  			try {
  				item.sendMessage(new Gson().toJson(data));
  			} catch (IOException e) {
  				e.printStackTrace();
  				continue;
  			}
  		}  
    }
	
	@OnOpen
    public void onOpen (Session session) {
		this.session = session;
		webSocketSet.add(this);     //加入set中
		addOnlineCount();           //在线数加1
		logger.info("有新连接加入！当前在线人数为" + getOnlineCount());
		logger.info("Client connected");

    }
	
	
	/**
	 * 连接关闭调用的方法
	 */
	@OnClose
	public void onClose(){
		webSocketSet.remove(this);  //从set中删除
		subOnlineCount();           //在线数减1
		logger.info("有一连接关闭！当前在线人数为" + getOnlineCount());
	}


	/**
	 * 发生错误时调用
	 * @param session
	 * @param error
	 */
	@OnError
	public void onError(Session session, Throwable error){
		System.out.println("webSocket由于被你粗暴的关闭了，它表示很疼，并向你扔了一堆异常...");
//		error.printStackTrace();
	}

	/**
	 * 这个方法与上面几个方法不一样。没有用注解，是根据自己需要添加的方法。
	 * @param message
	 * @throws IOException
	 */
	public void sendMessage(String message) throws IOException{
		this.session.getBasicRemote().sendText(message);
		//this.session.getAsyncRemote().sendText(message);
	}

	public static synchronized int getOnlineCount() {
		return onlineCount;
	}

	public static synchronized void addOnlineCount() {
		SigarSocketServlet.onlineCount++;
	}

	public static synchronized void subOnlineCount() {
		SigarSocketServlet.onlineCount--;
	}
}

4、在统一认证中处理Websocket

@Override
    public void configure(HttpSecurity http) throws Exception {
        http.authorizeRequests()
                .antMatchers("/sigar/**")
                .permitAll()
                .anyRequest().authenticated()
                .and().headers().frameOptions().disable()
                .and().csrf().disable();
    }

需要在此放行接口，但是仅仅这样还是不行的，依旧无法正常使用websocket，获取不到信息，因为还有个Nginx的配置哦，接下来让我们看看Nginx中的配置：
在conf文件里面添加

在server中添加
 location /dip/sigar {
      proxy_pass http://192.168.9.131:8080/dip/sigar;
      proxy_set_header Upgrade $http_upgrade;
      proxy_set_header Connection "upgrade";
}

Proxy_pass为请求转发的地址（设置成项目部署的ip和端口即可）
需修改http://IP地址:端口/dip/sigar形式

至此，整个websocket就已经是可以通信的状态了！大功告成。