SpringBoot集成WebSocket

1. 引入依赖

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

2. 配置WebSocket

@Configuration
public class WebSocketConfig {

    @Bean
    public ServerEndpointExporter serverEndpointExporter() {
        return new ServerEndpointExporter();
    }
}

3. 配置连接端口, 和客户端建立连接onOpen, onClose, 配置onMessage, onError, sendMessage方法

@Slf4j
@ServerEndpoint("/imserver/endpoint")
@Component
public class WebSocketServer {

    /**静态变量，用来记录当前在线连接数。应该把它设计成线程安全的。*/
    private static int onlineCount = 0;
    /**concurrent包的线程安全Set，用来存放每个客户端对应的MyWebSocket对象。*/
    private static ConcurrentHashMap<String,WebSocketServer> webSocketMap = new ConcurrentHashMap<>();
    /**与某个客户端的连接会话，需要通过它来给客户端发送数据*/
    private Session session;
    /**接收userId*/
    private String userId="";

    /**
     * 连接建立成功调用的方法*/
    @OnOpen
    public void onOpen(Session session) {
        this.session = session;
        this.userId= StreamlineContext.getUserName();
        if(webSocketMap.containsKey(userId)){
            webSocketMap.remove(userId);
            webSocketMap.put(userId,this);
            //加入set中
        }else{
            webSocketMap.put(userId,this);
            //加入set中
            addOnlineCount();
            //在线数加1
        }

        log.info("用户连接:"+userId+",当前在线人数为:" + getOnlineCount());

        try {
            JSONObject jsonObject = new JSONObject();
            jsonObject.put("msg", "连接成功");
            sendMessage(jsonObject.toJSONString());
        } catch (IOException e) {
            log.error("用户:"+userId+",网络异常!!!!!!");
        }
    }

    /**
     * 连接关闭调用的方法
     */
    @OnClose
    public void onClose() {
        if(webSocketMap.containsKey(userId)){
            webSocketMap.remove(userId);
            //从set中删除
            subOnlineCount();
        }
        log.info("用户退出:"+userId+",当前在线人数为:" + getOnlineCount());
    }

    /**
     * 收到客户端消息后调用的方法
     *
     * @param message 客户端发送过来的消息*/
    @OnMessage
    public void onMessage(String message, Session session) {
        log.info("用户消息:"+userId+",报文:"+message);
        //可以群发消息
        //消息保存到数据库、redis
        if(StringUtils.isNotBlank(message)){
            try {
                //解析发送的报文
                JSONObject jsonObject = JSON.parseObject(message);
                //追加发送人(防止串改)
                jsonObject.put("fromUserId",this.userId);
                String toUserId=jsonObject.getString("toUserId");
                //传送给对应toUserId用户的websocket
                if(StringUtils.isNotBlank(toUserId)&&webSocketMap.containsKey(toUserId)){
                    webSocketMap.get(toUserId).sendMessage(jsonObject.toJSONString());
                }else{
                    log.error("请求的account:"+toUserId+"不在该服务器上");
                    //否则不在这个服务器上，发送到mysql或者redis
                }
            }catch (Exception e){
                e.printStackTrace();
            }
        }
    }

    /**
     *
     * @param session
     * @param error
     */
    @OnError
    public void onError(Session session, Throwable error) {
        log.error("用户错误:"+this.userId+",原因:"+error.getMessage());
        error.printStackTrace();
    }
    /**
     * 实现服务器主动推送
     */
    public void sendMessage(String message) throws IOException {
        this.session.getBasicRemote().sendText(message);
    }


    /**
     * 发送自定义消息
     */
    public static void sendInfo(String message, @PathParam("userId") String userId) throws IOException {
        log.info("发送消息到:"+userId+"，报文:"+message);
        if(StringUtils.isNotBlank(userId)&&webSocketMap.containsKey(userId)){
            webSocketMap.get(userId).sendMessage(message);
        }else{
            log.error("用户"+userId+",不在线！");
        }
    }

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

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

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

4. 前端使用VUE自带WebSocket组件, 进行连接监听

<template>
    <div style="margin-top: 20px;">
        <span>选择用户:</span>
        <el-select v-model="account"  style="width: 300px">
            <el-option
            v-for="(item,index) in userData"
            :key="index"
            :label="item.userName + ' --- ' + item.account"
            :value="item.account"
            ></el-option>
        </el-select>
        <br>
        <div style="margin-top: 10px;"></div>
        <span>消息:</span>
        <el-input v-model="msg" placeholder="消息" style="width: 300px" />
        <button @click="send">发消息</button>
    </div>
</template>

<script> 
import cookieUtil from '../../common/js/util/cookie'
export default {
    data () {
        return {
            path:"ws://100.119.80.109:8900/imserver/endpoint" + "?access_token=" + cookieUtil.getCookie("access_token"),
            socket:"",
            loading: false,
            userData: [],
            account: 'admin',
            msg: ''
        }
    },
    mounted () {
        // 初始化
        this.init();
    },
    methods: {
        init: function () {
            if(typeof(WebSocket) === "undefined"){
                alert("您的浏览器不支持socket")
            }else{
                // 实例化socket
                this.socket = new WebSocket(this.path)
                // 监听socket连接
                this.socket.onopen = this.open
                // 监听socket错误信息
                this.socket.onerror = this.error
                // 监听socket消息
                this.socket.onmessage = this.getMessage
            }
        },
        open: function () {
            console.log("socket连接成功")
        },
        error: function () {
            console.log("连接错误")
        },
        getMessage: function (msg) {
            console.log(msg.data)
            let data = JSON.parse(msg.data)
            if (data.msg == '连接成功') {
                this.$message({
                    message: data.msg,
                    type: "success"
                });
            } else {
                this.$message({
                    message: data.fromUserId + "说: " + data.msg,
                    type: "success"
                });
            }
        },
        send: function () {
            let param = {
                msg: this.msg,
                toUserId: this.account
            }
            this.socket.send(JSON.stringify(param))
        },
        close: function () {
            console.log("socket已经关闭")
        },
        destroyed () {
            // 销毁监听
            this.socket.onclose = this.close
        }
	}
</script>

<style>

</style>