基於 Swoole 的微信掃碼登陸

隨着微信的普及，掃碼登陸方式愈來愈被如今的應用所使用。它由於不用去記住密碼，只要有微信號便可方便快捷登陸。微信的開放平臺原生就有支持掃碼登陸的功能，不過大部分人仍是在用公衆平臺，因此掃碼登陸只能自行實現。這裏基於微信公衆平臺的帶參數臨時二維碼，而且結合 Swoole 的 WebSocket 服務實現掃碼登陸。大致流程以下：

1. 客戶端打開登陸界面，鏈接到 WebSocket 服務
2. WebScoket 服務生成帶參數二維碼返回給客戶端
3. 用戶掃描展現的帶參數二維碼
4. 微信服務器回調掃碼事件並通知開發者服務器
5. 開發者服務器通知 WebSocket 服務
6. WebSocket 服務通知客戶端登陸成功

 

鏈接 WebSocket 服務

安裝完 Swoole 以後，咱們需用使用到 WebSocket 服務。新建一個 WebSocket 服務很是簡單：

1 $server = new swoole_websocket_server("0.0.0.0", 1099);
2 $server->on('open', function (swoole_websocket_server $server, $request) use ($config){
3     echo "server: handshake success with fd{$request->fd}\n";
4 });
5 
6 $server->on('message', function (swoole_websocket_server $server, $frame) {
7 
8 });

 

這裏的 message 回調其實用不到，由於都是服務端下發消息的，可是必須設定一個。設定的端口號若是低於 1024 則必需要有 root 權限，服務器記得去防火牆開啓該端口。

 

生成帶參數二維碼

WebSocket 服務在客戶端鏈接成功後，須要生成一張微信的帶參數二維碼返回給客戶端展現：

1 $server->on('open', function (swoole_websocket_server $server, $request) use ($config){
2     $app = Factory::officialAccount($config['wechat']);
3     $result = $app->qrcode->temporary($request->fd, 120);
4     $url = $app->qrcode->url($result['ticket']);
5     $server->push($request->fd, json_encode([
6         'message_type'    =>  'qrcode_url',
7         'url'       =>  $url
8     ]));
9 });

 

咱們在 open 回調中，生成一張臨時的二維碼，二維碼的場景值就是客戶端鏈接的文件描述符，這樣就能夠保證每一個客戶端的惟一性。有效時間設置爲 120 秒，防止一張二維碼被屢次掃碼使用。消息 push 到客戶端的時候必需要 json，方便客戶端處理。客戶端代碼也很簡單：

1 const socket = new WebSocket('ws://127.0.0.1:1099');
2     socket.addEventListener('message', function (event) {
3         var data = JSON.parse(event.data);
4         if (data.message_type == 'qrcode_url'){
5             $('#qrcode').attr('src', data.url);
6         }
7     });

 

 

回調掃碼事件

在客戶端展現二維碼後，須要提示用戶掃碼。對於用戶掃臨時的二維碼，微信會觸發相應的回調事件，咱們須要在該回調事件中處理用戶的掃碼行爲。其中咱們須要用到微信傳遞過來的一些參數：

FromUserName    發送方賬號（一個OpenID）
MsgType         消息類型，event
Event           事件類型，subscribe
EventKey        事件 KEY 值，qrscene_爲前綴，後面爲二維碼的參數值

這裏要注意一點：微信已關注掃碼推送的 EventKey 是沒有 qrscene_ 前綴的，只有未關注掃碼而後關注纔有。

收到微信回調後咱們首先要根據不一樣的事件類型作不一樣處理：

 1 if ($message['MsgType'] == 'event'){
 2     if ($message['Event'] == 'subscribe'){  //關注
 3         return $this->subscribe($message);
 4     }
 5     if ($message['Event'] == 'unsubscribe') {  //取消關注
 6         return $this->unsubscribe($message);
 7     }
 8     if ($message['Event'] == 'SCAN'){   //已關注掃碼
 9         return $this->scan($message);
10     }
11 }else{
12     return "您好！歡迎使用 SwooleWechat 掃描登陸";
13 }

 

這裏只講解一個關注事件的業務邏輯，其餘根據須要自行編碼：

 1 public function subscribe($message){
 2     $eventKey = intval(str_replace('qrscene_', '', $message['EventKey']));
 3     $openId = $message['FromUserName'];
 4     $user = $this->app->user->get($openId);
 5     $this->notify(json_encode([
 6         'type'  =>  'scan',
 7         'fd'    =>  $eventKey,
 8         'nickname'  =>  $user['nickname']
 9     ]));
10     $count = $this->count($openId);
11     $msgTemp = "%s，登陸成功！\n這是你第%s次登陸，玩的開心！";
12     return sprintf($msgTemp, $user['nickname'], $count);
13 }

 

這裏的 EventKey 實際上就是鏈接 WebSocket 的客戶端文件描述符，獲取到掃碼用戶的 OPEN_ID, 根據用戶的 OPEN_ID 獲取用戶信息，通知 WebSocket 服務，響應文本消息給微信。
這裏一個比較麻煩的點就是如何通知 WebSocket 服務，咱們知道處理微信回調的代碼是是不在 WebSocket 服務上的，那麼不一樣 Server 間如何通訊呢？Swoole 官方給出的解決方案有兩個：

1. 額外監聽一個 UDP 端口
2. 使用 swoole_client 做爲客戶端訪問 Server

這裏咱們選擇第二個方案，Swoole 1.8 版本支持一個 Server 監聽多個端口，咱們在 WebSocket 服務新增監聽一個 TCP 的端口：

1 $tcp_server = $server->addListener('0.0.0.0', 9999, SWOOLE_SOCK_TCP);
2 $tcp_server->set([]);
3 $tcp_server->on('receive', function ($serv, $fd, $threadId, $data) {
4 
5 });

 

主服務器是 WebSocket 或 Http 協議，新監聽的 TCP 端口默認會繼承主 Server 的協議設置，必須單獨調用 set 方法設置新的協議纔會啓用新協議

而後咱們就能夠在掃碼回調的進程中去通知 WebSocket 服務：

1 public function notify($message){
2     $client = new swoole_client(SWOOLE_SOCK_TCP);
3     if (!$client->connect('127.0.0.1', $this->config['notify_port'], -1)) {
4         return "connect failed. Error: {$client->errCode}\n";
5     }
6     $ret = $client->send($message);
7 }

 

 

通知登陸成功

在 WebSocket 服務收到登陸成功的通知後，就能夠根據須要處理一下用戶信息，而後把用戶信息傳遞給客戶端的瀏覽器展現結果，還記得咱們剛剛新監聽的 TCP 端口嗎？就能夠在 receive 事件中處理：

 1 $tcp_server->on('receive', function ($serv, $fd, $threadId, $data) {
 2     $data = json_decode($data, true);
 3     if ($data['type'] == 'scan'){
 4         $serv->push($data['fd'], json_encode([
 5             'message_type'    =>  'scan_success',
 6             'user'  =>  $data['nickname']
 7         ]));
 8     }
 9     $serv->close($fd);
10 });

 

最後登陸的界面：
發圖太麻煩，自行去 http://wechat.sunnyshift.com/index.php 測試地址看。

 

總結

整個過程並不難，主要的兩個難點就是對應鏈接用戶的掃碼用戶、不一樣 Server 之間的通訊，咱們的解決辦法就是把鏈接的文件描述符做爲臨時二維碼場景值 (這裏也能夠採用 Redis 來存儲映射關係)、監聽新的 TCP 端口來接受通知消息。能夠訪問 http://wechat.sunnyshift.com/index.php 試試看，記得要用電腦打開。