WebSocket实现网页聊天室

  1. 云栖社区>
  2. 博客>
  3. 正文

WebSocket实现网页聊天室

jkxqj 2016-04-20 13:01:00 浏览2143
展开阅读全文

1、先看演示效果,如下:

2、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,下面的Demo代码也是需要部署在Tomcat7.0.57上才能运行。
3、动手实现
1)新建一个dynamic web项目
2)java服务端代码:

import java.io.IOException;
import java.util.concurrent.CopyOnWriteArraySet;
   
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;
   
//该注解用来指定一个URI,客户端可以通过这个URI来连接到WebSocket。类似Servlet的注解mapping。无需在web.xml中配置。
@ServerEndpoint("/websocket")
public class MyWebSocket {
  // 静态变量,用来记录当前在线连接数。应该把它设计成线程安全的。
  private static int onlineCount = 0;
   
  // concurrent包的线程安全Set,用来存放每个客户端对应的MyWebSocket对象。若要实现服务端与单一客户端通信的话,可以使用Map来存放,其中Key可以为用户标识
  private static CopyOnWriteArraySet<MyWebSocket> webSocketSet = new CopyOnWriteArraySet<MyWebSocket>();
   
  // 与某个客户端的连接会话,需要通过它来给客户端发送数据
  private Session session;
   
  /**
   * 连接建立成功调用的方法
   * 
   * @param session
   *          可选的参数。session为与某个客户端的连接会话,需要通过它来给客户端发送数据
   */
  @OnOpen
  public void onOpen(Session session) {
    this.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 message
   *          客户端发送过来的消息
   * @param session
   *          可选的参数
   */
  @OnMessage
  public void onMessage(String message, Session session) {
    System.out.println("来自客户端的消息:" + message);
   
    // 群发消息
    for (MyWebSocket item : webSocketSet) {
      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);
  }
   
  public static synchronized int getOnlineCount() {
    return onlineCount;
  }
   
  public static synchronized void addOnlineCount() {
    MyWebSocket.onlineCount++;
  }
   
  public static synchronized void subOnlineCount() {
    MyWebSocket.onlineCount--;
  }
}

3)前端jsp代码:

<%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%>
<%
String path = request.getContextPath();
String basePath = request.getScheme()+"://"+request.getServerName()+":"+request.getServerPort()+path+"/";
%>
   
<!DOCTYPE HTML>
<html>
<head>
<base href="<%=basePath%>">
<title>聊天室</title>
<link rel="stylesheet"   href="//cdn.bootcss.com/bootstrap/3.3.5/css/bootstrap.min.css">
<link rel="stylesheet"   href="//cdn.bootcss.com/bootstrap/3.3.5/css/bootstrap-theme.min.css">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no">
<style>
body{
background-color: #FFF;
padding:60px;
}
#message{
background-color: pink;
border:10px;
solid: #00F;
}
    
</style>
   
</head>
<body>
       
<div class="container">
 <h1>欢迎光临聊天室 </h1>
       
    <div id="message"></div>
    <label>昵称:</label>
    <input id="username" type="text"/>
    <label>内容:</label>
    <input id="text" type="text" style="width:300px"/>
    <button onclick="send()">发送</button>
    <button onclick="closeWebSocket()">退出聊天室</button>
       
</div>
       
</body>
<script src="//cdn.bootcss.com/jquery/1.11.3/jquery.min.js"></script>
<script src="//cdn.bootcss.com/bootstrap/3.3.5/js/bootstrap.min.js"></script>
<script type="text/javascript">
      var websocket = null;
      //判断当前浏览器是否支持WebSocket
      if('WebSocket' in window){
          websocket = new WebSocket("ws://localhost:8080/websocket/websocket");
      }
      else{
          alert('您的浏览器不支持 websocket!')
      }
          
      //连接发生错误的回调方法
      websocket.onerror = function(){
          setMessageInnerHTML("error");
      };
          
      //连接成功建立的回调方法
      websocket.onopen = function(event){
          alert("链接成功,欢迎加入聊天室!");
      }
          
      //接收到消息的回调方法
      websocket.onmessage = function(event){
          setMessageInnerHTML(event.data);
      }
          
      //连接关闭的回调方法
      websocket.onclose = function(){
          var username=document.getElementById('username').value;
          setMessageInnerHTML(getNowFormatDate()+" "+username+" 退出了聊天室!");
      }
          
      //监听窗口关闭事件,当窗口关闭时,主动去关闭websocket连接,防止连接还没断开就关闭窗口,server端会抛异常。
      window.onbeforeunload = function(){
          websocket.close();
      }
          
      //将消息显示在网页上
      function setMessageInnerHTML(innerHTML){
          document.getElementById('message').innerHTML += innerHTML + '';
      }
          
      //关闭连接
      function closeWebSocket(){
          websocket.close();
      }
          
      //发送消息
      function send(){
          var username=document.getElementById('username').value;
          var message = document.getElementById('text').value;
          websocket.send(getNowFormatDate()+" "+username+"说: "+message);
          document.getElementById('text').value="";
      }
         
      function getNowFormatDate() {
          var myDate = new Date();
          myDate.getYear();        //获取当前年份(2位)
          myDate.getFullYear();    //获取完整的年份(4位,1970-????)
          myDate.getMonth();       //获取当前月份(0-11,0代表1月)
          myDate.getDate();        //获取当前日(1-31)
          myDate.getDay();         //获取当前星期X(0-6,0代表星期天)
          myDate.getTime();        //获取当前时间(从1970.1.1开始的毫秒数)
          myDate.getHours();       //获取当前小时数(0-23)
          myDate.getMinutes();     //获取当前分钟数(0-59)
          myDate.getSeconds();     //获取当前秒数(0-59)
          myDate.getMilliseconds();    //获取当前毫秒数(0-999)
          myDate.toLocaleDateString();     //获取当前日期
          var mytime=myDate.toLocaleTimeString();     //获取当前时间
         return myDate.toLocaleString( );        //获取日期与时间
        }
         
  </script>
</html>

注意:
1、在Eclipse或者MyEclipse中,需要添加Tomcat的library。直接拷贝Tomcat里lib目录下的jar包有时会出错。
2、java版本1.7及以上,tomcat版本7.0.47及以上

工程源码:免积分下载


网友评论

登录后评论
0/500
评论
jkxqj
+ 关注