springboot 学习之路 8 (整合websocket(1))

---

---

目录：【持续更新。。。。。】
　　
　　spring 部分常用注解
　　spring boot 学习之路1（简单入门）
　　spring boot 学习之路2（注解介绍）
　　spring boot 学习之路3（ 集成mybatis ）
　　spring boot 学习之路4（日志输出）
　　spring boot 学习之路5（打成war包部署tomcat）
　　spring boot 学习之路6（定时任务）
　　spring boot 学习之路6（集成durid连接池）
　　spring boot 学习之路7（静态页面自动生效问题）
　　spring boot 学习之路8 (整合websocket(1))
　　spring boot 学习之路9 (项目启动后就执行特定方法)

 

---

 

初探websocket:

　　WebSocket是html5新增加的一种通信协议，目前流行的浏览器都支持这个协议，例如Chrome，Safari，Firefox，Opera，IE等等，对该协议支持最早的应该是chrome，从chrome12就已经开始支持，随着协议草案的不断变化，各个浏览器对协议的实现也在不停的更新。该协议还是草案，没有成为标准，不过成为标准应该只是时间问题了，从WebSocket草案的提出到现在已经有十几个版本了，目前对该协议支持最完善的浏览器应该是chrome，毕竟WebSocket协议草案也是Google发布的。

WebSocket API简介:

　　

var ws = new WebSocket(“ws://localhost:9999/ws/huhy/”);   
ws.onopen = function(){ws.send(“Test!”); }; 
ws.onmessage = function(evt){console.log(evt.data);ws.close();}; 
ws.onclose = function(evt){console.log(“WebSocketClosed!”);}; 
ws.onerror = function(evt){console.log(“WebSocketError!”);};

注：

第一行代码是在申请一个WebSocket对象，参数是需要连接的服务器端的地址，同http协议使用http://开头一样，WebSocket协议的URL使用ws://开头，另外安全的WebSocket协议使用wss://开头。

第二行到第五行为WebSocket对象注册消息的处理函数，WebSocket对象一共支持四个消息 onopen, onmessage, onclose和onerror，当Browser和WebSocketServer连接成功后，会触发onopen消息；如果连接失败，发送、接收数据失败或者处理数据出现错误，browser会触发onerror消息；当Browser接收到WebSocketServer发送过来的数据时，就会触发onmessage消息，参数evt中包含server传输过来的数据；当Browser接收到WebSocketServer端发送的关闭连接请求时，就会触发onclose消息。我们可以看出所有的操作都是采用消息的方式触发的，这样就不会阻塞UI，使得UI有更快的响应时间，得到更好的用户体验。

---

说正事,

spring boot 和websocket的整合：

　　我分三步:

　　第一步：在pom中引入依赖jar包

　　　　

　　第二步：

　　　　开发静态页面：由于spring boot 应用，所以选择类控制页面

　　　　

　　　第三步:　　往spring容器中注入 ServerEndpointExporter

　　　　　　

 

　　　　　实现上面接口；

　　　　　　

package com.huhy.web.websocket;

/**
 * @Author:{huhy}
 * @DATE:Created on 2017/11/20 10:34
 * @Class Description:
 */
import org.springframework.stereotype.Component;

import javax.websocket.*;
import javax.websocket.server.PathParam;
import javax.websocket.server.ServerEndpoint;
import java.io.IOException;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;

/**
 * ServerEndpoint
 * <p>
 * 使用springboot的唯一区别是要@Component声明下，而使用独立容器是由容器自己管理websocket的，但在springboot中连容器都是spring管理的。
 * <p>
 * 虽然@Component默认是单例模式的，但springboot还是会为每个websocket连接初始化一个bean，所以可以用一个静态set保存起来。
 */
@ServerEndpoint("/ws/huhy/{userName}") //WebSocket客户端建立连接的地址
@Component
public class ChatRoomServerEndpoint {

    /**
     * 存活的session集合（使用线程安全的map保存）
     */
    private static Map<String, Session> livingSessions = new ConcurrentHashMap<>();

    /**
     * 建立连接的回调方法
     *
     * @param session  与客户端的WebSocket连接会话
     * @param userName 用户名，WebSocket支持路径参数
     */
    @OnOpen
    public void onOpen(Session session, @PathParam("userName") String userName) {
        livingSessions.put(session.getId(), session);
        sendMessageToAll(userName + " 加入聊天室");
    }

    /**
     * 收到客户端消息的回调方法
     *
     * @param message 客户端传过来的消息
     * @param session 对应的session
     */
    @OnMessage
    public void onMessage(String message, Session session, @PathParam("userName") String userName) {
        sendMessageToAll(userName + " : " + message);
    }


    /**
     * 发生错误的回调方法
     *
     * @param session
     * @param error
     */
    @OnError
    public void onError(Session session, Throwable error) {
        System.out.println("发生错误");
        error.printStackTrace();
    }

    /**
     * 关闭连接的回调方法
     */
    @OnClose
    public void onClose(Session session, @PathParam("userName") String userName) {
        livingSessions.remove(session.getId());
        sendMessageToAll(userName + " 退出聊天室");
    }


    /**
     * 单独发送消息
     *
     * @param session
     * @param message
     */
    public void sendMessage(Session session, String message) {
        try {
            session.getBasicRemote().sendText(message);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    /**
     * 群发消息
     *
     * @param message
     */
    public void sendMessageToAll(String message) {
        livingSessions.forEach((sessionId, session) -> {
            sendMessage(session, message);
        });
    }

}

 

 

---

 

　测试：

　　　　先启动spring boot 应用:

　　　　

　　　　启动两个以上页面

 　　　　

　　　　输入验证是不是可以同步：