安裝express和socket.io
package.json文件如下:
//package.json { "name": "chatroom", "version": "1.0.0", "description": "A simple chatroom", "main": "index.js", "scripts": { "test": "echo \"Error: no test specified\" && exit 1" }, "repository": { "type": "git", "url": "git+https://github.com/ddvdd008/chatroom.git" }, "keywords": [ "chatroom", "nodejs", "express" ], "author": "ddvdd", "license": "ISC", "bugs": { "url": "https://github.com/ddvdd008/chatroom/issues" }, "homepage": "https://github.com/ddvdd008/chatroom#readme" }
安裝express和socket.io
npm install express --save npm install socket.io --save
package.json自動新增依賴
"dependencies": { "express": "^4.16.2", "socket.io": "^2.0.4" }
因為我們使用express框架寫后端服務,用socket.io(Socket.io實際上是WebSocket的父集,Socket.io封裝了WebSocket和輪詢等方法,他會根據情況選擇方法來進行通訊。)來對客戶端和服務端建立一個持久鏈接,便于通訊。
到這里準備工作進行的差不多了,下面我們開始一步步實現。
搭建web服務器
express創建服務
學過node同學應該不陌生,利用http.createServer就能簡單的創建一個服務器,這次我們利用express來創建服務。在項目根目錄創建一個app.js。
const express = require('express'); const app = express(); // 創建express實例,賦值給app。 const fs = require('fs'); // 這個是node的文件讀取模塊,用于讀取文件 const path = require('path'); // 這是node的路徑處理模塊,可以格式化路徑 app.listen(3000,()=>{ console.log("server running at 127.0.0.1:3000"); // 代表監聽3000端口,然后執行回調函數在控制臺輸出。 }); app.get('/',(req,res)=>{ res.redirect('/chat.html'); // express的重定向函數。如果瀏覽器請求了根路由'/',瀏覽器就給他重定向到 '127.0.0.1:3000/chat.html'路由中 }); app.get('/chat.html',(req,res)=>{ fs.readFile(path.join(__dirname,'./public/chat.html'),function(err,data){ //讀取文件,readFile里傳入的是文件路徑和回調函數,這里用path.join()格式化了路徑。 if(err){ console.error("讀取chat.html發生錯誤",err); //錯誤處理 res.send('4 0 4'); //如果發生錯誤,向瀏覽器返回404 } else { res.end(data); //這里的data就是回調函數的參數,在readFile內部已經將讀取的數據傳遞給了回調函數的data變量。 } //我們將data傳到瀏覽器,就是把html文件傳給瀏覽器 }) });
你們看了以后會說,這express框架看來也沒那么簡便啊,一個最簡單的發送單頁面的方法跟node自帶http.createServer沒太大區別餓,也挺麻煩的。從目前來看確實如此,我這不是為了讓你們容易理解嘛~ express提供了一個非常強大的中間件,幫我們托管靜態資源文件,下面我們就來實現:
app.use('/',express.static(path.join(__dirname,'./public'))); //一句話就搞定。
代替原來的:
app.get('/chat.html',(req,res)=>{ fs.readFile(path.join(__dirname,'./public/chat.html'),function(err,data){ if(err){ console.error("讀取chat.html發生錯誤",err); res.send('4 0 4'); } else { res.end(data); } }) });
__dirname表示當前文件所在的絕對路徑,所以我們使用path.join將app.js的絕對路徑和public加起來就得到了public的絕對路徑。用path.join是為了避免出現 ././public 這種奇怪的路徑,express.static就幫我們托管了public文件夾中的靜態資源。只要有 127.0.0.1:3000/XXX/AAA 的路徑都會去public文件夾下找XXX文件夾下的AAA文件然后發送給瀏覽器。
現在再來看這段代碼是不是簡介了很多,具體了解app.use()干了什么的同學可以去這里
socket.io建立客戶端和服務端的鏈接
創建完上面的服務后,我們需要把socket.io引用進來,讓客戶端和服務端建立長久鏈接。我們把app.js進行如下改造:
const express = require('express'); const app = express(); // 創建express實例,賦值給app。 const server = require('http').Server(app); const io = require('socket.io')(server); //將socket的監聽加到app設置的模塊里。這兩句理解不了的可以去socket.io官網去看 const path = require('path'); // 這是node的路徑處理模塊,可以格式化路徑 server.listen(3000,()=>{ console.log("server running at 127.0.0.1:3000"); // 代表監聽3000端口,然后執行回調函數在控制臺輸出。 }); ... ... app.use('/',express.static(path.join(__dirname,'./public'))); //一句話就搞定。 io.on('connection',(socket)=>{ //監聽客戶端的連接事件 });
o.on表示監聽某個事件,該事件一發生,就觸發回調函數。'connection‘就是一個事件名,它已經定義好了,只要用戶連接上就會觸發。現在app.js基本已經完成,我們在根目錄執行:
node app.js
>
現在訪問http://127.0.0.1:3000/static/chat.html:
哎?啥也沒有。。。那不廢話!我們都沒url請求對應的靜態資源!
添加靜態html
我們在項目根目錄創建public文件夾,public文件夾里面新建chat.html文件:
<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <title>聊天室</title> </head> <body> 這是我們的聊天室 </body> </html>
現在我們刷新下頁面,你看頁面出現了:
>
到這里其實一個最簡單的瀏覽器和web服務器協作的項目就已經完成,后面我們要不斷完善頁面,給服務器后端加業務功能來實現多人聊天室。
基本功能實現
登陸功能,我們需要一個用戶名,(不需要密碼),該用戶名必須客戶端服務器都有存儲。每次傳輸信息基本都需要包括用戶名,否則不知道是誰發的。
群聊功能,我們需要分辨信息來己方和對方
登陸功能實現
login頁面重構
最基本的登陸界面由一個用戶名輸入框和登錄按鈕組成:
//chat.html <!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <title>聊天室</title> <style> *{ margin:0; padding:0; box-sizing: border-box; -webkit-box-sizing: border-box; -moz-box-sizing: border-box; } .container{ position: absolute; top:0; left:0; right:0; bottom:0; background-color: grey; padding: 50px; } .container .title{ width:300px; margin: 0 auto; font-size: 30px; font-family: 'Franklin Gothic Medium'; font-weight: bold; text-align: center; margin-bottom:50px; } .container .login-wrap{ width:400px; padding: 20px; border: 1px solid #000; margin: 0 auto; text-align: center; } .login-wrap .user-ipt{ width:360px; text-align: center; vertical-align: middle; } .login-wrap .login-button{ width:60px; height:24px; line-height:20px; font-size: 14px; padding: 2px 0; border-radius: 5px; margin-top:10px; } </style> </head> <body> <p class="container"> <p class="title">歡迎來到ddvdd聊天室</p> <p class="login-wrap"> <p class="user-ipt"> <span class="user-name">用戶名:</span> <input id="name" class="name-ipt" type="text" /> </p> <button id="loginbutton" class="login-button">登陸</button> </p> </p> </body> </html>
簡單的加點樣式,靜態頁面就完成了,我們刷新下頁面:
login頁面交互
昨天下午寫到一半。。。部門突然要去團建聚會,只能匆匆提交代碼,草草了事。今天一大早來到公司繼續給大家碼
廢話不多說進入正題,登陸這塊交互,當用戶訪問服務器并且成功登陸算一個在線登陸人數,每登陸一個用戶,服務器都會把用戶信息存入一個數組中,保存在服務器,這里要注意一點,服務器會對用戶登陸的用戶名進行校驗,校驗結果會返回給客戶端,客戶端通過校驗結果,改變當前頁面是否進入聊天頁面。
上面的服務器和客戶端交互都是通過socket.io來實現通訊的,前端的業務交互我們這里就采用jquery來實現,在public文件夾下新建js文件夾,下載jquery-3.2.1.min.js、新建main.js。然后對chat.html引入需要的sdk:
<script src="http://m.argcandargv.com/skin/default/image/lazy.gif" class="lazy" original="http://m.argcandargv.com/skin/default/image/nopic.gif" src="http://m.argcandargv.com/skin/default/image/lazy.gif" class="lazy" original="http://m.argcandargv.com/skin/default/image/nopic.gif" src="http://m.argcandargv.com/skin/default/image/lazy.gif" class="lazy" original="http://m.argcandargv.com/skin/default/image/nopic.gif">引入完sdk,我們對main的js添加登錄功能:
//main.js $(function(){ const url = 'http://127.0.0.1:3000'; let _username = ''; let _$inputname = $('#name'); let _$loginButton = $('#loginbutton'); let socket = io.connect(url); //設置用戶名,當用戶登錄的時候觸發 let setUsername = () => { _username = _$inputname.val().trim(); //得到輸入框中用戶輸入的用戶名 //判斷用戶名是否存在 if(_username) { socket.emit('login',{username: _username}); //如果用戶名存在,就代表可以登錄了,我們就觸發登錄事件,就相當于告訴服務器我們要登錄了 } else{ alert('請輸入用戶名!'); } }; _$loginButton.on('click',function (event) { //監聽按鈕的點擊事件,如果點擊,就說明用戶要登錄,就執行setUsername函數 setUsername(); }); socket.on('loginResult',(data)=>{ if(data.code === 0) { // 登陸成功,切換至聊天室頁面 } else if(data.code ===1){ alert('用戶已登錄!'); } else{ alert('登錄失敗!'); } }) }); //app.js const express = require('express'); const app = express(); // 創建express實例,賦值給app。 const server = require('http').Server(app); const io = require('socket.io')(server); //將socket的監聽加到app設置的模塊里。這兩句理解不了的可以去socket.io官網去看 const path = require('path'); // 這是node的路徑處理模塊,可以格式化路徑 const users = []; //用來保存所有的用戶信息 let usersNum = 0; //統計在線登錄人數 server.listen(3000,()=>{ console.log("server running at 127.0.0.1:3000"); // 代表監聽3000端口,然后執行回調函數在控制臺輸出。 }); app.get('/',(req,res)=>{ res.redirect('/static/chat.html'); // express的重定向函數。如果瀏覽器請求了根路由'/',瀏覽器就給他重定向到 '127.0.0.1:3000/chat.html'路由中 }); app.use('/static',express.static(path.join(__dirname,'./public'))); //一句話就搞定。 io.on('connection',(socket)=>{ //監聽客戶端的連接事件 socket.on('login',(data)=>{ if(checkUserName(data)){ socket.emit('loginResult',{code:1}); //code=1 用戶已登錄 } else{ //將該用戶的信息存進數組中 users.push({ username: data.username, message: [] }); socket.emit('loginResult',{code:0}); //code=0 用戶登錄成功 usersNum = users.length; console.log(`用戶${data.username}登錄成功,進入ddvdd聊天室,當前在線登錄人數:${usersNum}`); } }); //斷開連接后做的事情 socket.on('disconnect',()=>{ //注意,該事件不需要自定義觸發器,系統會自動調用 usersNum = users.length; console.log(`當前在線登錄人數:${usersNum}`); }); }); //校驗用戶是否已經登錄 const checkUserName = (data) => { let isExist = false; users.map((user) => { if(user.username === data.username){ isExist = true; } }); return isExist; }上面代碼大家需要了解以下幾點:
socket.on 表示監聽事件,后面接一個回調函數用來接收emit發出事件傳遞過來的對象。
socket.emit 用來觸發事件,傳遞對象給on監聽事件。
我們socket連接之后的監聽觸發事件都要寫在io.on('connection')的回調里面,因為這些事件都是連接之后發生的,就算是斷開連接的事件 disconnect 也是在連接事件中發生的,沒有正在連接的狀態,哪來的斷開連接呢?
理解雖然服務器端只有app.js一個文件,但是不同的客戶端連接后信息是不同的,所以我們必須要將一些公用的信息,比如說,儲存所有登錄用戶的數組,所有用戶發送的所有信息存儲在外部,一定不能存儲在connecion里
效果展示:
群聊功能實現
寫完簡單的登錄功能,現在我們來寫這項目最重要的功能群聊。首先我們先來處理下頁面,因為功能簡單,所以不單獨建立html來顯示聊天室,就直接寫在login頁面,通過class名稱的變化來切換登錄后,聊天室的顯示。
聊天室頁面重構
下面我們對chat.html進行整改:
<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <title>聊天室</title> <script src="http://m.argcandargv.com/skin/default/image/lazy.gif" class="lazy" original="http://m.argcandargv.com/skin/default/image/nopic.gif" <script src="http://m.argcandargv.com/skin/default/image/lazy.gif" class="lazy" original="http://m.argcandargv.com/skin/default/image/nopic.gif" <script src="http://m.argcandargv.com/skin/default/image/lazy.gif" class="lazy" original="http://m.argcandargv.com/skin/default/image/nopic.gif" <style> *{ margin:0; padding:0; box-sizing: border-box; -webkit-box-sizing: border-box; -moz-box-sizing: border-box; } .container{ position: absolute; top:0; left:0; right:0; bottom:0; background-color: darkgrey; padding: 50px; overflow-y: scroll; } .container .title{ margin: 0 auto; font-size: 30px; font-family: 'Franklin Gothic Medium'; font-weight: bold; text-align: center; margin-bottom:20px; } .container .login-wrap{ width:400px; padding: 20px; border: 1px solid #000; margin: 0 auto; text-align: center; } .login-wrap .user-ipt{ width:360px; text-align: center; vertical-align: middle; } .login-wrap .login-button{ width:60px; height:24px; line-height:20px; font-size: 14px; padding: 2px 0; border-radius: 5px; margin-top:10px; } .chat-wrap .chat-content{ width:100%; height:600px; background-color: whitesmoke; padding:10px; } .chat-wrap .send-wrap{ margin-top: 20px; } .message-ipt{ width: 200px; height: 100px; padding: 0 5px; vertical-align: bottom; } .chat-content p{ display: block; margin-bottom: 10px; } .chat-content p .msg{ display: inline-block; padding: 8px 11px; border-radius:6px; } .chat-content .self-message .msg{ background-color:#d0e7ff; border: 1px solid #c9dfff; } .chat-content .other-message .msg{ background-color:white; border: 1px solid #eee; } .chat-content .self-message{ text-align:right; } .chat-content .other-message{ text-align-last:left; } </style> </head> <body> <p class="container"> <p id="loginbox" class="login-wrap"> <p class="title">登錄</p> <p class="user-ipt"> <span class="user-name">用戶名:</span> <input id="name" class="name-ipt" type="text" /> </p> <button id="loginbutton" class="login-button">登錄</button> </p> <p id="chatbox" class="chat-wrap" style="display:none"> <p id="content" class="chat-content"> <!-- 聊天內容 --> </p> <p class="send-wrap"> <textarea rows="3" cols="20" id="chatmessage" class="message-ipt" type="textarea" placeholder="請輸入要發送的信息內容"></textarea> </p> </p> </p> </body> </html>新增chatbox容器來作為聊天室,里面有一個群聊的聊天框,和一個發送消息的文本框。通過上面loginResult回調,對loginbox進行隱藏,顯示chatbox:
//顯示聊天室界面 let showChatRoom = () => { $('#loginbox').hide('slow'); _$loginButton.off('click'); $(`<p class="title">歡迎${_username}來到ddvdd聊天室</p>`).insertBefore($("#content")); $("#chatbox").show('slow'); }消息事件發送監聽機制
聊天一定是客戶端觸發的,所以發送信息是客戶端觸發,服務器監聽。
服務器監聽到發送信息的事件后會存儲信息,然后觸發發送信息成功事件廣播給所有客戶端,將信息傳給所有客戶端。
發送消息sendMessage事件
//main.js //發送消息 let sendMessage = function () { let _message = _$chattextarea.val(); if(_message) { socket.emit('sendMessage',{username: _username, message: _message}); } else{ alert('請輸入發送消息!'); } }; ... _$chattextarea.on('keyup',function (event) { if(event.keyCode === 13) { sendMessage(); _$chattextarea.val(''); } });服務器端監聽sendMessage事件
//app.js socket.on('sendMessage',(data)=>{ for(let _user of users) { if(_user.username === data.username) { _user.message.push(data.message); //信息存儲之后觸發receiveMessage將信息發給所有瀏覽器-廣播事件 io.emit('receiveMessage',data); break; } } });我們是遍歷服務器端的用戶數組,找到該用戶,將發送的信息存起來,然后觸發receiveMessage事件廣播到所有瀏覽器,sendMessage是寫在connection里,login之外的,為什么這么做大家一定要理解,發送消息是連接時候做的事情,而不是登錄時做的事情。
注意的是,我使用的是io.emit,他是真正的廣播到所有瀏覽器,socket.broadcast.emit則不會廣播到自己的瀏覽器。
客戶端監聽receiveMessage事件
//main.js socket.on('receiveMessage',(data)=>{ showMessage(data); }) //顯示消息 let showMessage = function (data) { //先判斷這個消息是不是自己發出的,然后再以不同的樣式顯示 if(data.username === _username){ $("#content").append(`<p class='self-message'><span class='msg'>${data.message}</span><span class='name'> :${data.username}</span></p>`); }else { $("#content").append(`<p class='other-message'><span class='name'>${data.username}: </span><span class='msg'>${data.message}</span></p>`); } };寫到這邊,我們的聊天室基本功能已經完成了,來看看效果吧!打開三個瀏覽器,分別登錄老大、老二、老三,發一句“大噶好~,我是渣渣輝!”。
相關推薦:
vue組件父子間通信實現聊天室實例詳解
實例詳解vue組件父子間通信之聊天室
用Node.js編寫多人實時在線聊天室
以上就是nodejs和express搭建多人聊天室的詳細內容,更多請關注php中文網其它相關文章!