基于 Swoole 的微信扫码登陆

随着微信的普及,扫码登陆方式愈来愈被如今的应用所使用。它由于不用去记住密码,只要有微信号便可方便快捷登陆。微信的开放平台原生就有支持扫码登陆的功能,不过大部分人仍是在用公众平台,因此扫码登陆只能自行实现。这里基于微信公众平台的带参数临时二维码,而且结合 Swoole 的 WebSocket 服务实现扫码登陆。大致流程以下:php

  1. 客户端打开登陆界面,链接到 WebSocket 服务
  2. WebScoket 服务生成带参数二维码返回给客户端
  3. 用户扫描展现的带参数二维码
  4. 微信服务器回调扫码事件并通知开发者服务器
  5. 开发者服务器通知 WebSocket 服务
  6. WebSocket 服务通知客户端登陆成功

链接 WebSocket 服务

安装完 Swoole 以后,咱们需用使用到 WebSocket 服务。新建一个 WebSocket 服务很是简单:web

$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 权限,服务器记得去防火墙开启该端口。json

生成带参数二维码

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_ 前缀的,只有未关注扫码而后关注才有。

收到微信回调后咱们首先要根据不一样的事件类型作不一样处理:websocket

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 扫描登陆";
}

这里只讲解一个关注事件的业务逻辑,其余根据须要自行编码:swoole

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 官方给出的解决方案有两个:app

  1. 额外监听一个UDP端口
  2. 使用 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 试试看,记得要用电脑打开。

公众号后台发 ‘swoole-wechat’ 获取完整的源代码仓库地址,完。

相关文章
相关标签/搜索