HTML5新特性之WebSocket

最新推荐文章于 2024-09-25 21:35:05 发布

liuhe688

最新推荐文章于 2024-09-25 21:35:05 发布

阅读量1.9w

点赞数 18

分类专栏： Front End

本文链接：https://blog.csdn.net/liuhe688/article/details/50496780

版权

Front End 专栏收录该内容

27 篇文章 1 订阅

订阅专栏

在Web应用越来越复杂的今天，消息推送已经成为一个非常重要的功能了，有了消息推送，Web页面就能够及时的接收到来自服务端的消息，为用户展现最好的交互体验。过去我们在实现Web页面的消息推送时，一般都是由页面发起请求，以轮询的方式向服务器获取数据，实现起来极为不便，业务逻辑也相对较为复杂。

为了解决这个问题，进而实现真正意义上的消息推送，HTML5定义了一套新的规范，这就是WebSocket。下面我们就来介绍一下WebSocket这个新特性。

WebSocket是一种用于在服务器和客户端之间实现高效的双向通信的机制，通过WebSocket，能够实现在一个HTTP连接上自由地双向收发消息。

在通过WebSocket进行双向通信时，首先我们需要和服务器建立连接，这需要由客户端通过HTTP方式发送，服务器将会确认连接对象的源和协议，并发送连接许可响应，在客户端收到响应之后，一个WebSocket通信就正式建立起来了。

那么我们如何在客户端向服务器端发送请求呢？这时我们需要实例化一个WebSocket，代码如下所示：

var socket = new WebSocket('ws://www.websocket-testing.com:9000/server', 'subprotocol');

上面构造函数中的第一个参数是将要进行连接的WebScoket服务器的URL，第二个参数则是子协议名。需要注意的是，URL中我们可以选择“ws://”或“wss://”这两种协议，这两种协议分别默认使用80和443端口来通信，如果使用后者，是可以用TLS对通信加密的。第二个参数也可以是一个数组，以指定多个子协议名。

在执行构造函数之后，通信内部就会建立连接，一旦连接建立成功，WebSocket实例的open事件就会被触发：

socket.onopen = function(e) {
	console.log('websocket connection has established');
}

在连接建立成功之后，就可以进行消息收发了，这时我们可以调用send方法将消息发送到服务器，然后通过捕获message事件接收来自服务器的消息：

//send message to websocket server
socket.send('hello, server');

//receive message from websocket server
socket.onmessage = function(e){
	//obtain the message from server
	var message = e.data;
	
	//do something
}

在上面的代码中，我们发送了一个字符串类型的消息到服务器端，然后接收来自服务器端消息时，我们可以从event的data属性中取得。目前WebSocket可以收发消息的类型有String、Blob和ArrayBuffer，后面两个主要用于收发二进制数据的，日常开发中我们使用String类型就足够了，如果我们想要发送自定义对象，只需将其转换成JSON字符串后发送，如果客户端和服务端是以JSON形式通信，客户端收到消息后在将其转换为JavaScript对象即可。

在通信结束后，客户端可以调用close方法主动断开与服务器端的连接，如果连接断开，close事件就会被触发，我们可以捕获此事件，做进一步的操作处理：

//cut off the connection
socket.close();

socket.onclose = function(e){
	//do something
}

有些时候，因为网络问题或者服务器宕机的原因，客户端连接被切断，此时我们可以在捕获close事件后，试图重新建立连接，如下面代码所示：

socket.onclose = function() {
	setTimeout(function() {
		//reconnect operation
	}, 100000);
}

如果服务器宕机之后，有新的客户端试图连接，这种情况下会导致连接失败，error就会被触发，我们可以捕获error事件，做相应的处理操作：

socket.onerror = function() {
	console.log('socket error occurred');
};

需要注意的是，连接失败后，error和close会相继触发，所以实际开发中要避免处理操作的重叠。

接下来，为了能够更好的展示WebSocket的交互过程，我们会建立起从客户端到服务端的一个简易的实时在线聊天程序。

服务端

要建立起聊天程序，首先我们需要搭建服务端环境，使其支持WebSocket通信，目前大多服务器端编程语言都有自己相对应的库，大家可以根据自己的熟悉程度去选择，在这里我们选用Node.js搭建一个简易的WebSocket服务。

Node.js平台上有很多功能强大的WebSocket库，感兴趣的同学们都可以去了解一下，这里我们为了阐述基本用法，就选取一个叫ws的简易的库，使用npm命令安装即可：

npm install ws

如果对这个库不太熟悉的话，可以去github上看一下其使用说明：https://github.com/websockets/ws。

那么接下来我们就要创建一个简单的服务了，安装完ws库之后，只需在node_modules同级目录下创建一个websocket-server.js文件即可，如图：

下面是websocket-server.js中的一段简易的代码：

var WebSocketServer = require('ws').Server;
var socketServer = new WebSocketServer({ port: 9000 });

//to store all connected clients
var clients = [];

socketServer.on('connection', function(socket) {

	//if not the specified origin, disconnect the socket
	var origin = socket.upgradeReq.headers.origin;
	if (origin !== 'http://localhost') {
		socket.close();
		return;
	}

	//add to clients when socket is connected
	clients.push(socket);

	//broadcast to clients when new message comes from one client
	socket.on('message', function(message) {
		console.log(message);
		clients.forEach(function(client) {
			if (client !== socket) {
				client.send(message);
			}
		});
	});

	//remove from clients when socket is offline or disconnected
	socket.on('close', function() {
		for (var i = 0; i < clients.length; i++) {
			var client = clients[i];
			if (client === socket) {
				clients.splice(i, 1);
			}
		}
	});
});

console.log('socketServer is listening on 9000...');

在上面的代码中，首先我们创建一个独立运行的WebSocket服务，在9000端口监听客户端的连接请求，然后在客户端连接到服务端时，如果是安全的请求，就将其加入到clients中，当一个客户端发送消息时，服务端就会将这条消息广播到其他的客户端，最后当有客户端断开连接时，服务端将其从clients中移除。

这时，我们只需在命令行中使用node命令将服务运行起来：

node websocket-server.js

客户端

在服务端的服务建立起来之后，接下来我们就可以实现客户端逻辑了。在客户端中，我们会建立一个聊天窗口，上面显示聊天的消息内容，下面放置一个输入区，可以将输入内容发送至服务器端，服务器再分发给其他客户端，每个客户端收到消息后将消息追加到显示区域，单个客户端的UI视图如下：

下面来看一下基本的html结构：

<html>
	<head>
		<title>WebSocket</title>
		<link rel="stylesheet" type="text/css" href="css/main.css">
	</head>
	<body>
		<div id="chatting-room">
			<div class="description">chattings</div>
			<div id="chatting-messages">
				<!-- chatting messages will be here -->
			</div>
			<div class="input-container">
				<div id="chatting-input" contenteditable></div>
			</div>
			<div class="action-container">
				<button οnclick="sendMessage();">Send</button>
			</div>
		</div>
		<script type="text/javascript" src="js/jquery.js"></script>
		<script type="text/javascript" src="js/main.js"></script>
	</body>
</html>

在上面的代码中，我们看到button绑定了click事件，点击发送按钮，会触发sendMessage函数，将消息通过WebSocket发送至服务器端，而从服务器端返回的数据将会显示在#chatting-messages区域。

我们知道，客户端和服务器端的通信功能是基于WebSocket的，所以首先我们必须创建一个WebSocket实例对象：

window.username = prompt('please input your name') || 'scott';

//connect to a socket server
window.socket = new WebSocket('ws://localhost:9000');

//capture open event
socket.onopen = function() {
	console.log('socket connected');
};

//capture message event
socket.onmessage = function(e) {
	appendMessage(JSON.parse(e.data), false);
};

//capture close event
socket.onclose = function(e) {
	console.log('socket disconnected');
};

在这段代码中，首先我们在开始聊天之前获取用户输入的用户名，然后创建一个WebSocket实例，然后注册相关的事件函数，在onmessage函数中，我们注意到调用了appendMessage函数，这个函数是负责向聊天内容显示区域追加一条消息，下面我们来看一下appendMessage和sendMessage函数：

//append message to chatting-messages area
function appendMessage(data, isSelf) {
	var message = '<img class="icon" src="img/icon.png">'
				+ '<div class="message">'
				+ '	<span class="message-name">' + data.name + '</span>'
				+ '	<div class="message-content">' + data.message + '</div>'
				+ '</div>';
	var messageBody = $('<div class="message-body"></div>');
	if (isSelf) {
		messageBody.addClass('message-self');
	}
	messageBody.html(message);

	$('#chatting-messages').append(messageBody);
}

//collect user's input and send the message to server
function sendMessage() {
	var editArea = $('#chatting-input'),
		message = editArea.text().trim();

	if (!message) return;

	var messageObject = {name: window.username, message: message};

	window.socket.send(JSON.stringify(messageObject));
	appendMessage(messageObject, true);

	editArea.html('');
}

在appendMessage函数中，指定两个参数，第一个是要追加显示的数据，包含用户名和消息内容，第二个参数是鉴别是否是客户端自己发送的消息，如果是自己发送的，则会将消息显示在窗口的右侧。下面的sendMessage函数中，我们收集用户输入的数据，处理成JSON字符串，然后通过WebSocket发送至服务器端，同时将消息追加到显示区域。

到这里，我们的客户端逻辑就完成了，是不是非常简单？其实我们使用WebSocket只需要处理好几个相关的函数，便可与服务器端无缝地进行实时双向通信。

WebSocket的讲解到这里就结束了，在实际的应用开发中，客户端只需要配合服务器端，在数据和事件处理方面做到统一，便可构建一个实时高效的双向通信系统，实现真正意义上Web消息推送。

谢谢大家。