欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识！
您现在的位置是： 首页  >  IT编程

使用Java和WebSocket实现网页聊天室实例代码

程序员文章站 2024-03-12 19:01:44
在没介绍正文之前，先给大家介绍下websocket的背景和原理： 背景 在浏览器中通过http仅能实现单向的通信,comet可以一定程度上模拟双向通信,但效率较低,并需...

在没介绍正文之前，先给大家介绍下websocket的背景和原理：

背景

在浏览器中通过http仅能实现单向的通信,comet可以一定程度上模拟双向通信,但效率较低,并需要服务器有较好的支持; flash中的socket和xmlsocket可以实现真正的双向通信,通过 flex ajax bridge,可以在javascript中使用这两项功能. 可以预见,如果websocket一旦在浏览器中得到实现,将会替代上面两项技术,得到广泛的使用.面对这种状况，html5定义了websocket协议，能更好的节省服务器资源和带宽并达到实时通讯。

在javaee7中也实现了websocket协议。

原理

websocket protocol 。

现很多网站为了实现即时通讯，所用的技术都是轮询(polling)。轮询是在特定的的时间间隔（如每1秒），由浏览器对服务器发出http request，然后由服务器返回最新的数据给客户端的浏览器。这种传统的http request 的模式带来很明显的缺点 – 浏览器需要不断的向服务器发出请求，然而http request 的header是非常长的，里面包含的有用数据可能只是一个很小的值，这样会占用很多的带宽。

而比较新的技术去做轮询的效果是comet – 用了ajax。但这种技术虽然可达到全双工通信，但依然需要发出请求。

在 websocket api，浏览器和服务器只需要做一个握手的动作，然后，浏览器和服务器之间就形成了一条快速通道。两者之间就直接可以数据互相传送。在此websocket 协议中，为我们实现即时服务带来了两大好处：

1. header

互相沟通的header是很小的-大概只有 2 bytes

2. server push

服务器的推送，服务器不再被动的接收到浏览器的request之后才返回数据，而是在有新数据时就主动推送给浏览器。

一、项目简介

websocket是html5一种新的协议，它实现了浏览器与服务器全双工通信，这里就将使用websocket来开发网页聊天室，前端框架会使用amazeui，后台使用java，编辑器使用umeditor。

二、涉及知识点

网页前端（html+css+js）和java

三、软件环境 tomcat 7 jdk 7 eclipse javaee 现代浏览器

 四、效果截图

效果1

使用Java和WebSocket实现网页聊天室实例代码

效果2

使用Java和WebSocket实现网页聊天室实例代码

五、项目实战

 1. 新建项目

打开eclipse javaee，新建一个名为chat的dynamic web project，然后导入处理json格式字符串所需要的包，把commons-beanutils-1.8.0.jar、commons-collections-3.2.1.jar、commons-lang-2.5.jar、commons-logging-1.1.1.jar、ezmorph-1.0.6.jar和json-lib-2.4-jdk15.jar这几个包放在webcontent/web-inf/lib目录下，最后把项目发布到tomcat服务器上，到此空项目就搭建完成了。

2. 编写前端页面

在webcontent目录下新建一个名为index.jsp的页面，这里使用了amazeui框架，它是一个跨屏自适应的前端框架，消息输入框使用了umeditor，它是一个富文本在线编辑器，能让我们的消息内容多姿多彩。

首先从 amazeui官网 下载压缩包，然后解压把assets文件夹拷贝到webcontent目录下，这样我们就能使用amazeui了。

再从 uediter官网 下载mini版的jsp版本压缩包，解压后把整个目录拷贝到webcontent目录下，接下来就可以编写前端代码了，代码如下（你可以按照自己的喜好编写）：

<%@ page language="java" contenttype="text/html; charset=utf-8" pageencoding="utf-8"%>
<!doctype html>
<html lang="zh">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no">
<title>shiyanlou chat</title>
<!-- set render engine for 360 browser -->
<meta name="renderer" content="webkit">
<!-- no baidu siteapp-->
<meta http-equiv="cache-control" content="no-siteapp" />
<link rel="alternate icon" href="assets/i/favicon.ico">
<link rel="stylesheet" href="assets/css/amazeui.min.css">
<link rel="stylesheet" href="assets/css/app.css">
<!-- umeditor css -->
<link href="umeditor/themes/default/css/umeditor.css" rel="stylesheet">
<style>
.title {
 text-align: center;
}
.chat-content-container {
 height: 29rem;
 overflow-y: scroll;
 border: 1px solid silver;
}
</style>
</head>
<body>
 <!-- title start -->
 <div class="title">
  <div class="am-g am-g-fixed">
   <div class="am-u-sm-12">
    <h1 class="am-text-primary">shiyanlou chat</h1>
   </div>
  </div>
 </div>
 <!-- title end -->
 <!-- chat content start -->
 <div class="chat-content">
  <div class="am-g am-g-fixed chat-content-container">
   <div class="am-u-sm-12">
    <ul id="message-list" class="am-comments-list am-comments-list-flip"></ul>
   </div>
  </div>
 </div>
 <!-- chat content start -->
 <!-- message input start -->
 <div class="message-input am-margin-top">
  <div class="am-g am-g-fixed">
   <div class="am-u-sm-12">
    <form class="am-form">
     <div class="am-form-group">
      <script type="text/plain" id="myeditor" style="width: 100%;height: 8rem;"></script>
     </div>
    </form>
   </div>
  </div>
  <div class="am-g am-g-fixed am-margin-top">
   <div class="am-u-sm-6">
    <div id="message-input-nickname" class="am-input-group am-input-group-primary">
     <span class="am-input-group-label"><i class="am-icon-user"></i></span>
     <input id="nickname" type="text" class="am-form-field" placeholder="please enter nickname"/>
    </div>
   </div>
   <div class="am-u-sm-6">
    <button id="send" type="button" class="am-btn am-btn-primary">
     <i class="am-icon-send"></i> send
    </button>
   </div>
  </div>
 </div>
 <!-- message input end -->
 <!--[if (gte ie 9)|!(ie)]><!-->
 <script src="assets/js/jquery.min.js"></script>
 <!--<![endif]-->
 <!--[if lte ie 8 ]>
 <script src="http://libs.baidu.com/jquery/1.11.1/jquery.min.js"></script>
 <![endif]-->
 <!-- umeditor js -->
 <script charset="utf-8" src="umeditor/umeditor.config.js"></script>
 <script charset="utf-8" src="umeditor/umeditor.min.js"></script>
 <script src="umeditor/lang/zh-cn/zh-cn.js"></script>
 <script>
  $(function() {
   // 初始化消息输入框
   var um = um.geteditor('myeditor');
   // 使昵称框获取焦点
   $('#nickname')[0].focus();
  });
 </script>
</body>
</html>

编写完成之后启动tomcat服务器，然后访问 http://localhost:8080/chat/index.jsp   ，会看到如下界面。

使用Java和WebSocket实现网页聊天室实例代码

3. 编写后台代码

新建一个com.shiyanlou.chat的包，在包中创建一个名为chatserver的类，从javaee 7开始就统一了websocket的api，因此无论是什么服务器，用java写的代码都是一样的，代码如下：

package com.shiyanlou.chat;
import java.text.simpledateformat;
import java.util.date;
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 net.sf.json.jsonobject;
/**
 * 聊天服务器类
 * @author shiyanlou
 *
 */
@serverendpoint("/websocket")
public class chatserver {
 private static final simpledateformat date_format = new simpledateformat("yyyy-mm-dd hh:mm");	// 日期格式化
 @onopen
 public void open(session session) {
  // 添加初始化操作
 }
 /**
  * 接受客户端的消息，并把消息发送给所有连接的会话
  * @param message 客户端发来的消息
  * @param session 客户端的会话
  */
 @onmessage
 public void getmessage(string message, session session) {
  // 把客户端的消息解析为json对象
  jsonobject jsonobject = jsonobject.fromobject(message);
  // 在消息中添加发送日期
  jsonobject.put("date", date_format.format(new date()));
  // 把消息发送给所有连接的会话
  for (session opensession : session.getopensessions()) {
   // 添加本条消息是否为当前会话本身发的标志
   jsonobject.put("isself", opensession.equals(session));
   // 发送json格式的消息
   opensession.getasyncremote().sendtext(jsonobject.tostring());
  }
 }
 @onclose
 public void close() {
  // 添加关闭会话时的操作
 }
 @onerror
 public void error(throwable t) {
  // 添加处理错误的操作
 }
}

4. 前后台交互

后台写完了，前台要用websocket连接后台，需要新建一个websocket对象，然后就可以和服务器端进行交互，从浏览器发送消息给服务器端，同时要验证输入框的内容是否为空，然后接受服务端发送的消息，把它们动态地添加到聊天内容框中，在

var um = um.geteditor('myeditor');
$('#nickname')[0].focus();
// 新建websocket对象，最后的/websocket对应服务器端的@serverendpoint("/websocket")
var socket = new websocket('ws://${pagecontext.request.getservername()}:${pagecontext.request.getserverport()}${pagecontext.request.contextpath}/websocket');
   // 处理服务器端发送的数据
   socket.onmessage = function(event) {
    addmessage(event.data);
   };
   // 点击send按钮时的操作
   $('#send').on('click', function() {
    var nickname = $('#nickname').val();
    if (!um.hascontents()) {	// 判断消息输入框是否为空
     // 消息输入框获取焦点
     um.focus();
     // 添加抖动效果
     $('.edui-container').addclass('am-animation-shake');
     settimeout("$('.edui-container').removeclass('am-animation-shake')", 1000);
    } else if (nickname == '') {	// 判断昵称框是否为空
     //昵称框获取焦点
     $('#nickname')[0].focus();
     // 添加抖动效果
     $('#message-input-nickname').addclass('am-animation-shake');
     settimeout("$('#message-input-nickname').removeclass('am-animation-shake')", 1000);
    } else {
     // 发送消息
     socket.send(json.stringify({
      content : um.getcontent(),
      nickname : nickname
     }));
     // 清空消息输入框
     um.setcontent('');
     // 消息输入框获取焦点
     um.focus();
    }
   });
   // 把消息添加到聊天内容中
   function addmessage(message) {
    message = json.parse(message);
    var messageitem = '<li class="am-comment '
      + (message.isself ? 'am-comment-flip' : 'am-comment')
      + '">'
      + '<a href="javascript:void(0)" ><img src="assets/images/'
      + (message.isself ? 'self.png' : 'others.jpg')
      + '" alt="" class="am-comment-avatar" width="48" height="48"/></a>'
      + '<div class="am-comment-main"><header class="am-comment-hd"><div class="am-comment-meta">'
      + '<a href="javascript:void(0)" class="am-comment-author">'
      + message.nickname + '</a> <time>' + message.date
      + '</time></div></header>'
      + '<div class="am-comment-bd">' + message.content
      + '</div></div></li>';
    $(messageitem).appendto('#message-list');
    // 把滚动条滚动到底部
    $(".chat-content-container").scrolltop($(".chat-content-container")[0].scrollheight);
   }

到这步，简单的网页聊天室就完成了，你可以多开几个窗口或在局域网中邀请小伙伴们来一起测试。

六、小结

本次项目课使用websocket实现了简单的网页聊天室，其实websocket不仅可以应用于浏览器，也可以应用于桌面客户端。

七、思考题

本次项目课只是简单的实现聊天室，其实还有很多功能可以增加，例如头像上传功能、一对一聊天功能等，让我们一起来完善聊天室吧。

看到这里想不想马上去试试，点击这里--- 为你免费提供在线编译环境，让你不再为搭建环境而烦恼

以上所述是小编给大家介绍的使用java和websocket实现网页聊天室实例代码的相关知识，希望对大家有所帮助

上一篇： JAVA基础之控制台输入输出的实例代码

下一篇： MyEclipse 2016 CI 4新增BootStrap模板

推荐阅读