准備域名和證書
任務時間:20min ~ 40min
小程序后台服務需要通過 HTTPS 訪問,在實驗開始之前,我們要准備域名和 SSL 證書。
域名注冊
如果您還沒有域名,可以在騰訊雲上選購,過程可以參考下面的視頻:
- 視頻 - 在騰訊雲上購買域名
域名解析
域名購買完成后, 需要將域名解析到實驗雲主機上,實驗雲主機的 IP 為:
<您的 CVM IP 地址>
在騰訊雲購買的域名,可以到控制台添加解析記錄,過程可參考下面的視頻:
- 視頻 - 如何在騰訊雲上解析域名
域名設置解析后需要過一段時間才會生效,通過 ping
命令檢查域名是否生效 [?],如:
ping www.yourmpdomain.com
如果 ping 命令返回的信息中含有你設置的解析的 IP 地址,說明解析成功。
注意替換下面命令中的
www.yourmpdomain.com
為您自己的注冊的域名
申請 SSL 證書
騰訊雲提供了 SSL 證書的免費申請,申請方式可參考下面視頻:
- 視頻 - 在騰訊雲上申請 SSL 證書
申請提交后,審批結果會以短信的形式通知。審批通過后,可以到 SSL 控制台下載您的證書文件,可參考下面的視頻:
- 視頻 - 在騰訊雲上下載 SSL 證書
搭建小程序開發環境
任務時間:15min ~ 30min
在開始搭建我們的小程序服務器之前,需要先完成客戶端小程序開發環境的搭建。
注冊開發者賬號
如果你還不是小程序開發者,請先在微信公眾平台並注冊:
具體注冊流程可參考如下視頻:
- 視頻 - 注冊開發者賬號
若您已注冊,請點擊下一步。
配置小程序服務器信息
登錄微信公眾平台后,依次進入 設置
- 開發設置
- 服務器域名
- 修改
。
掃碼完成身份校驗后,request 合法域名和 socket 合法域名均填寫在上一步准備好的域名地址。
配置完成后,點擊 保存並提交
。您可以點擊如下視頻查看如何進行配置:
- 視頻 - 配置小程序服務器信息
運行配套小程序代碼
要運行本實驗配套的小程序代碼,請下載下列資源:
源碼下載后,請解壓到本地工作目錄。
開發工具下載后,請安裝並啟動,然后用微信掃碼登錄。
登錄后,選擇 本地小程序項目
- 添加項目
,使用以下配置:
- AppID:填寫小程序的 AppID,請登錄公眾平台后在
設置
-開發設置
-開發者 ID
中查看 - 項目名稱:填寫任意您喜歡的名稱
- 項目目錄:選擇剛才解壓的配套源碼目錄(目錄包含
app.js
)
填寫完成后,點擊 添加項目
。具體操作可查看如下視頻:
- 視頻 - 運行配套小程序代碼
設置實驗域名
在開發工具的 編輯
面板中,選中 app.js
進行編輯,需要修改小程序通信域名[?],請參考下面的配置:
App({
config: {
host: 'www.yourdomain.com' // 這個地方填寫你的域名
},
onLaunch () {
console.log('App.onLaunch()');
}
});
當然,這步操作也錄制了對應的視頻:
- 視頻 - 設置實驗域名
實驗配套源碼所用通信域名都會使用該設置,為了您順利進行實驗,請把域名修改為之前步驟准備的域名
搭建 HTTP 服務
任務時間:15min ~ 30min
下面的步驟,將帶大家在服務器上使用 Node 和 Express 搭建一個 HTTP 服務器
安裝 NodeJS
使用下面的命令安裝 NodeJS
sudo apt-get update
sudo wget https://mc.qcloudimg.com/static/archive/262420521a966befe17dfa0070ddb272/node-v6.11.0.tar.gz
sudo tar xvf node-v6.11.0.tar.gz
cd node-v6.11.0
sudo ./configure
sudo make
sudo make install
sudo cp /usr/local/bin/node /usr/sbin/
安裝完成后,使用下面的命令測試安裝結果
node -v
編寫 HTTP Server 源碼
使用下面的命令在服務器創建一個工作目錄:
sudo mkdir -p /data/release/webapp
進入此工作目錄
cd /data/release/webapp
在工作目錄創建 package.json 文件,並修改文件的訪問權限。
sudo touch package.json
sudo chmod a+r+w package.json
修改 package.json 添加我們服務器包的名稱和版本號,可參考下面的示例。
示例代碼:/data/release/webapp/package.json
{
"name": "webapp",
"version": "1.0.0"
}
完成后,使用 Ctrl + S
保存文件
在工作目錄創建 app.js
cd /data/release/webapp
sudo touch app.js
sudo chmod a+rw app.js
修改 app.js 文件,使用 Express.js 來監聽 8765
端口[?],app.js文件可參考下面的示例代碼。
示例代碼:/data/release/webapp/app.js
// 引用 express 來支持 HTTP Server 的實現
const express = require('express');
// 創建一個 express 實例
const app = express();
// 實現唯一的一個中間件,對於所有請求,都輸出 "Response from express"
app.use((request, response, next) => {
response.write('Response from express');
response.end();
});
// 監聽端口,等待連接
const port = 8765;
app.listen(port);
// 輸出服務器啟動日志
console.log(`Server listening at http://127.0.0.1:${port}`);
本實驗會以 8765 端口的打開作為實驗步驟完成的依據,為了后面的實驗步驟順利進行,請不要使用其它端口號
運行 HTTP 服務
在開始之前,我們先來安裝 [PM2]
sudo apt-get install npm
sudo npm install -g pm2
PM2 安裝時間可能稍長,請耐心等候 [?]
我們的服務器源碼里使用到了 Express 模塊,下面的命令使用 NPM 來安裝 Express
cd /data/release/webapp
sudo npm install express --save
安裝完成后,使用 PM2 來啟動 HTTP 服務
cd /data/release/webapp
pm2 start app.js
現在,您的 HTTP 服務已經在 http://<您的 CVM IP 地址>:8765 運行
要查看服務輸出的日志,可以使用下面的命令:
pm2 logs
如果要重啟服務,可以使用下面的命令:
pm2 restart app
我們使用 PM2 來進行 Node 進程的運行、監控和管理
NPM 倉庫在國內訪問速度可能不太理想,如果實在太慢可以嘗試使用 CNPM 的 Registry 進行安裝:
npm install pm2 -g --registry=https://r.cnpmjs.org/
搭建 HTTPS 服務
任務時間:15min ~ 30min
微信小程序要求和服務器的通信都通過 HTTPS 進行
安裝 Nginx
在 Ubuntu 上,可直接使用 apt-get
來安裝 Nginx
sudo apt-get install nginx -y
安裝完成后,使用 nginx
命令啟動 Nginx:
sudo /etc/init.d/nginx start
此時訪問 http://<您的域名> 可以看到 Nginx 測試頁面 [?]
如果你的機器同時安裝了其他軟件占用80端口,那上面的訪問方式就不能使用了,而且 Nginx 都可能啟動不了,你需要關閉該軟件再重新啟動 Nginx。
配置 HTTPS 反向代理
修改 /etc/nginx 目錄的讀寫權限
sudo chmod a+rw /etc/nginx
將之前下載的 SSL 證書(解壓后 Nginx 目錄分別以 crt 和 key 作為后綴的文件)通過拖動到左側文件瀏覽器 /etc/nginx 目錄
的方式來上傳文件到服務器上。
如何上傳 SSL 證書到 /etc/nginx 目錄
在 /etc/nginx/conf.d 目錄創建 ssl.conf 文件
cd /etc/nginx/conf.d
sudo touch ssl.conf
sudo chmod a+rw ssl.conf
將 ssl.conf 文件修改為如下內容
示例代碼:/etc/nginx/conf.d/ssl.conf
server {
listen 443;
server_name www.example.com; # 改為綁定證書的域名
# ssl 配置
ssl on;
ssl_certificate 1_www.example.com_bundle.crt; # 改為自己申請得到的 crt 文件的名稱
ssl_certificate_key 2_www.example.com.key; # 改為自己申請得到的 key 文件的名稱
ssl_session_timeout 5m;
ssl_protocols TLSv1 TLSv1.1 TLSv1.2;
ssl_ciphers ECDHE-RSA-AES128-GCM-SHA256:HIGH:!aNULL:!MD5:!RC4:!DHE;
ssl_prefer_server_ciphers on;
location / {
proxy_pass http://127.0.0.1:8765;
}
}
按 Ctrl + S
保存配置文件,讓 Nginx 重新加載配置使其生效:
sudo nginx -s reload
在瀏覽器通過 https 的方式訪問你解析的域名來測試 HTTPS 是否成功啟動
在小程序中測試 HTTPS 訪問
打開配套的小程序,點擊 實驗一:HTTPS
,點擊 發送請求
來測試訪問結果。
如果服務器響應成功,請點擊下一步。
小程序會話
任務時間:45min ~ 90min
小程序不支持 Cookie 存儲和跟蹤,服務器需要自行實現會話層
安裝 MongoDB
使用 apt-get 在機器上安裝 [MongoDB] 及其客戶端命令行工具:
sudo apt-get install mongodb-server mongodb -y
安裝結束后,可以使用下面的命令查看安裝的版本:
sudo mongod --version
sudo mongo --version
MongoDB 是一款 NoSQL 數據庫,支持 JSON 格式的結構化文檔存儲和查詢,對 JavaScript 有着友好的支持
啟動 MongoDB
創建目錄,用於 MongoDB 數據和日志存儲:
sudo mkdir -p /data/mongodb
sudo mkdir -p /data/logs/mongodb
創建后,使用下面的命令來啟動 MongoDB:[?]
sudo mongod --fork --dbpath /data/mongodb --logpath /data/logs/mongodb/webapp.log
可以使用下面的命令來檢查是否啟動成功 [?]
netstat -ltp | grep 27017
MongoDB 首次啟動可能會花費大概 1min 時間,請耐心等待
MongoDB 默認監聽 27017 端口等待連接,下面的命令查看當前 27017 端口被哪個進程占用,如果是 MongoDB 的進程,則表示啟動成功。
添加 MongoDB 用戶
登錄本地 MongoDB 服務:
sudo mongo
登錄后,創建一個用戶 webapp
[?]:
use webapp;
db.createUser({ user: 'webapp', pwd: 'webapp-dev', roles: ['dbAdmin', 'readWrite']});
創建完成后,使用 exit
退出命令行工具。
創建的用戶和密碼將用於下一步中連接數據庫時使用,如果使用不同的用戶或密碼,注意要保存好
安裝 Node 模塊
實現小程序的會話功能,我們需要安裝 [connect-mongo] 和 [wafer-node-session]
cd /data/release/webapp
sudo npm install connect-mongo wafer-node-session --save
[connect-mongo][https://github.com/jdesboeufs/connect-mongo] 模塊通過連接到 MongoDB 為會話提供存儲
[wafer-node-session][https://github.com/tencentyun/wafer-node-session] 是由騰訊雲提供的獨立小程序會話管理中間件
實現小程序會話
在工作目錄創建配置文件 config.js,用於保存我們服務所用的配置[?].
cd /data/release/webapp
sudo touch config.js
sudo chmod a+rw config.js
修改配置文件 config.js,可參考下面的實現(注:請將參考配置文件中的 YORU_APP_ID 和 YOUR_APP_SECRET 替換為你申請的小程序對應的 AppID 和 AppSecret):
示例代碼:/data/release/webapp/config.js
module.exports = {
serverPort: '8765',
// 小程序 appId 和 appSecret
// 請到 https://mp.weixin.qq.com 獲取 AppID 和 AppSecret
appId: 'YORU_APP_ID',
appSecret: 'YOUR_APP_SECRET',
// mongodb 連接配置,生產環境請使用更復雜的用戶名密碼
mongoHost: '127.0.0.1',
mongoPort: '27017',
mongoUser: 'webapp',
mongoPass: 'webapp-dev',
mongoDb: 'webapp'
};
編輯 app.js,添加會話實現邏輯,可參考下面的代碼:
示例代碼:/data/release/webapp/app.js
// 引用 express 來支持 HTTP Server 的實現
const express = require('express');
// 引用 wafer-session 支持小程序會話
const waferSession = require('wafer-node-session');
// 使用 MongoDB 作為會話的存儲
const MongoStore = require('connect-mongo')(waferSession);
// 引入配置文件
const config = require('./config');
// 創建一個 express 實例
const app = express();
// 添加會話中間件,登錄地址是 /login
app.use(waferSession({
appId: config.appId,
appSecret: config.appSecret,
loginPath: '/login',
store: new MongoStore({
url: `mongodb://${config.mongoUser}:${config.mongoPass}@${config.mongoHost}:${config.mongoPort}/${config.mongoDb}`
})
}));
// 在路由 /me 下,輸出會話里包含的用戶信息
app.use('/me', (request, response, next) => {
response.json(request.session ? request.session.userInfo : { noBody: true });
if (request.session) {
console.log(`Wafer session success with openId=${request.session.userInfo.openId}`);
}
});
// 實現一個中間件,對於未處理的請求,都輸出 "Response from express"
app.use((request, response, next) => {
response.write('Response from express');
response.end();
});
// 監聽端口,等待連接
app.listen(config.serverPort);
// 輸出服務器啟動日志
console.log(`Server listening at http://127.0.0.1:${config.serverPort}`);
源碼編寫完成后,重啟服務:
pm2 restart app
重啟后,使用配套的小程序完成會話測試:打開配套小程序 - 點擊 實驗二:會話
- 獲取會話
,如果您能看到您的微信頭像,那就表示會話已經成功獲取了。
隨着服務變得復雜,我們可以把配置集中起來方便管理,比如目前我們需要保存:服務器運行端口、小程序配置、MongoDB 連接配置
WebSocket 服務
任務時間:45min ~ 90min
安裝 ws 模塊
本實驗使用 ws
模塊來在服務器上支持 WebSocket 協議,下面使用 NPM 來安裝:
cd /data/release/webapp
sudo apt-get install npm -y
sudo npm install --save ws
實現 WebSocket 服務器
創建 websocket.js 文件,實現 WebSocket 服務
cd /data/release/webapp
sudo touch websocket.js
sudo chmod a+rw websocket.js
修改 websocket.js 文件,可參考下面的代碼:
示例代碼:/data/release/webapp/websocket.js
// 引入 ws 支持 WebSocket 的實現
const ws = require('ws');
// 導出處理方法
exports.listen = listen;
/**
* 在 HTTP Server 上處理 WebSocket 請求
* @param {http.Server} server
* @param {wafer.SessionMiddleware} sessionMiddleware
*/
function listen(server, sessionMiddleware) {
// 使用 HTTP Server 創建 WebSocket 服務,使用 path 參數指定需要升級為 WebSocket 的路徑
const wss = new ws.Server({ server, path: '/ws' });
// 監聽 WebSocket 連接建立
wss.on('connection', (ws,request) => {// 要升級到 WebSocket 協議的 HTTP 連接
// 被升級到 WebSocket 的請求不會被 express 處理,
// 需要使用會話中間節獲取會話
sessionMiddleware(request, null, () => {
const session = request.session;
if (!session) {
// 沒有獲取到會話,強制斷開 WebSocket 連接
ws.send(JSON.stringify(request.sessionError) || "No session avaliable");
ws.close();
return;
}
// 保留這個日志的輸出可讓實驗室能檢查到當前步驟是否完成
console.log(`WebSocket client connected with openId=${session.userInfo.openId}`);
serveMessage(ws, session.userInfo);
});
});
// 監聽 WebSocket 服務的錯誤
wss.on('error', (err) => {
console.log(err);
});
}
/**
* 進行簡單的 WebSocket 服務,對於客戶端發來的所有消息都回復回去
*/
function serveMessage(ws, userInfo) {
// 監聽客戶端發來的消息
ws.on('message', (message) => {
console.log(`WebSocket received: ${message}`);
ws.send(`Server: Received(${message})`);
});
// 監聽關閉事件
ws.on('close', (code, message) => {
console.log(`WebSocket client closed (code: ${code}, message: ${message || 'none'})`);
});
// 連接后馬上發送 hello 消息給會話對應的用戶
ws.send(`Server: 恭喜,${userInfo.nickName}`);
}
編輯 app.js,調用 WebSocket 服務,可參考下面代碼:
示例代碼:/data/release/webapp/app.js
// HTTP 模塊同時支持 Express 和 WebSocket
const http = require('http');
// 引用 express 來支持 HTTP Server 的實現
const express = require('express');
// 引用 wafer-session 支持小程序會話
const waferSession = require('wafer-node-session');
// 使用 MongoDB 作為會話的存儲
const MongoStore = require('connect-mongo')(waferSession);
// 引入配置文件
const config = require('./config');
// 引入 WebSocket 服務實現
const websocket = require('./websocket');
// 創建一個 express 實例
const app = express();
// 獨立出會話中間件給 express 和 ws 使用
const sessionMiddleware = waferSession({
appId: config.appId,
appSecret: config.appSecret,
loginPath: '/login',
store: new MongoStore({
url: `mongodb://${config.mongoUser}:${config.mongoPass}@${config.mongoHost}:${config.mongoPort}/${config.mongoDb}`
})
});
app.use(sessionMiddleware);
// 在路由 /me 下,輸出會話里包含的用戶信息
app.use('/me', (request, response, next) => {
response.json(request.session ? request.session.userInfo : { noBody: true });
if (request.session) {
console.log(`Wafer session success with openId=${request.session.userInfo.openId}`);
}
});
// 實現一個中間件,對於未處理的請求,都輸出 "Response from express"
app.use((request, response, next) => {
response.write('Response from express');
response.end();
});
// 創建 HTTP Server 而不是直接使用 express 監聽
const server = http.createServer(app);
// 讓 WebSocket 服務在創建的 HTTP 服務器上監聽
websocket.listen(server, sessionMiddleware);
// 啟動 HTTP 服務
server.listen(config.serverPort);
// 輸出服務器啟動日志
console.log(`Server listening at http://127.0.0.1:${config.serverPort}`);
修改完成后,按 Ctrl + S
保存文件,並重啟服務:
pm2 restart app
更新 Nginx 代理
編輯 Nginx 配置 ssl.conf,添加 WebSocket 支持,可參考下面的配置(注:請將參考配置文件中的 www.example.com 替換為前面步驟申請的域名,將 1_www.example.com_bundle.crt 和 2_www.example.com.key 替換為前面步驟申請並上傳的 SSL 證書的名稱):
示例代碼:/etc/nginx/conf.d/ssl.conf
# WebSocket 配置
map $http_upgrade $connection_upgrade {
default upgrade;
'' close;
}
server {
listen 443;
server_name www.example.com; # 改為綁定證書的域名
# ssl 配置
ssl on;
ssl_certificate 1_www.example.com_bundle.crt; # 改為自己申請得到的 crt 文件的名稱
ssl_certificate_key 2_www.example.com.key; # 改為自己申請得到的 key 文件的名稱
ssl_session_timeout 5m;
ssl_protocols TLSv1 TLSv1.1 TLSv1.2;
ssl_ciphers ECDHE-RSA-AES128-GCM-SHA256:HIGH:!aNULL:!MD5:!RC4:!DHE;
ssl_prefer_server_ciphers on;
# WebSocket 配置
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection $connection_upgrade;
location / {
proxy_pass http://127.0.0.1:8765;
}
}
配置完成后,按 Ctrl + S
保存,並且通知 Nginx 進程重新加載配置:
sudo nginx -s reload
測試 WebSocket
打開配套的小程序,點擊 實驗三:WebSocket
。進入測試頁面后,點擊 連接
按鈕,如果出現連接成功的提示,表示 WebSocket 服務已經正常運行,可以收發消息。
剪刀石頭布小游戲
任務時間:45min ~ 90min
實現游戲房間邏輯
創建 /data/release/webapp/game 目錄用於存放剪刀石頭布小游戲的代碼
sudo mkdir -p /data/release/webapp/game
添加 game/Room.js 實現游戲房間邏輯[?]
cd /data/release/webapp/game
sudo touch Room.js
sudo chmod a+rw Room.js
修改 game/Room.js,可參考下面的代碼:
示例代碼:/data/release/webapp/game/Room.js
/**
enum GameChoice {
// 剪刀
Scissors = 1,
// 石頭
Rock = 2,
// 布
Paper = 3
}
*/
function judge(choice1, choice2) {
// 和局
if (choice1 == choice2) return 0;
// Player 1 沒出,Player 2 勝出
if (!choice1) return 1;
// Player 2 沒出,Player 1 勝出
if (!choice2) return -1;
// 都出了就這么算
return (choice1 - choice2 + 3) % 3 == 1 ? -1 : 1;
}
/** @type {Room[]} */
const globalRoomList = [];
// 每個房間最多兩人
const MAX_ROOT_MEMBER = 2;
// 游戲時間,單位秒
const GAME_TIME = 3;
let nextRoomId = 0;
/** 表示一個房間 */
module.exports = class Room {
/** 獲取所有房間 */
static all() {
return globalRoomList.slice();
}
/** 獲取有座位的房間 */
static findRoomWithSeat() {
return globalRoomList.find(x => !x.isFull());
}
/** 創建新房間 */
static create() {
const room = new Room();
globalRoomList.unshift(room);
return room;
}
constructor() {
this.id = `room${nextRoomId++}`;
this.players = [];
}
/** 添加玩家 */
addPlayer(player) {
const { uid, uname } = player.user;
console.log(`Player ${uid}(${uname}) enter ${this.id}`);
this.players.push(player);
if (this.isFull()) {
this.startGame();
}
}
/** 刪除玩家 */
removePlayer(player) {
const { uid, uname } = player.user;
console.log(`Player ${uid}(${uname}) leave ${this.id}`);
const playerIndex = this.players.indexOf(player);
if (playerIndex != -1) {
this.players.splice(playerIndex, 1);
}
if (this.players.length === 0) {
console.log(`Room ${this.id} is empty now`);
const roomIndex = globalRoomList.indexOf(this);
if (roomIndex > -1) {
globalRoomList.splice(roomIndex, 1);
}
}
}
/** 玩家已滿 */
isFull() {
return this.players.length == MAX_ROOT_MEMBER;
}
/** 開始游戲 */
startGame() {
// 保留這行日志輸出可以讓實驗室檢查到實驗的完成情況
console.log('game started!');
// 當局積分清零
this.players.forEach(player => player.gameData.roundScore = 0);
// 集合玩家用戶和游戲數據
const players = this.players.map(player => Object.assign({}, player.user, player.gameData));
// 通知所有玩家開始
for (let player of this.players) {
player.send('start', {
gameTime: GAME_TIME,
players
});
}
// 計時結束
setTimeout(() => this.finishGame(), GAME_TIME * 1000);
}
/** 結束游戲 */
finishGame() {
const players = this.players;
// 兩兩對比算分
for (let i = 0; i < MAX_ROOT_MEMBER; i++) {
let p1 = players[i];
if (!p1) break;
for (let j = i + 1; j < MAX_ROOT_MEMBER; j++) {
let p2 = players[j];
const result = judge(p1.gameData.choice, p2.gameData.choice);
p1.gameData.roundScore -= result;
p2.gameData.roundScore += result;
}
}
// 計算連勝獎勵
for (let player of players) {
const gameData = player.gameData;
// 勝局積分
if (gameData.roundScore > 0) {
gameData.winStreak++;
gameData.roundScore *= gameData.winStreak;
}
// 敗局清零
else if (gameData.roundScore < 0) {
gameData.roundScore = 0;
gameData.winStreak = 0;
}
// 累積總分
gameData.totalScore += gameData.roundScore;
}
// 計算結果
const result = players.map(player => {
const { uid } = player.user;
const { roundScore, totalScore, winStreak, choice } = player.gameData;
return { uid, roundScore, totalScore, winStreak, choice };
});
// 通知所有玩家游戲結果
for (let player of players) {
player.send('result', { result });
}
}
}
處理游戲開始、計算結果、積分等邏輯
實現玩家邏輯
添加 game/Player.js
cd /data/release/webapp/game
sudo touch Player.js
sudo chmod a+rw Player.js
修改 game/Player.js,實現玩家邏輯[?],可參考下面的代碼:
示例代碼:/data/release/webapp/game/Player.js
const Room = require("./Room");
/**
* 表示一個玩家,處理玩家的公共游戲邏輯,消息處理部分需要具體的玩家實現(請參考 ComputerPlayer 和 HumanPlayer)
*/
module.exports = class Player {
constructor(user) {
this.id = user.uid;
this.user = user;
this.room = null;
this.gameData = {
// 當前的選擇(剪刀/石頭/布)
choice: null,
// 局積分
roundScore: 0,
// 總積分
totalScore: 0,
// 連勝次數
winStreak: 0
};
}
/**
* 上線當前玩家,並且異步返回給玩家分配的房間
*/
online(room) {
// 處理玩家 'join' 消息
// 為玩家尋找一個可用的房間,並且異步返回
this.receive('join', () => {
if (this.room) {
this.room.removePlayer(this);
}
room = this.room = room || Room.findRoomWithSeat() || Room.create();
room.addPlayer(this);
});
// 處理玩家 'choise' 消息
// 需要記錄玩家當前的選擇,並且通知到房間里的其它玩家
this.receive('choice', ({ choice }) => {
this.gameData.choice = choice;
this.broadcast('movement', {
uid: this.user.uid,
movement: "choice"
});
});
// 處理玩家 'leave' 消息
// 讓玩家下線
this.receive('leave', () => this.offline);
}
/**
* 下線當前玩家,從房間離開
*/
offline() {
if (this.room) {
this.room.removePlayer(this);
this.room = null;
}
this.user = null;
this.gameData = null;
}
/**
* 發送指定消息給當前玩家,需要具體子類實現
* @abstract
* @param {string} message 消息類型
* @param {*} data 消息數據
*/
send(message, data) {
throw new Error('Not implement: AbstractPlayer.send()');
}
/**
* 處理玩家發送的消息,需要具體子類實現
* @abstract
* @param {string} message 消息類型
* @param {Function} handler
*/
receive(message, handler) {
throw new Error('Not implement: AbstractPlayer.receive()');
}
/**
* 給玩家所在房間里的其它玩家發送消息
* @param {string} message 消息類型
* @param {any} data 消息數據
*/
broadcast(message, data) {
if (!this.room) return;
this.others().forEach(neighbor => neighbor.send(message, data));
}
/**
* 獲得玩家所在房間里的其他玩家
*/
others() {
return this.room.players.filter(player => player != this);
}
}
處理玩家加入游戲、選擇出拳、通知其他玩家等邏輯
實現電腦玩家
在實現人類玩家之前,我們先來創建 ComputerPlayer.js 來實現電腦玩家[?]
cd /data/release/webapp/game
sudo touch ComputerPlayer.js
sudo chmod a+rw ComputerPlayer.js
修改 ComputerPlayer.js 實現電腦玩家
示例代碼:/data/release/webapp/game/ComputerPlayer.js
const EventEmitter = require('events');
const Player = require('./Player');
let nextComputerId = 0;
/**
* 機器人玩家實現,使用 EventEmitter 接收和發送消息
*/
module.exports = class ComputerPlayer extends Player {
constructor() {
const computerId = `robot-${++nextComputerId}`;
super({
uid: computerId,
uname: computerId,
uavatar: 'http://www.scoutiegirl.com/wp-content/uploads/2015/06/Blue-Robot.png'
});
this.emitter = new EventEmitter();
}
/**
* 模擬玩家行為
*/
simulate() {
this.receive('start', () => this.play());
this.receive('result', () => this.stop());
this.send('join');
}
/**
* 游戲開始后,隨機時間后隨機選擇
*/
play() {
this.playing = true;
const randomTime = () => Math.floor(100 + Math.random() * 2000);
const randomChoice = () => {
if (!this.playing) return;
this.send("choice", {
choice: Math.floor(Math.random() * 10000) % 3 + 1
});
setTimeout(randomChoice, randomTime());
}
setTimeout(randomChoice, 10);
}
/**
* 游戲結束后,標記起來,阻止繼續隨機選擇
*/
stop() {
this.playing = false;
}
/**
* 發送消息給當前玩家,直接轉發到 emitter
*/
send(message, data) {
this.emitter.emit(message, data);
}
/**
* 從當前的 emitter 處理消息
*/
receive(message, handle) {
this.emitter.on(message, handle);
}
}
測試游戲邏輯的時候,可能沒有其它人可以一起參與,實現一個電腦玩家是不錯的選擇
實現人類玩家
人類玩家通過 WebSocket 信道來實現玩家的輸入輸出[?],我們需要添加 game/Tunnel.js 和 game/HumanPlayer.js 來實現人類玩家邏輯,可參考下面的代碼:
cd /data/release/webapp/game
sudo touch Tunnel.js
sudo touch HumanPlayer.js
sudo chmod a+rw Tunnel.js
sudo chmod a+rw HumanPlayer.js
修改 game/Tunnel.js 文件
示例代碼:/data/release/webapp/game/Tunnel.js
const EventEmitter = require('events');
/**
* 封裝 WebSocket 信道
*/
module.exports = class Tunnel {
constructor(ws) {
this.emitter = new EventEmitter();
this.ws = ws;
ws.on('message', packet => {
try {
// 約定每個數據包格式:{ message: 'type', data: any }
const { message, data } = JSON.parse(packet);
this.emitter.emit(message, data);
} catch (err) {
console.log('unknown packet: ' + packet);
}
});
}
on(message, handle) {
this.emitter.on(message, handle);
}
emit(message, data) {
this.ws.send(JSON.stringify({ message, data }));
}
}
修改 game/HumanPlayer.js 文件
示例代碼:/data/release/webapp/game/HumanPlayer.js
const co = require('co');
const Player = require('./Player');
const ComputerPlayer = require('./ComputerPlayer');
const Tunnel = require('./Tunnel');
/**
* 人類玩家實現,通過 WebSocket 信道接收和發送消息
*/
module.exports = class HumanPlayer extends Player {
constructor(user, ws) {
super(user);
this.ws = ws;
this.tunnel = new Tunnel(ws);
this.send('id', user);
}
/**
* 人類玩家上線后,還需要監聽信道關閉,讓玩家下線
*/
online(room) {
super.online(room);
this.ws.on('close', () => this.offline());
// 人類玩家請求電腦玩家
this.receive('requestComputer', () => {
const room = this.room;
while(room && !room.isFull()) {
const computer = new ComputerPlayer();
computer.online(room);
computer.simulate();
}
});
}
/**
* 下線后關閉信道
*/
offline() {
super.offline();
if (this.ws && this.ws.readyState == this.ws.OPEN) {
this.ws.close();
}
this.ws = null;
this.tunnel = null;
if (this.room) {
// 清理房間里面的電腦玩家
for (let player of this.room.players) {
if (player instanceof ComputerPlayer) {
this.room.removePlayer(player);
}
}
this.room = null;
}
}
/**
* 通過 WebSocket 信道發送消息給玩家
*/
send(message, data) {
this.tunnel.emit(message, data);
}
/**
* 從 WebSocket 信道接收玩家的消息
*/
receive(message, callback) {
this.tunnel.on(message, callback);
}
}
人類玩家和電腦玩家的邏輯是一致的,但是 IO 不同,人類玩家使用之前實現的 WebSocket 服務進行輸入輸出,而電腦玩家直接使用 EventEmiter 處理
添加游戲服務入口
游戲的實現已經完成了,接下來,編輯 websocket.js 添加服務入口,可參考下面的代碼:
示例代碼:/data/release/webapp/websocket.js
// 引入 url 模塊用於解析 URL
const url = require('url');
// 引入 ws 支持 WebSocket 的實現
const ws = require('ws');
// 引入人類玩家
const HumanPlayer = require('./game/HumanPlayer');
// 導出處理方法
exports.listen = listen;
/**
* 在 HTTP Server 上處理 WebSocket 請求
* @param {http.Server} server
* @param {wafer.SessionMiddleware} sessionMiddleware
*/
function listen(server, sessionMiddleware) {
// 使用 HTTP Server 創建 WebSocket 服務,使用 path 參數指定需要升級為 WebSocket 的路徑
const wss = new ws.Server({ server });
// 同時支持 /ws 和 /game 的 WebSocket 連接請求
wss.shouldHandle = (request) => {
const path = url.parse(request.url).pathname;
request.path = path;
return ['/ws', '/game'].indexOf(path) > -1;
};
// 監聽 WebSocket 連接建立
wss.on('connection', (ws, request) => {
// request: 要升級到 WebSocket 協議的 HTTP 連接
// 被升級到 WebSocket 的請求不會被 express 處理,
// 需要使用會話中間節獲取會話
sessionMiddleware(request, null, () => {
const session = request.session;
if (!session) {
// 沒有獲取到會話,強制斷開 WebSocket 連接
ws.send(JSON.stringify(request.sessionError) || "No session avaliable");
ws.close();
return;
}
console.log(`WebSocket client connected with openId=${session.userInfo.openId}`);
// 根據請求的地址進行不同處理
switch (request.path) {
case '/ws': return serveMessage(ws, session.userInfo);
case '/game': return serveGame(ws, session.userInfo);
default: return ws.close();
}
});
});
// 監聽 WebSocket 服務的錯誤
wss.on('error', (err) => {
console.log(err);
});
}
/**
* 進行簡單的 WebSocket 服務,對於客戶端發來的所有消息都回復回去
*/
function serveMessage(ws, userInfo) {
// 監聽客戶端發來的消息
ws.on('message', (message) => {
console.log(`WebSocket received: ${message}`);
ws.send(`Server: Received(${message})`);
});
// 監聽關閉事件
ws.on('close', (code, message) => {
console.log(`WebSocket client closed (code: ${code}, message: ${message || 'none'})`);
});
// 連接后馬上發送 hello 消息給會話對應的用戶
ws.send(`Server: 恭喜,${userInfo.nickName}`);
}
/**
* 使用 WebSocket 進行游戲服務
*/
function serveGame(ws, userInfo) {
const user = {
uid: userInfo.openId,
uname: userInfo.nickName,
uavatar: userInfo.avatarUrl
};
// 創建玩家
const player = new HumanPlayer(user, ws);
// 玩家上線
player.online();
}
安裝 co 模塊
我們的源碼中使用到了 co 進行協程管理,啟動游戲服務前,需要先安裝:
cd /data/release/webapp
sudo npm install co --save
測試游戲服務
重啟 Node 服務:
pm2 restart app
打開配套的小程序,點擊 實驗四 - 剪刀石頭布小游戲
,點擊 開始
按鈕進行游戲。
完成實驗
恭喜!您已經完成了小程序服務的全部實驗內容!你可以選擇保留已經運行的服務,繼續進行小程序的學習研究,建議留用機器。