用户、会话和第三方登录集成
“你应该明白,我的朋友,
宇宙从来无所谓起始,
它也永远不会有结局,
因为邦迪,戈尔德,还有我,
直到我们头发掉精光,
对这一点都深信不疑!”
--《物理世界奇遇记》
3.8.1 扩展类库:用户、会话和第三方登录集成
首先,特别感谢@Aevit ,允许我将些扩展类库进行开源。原来此类库的功能只是当前开发项目中的功能,我现将其抽离成可配置使用的扩展类库,以供大家共享。
此类库主要特点有:
- 1、可以和第三方登录集成,包括:微信登录、新浪登录、QQ登录
- 2、为客户端提供了直接可以调用的登录接口
- 3、为服务端提供了直接可以检测用户登录态的操作
- 4、支持token落地、高效缓存和分布式的数据库存储
- 5、展示了如何开发一个项目级的类库、包括数据库配置、翻译等
温馨提示:
此扩展类库还在开发完善中,但已有项目在使用,感兴趣的同学可以尝试使用。
3.8.2 安装
(1)扩展包下载
从 PhalApi-Library 扩展库中下载获取 User 用户包,如使用:
git clone https://git.oschina.net/dogstar/PhalApi-Library.git
然后把 User 目录复制到 ./PhalApi/Library/ 下,即:
cp ./PhalApi-Library/User ./PhalApi/Library/ -R
(2)数据库表导入
默认下,User类库会使用默认的数据库配置,但有追加一些需要用到的表。因此需要导入以下表:
$ cd /Library/User
$ tree
├── Data
│ ├── user_login_qq.sql
│ ├── user_login_sina.sql
│ ├── user_login_weixin.sql
│ ├── user_session.sql
│ └── user.sql
温馨提示:
导入前,可以自行调整表的前缀。
(3)数据库配置
将 PhalApi-Library/User/Config/dbs.php 里面的配置拷贝到你的项目配置:
//请将以下配置拷贝到 ./Config/dbs.php 文件对应的位置中
//10张表,可根据需要,自行调整表前缀、主键名和路由
'user_session' => array(
'prefix' => 'phalapi_',
'key' => 'id',
'map' => array(
array('db' => 'db_demo'),
array('start' => 0, 'end' => 9, 'db' => 'db_demo'),
),
),
(4)入口注册
//必须显式注册,以便可以让服务自行初始化
DI()->userLite = new User_Lite();
(5)其他可选配置
- 为了体现高效缓存的好处,建议先注册DI()->cache
- 为了接口更明朗的参数规则说明,建议将下而规则追加到配置文件./Config/app.php中:
return array(
/**
* 应用接口层的统一参数
*/
'apiCommonRules' => array(
//其他原来的参数配置
...
//登录信息
'userId' => array(
'name' => 'user_id', 'type' => 'int', 'default' => 0, 'require' => false,
),
'token' => array(
'name' => 'token', 'type' => 'string', 'default' => '', 'require' => false,
),
),
(6)checkApiParams.php的初始化
同样,需要在checkApiParams.php文件显式注册,才能让User这个扩展类库完成自我的必要初始化:
//装载你的接口
DI()->loader->addDirs(array('Demo', 'Library'));
DI()->userLite = new User_Lite();
否则会导致service不存在。
3.8.3 入门使用
(1)对于客户端
(1-1)微信登录
1、功能说明
实现通过微信登录,并且首次登录时,自动创建用户并绑定。
2、接口URL
/?service=User_User_Login.weixin + 公共参数(免登录态)
3、接口参数
参数 | 必须 | 默认值 | 说明 |
---|---|---|---|
wx_openid | 1 | 微信OPENID | |
wx_token | 1 | 微信TOKEN | |
wx_expires_in | 1 | 微信失效时间 |
4、返回结果
返回字段
参数 | 类型 | 说明 |
---|---|---|
info | object | 登录成功后的相关信息 |
user_id | int | 用户ID |
token | string | 用户TOKEN |
is_new | int | 是否为首次登录,0不是,1是 |
结果示例
{
"ret": 200,
"data": {
"code": 0, //0正常登录
"info": {
"user_id": 3, //用户ID
"token": "430C0F31FAF1FB1565E4290D1B61185A2408A6DEEA1604C1B5AEB14E44BDF2E0", //用户TOKEN
"is_new": 0 //是否为首次登录,0不是,1是
},
"msg": ""
},
"msg": ""
}
请求示例
/service=User_User_Login.weixin&wx_openid=wx_122348561111&wx_token=ASDF&wx_expires_in=130000000&name=weixinName&avatar=phpunit.png
(1-2)QQ登录
1、功能说明
实现通过QQ登录,并且首次登录时,自动创建用户并绑定。
2、接口URL
/?service=User_User_Login.qq + 公共参数(免登录态)
3、接口参数
参数 | 必须 | 默认值 | 说明 |
---|---|---|---|
qq_openid | 1 | QQ的OPENID | |
qq_token | 1 | QQ的TOKEN | |
qq_expires_in | 1 | QQ的失效时间 |
4、返回结果
返回字段
参数 | 类型 | 说明 |
---|---|---|
info | object | 登录成功后的相关信息 |
user_id | int | 用户ID |
token | string | 用户TOKEN |
is_new | int | 是否为首次登录,0不是,1是 |
结果示例
{
"ret": 200,
"data": {
"code": 0, //0正常登录
"info": {
"user_id": 3, //用户ID
"token": "430C0F31FAF1FB1565E4290D1B61185A2408A6DEEA1604C1B5AEB14E44BDF2E0", //用户TOKEN
"is_new": 0 //是否为首次登录,0不是,1是
},
"msg": ""
},
"msg": ""
}
请求示例
/service=User_User_Login.qq&qq_openid=xxxx&qq_token=ASDF&qq_expires_in=130000000&name=sinaName&avatar=http://dev.phalapi.com/no_avatar.png
(1-3)新浪微博登录
1、功能说明
实现通过新浪微博登录,并且首次登录时,自动创建用户并绑定。
2、接口URL
/?service=User_User_Login.sina
3、接口参数
参数 | 必须 | 默认值 | 说明 |
---|---|---|---|
sina_openid | 1 | 新浪微博OPENID | |
sina_token | 1 | 新浪微博TOKEN | |
sina_expires_in | 1 | 新浪微博失效时间 |
4、返回结果
返回字段
参数 | 类型 | 说明 |
---|---|---|
info | object | 登录成功后的相关信息 |
user_id | int | 用户ID |
token | string | 用户TOKEN |
is_new | int | 是否为首次登录,0不是,1是 |
结果示例
{
"ret": 200,
"data": {
"code": 0, //0正常登录
"info": {
"user_id": 3, //用户ID
"token": "430C0F31FAF1FB1565E4290D1B61185A2408A6DEEA1604C1B5AEB14E44BDF2E0", //用户TOKEN
"is_new": 0 //是否为首次登录,0不是,1是
},
"msg": ""
},
"msg": ""
}
请求示例
/service=User_User_Login.weixin&wx_openid=wx_122348561111&wx_token=ASDF&wx_expires_in=130000000&name=weixinName&avatar=phpunit.png
(1-4)用户信息
1、功能说明
获取用户个人信息
2、接口URL
/?service=User_User_Info.getUserInfo + 公共参数
3、接口参数
参数 | 必须 | 默认值 | 说明 |
---|---|---|---|
other_user_id | 1 | 用户id |
4、返回结果
返回字段
参数 | 类型 | 说明 |
---|---|---|
info | object | 登录成功后的相关信息 |
user_id | int | 用户ID |
username | string | 用户名 |
nickname | string | 用户昵称 |
avatar | string | 用户头像url |
结果示例
{
"ret": 200,
"data": {
"code": 0,
"info": {
"username": "aevit",
"nickname": "test",
"avatar": "",
"user_id": 1
},
"msg": ""
},
"msg": ""
}
请求示例
/service=User_User_Info.getUserInfo&other_user_id=1
(2)对于服务端
(1)温柔式检测登录态
$isLogin = DI()->userLite->check();
(2)强制式检测登录态
DI()->userLite->check(true);
(3)更多操作
当需要对用户进行退出登录时,可以在接口中执行:
DI()->userLite->logout();
当需要为用户新建一个会话时,可以在接口中执行:
DI()->userLite->generateSession(1); //假设用户ID为1
当需要为用户延长登录态有效时间时(默认为一个月),可以在接口进行心跳操作,从而再延长一个月有效时间:
DI()->userLite->heartbeat();
3.8.4 示例
(1)假设在我们的应用的接口中:
<?php
class Api_Test extends PhalApi_Api {
public function go() {
Di()->userLite->check(true);
return 'ok';
}
}
(2)先调用微信的登录:
/user/?service=User_User_Login.Weixin&wx_openid=wx_122348561111&wx_token=ASDF&wx_expires_in=130000000&name=weixinName&avatar=phpunit.png
返回:
{
"ret": 200,
"data": {
"code": 0,
"info": {
"user_id": 94,
"token": "8509BE9C80B67009C559E6A2C4B88E02C885DA6B9FEFFC2DA080999377D08FBF",
"is_new": 0
},
"msg": ""
},
"msg": ""
}
(3)再调用我们应用 的接口:
/user/?service=Test.go&user_id=94&token=CE1218493B3A441FCF630E24E98FD3640133EBA6D734C90A620A11C07CE35323
返回:
{"ret":200,"data":"ok","msg":""}
(4)未登录下,返回:
{"ret":401,"data":[],"msg":"\u975e\u6cd5\u8bf7\u6c42\uff1auser not login"}
更多建议: