websocket springboot 聊天室 群聊 私聊

项目需求

  • 利用 websocket 实现 消息的推送,比定时任务更加节约性能
  • 利用websocket 可以实现消息的群聊和私聊,我们可以根据这个进行开发

项目实现

  • 在eclipse 上面 创建一个springboot 项目 版本1.5.2 release
  • pom.xml 加入相关依赖
<dependencies>
	<!--Web项目必须加上-->
	<dependency>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-web</artifactId>
	</dependency>

	<!--造成用户启动失败的原因之一  -->
	<!-- <dependency>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter</artifactId>
	</dependency>  -->

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

	<dependency>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-test</artifactId>
		<scope>test</scope>
	</dependency>
	<!--访问静态资源配置下面的依赖-->
	<dependency>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-thymeleaf</artifactId>
	</dependency>
	<!--允许不严格的html5格式出现-->
	<dependency>
		<groupId>net.sourceforge.nekohtml</groupId>
		<artifactId>nekohtml</artifactId>
		<version>1.9.22</version>
	</dependency>
	<!-- google的集合 -->
	<dependency>
		<groupId>com.google.collections</groupId>
		<artifactId>google-collections</artifactId>
		<version>1.0</version>
	</dependency>
	<!-- JSON Configuration -->
	<dependency>
		<groupId>com.alibaba</groupId>
		<artifactId>fastjson</artifactId>
		<version>1.2.6</version>
	</dependency>
</dependencies>
  • 启动类
package com.fsl.springbootwebsocket;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.ComponentScan;

@SpringBootApplication
@ComponentScan("com.fsl.springbootwebsocket")
public class SpringbootWebsocketApplication {

	public static void main(String[] args) {
		SpringApplication.run(SpringbootWebsocketApplication.class, args);
	}

}
  • application.properties
server.port=9030

spring.thymeleaf.content-type=text/html 
spring.thymeleaf.cache=false 
spring.thymeleaf.mode =LEGACYHTML5
  • websocket 的基础配置 1
package com.fsl.springbootwebsocket.config;

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

@Configuration
public class WebSocketStompConfig{
    @Bean
    public ServerEndpointExporter serverEndpointExporter()
    {
        return new ServerEndpointExporter();
    }
}
  • websocket 的基础配置 2
package com.fsl.springbootwebsocket.config;

import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONObject;
import com.google.common.collect.Maps;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
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.Set;
import java.util.concurrent.ConcurrentHashMap;

@Component
@ServerEndpoint("/websocket/{username}")
public class WebSocket {
	private Logger logger = LoggerFactory.getLogger(this.getClass());
	/**
	 * 在线人数
	 */
	public static int onlineNumber = 0;
	/**
	 * 以用户的姓名为key,WebSocket为对象保存起来
	 */
	private static Map<String, WebSocket> clients = new ConcurrentHashMap<String, WebSocket>();
	/**
	 * 会话
	 */
	private Session session;
	/**
	 * 用户名称
	 */
	private String username;

	/**
	 * 建立连接
	 *
	 * @param session
	 */
	@OnOpen
	public void onOpen(@PathParam("username") String username, Session session) {
		onlineNumber++;
		logger.info("现在来连接的客户id:" + session.getId() + "用户名:" + username);
		this.username = username;
		this.session = session;
		logger.info("有新连接加入! 当前在线人数" + onlineNumber);
		try {
			// messageType 1代表上线 2代表下线 3代表在线名单 4代表普通消息
			// 先给所有人发送通知,说我上线了
			Map<String, Object> map1 = Maps.newHashMap();
			map1.put("messageType", 1);
			map1.put("username", username);
			sendMessageAll(JSON.toJSONString(map1), username);

			// 把自己的信息加入到map当中去
			clients.put(username, this);
			// 给自己发一条消息:告诉自己现在都有谁在线
			Map<String, Object> map2 = Maps.newHashMap();
			map2.put("messageType", 3);
			// 移除掉自己
			Set<String> set = clients.keySet();
			map2.put("onlineUsers", set);
			sendMessageTo(JSON.toJSONString(map2), username);
		} catch (IOException e) {
			logger.info(username + "上线的时候通知所有人发生了错误");
		}

	}

	@OnError
	public void onError(Session session, Throwable error) {
		logger.info("服务端发生了错误" + error.getMessage());
		// error.printStackTrace();
	}

	/**
	 * 连接关闭
	 */
	@OnClose
	public void onClose() {
		onlineNumber--;
		// webSockets.remove(this);
		clients.remove(username);
		try {
			// messageType 1代表上线 2代表下线 3代表在线名单 4代表普通消息
			Map<String, Object> map1 = Maps.newHashMap();
			map1.put("messageType", 2);
			map1.put("onlineUsers", clients.keySet());
			map1.put("username", username);
			sendMessageAll(JSON.toJSONString(map1), username);
		} catch (IOException e) {
			logger.info(username + "下线的时候通知所有人发生了错误");
		}
		logger.info("有连接关闭! 当前在线人数" + onlineNumber);
	}

	/**
	 * 收到客户端的消息
	 *
	 * @param message
	 *            消息
	 * @param session
	 *            会话
	 */
	@OnMessage
	public void onMessage(String message, Session session) {
		try {
            logger.info("来自客户端消息:" + message+"客户端的id是:"+session.getId());
            JSONObject jsonObject = JSON.parseObject(message);
            String textMessage = jsonObject.getString("message");
            String fromusername = jsonObject.getString("username");
            String tousername = jsonObject.getString("to");
            //如果不是发给所有,那么就发给某一个人
            //messageType 1代表上线 2代表下线 3代表在线名单  4代表普通消息
            Map<String,Object> map1 = Maps.newHashMap();
            map1.put("messageType",4);
            map1.put("textMessage",textMessage);
            map1.put("fromusername",fromusername);
            if(tousername.equals("All")){
                map1.put("tousername","所有人");
                sendMessageAll(JSON.toJSONString(map1),fromusername);
            }
            else{
                map1.put("tousername","java");
                sendMessageTo(JSON.toJSONString(map1),"java"); //c++或者任何一个用户   对java 说
                map1.put("fromusername","java");
                map1.put("tousername","browser");
                map1.put("textMessage","5896");
                sendMessageTo(JSON.toJSONString(map1),"browser"); // java 对  浏览器   说
            }
        }
        catch (Exception e){
            logger.info("发生了错误了");
        }
	}

	public void sendMessageTo(String message, String ToUserName) throws IOException {
		for (WebSocket item : clients.values()) {
			if (item.username.equals(ToUserName)) {
				item.session.getAsyncRemote().sendText(message);
				break;
			}
		}
	}

	public void sendMessageAll(String message, String FromUserName) throws IOException {
		for (WebSocket item : clients.values()) {
			item.session.getAsyncRemote().sendText(message);
		}
	}

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

}

// 初始代码
/*try {
JSONObject jsonObject = JSON.parseObject(message);
String textMessage = jsonObject.getString("message");
String fromusername = jsonObject.getString("username");// 谁发送的消息
String tousername = jsonObject.getString("to"); // 将消息发送给谁
Map<String, Object> map1 = Maps.newHashMap();
map1.put("messageType", 4);
map1.put("textMessage", textMessage);
map1.put("fromusername", fromusername);
if (tousername.equals("java")) {
	map1.put("tousername", tousername);
	System.err.println("我是c++,我正在给java发送数据");
	sendMessageTo(JSON.toJSONString(map1), tousername);
	System.err.println("我是java,我收到了数据,并准备发送给浏览器");
	map1.put("fromusername", "java");
	sendMessageTo("123", "browser");
	System.err.println("我是浏览器,我收到了来自java端的数据");
} else if (tousername.equals("browser")) {
	map1.put("tousername", tousername);
	sendMessageTo(JSON.toJSONString(map1), tousername);
}else{
	System.err.println("发送数据错误");
}
} catch (IOException e) {      
e.printStackTrace();
}*/
  • 连接websocket的启动类
package com.fsl.springbootwebsocket.controller;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@Controller
//@RestController
public class WebSocketController {

    private Logger logger = LoggerFactory.getLogger(this.getClass());

    @RequestMapping("/websocket/{name}")
    public String webSocket(@PathVariable String name, Model model){
        try{
            logger.info("跳转到websocket的页面上");
            model.addAttribute("username",name);
            return "websocket";
        }
        catch (Exception e){
            logger.info("跳转到websocket的页面上发生异常,异常信息是:"+e.getMessage());
            return "index";
        }
    }
    
}
  • 页面展示 index.html
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>首页信息</title>
    <script src="js/jquery-2.1.1.min.js" type="text/javascript" charset="utf-8"></script>
    <link rel="stylesheet" type="text/css" href="css/bootstrap.min.css" />
</head>
<body>
<div>
    <span>这里是首页的信息</span>
</div>
<div>
    <input type="text" id="show" value="aaaaaa">
</div>
</body>
<script>
    $(function () {
       console.log("输入框的值是:"+$("#show").val());
    });
</script>
</html>
  • 页面展示 websocket.html
<!DOCTYPE html>
<html>
<head>
    <title>websocket</title>
    <script type="text/javascript" src="http://ajax.microsoft.com/ajax/jquery/jquery-1.4.min.js"></script>
    <script src="http://cdn.bootcss.com/stomp.js/2.3.3/stomp.min.js"></script>
    <script src="https://cdn.bootcss.com/sockjs-client/1.1.4/sockjs.min.js"></script>
</head>

<body>
    <div style="margin: auto;text-align: center">
        <h2>Welcome to websocket</h2>
    </div>
    <br/>
    <div style="margin: auto;text-align: center">
        <select id="onLineUser">
            <option>--所有--</option>
        </select>
        <input id="text" type="text" />
        <button onclick="send()">发送消息</button>
    </div>
    <br>
    <div style="margin-right: 10px;text-align: right">
        <button onclick="closeWebSocket()">关闭连接</button>
    </div>
    <hr/>
    <div id="message" style="text-align: center;"></div>
    <input  type="text" th:value="${username}" id="username" style="display: none" />
</body>


<script type="text/javascript">
    var webSocket;
    var commWebSocket;
    var username = document.getElementById('username').value;
    setMessageInnerHTML("当前用户是:" + username ) ;
    
    if ("WebSocket" in window)
    {
        webSocket = new WebSocket("ws://localhost:9030/websocket/"+document.getElementById('username').value);
		console.log(webSocket);
		console.log(document.getElementById('username').value);
        //连通之后的回调事件
        webSocket.onopen = function()
        {
            //webSocket.send( document.getElementById('username').value+"已经上线了");
            console.log("已经连通了websocket");
            setMessageInnerHTML("已经连通了websocket");
        };

        //接收后台服务端的消息
        webSocket.onmessage = function (evt)
        {
            var received_msg = evt.data;
            console.log("数据已接收:" +received_msg);
            var obj = JSON.parse(received_msg);
            console.log("可以解析成json:"+obj.messageType);
            //1代表上线 2代表下线 3代表在线名单 4代表普通消息
            if(obj.messageType==1){
                //把名称放入到selection当中供选择
                var onlineName = obj.username;
                var option = "<option>"+onlineName+"</option>";
                $("#onLineUser").append(option);
                setMessageInnerHTML(onlineName+"上线了");
            }
            else if(obj.messageType==2){
                $("#onLineUser").empty();
                var onlineName = obj.onlineUsers;
                var offlineName = obj.username;
                var option = "<option>"+"--所有--"+"</option>";
                for(var i=0;i<onlineName.length;i++){
                    if(!(onlineName[i]==document.getElementById('username').value)){
                        option+="<option>"+onlineName[i]+"</option>"
                    }
                }
                $("#onLineUser").append(option);

                setMessageInnerHTML(offlineName+"下线了");
            }
            else if(obj.messageType==3){
                var onlineName = obj.onlineUsers;
                var option = null;
                for(var i=0;i<onlineName.length;i++){
                    if(!(onlineName[i]==document.getElementById('username').value)){
                        option+="<option>"+onlineName[i]+"</option>"
                    }
                }
                $("#onLineUser").append(option);
                console.log("获取了在线的名单"+onlineName.toString());
            }
            else{
                setMessageInnerHTML(obj.fromusername+"对"+obj.tousername+"说:"+obj.textMessage);
            }
        };

        //连接关闭的回调事件
        webSocket.onclose = function()
        {
            console.log("连接已关闭...");
            setMessageInnerHTML("连接已经关闭....");
        };
    }
    else{
        // 浏览器不支持 WebSocket
        alert("您的浏览器不支持 WebSocket!");
    }
    //将消息显示在网页上
    function setMessageInnerHTML(innerHTML) {
        document.getElementById('message').innerHTML += innerHTML + '<br/>';
    }

    function closeWebSocket() {
        //直接关闭websocket的连接
        webSocket.close();
    }

    function send() {
        var selectText = $("#onLineUser").find("option:selected").text();
        if(selectText=="--所有--"){
            selectText = "All";
        }
        else{
            setMessageInnerHTML(document.getElementById('username').value+"对"+selectText+"说:"+ $("#text").val());
        }
        var message = {
            "message":document.getElementById('text').value,
            "username":document.getElementById('username').value,
            "to":selectText
        };
        webSocket.send(JSON.stringify(message));
        $("#text").val("");

    }
</script>

</html>
  • 还有部分的css js

启动项目(后面的名字都是自定义的)

  • 访问地址: localhost:9030/websocket/jack
  • 访问地址: localhost:9030/websocket/mike
  • 访问地址: localhost:9030/websocket/java
    • 访问地址: localhost:9030/websocket/browser

参考文章

遇到的问题








评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值