微服務-springboot+websocket在線聊天室

本文轉載自查看原文 2019-01-05 10:57 1093 微服務

一.引入依賴

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

二.注入ServerEndpointExporter

編寫一個WebSocketConfig配置類，注入對象ServerEndpointExporter，

這個bean會自動注冊使用了@ServerEndpoint注解聲明的Websocket endpoint

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.server.standard.ServerEndpointExporter;

/**
 * @Description: 編寫一個WebSocketConfig配置類，注入對象ServerEndpointExporter，
 *      這個bean會自動注冊使用了@ServerEndpoint注解聲明的Websocket endpoint
 */
@Configuration
public class WebSocketConfig {
    @Bean
    public ServerEndpointExporter serverEndpointExporter() {
        return new ServerEndpointExporter();
    }
}

三.websocket的具體實現類

使用springboot的唯一區別是要@Component聲明下，而使用獨立容器是由容器自己管理websocket的，

但在springboot中連容器都是spring管理的。

雖然@Component默認是單例模式的，但springboot還是會為每個websocket連接初始化一個bean，

所以可以用一個靜態set保存起來。

import org.springframework.stereotype.Component;

import javax.websocket.*;
import javax.websocket.server.ServerEndpoint;
import java.util.concurrent.CopyOnWriteArraySet;

/**
 *  * @Description: websocket的具體實現類
 *  * 使用springboot的唯一區別是要@Component聲明下，而使用獨立容器是由容器自己管理websocket的，
 *  * 但在springboot中連容器都是spring管理的。
 *     雖然@Component默認是單例模式的，但springboot還是會為每個websocket連接初始化一個bean，
 *     所以可以用一個靜態set保存起來。
*/
@ServerEndpoint(value = "/websocket")
@Component
public class MyWebSocket {
    //用來存放每個客戶端對應的MyWebSocket對象。
    private static CopyOnWriteArraySet<MyWebSocket> webSocketSet = new CopyOnWriteArraySet<MyWebSocket>();

    //與某個客戶端的連接會話，需要通過它來給客戶端發送數據
    private Session session;

    /**
     * 連接建立成功調用的方法
     */
    @OnOpen
    public void onOpen(Session session) {
        this.session = session;
        webSocketSet.add(this);     //加入set中
        System.out.println("有新連接加入！當前在線人數為" + webSocketSet.size());
        //群發消息，告訴每一位
        broadcast(session.getId()+"連接上WebSocket-->當前在線人數為："+webSocketSet.size());
    }

    /**
     * 連接關閉調用的方法
     */
    @OnClose
    public void onClose() {
        webSocketSet.remove(this);  //從set中刪除
        System.out.println("有一連接關閉！當前在線人數為" + webSocketSet.size());

        //群發消息，告訴每一位
        broadcast(session.getId()+"下線，當前在線人數為："+webSocketSet.size());
    }

    /**
     * 收到客戶端消息后調用的方法
     *
     * @param message 客戶端發送過來的消息
     * */
    @OnMessage
    public void onMessage(String message, Session session) {
        System.out.println("來自客戶端的消息:" + message);
        //群發消息
        broadcast(message);
    }

    /**
     * 發生錯誤時調用
     *
     */
    @OnError
    public void onError(Session session, Throwable error) {
        System.out.println("發生錯誤");
        error.printStackTrace();
    }

    /**
     * 群發自定義消息
     * */
    public  void broadcast(String message){
        for (MyWebSocket item : webSocketSet) {
            //同步異步說明參考：http://blog.csdn.net/who_is_xiaoming/article/details/53287691
            //this.session.getBasicRemote().sendText(message);
            item.session.getAsyncRemote().sendText(message);//異步發送消息.
        }
    }
}

四.編寫index.ftl

<!DOCTYPE html>
<html>
<head lang="en">
    <title>Spring Boot Demo - FreeMarker</title>

    <link href="/css/index.css" rel="stylesheet" />
    <script src="/js/index.js"></script>
</head>
<body>
    <button onclick="connectWebSocket()">連接WebSocket</button>
    <button onclick="closeWebSocket()">斷開連接</button>
    <hr />
    <br />
    消息：<input id="text" type="text" />
    <button onclick="send()">發送消息</button>
    <div id="message"></div>
</body>
</html>

五.編寫index.js

var websocket = null;
function connectWebSocket(){
    //判斷當前瀏覽器是否支持WebSocket
    //判斷當前瀏覽器是否支持WebSocket
    if ('WebSocket'in window) {
        websocket = new WebSocket("ws://localhost:8080/websocket");
    } else {
        alert('當前瀏覽器不支持websocket');
    }

    //連接發生錯誤的回調方法
    websocket.onerror = function() {
        setMessageInnerHTML("error");
    };

    //接收到消息的回調方法
    websocket.onmessage = function(event) {
        setMessageInnerHTML(event.data);
    }

    //連接關閉的回調方法
    websocket.onclose = function() {
        setMessageInnerHTML("Loc MSG:關閉連接");
    }

    //監聽窗口關閉事件，當窗口關閉時，主動去關閉websocket連接，防止連接還沒斷開就關閉窗口，server端會拋異常。
    window.onbeforeunload = function() {
        websocket.close();
    }
}

//將消息顯示在網頁上
function setMessageInnerHTML(innerHTML) {
    document.getElementById('message').innerHTML += innerHTML + '<br/>';
}

//關閉連接
function closeWebSocket() {
    websocket.close();
}

//發送消息
function send() {
    var message = document.getElementById('text').value;
    websocket.send(message);
}

六.index.css

#message{
    margin-top:40px;
    border:1px solid gray;
    padding:20px;
}

七.controller

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;

@Controller
@RequestMapping("web")
public class WebController {

    @RequestMapping("index")
    public String index(){
        return "index";
    }
}

測試：http://localhost:8080/web/index

點擊【連接WebSocket】,然后就可以發送消息了。

打開另外一個瀏覽器或者直接打開一個TAB訪問地址http://localhost:8080/web/index

點擊【連接WebSocket】,然后就可以發送消息了。

觀察兩邊的信息打印，看是否可以接收到消息。

源碼：下載地址

單聊

一.創建消息對象socketMsg

public class SocketMsg {
    private int type;//聊天類型0：群聊，1：單聊
    private String fromuUser://發送者
    private String toUser;//接收者
    private String msg;//發送的消息

    public int getType() {
        return type;
    }

    public void setType(int type) {
        this.type = type;
    }

    public String getFromuUser() {
        return fromuUser;
    }

    public void setFromuUser(String fromuUser) {
        this.fromuUser = fromuUser;
    }

    public String getToUser() {
        return toUser;
    }

    public void setToUser(String toUser) {
        this.toUser = toUser;
    }

    public String getMsg() {
        return msg;
    }

    public void setMsg(String msg) {
        this.msg = msg;
    }

二.調整建立連接的方法（MyWebSocket）:

這里主要是要使用一個map對象保存頻道號和session之前的關系，之后就可以通過頻道號獲取session，然后使用session進行消息的發送。

//用來記錄sessionId和該session進行綁定
    private static ConcurrentHashMap<String,Session> map = new ConcurrentHashMap<String, Session>();

三.修改連接的方法onOpen:

在建立連接的時候，就保存頻道號（這里使用的是session.getId()作為頻道號）

/**
     * 連接建立成功調用的方法
     */
    @OnOpen
    public void onOpen(Session session) {
        this.session = session;
        map.put(session.getId(),session);

        webSocketSet.add(this);     //加入set中
        System.out.println("有新連接加入:"+session.getId()+"！當前在線人數為" + webSocketSet.size());
        //群發消息，告訴每一位
        broadcast(session.getId()+"連接上WebSocket-->當前在線人數為："+webSocketSet.size());
    }

三.修改消息發送的方法onMessage:

 /**
     * 收到客戶端消息后調用的方法
     *
     * @param message 客戶端發送過來的消息
     * */
    @OnMessage
    public void onMessage(String message, Session session) {
        System.out.println("來自客戶端的消息:" + session.getId() + ":" + message);

        //從客戶端傳過來的數據是json數據，所以這里使用jackson進行轉換為SocketMsg對象，
        // 然后通過socketMsg的type進行判斷是單聊還是群聊，進行相應的處理:
        ObjectMapper objectMapper = new ObjectMapper();
        SocketMsg socketMsg;
        try {
            socketMsg = objectMapper.readValue(message, SocketMsg.class);
            if(socketMsg.getType() == 1){
                //單聊
                socketMsg.setFromUser(session.getId());//發送者.
                Session fromSession = map.get(socketMsg.getFromUser());
                Session toSession = map.get(socketMsg.getToUser());
                if(toSession != null){
                    //發送給發送者和接受者.
                    fromSession.getAsyncRemote().sendText(session.getId()+"："+socketMsg.getMsg());
                    toSession.getAsyncRemote().sendText(session.getId()+"："+socketMsg.getMsg());
                }else{
                    //發送給發送者
                    fromSession.getAsyncRemote().sendText("系統消息：對方已下線");
                }
            }else{
                //群聊
                broadcast(message);
            }
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

四.頁面調整

消息：<input id="text" type="text" />
    接收者：<input id="toUser" type="text" />
    <button onclick="send()">發送消息</button>

五.js調整

//發送消息
function send() {
    var message = document.getElementById('text').value;
    var toUser = document.getElementById('toUser').value;
    var socketMsg = {msg:message,toUser:toUser};
    if(toUser == ''){
        //群聊.
        socketMsg.type = 0;
    }else{
        //單聊.
        socketMsg.type = 1;
    }
    websocket.send(JSON.stringify(message));
}

運行測試：

2的消息：

1的消息：

0的消息：

源碼：下載地址

免責聲明！

本站轉載的文章為個人學習借鑒使用，本站對版權不負任何法律責任。如果侵犯了您的隱私權益，請聯系本站郵箱yoyou2525@163.com刪除。

猜您在找 SpringBoot+WebSocket 實現簡易聊天室 springboot+websocket實現簡單的在線聊天功能 Django實現WebSocket在線聊天室（channels庫） websocket 多聊天室功能基於Java的在線聊天室在線聊天室的實現(3)--簡易聊天室的實現 websocket(二)：SSM+websocket的聊天室基於WebSocket實現網頁版聊天室 PHP 之websocket實現聊天室功能 websocket實現一個聊天室