学习记录：springboot + websocket + spring-messaging实现服务器向浏览器广播式通信

http协议很好地解决了客户端向服务器通信的问题，虽然已经满足了大部分需求，但是难免会有服务器需要向客户端通信的情况，一般的解决方式就有ajax轮询、长轮询、socket。

ajax轮询就是定时使用ajax访问服务器，询问是否有新的消息。

长轮询则是访问服务器后，如果没有新消息，则服务器不做响应，直到请求超时或者有新消息，客户端再次发起请求。

这两种方式都会增加服务器压力，而且感觉有点笨。最好的方式就是使用socket进行长连接，双向通信。

参考了一些网上的博客，但是总是存在一些问题，所以自己整理了一下代码。文中不会对一些概念和术语或者技术做过多解释，这些东西网上很多，而且都比我懂，我只放出源代码，抛砖引玉，让大家少掉坑。

目录结构

红圈内是比较重要的文件，本文也只列出比较重要的文件，源代码我会在末尾给出。

pom.xml

    4.0.0
    com.web.socket
    websocket
    war
    0.0.1-SNAPSHOT
    websocket Maven Webapp
    http://maven.apache.org
      
        org.springframework.boot  
        spring-boot-starter-parent  
        2.0.0.RELEASE  
      
      
        UTF-8  
        UTF-8  
        1.8  
     
    
           
            org.springframework  
            spring-messaging  
          
          
            org.springframework.boot  
            spring-boot-starter  
          
          
            org.springframework.boot  
            spring-boot-starter-web  
         
          
           org.springframework.boot  
           spring-boot-starter-websocket  
        
       
            org.springframework.boot
            spring-boot-starter-thymeleaf
        
          
            javax.servlet  
            javax.servlet-api  
            provided  
         
        
            junit
            junit
            test
        
    
    
        websocket
    

WebSocketConfig.java

这里继承的类过时了，但是水平有限，一直不知道应该怎么替换，有大佬知道的指点指点

package com.web.socket.config;

import org.springframework.context.annotation.Configuration;
import org.springframework.messaging.simp.config.MessageBrokerRegistry;
import org.springframework.web.socket.config.annotation.AbstractWebSocketMessageBrokerConfigurer;
import org.springframework.web.socket.config.annotation.EnableWebSocketMessageBroker;
import org.springframework.web.socket.config.annotation.StompEndpointRegistry;

/**
 * @title websocket配置
 * @author yc 2018年5月21日
 */
@Configuration
//表示开启使用STOMP协议来传输基于代理的消息，Broker就是代理的意思。
@EnableWebSocketMessageBroker
public class WebSocketConfig extends AbstractWebSocketMessageBrokerConfigurer{
	/**
	 * @title 用来配置消息代理，由于我们是实现推送功能，这里的消息代理是/topic
	 * @author yc 2018年5月21日
	 */
	@Override
	public void configureMessageBroker(MessageBrokerRegistry registry) {
		registry.enableSimpleBroker(AppConfig.BROKER);
	}
	/**
	 * @title 表示注册STOMP协议的节点，并指定映射的URL。
	 * @author yc 2018年5月21日
	 */
	@Override
	public void registerStompEndpoints(StompEndpointRegistry registry) {
		//这一行代码用来注册STOMP协议节点，同时指定使用SockJS协议。 
		registry.addEndpoint(AppConfig.ENDPOINT).withSockJS();
	}
}

AppConfig.java

package com.web.socket.config;

/**
 * @title 全局参数
 * @author yc 2018年5月23日
 */
public class AppConfig {
	/**
	 * 被订阅的频道
	 */
	public static final String SUBSCRIBE = "/topic/message";
	/**
	 * stomp节点
	 */
	public static final String ENDPOINT = "/endpointYC";
	/**
	 * 消息代理
	 */
	public static final String BROKER = "/topic";
}

WebSocketController.java

package com.web.socket.controller;


import java.io.IOException;


import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.messaging.handler.annotation.MessageMapping;
import org.springframework.messaging.handler.annotation.SendTo;
import org.springframework.messaging.simp.SimpMessagingTemplate;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.ResponseBody;

import com.web.socket.config.AppConfig;
import com.web.socket.entity.RequestMessage;
import com.web.socket.entity.ResponseMessage;

@Controller
public class WsController {
	@Autowired
	private SimpMessagingTemplate simpMessagingTemplate;
	
	/**
	 * @title websocket产生消息，并推送
	 * @author yc 2018年5月23日
	 * @param message
	 * @return
	 */
	@MessageMapping("/ws")//和@RequestMapping类似
        @SendTo(AppConfig.SUBSCRIBE)//当服务器有消息需要推送的时候，会对订阅了@SendTo中路径的浏览器发送消息
        public ResponseMessage say(RequestMessage message) {
            System.out.println(message.getName());
            return new ResponseMessage(message.toString());
        }
	
	/**
	 * @title http请求产生消息，并推送
	 * @author yc 2018年5月23日
	 * @param message
	 * @return
	 * @throws IOException
	 */
	@PostMapping("/http")
	@ResponseBody
	public String send(@RequestBody RequestMessage message) throws IOException {
		System.out.println(message.getName());
		simpMessagingTemplate.convertAndSend(AppConfig.SUBSCRIBE,new ResponseMessage(message.toString()) );
		return "success";
	}
}

ws.html

    
    
    
    
    




    

        连接
        断开连接
    
    

        名字
        内容
        发送
        

    

以上就是比较重要的文件，注释都写得比较清楚了。

使用浏览器访http://127.0.0.1/ws就可以测试websocket方式广播。

在有socket连接的情况下，访问http://127.0.0.1/http，并使用post方式请求，就可以在ws页面看到发送的数据了。

后面有时间可能会再研究下点对点的通信方式。

源代码：https://github.com/qing-yan/qing

参考资料：

https://blog.csdn.net/u012702547/article/details/53816326