webscoket属于一种新的协议,与http协议有交叉但不完全相同,http属于无状态的协议,当客户端访问服务器关闭时,服务器就会忘记这个用户,当再次请求的时候要再次发出信号才行,所以这个时候就出现session和cookie来解决这个问题了,然而webscoket属于一种长期连接的一种协议,当客户端与服务器进行一次连接,只要不关闭,就会保持一直连接的状态,并且客户端还能实时的接受服务器发送的信息,就好像两个人聊天一样,能够实时的对话。(以上纯属个人见解,如有不同见解,欢迎打扰。)
1.springboot 框架的快速搭建在这里就不多少了,网上百度一下一大堆,很简单的。直接说配置了。
首先在搭建springboot的时候需要引入一个 <dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-websocket</artifactId>
</dependency> 这样的依赖。 我把我的pom.xml文件放在下面。
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.example</groupId>
<artifactId>webskt</artifactId>
<version>0.0.1-SNAPSHOT</version>
<packaging>war</packaging>
<name>webskt</name>
<description>Demo project for Spring Boot</description>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>1.5.9.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<java.version>1.8</java.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-jpa</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-jdbc</artifactId>
</dependency>
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>1.3.1</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-websocket</artifactId>
</dependency>
<dependency>
<groupId>com.microsoft.sqlserver</groupId>
<artifactId>mssql-jdbc</artifactId>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>javax</groupId>
<artifactId>javaee-api</artifactId>
<version>7.0</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-tomcat</artifactId>
<scope>provided</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
然后利用注解@ServerEndpoint 配置 。
package com.example.webskt.config;
import org.springframework.stereotype.Component;
import org.springframework.web.socket.server.standard.SpringConfigurator;
import javax.websocket.OnClose;
import javax.websocket.OnError;
import javax.websocket.OnMessage;
import javax.websocket.OnOpen;
import javax.websocket.Session;
import javax.websocket.server.ServerEndpoint;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.util.concurrent.CopyOnWriteArraySet;
@ServerEndpoint(value="/SocketServer")
@Component
public class SocketServer {
//静态变量,用来记录当前在线连接数。应该把它设计成线程安全的。
private static int onlineCount = 0;
public static String jsons;
//concurrent包的线程安全Set,用来存放每个客户端对应的MyWebSocket对象。若要实现服务端与单一客户端通信的话,可以使用Map来存放,其中Key可以为用户标识
private static CopyOnWriteArraySet<SocketServer> webSocketSet = new CopyOnWriteArraySet<SocketServer>();
//与某个客户端的连接会话,需要通过它来给客户端发送数据
private Session session;
@OnMessage
public void onMessage(String message, Session session) throws IOException, InterruptedException {
if("close".equals(message)){
onClose();
}
else{
//群发消息
for(SocketServer item: webSocketSet){
try {
item.sendMessage(message);
} catch (IOException e) {
e.printStackTrace();
continue;
}
}
}
// int i=0;
// while(true){
// i++;
// Thread.sleep(2000);
// session.getBasicRemote().
// sendText("This is an intermediate server message. Count: " +jsons+
// + i);
// if("".equals(jsons)){
// break;
// }
//
// }
//
// String []cmds = {"curl", "-i", "-w", "状态%{http_code};DNS时间%{time_namelookup};"
// + "等待时间%{time_pretransfer}TCP 连接%{time_connect};发出请求%{time_starttransfer};"
// + "总时间%{time_total}","http://www.baidu.com"};
// String cmds[]={"1","zhangsan","lisi","wnagwu","wanlou"};
// ProcessBuilder pb=new ProcessBuilder(cmds);
// System.out.println(" pb="+ pb);
// pb.redirectErrorStream(true);
// Process p;
//
// try {
// p = pb.start();
// BufferedReader br=null;
// String line=null;
//
// br=new BufferedReader(new InputStreamReader(p.getInputStream()));
// while((line=br.readLine())!=null){
// // Send the first message to the client
// session.getBasicRemote().sendText(line);
// }
// br.close();
// } catch (IOException e) {
// // TODO Auto-generated catch block
// e.printStackTrace();
// }
}
/**
* 连接建立成功调用的方法
* @param session 可选的参数。session为与某个客户端的连接会话,需要通过它来给客户端发送数据
*/
@OnOpen
public void onOpen(Session session) {
this.session = session;
System.out.println("session="+session);
webSocketSet.add(this); //加入set中
addOnlineCount(); //在线数加1
System.out.println("有新连接加入!当前在线人数为" + getOnlineCount());
}
@OnClose
public void onClose() {
webSocketSet.remove(this); //从set中删除
subOnlineCount(); //在线数减1
System.out.println("有一连接关闭!当前在线人数为" + getOnlineCount());
}
/**
* 发生错误时调用
* @param session
* @param error
*/
@OnError
public void onError(Session session, Throwable error){
System.out.println("发生错误");
error.printStackTrace();
}
/**
* 这个方法与上面几个方法不一样。没有用注解,是根据自己需要添加的方法。
* @param message
* @throws IOException
*/
public void sendMessage(String message) throws IOException{
this.session.getBasicRemote().sendText(message);
//this.session.getAsyncRemote().sendText(message);
}
public static synchronized int getOnlineCount() {
return onlineCount;
}
public static synchronized void addOnlineCount() {
SocketServer.onlineCount++;
}
public static synchronized void subOnlineCount() {
SocketServer.onlineCount--;
}
}
,
然后在配置这个。
package com.example.webskt.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.server.standard.ServerEndpointExporter;
@Configuration
public class WebSocketConfig {
@Bean
public ServerEndpointExporter serverEndpointExporter() {
return new ServerEndpointExporter();
}
}
后端基本就是这样了,下面看前端的。
<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
<meta charset="UTF-8"/>
<title>广播式WebSocket</title>
<script src="../static/scoket/sockjs.min.js" th:src="@{/static/scoket/sockjs.min.js}"></script>
<script src="../static/scoket/stomp.js" th:src="@{/static/scoket/stomp.js}"></script>
<script src="../static/scoket/jquery-3.1.1.js" th:src="@{/static/scoket/jquery-3.1.1.js}"></script>
</head>
<body>
<div>
<input type="text" id="te"/>
<input type="button" value="Start" οnclick="start()" />发送
</div>
<div id="messages"></div>
<div id="aaa"></div>
<script type="text/javascript">
var webSocket =null;
if('WebSocket' in window){
//console.log("sdasd="+window.location.host);
webSocket = new WebSocket('ws://'+window.location.host+'/webskt/SocketServer');
/* webSocket = new WebSocket('ws://localhost:8080/webskt/SocketServer'); */
}
else{
document.getElementById('messages').innerHTML = '连接失败!!';
}
webSocket.onerror = function(event) {
onError(event)
};
webSocket.onopen = function(event) {
onOpen(event)
};
webSocket.onmessage = function(event) {
onMessage(event);
// console.log(eval(event.data));// 接收到的实时数据!!
};
//连接关闭的回调方法
webSocket.onclose = function () {
document.getElementById('messages').innerHTML = 'Connection close';
}
//监听窗口关闭事件,当窗口关闭时,主动去关闭websocket连接,防止连接还没断开就关闭窗口,server端会抛异常。
window.onbeforeunload = function () {
close();
}
function onMessage(event) {
document.getElementById('messages').innerHTML
+= '<br />' + event.data;
}
function onOpen(event) {
document.getElementById('messages').innerHTML
= 'Connection open';
}
function onError(event) {
alert("连接失败!!");
}
//关闭!!
function close(){
webSocket.close();
return false;
}
function start() {
webSocket.send($('#te').val());
return false;
}
</script>
</body>
</html>
这里要注意。@ServerEndpoint(value="/SocketServer") 配置这里的value 要与前端 webSocket = new WebSocket('ws://'+window.location.host+'/webskt/SocketServer'); 后面的这个名字一致,是通过这个来进行通信的,这里用的是ws,并不是http,后面连接是本机地址+项目名称+注解的value名称。
开两个浏览器可以测试一下,这个是广播群发的功能,单个发送还在开发中。不过当我用springboot框架搭建这个的时候在本机测试没问题,但是放在服务器上出现jar包缺少的问题,纠结了好长时间没搞明白,希望知道的小伙伴能告诉我下,感激不尽!