Java和WebSocket開發網頁聊天室

時間 2019-11-21

原文原文鏈接

小編心語：咳咳咳，今天又是聊天室，到如今爲止小編已經分享了不下兩個了，這一次跟以前的又不大相同，這一次是網頁聊天室，具體怎麼着，還請各位看官往下看~
javascript

1、項目簡介
WebSocket是HTML5一種新的協議，它實現了瀏覽器與服務器全雙工通訊，這裏就將使用WebSocket來開發網頁聊天室，前端框架會使用AmazeUI，後臺使用Java，編輯器使用UMEditor。
2、涉及知識點
網頁前端（HTML+CSS+JS）和Java
3、軟件環境css

Tomcat 7
JDK 7
Eclipse JavaEE
現代瀏覽器

4、效果截圖
效果1

效果2

5、源代碼下載
（此操做需在實驗樓網站上的虛擬平臺能夠實現）html

$ git clone https://github.com/shiyanlou/java_websocket_chat.git

6、項目實戰
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，會看下入界面。

3. 編寫後臺代碼
新建一個com.shiyanlou.chat的包，在包中建立一個名爲ChatServer的類，從JavaEE 7開始就統一了WebSocket的API，所以不管是什麼服務器，用Java寫的代碼都是同樣的，代碼以下：java

/**
 * 聊天服務器類
 * @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) {
        // 添加處理錯誤的操做
    }
}

更多詳細代碼和步驟請登陸該項目課：http://www.shiyanlou.com/courses/113jquery

4. 先後臺交互
後臺寫完了，前臺要用WebSocket鏈接後臺，須要新建一個WebSocket對象，而後就能夠和服務器端進行交互，從瀏覽器發送消息給服務器端，同時要驗證輸入框的內容是否爲空，而後接受服務端發送的消息，把它們動態地添加到聊天內容框中，git

var um = UM.getEditor('myEditor');
$('#nickname')[0].focus();

以後添加代碼以下：github

// 新建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);
            }

到這步，簡單的網頁聊天室就完成了，你能夠多開幾個窗口或在局域網中邀請小夥伴們來一塊兒測試。
7、小結
本次項目課使用WebSocket實現了簡單的網頁聊天室，其實WebSocket不只能夠應用於瀏覽器，也能夠應用於桌面客戶端。
8、思考題
本次項目課只是簡單的實現聊天室，其實還有不少功能能夠增長，例如頭像上傳功能、一對一聊天功能等，讓咱們一塊兒來完善聊天室吧。

各位看官們，辛苦了！今天的內容到這裏就結束了~請明天繼續收看！~
有更多基礎課、項目課歡迎你們登錄實驗樓官方網站http://www.shiyanlou.com。
如今登錄實驗樓更有元旦感恩好禮相送http://www.shiyanlou.com/huodong/thanks.htmlweb

相關標籤/搜索

每日一句

每一个你不满意的现在，都有一个你没有努力的曾经。