基于 Swoole 的微信扫码登录

Posted 2020-11-22 Raylove

随着微信的普及，扫码登录方式越来越被现在的应用所使用。它因为不用去记住密码，只要有微信号即可方便快捷登录。微信的开放平台原生就有支持扫码登录的功能，不过大部分人还是在用公众平台，所以扫码登录只能自行实现。这里基于微信公众平台的带参数临时二维码，并且结合 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}
";
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，登录成功！
这是你第%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}
";
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 试试看，记得要用电脑打开。