基于webSocket的多人聊天系统

一.WebSocket简单介绍

　　随着互联网的发展，传统的HTTP协议已经很难满足Web应用日益复杂的需求了。近年来，随着HTML5的诞生，WebSocket协议被提出，它实现了浏览器与服务器的全双工通信，扩展了浏览器与服务端的通信功能，使服务端也能主动向客户端发送数据。

　　我们知道，传统的HTTP协议是无状态的，每次请求（request）都要由客户端（如 浏览器）主动发起，服务端进行处理后返回response结果，而服务端很难主动向客户端发送数据；这种客户端是主动方，服务端是被动方的传统Web模式 对于信息变化不频繁的Web应用来说造成的麻烦较小，而对于涉及实时信息的Web应用却带来了很大的不便，如带有即时通信、实时数据、订阅推送等功能的应 用。在WebSocket规范提出之前，开发人员若要实现这些实时性较强的功能，经常会使用折衷的解决方法：轮询（polling）和Comet技术。其实后者本质上也是一种轮询，只不过有所改进。

　　轮询是最原始的实现实时Web应用的解决方案。轮询技术要求客户端以设定的时间间隔周期性地向服务端发送请求，频繁地查询是否有新的数据改动。明显地，这种方法会导致过多不必要的请求，浪费流量和服务器资源。

　　Comet技术又可以分为长轮询和流技术。长轮询改进了上述的轮询技术，减小了无用的请求。它会为某些数据设定过期时间，当数据过期后才会向服务端发送请求；这种机制适合数据的改动不是特别频繁的情况。流技术通常是指客户端使用一个隐藏的窗口与服务端建立一个HTTP长连接，服务端会不断更新连接状态以保持HTTP长连接存活；这样的话，服务端就可以通过这条长连接主动将数据发送给客户端；流技术在大并发环境下，可能会考验到服务端的性能。

　　这两种技术都是基于请求-应答模式，都不算是真正意义上的实时技术；它们的每一次请求、应答，都浪费了一定流量在相同的头部信息上，并且开发复杂度也较大。

　　伴随着HTML5推出的WebSocket，真正实现了Web的实时通信，使B/S模式具备了C/S模式的实时通信能力。WebSocket的工作流程是这 样的：浏览器通过JavaScript向服务端发出建立WebSocket连接的请求，在WebSocket连接建立成功后，客户端和服务端就可以通过 TCP连接传输数据。因为WebSocket连接本质上是TCP连接，不需要每次传输都带上重复的头部数据，所以它的数据传输量比轮询和Comet技术小 了很多。本文不详细地介绍WebSocket规范，主要介绍下WebSocket在Java Web中的实现。

　　JavaEE 7中出了JSR-356:Java API for WebSocket规范。不少Web容器，如Tomcat,Nginx,Jetty等都支持WebSocket。Tomcat从7.0.27开始支持 WebSocket，从7.0.47开始支持JSR-356。

二.WebSocket服务器端

方式一：继承WebSocketServlet(该方式的代码需要部署在Tomcat7.0.27及以上的版本才能运行。tomcat 8.0之后好像没有了org.apache.catalina.websocket.WebSocketServlet这个类)

ChatWebSocket：

package com.solin.chat;

import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServletRequest;

import org.apache.catalina.websocket.StreamInbound;
import org.apache.catalina.websocket.WebSocketServlet;


/**
 * web容器实现了webSocket客户端
 * web容器:tomcat jetty websphere weblogic
 * Tomcat从7.0.27开始支持 WebSocket，从7.0.47开始支持JSR-356
 * 此项目使用的是tomcat7,tomcat8.0以上websocket的实现与7.x有很大的差别.
 * @author Solin
 * 
 */
@WebServlet(urlPatterns = {"/webChat"})
public class ChatWebSocket extends WebSocketServlet{
	private static final long serialVersionUID = 4646660835897075988L;

	@Override
	protected StreamInbound createWebSocketInbound(String arg0, HttpServletRequest arg1) {
		return new ChatMsgInbound();
	}
	
}

ChatMsgInbound：

package com.solin.chat;

import java.io.IOException;
import java.nio.ByteBuffer;
import java.nio.CharBuffer;

import org.apache.catalina.websocket.MessageInbound;
import org.apache.catalina.websocket.WsOutbound;

/**
 * 消息处理类
 * @author Solin
 *
 */
public class ChatMsgInbound extends MessageInbound{

	/**
	 * 客户端与服务器建立连接时
	 */
	@Override
	protected void onOpen(WsOutbound outbound) {
		ChatMsgInboundPool.getMessageInbound().add(this);
		super.onOpen(outbound);
	}
	
	/**
	 * 当连接关闭时
	 */
	@Override
	protected void onClose(int status) {
		ChatMsgInboundPool.getMessageInbound().remove(this);
		super.onClose(status);
	}

	/**
	 * 当接收到二进制消息内容时  怎么处理
	 */
	@Override
	protected void onBinaryMessage(ByteBuffer byteBuffer) throws IOException {
		for(MessageInbound msgIn : ChatMsgInboundPool.getMessageInbound()){
			ByteBuffer bb = ByteBuffer.wrap(byteBuffer.array());
			WsOutbound ws = msgIn.getWsOutbound();
			ws.writeBinaryMessage(bb);
			ws.flush();
		}
	}

	/**
	 * 当接收到文本消息内容时  怎么处理
	 */
	@Override
	protected void onTextMessage(CharBuffer charBuffer) throws IOException {
		for(MessageInbound msgIn : ChatMsgInboundPool.getMessageInbound()){
			CharBuffer cb = CharBuffer.wrap(charBuffer);
			WsOutbound ws = msgIn.getWsOutbound();
			ws.writeTextMessage(cb);
			ws.flush();
		}
	}
}

ChatMsgInboundPool：

package com.solin.chat;

import java.util.ArrayList;
import java.util.List;

import org.apache.catalina.websocket.MessageInbound;

/**
 * 帮助类
 * @author Solin
 *
 */
public class ChatMsgInboundPool {
	//连接池，用来保存每个客户端连接的对象
	private static List<MessageInbound> msgList 
		= new ArrayList<MessageInbound>();
	
	public static List<MessageInbound> getMessageInbound(){
		return msgList;
	}
}

方式二：JSR356实现WebSocket(该方式的代码需要部署在Tomcat7.0.47以上的版本才能运行)

WebSocketTest：

package com.solin.chat;

import java.io.IOException;
import java.util.ArrayList;
import java.util.List;

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;

/**
 * JSR356实现WebSocket有两种方式,一种是使用注解的,另一种是继承javax.websocket.Endpoint类,
 * 推荐方式是使用注解(本例使用注解)
 * 
 * @ServerEndpoint 注解是一个类层次的注解，它的功能主要是将目前的类定义成一个websocket服务器端,
 * 注解的值将被用于监听用户连接的终端访问URL地址,客户端可以通过这个URL来连接到WebSocket服务器端
 */
@ServerEndpoint("/websocket")
public class WebSocketTest {
	//连接池，用来保存每个客户端连接的对象
	private static List<WebSocketTest> msgList 
		= new ArrayList<WebSocketTest>();
	
	//与某个客户端的连接会话，需要通过它来给客户端发送数据
	private Session session;
	
	/**
	 * 连接建立成功调用的方法
	 * @param session  可选的参数。session为与某个客户端的连接会话，需要通过它来给客户端发送数据
	 */
    @OnOpen
    public void onOpen(Session session){
    	this.session = session;
	    msgList.add(this);
	    System.out.println("有新连接加入");
    }
    
    /**
     * 连接关闭调用的方法
     */
    @OnClose
    public void onClose(){
	    msgList.remove(this);
	    System.out.println("有连接关闭");
    }
    
    /**
     * 收到客户端消息后调用的方法
     * @param message 客户端发送过来的消息
     * @param session 可选的参数
     */
    @OnMessage
    public void onMessage(String message, Session session) {
	    System.out.println("来自客户端的消息:" + message);
	    //群发消息
	    for(WebSocketTest item: msgList){
		    try {
		    	item.sendMessage(message);
		    } catch (IOException e) {
			    e.printStackTrace();
			    continue;
		    }
	    }
    }
    
    /**
     * 发生错误时调用
     * @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);
    }
}

三.WebSocket客户端

index.jsp

<%@ page language="java" contentType="text/html; charset=UTF-8"
    pageEncoding="UTF-8"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
	<head>
		<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
		<title>基于Java服务器端的消息主动推送技术揭秘</title>
		<style type="text/css">
			*{
				margin:0;
				padding:0;
			}
			body{background:#e2e2e2;}
			.chatBox{
				width:680px;
				margin:0 auto;
				text-align:center;
			}
			.chatBox h1{
				font-size:30px;
				color:#D29575;
				margin-top:20px;
			}
			.tipBox{
				text-align:left;
				line-height:35px;
			}
			.inputText{height:30px;}
			.chatContainer{
				width:100%;
				height:300px;
				overflow:hidden;
				text-align:left;
				border:1px solid #000;
			}
			.sendBox{text-align:left;}
			button{
				height:30px;
				width:80px;
				color:#fff;
				font-size:20px;
				background:#2996A1;
				margin:7px auto;
				cursor:pointer;
				outline:none;
			}
		</style>
		<script type="text/javascript" src="js/jquery-1.7.2.min.js"></script>
		<script type="text/javascript">
			var ws;
			var socketCreated = false;
			var isLogout = false;
			//页面一加载就执行
			$(function(){
				$("#sendBox").hide();
				//判断浏览器是否支持WebSocket
				if(window.WebSocket || window.MozWebSocket){
					$("#chatContainer").append("<span style='color:green;'>您的浏览器支持WebSocket，您可以尝试连接到聊天服务器！</span><br/>");
					$("#conUrl").val("localhost:8080/Solin_Chat/webChat");
				}else{
					$("#chatContainer").append("<span style='color:red;'>浏览器不支持WebSocket，请更换浏览器！</span><br/>");
				}
				//绑定消息发送事件
				$("#sendMsgBtn").click(function(){
					var msg = $("#msgContent").val().trim();
					if(msg != ""){
						ws.send($("#loginUser").val()+"说："+msg+"<br/>");
					}
					$("#msgContent").val("");
				});
				
				//给连接按钮绑定点击事件
				$("#conBtn").click(function(){
					//0：正在连接   1：已连接   2：正在关闭连接   3：已关闭连接
					if(socketCreated && (ws.readyState == 0 || ws.readyState == 1)){//已经连接了
						ws.send("<span style='color:blue;font-weight:bold'>["+$("#loginUser").val()+"]离开了聊天室...</span><br/>")
						socketCreated = false;
						isLogout = true;
						ws.close();//关闭连接
						$("#conBtn").html("连接");//修改按钮文字
						$("#sendBox").hide();
					}else{//还没连接
						//申请WebSocket对象
						if("WebSocket" in window){
							ws = new WebSocket("ws://"+$("#conUrl").val());
						}else if("MozWebSocket" in window){
							ws = new MozWebSocket("ws://"+$("#conUrl").val());
						}
						socketCreated = true;
						isLogout = false;
						$("#conBtn").html("断开");//修改按钮文字
						
						//注册事件
						ws.onopen = wsOnOpen;//获得连接时
						ws.onmessage = wsOnMessage;//接收消息时
						ws.onclose = wsOnClose;//关闭连接时
						ws.onerror = wsOnError;//处理发生错误时(消息发送错误、连接错误)
					}
				});
			});
			
			function wsOnOpen(){
				ws.send("<span style='color:red;font-weight:bold'>["+$("#loginUser").val()+"]进入了聊天室...</span><br/>");
				$("#sendBox").show();
			}
			
			function wsOnMessage(event){
				$("#chatContainer").append(event.data);
			}
			
			function wsOnClose(){
				
			}
			
			function wsOnError(){
				$("#chatContainer").append("连接错误，请检查...<br/>");
			}
		</script>
	</head>
	<body>
		<div class="chatBox">
			<h1>基于Java服务器端的消息主动推送技术揭秘</h1>
			<div class="tipBox">
				服务器地址：<input type="text" class="inputText" id="conUrl" style="width:315px;" />
				用户名：<input type="text" class="inputText" id="loginUser" value="Solin" style="width:190px;" />
				<button type="button" id="conBtn">连接</button>
			</div>
			<div class="chatContainer" id="chatContainer"></div>
			<div class="sendBox" id="sendBox">
				<input type="text" class="inputText" style="width:588px;" id="msgContent" />
				<button type="button" id="sendMsgBtn">发送</button>
			</div>
		</div>
	</body>
</html>

四.测试结果