項目需求
- 利用 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);
}
}
server.port=9030
spring.thymeleaf.content-type=text/html
spring.thymeleaf.cache=false
spring.thymeleaf.mode =LEGACYHTML5
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();
}
}
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();
}*/
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";
}
}
}
<!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>
<!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>
啓動項目(後面的名字都是自定義的)
- 訪問地址： localhost:9030/websocket/jack
- 訪問地址： localhost:9030/websocket/mike
- 訪問地址： localhost:9030/websocket/java
-
- 訪問地址： localhost:9030/websocket/browser
參考文章
遇到的問題
