隨著微信的普及,掃碼登錄方式越來越被現在的應用所使用。它因為不用去記住密碼,只要有微信號即可方便快捷登錄。微信的開放平臺原生就有支持掃碼登錄的功能,不過大部分人還是在用公眾平臺,所以掃碼登錄只能自行實現。這裡基於微信公眾平臺的帶參數臨時二維碼,並且結合 Swoole 的 WebSocket 服務實現 ...
隨著微信的普及,掃碼登錄方式越來越被現在的應用所使用。它因為不用去記住密碼,只要有微信號即可方便快捷登錄。微信的開放平臺原生就有支持掃碼登錄的功能,不過大部分人還是在用公眾平臺,所以掃碼登錄只能自行實現。這裡基於微信公眾平臺的帶參數臨時二維碼,並且結合 Swoole 的 WebSocket 服務實現掃碼登錄。大體流程如下:
- 客戶端打開登錄界面,連接到 WebSocket 服務
- WebScoket 服務生成帶參數二維碼返回給客戶端
- 用戶掃描展示的帶參數二維碼
- 微信伺服器回調掃碼事件並通知開發者伺服器
- 開發者伺服器通知 WebSocket 服務
- WebSocket 服務通知客戶端登錄成功
連接 WebSocket 服務
安裝完 Swoole 之後,我們需用使用到 WebSocket 服務。新建一個 WebSocket 服務非常簡單:
$server = new swoole_websocket_server("0.0.0.0", 1099);
$server->on('open', function (swoole_websocket_server $server, $request) use ($config){
echo "server: handshake success with fd{$request->fd}\n";
});
$server->on('message', function (swoole_websocket_server $server, $frame) {
});
這裡的 message 回調其實用不到,因為都是服務端下發消息的,但是必須設定一個。設定的埠號如果低於 1024 則必須要有 root 許可權,伺服器記得去防火牆開啟該埠。
生成帶參數二維碼
WebSocket 服務在客戶端連接成功後,需要生成一張微信的帶參數二維碼返回給客戶端展示:
$server->on('open', function (swoole_websocket_server $server, $request) use ($config){
$app = Factory::officialAccount($config['wechat']);
$result = $app->qrcode->temporary($request->fd, 120);
$url = $app->qrcode->url($result['ticket']);
$server->push($request->fd, json_encode([
'message_type' => 'qrcode_url',
'url' => $url
]));
});
我們在 open 回調中,生成一張臨時的二維碼,二維碼的場景值就是客戶端連接的文件描述符,這樣就可以保證每個客戶端的唯一性。有效時間設置為 120 秒,防止一張二維碼被多次掃碼使用。消息 push 到客戶端的時候必須要 json,方便客戶端處理。客戶端代碼也很簡單:
const socket = new WebSocket('ws://127.0.0.1:1099');
socket.addEventListener('message', function (event) {
var data = JSON.parse(event.data);
if (data.message_type == 'qrcode_url'){
$('#qrcode').attr('src', data.url);
}
});
回調掃碼事件
在客戶端展示二維碼後,需要提示用戶掃碼。對於用戶掃臨時的二維碼,微信會觸發相應的回調事件,我們需要在該回調事件中處理用戶的掃碼行為。其中我們需要用到微信傳遞過來的一些參數:
FromUserName 發送方帳號(一個OpenID)
MsgType 消息類型,event
Event 事件類型,subscribe
EventKey 事件 KEY 值,qrscene_為首碼,後面為二維碼的參數值
這裡要註意一點:微信已關註掃碼推送的EventKey
是沒有qrscene_
首碼的,只有未關註掃碼然後關註才有。
收到微信回調後我們首先要根據不同的事件類型做不同處理:
if ($message['MsgType'] == 'event'){
if ($message['Event'] == 'subscribe'){ //關註
return $this->subscribe($message);
}
if ($message['Event'] == 'unsubscribe') { //取消關註
return $this->unsubscribe($message);
}
if ($message['Event'] == 'SCAN'){ //已關註掃碼
return $this->scan($message);
}
}else{
return "您好!歡迎使用 SwooleWechat 掃描登錄";
}
這裡只講解一個關註事件的業務邏輯,其他根據需要自行編碼:
public function subscribe($message){
$eventKey = intval(str_replace('qrscene_', '', $message['EventKey']));
$openId = $message['FromUserName'];
$user = $this->app->user->get($openId);
$this->notify(json_encode([
'type' => 'scan',
'fd' => $eventKey,
'nickname' => $user['nickname']
]));
$count = $this->count($openId);
$msgTemp = "%s,登錄成功!\n這是你第%s次登錄,玩的開心!";
return sprintf($msgTemp, $user['nickname'], $count);
}
這裡的 EventKey 實際上就是連接 WebSocket 的客戶端文件描述符,獲取到掃碼用戶的 OPEN_ID, 根據用戶的 OPEN_ID 獲取用戶信息,通知 WebSocket 服務,響應文本消息給微信。
這裡一個比較麻煩的點就是如何通知 WebSocket 服務,我們知道處理微信回調的代碼是是不在 WebSocket 服務上的,那麼不同 Server 間如何通信呢?Swoole 官方給出的解決方案有兩個:
- 額外監聽一個 UDP 埠
- 使用 swoole_client 作為客戶端訪問 Server
這裡我們選擇第二個方案,Swoole 1.8 版本支持一個 Server 監聽多個埠,我們在 WebSocket 服務新增監聽一個 TCP 的埠:
$tcp_server = $server->addListener('0.0.0.0', 9999, SWOOLE_SOCK_TCP);
$tcp_server->set([]);
$tcp_server->on('receive', function ($serv, $fd, $threadId, $data) {
});
主伺服器是 WebSocket 或 Http 協議,新監聽的 TCP 埠預設會繼承主 Server 的協議設置,必須單獨調用 set 方法設置新的協議才會啟用新協議
然後我們就可以在掃碼回調的進程中去通知 WebSocket 服務:
public function notify($message){
$client = new swoole_client(SWOOLE_SOCK_TCP);
if (!$client->connect('127.0.0.1', $this->config['notify_port'], -1)) {
return "connect failed. Error: {$client->errCode}\n";
}
$ret = $client->send($message);
}
通知登錄成功
在 WebSocket 服務收到登錄成功的通知後,就可以根據需要處理一下用戶信息,然後把用戶信息傳遞給客戶端的瀏覽器展示結果,還記得我們剛剛新監聽的 TCP 埠嗎?就可以在 receive 事件中處理:
$tcp_server->on('receive', function ($serv, $fd, $threadId, $data) {
$data = json_decode($data, true);
if ($data['type'] == 'scan'){
$serv->push($data['fd'], json_encode([
'message_type' => 'scan_success',
'user' => $data['nickname']
]));
}
$serv->close($fd);
});
總結
整個過程並不難,主要的兩個難點就是對應連接用戶的掃碼用戶、不同 Server 之間的通信,我們的解決辦法就是把連接的文件描述符作為臨時二維碼場景值 (這裡也可以採用 Redis 來存儲映射關係)、監聽新的 TCP 埠來接受通知消息。可以訪問 http://wechat.sunnyshift.com/index.php 試試看,記得要用電腦打開。
更多學習內容請訪問:
怎麼從一名碼農成為架構師的必看知識點:目錄大全(不定期更新)