查看: 546|回复: 0

[PHP学习] yii2项目实战之restful api授权验证详解

发表于 2018-3-31 08:00:03

前言

什么是restful风格的api呢?我们之前有写过大篇的文章来介绍其概念以及基本操作。

既然写过了,那今天是要说点什么吗?

这篇文章主要针对实际场景中api的部署来写。

我们今天就来大大的侃侃那些年api遇到的授权验证问题!独家干活,如果看完有所受益,记得不要忘记给我点赞哦。

业务分析

我们先来了解一下整个逻辑

  • 用户在客户端填写登录表单
  • 用户提交表单,客户端请求登录接口login
  • 服务端校验用户的帐号密码,并返回一个有效的token给客户端
  • 客户端拿到用户的token,将之存储在客户端比如cookie中
  • 客户端携带token访问需要校验的接口比如获取用户个人信息接口
  • 服务端校验token的有效性,校验通过,反正返回客户端需要的信息,校验失败,需要用户重新登录

本文我们以用户登录,获取用户的个人信息为例进行详细的完整版说明。
以上,便是我们本篇文章要实现的重点。先别激动,也别紧张,分析好了之后,细节部分我们再一步一个脚印走下去。

准备工作

  • 你应该有一个api应用,如果你还没有,请先移步这里→_→Restful api基础
  • 对于客户端,我们准备采用postman进行模拟,如果你的google浏览器还没有安装postman,请先自行下载
  • 要测试的用户表需要有一个api_token的字段,没有的请先自行添加,并保证该字段足够长度
  • api应用开启了路由美化,并先配置post类型的login操作和get类型的signup-test操作
  • 关闭了user组件的session会话

关于上面准备工作的第4点和第5点,我们贴一下代码方便理解

  1. 'components' => [
  2. 'user' => [
  3. 'identityClass' => 'common\models\User',
  4. 'enableAutoLogin' => true,
  5. 'enableSession' => false,
  6. ],
  7. 'urlManager' => [
  8. 'enablePrettyUrl' => true,
  9. 'showScriptName' => false,
  10. 'enableStrictParsing' => true,
  11. 'rules' => [
  12. [
  13. 'class' => 'yii\rest\UrlRule',
  14. 'controller' => ['v1/user'],
  15. 'extraPatterns' => [
  16. 'POST login' => 'login',
  17. 'GET signup-test' => 'signup-test',
  18. ]
  19. ],
  20. ]
  21. ],
  22. // ......
  23. ],
复制代码

signup-test操作我们后面添加测试用户,为登录操作提供便利。其他类型的操作后面看需要再做添加。

认证类的选择

我们在api\modules\v1\controllers\UserController中设定的model类指向 common\models\User类,为了说明重点这里我们就不单独拿出来重写了,看各位需要,有必要的话再单独copy一个User类到api\models下。

校验用户权限我们以 yii\filters\auth\QueryParamAuth 为例

  1. use yii\filters\auth\QueryParamAuth;
  2. public function behaviors()
  3. {
  4. return ArrayHelper::merge (parent::behaviors(), [
  5. 'authenticator' => [
  6. 'class' => QueryParamAuth::className()
  7. ]
  8. ] );
  9. }
复制代码

如此一来,那岂不是所有访问user的操作都需要认证了?那不行,客户端第一个访问login操作的时候哪来的token,yii\filters\auth\QueryParamAuth对外提供一个属性,用于过滤不需要验证的action。我们将UserController的behaviors方法稍作修改

  1. public function behaviors()
  2. {
  3. return ArrayHelper::merge (parent::behaviors(), [
  4. 'authenticator' => [
  5. 'class' => QueryParamAuth::className(),
  6. 'optional' => [
  7. 'login',
  8. 'signup-test'
  9. ],
  10. ]
  11. ] );
  12. }
复制代码

这样login操作就无需权限验证即可访问了。

添加测试用户

为了避免让客户端登录失败,我们先写一个简单的方法,往user表里面插入两条数据,便于接下来的校验。

UserController增加signupTest操作,注意此方法不属于讲解范围之内,我们仅用于方便测试。

  1. use common\models\User;
  2. /**
  3. * 添加测试用户
  4. */
  5. public function actionSignupTest ()
  6. {
  7. $user = new User();
  8. $user->generateAuthKey();
  9. $user->setPassword('123456');
  10. $user->username = '111';
  11. $user->email = '111@111.com';
  12. $user->save(false);
  13. return [
  14. 'code' => 0
  15. ];
  16. }
复制代码

如上,我们添加了一个username是111,密码是123456的用户

登录操作

假设用户在客户端输入用户名和密码进行登录,服务端login操作其实很简单,大部分的业务逻辑处理都在api\models\loginForm上,来先看看login的实现

use api\models\LoginForm;

  1. /**
  2. * 登录
  3. */
  4. public function actionLogin ()
  5. {
  6. $model = new LoginForm;
  7. $model->setAttributes(Yii::$app->request->post());
  8. if ($user = $model->login()) {
  9. if ($user instanceof IdentityInterface) {
  10. return $user->api_token;
  11. } else {
  12. return $user->errors;
  13. }
  14. } else {
  15. return $model->errors;
  16. }
  17. }
复制代码

登录成功后这里给客户端返回了用户的token,再来看看登录的具体逻辑的实现

新建api\models\LoginForm.PHP

  1. <?php
  2. namespace api\models;
  3. use Yii;
  4. use yii\base\Model;
  5. use common\models\User;
  6. /**
  7. * Login form
  8. */
  9. class LoginForm extends Model
  10. {
  11. public $username;
  12. public $password;
  13. private $_user;
  14. const GET_API_TOKEN = 'generate_api_token';
  15. public function init ()
  16. {
  17. parent::init();
  18. $this->on(self::GET_API_TOKEN, [$this, 'onGenerateApiToken']);
  19. }
  20. /**
  21. * @inheritdoc
  22. * 对客户端表单数据进行验证的rule
  23. */
  24. public function rules()
  25. {
  26. return [
  27. [['username', 'password'], 'required'],
  28. ['password', 'validatePassword'],
  29. ];
  30. }
  31. /**
  32. * 自定义的密码认证方法
  33. */
  34. public function validatePassword($attribute, $params)
  35. {
  36. if (!$this->hasErrors()) {
  37. $this->_user = $this->getUser();
  38. if (!$this->_user || !$this->_user->validatePassword($this->password)) {
  39. $this->addError($attribute, '用户名或密码错误.');
  40. }
  41. }
  42. }
  43. /**
  44. * @inheritdoc
  45. */
  46. public function attributeLabels()
  47. {
  48. return [
  49. 'username' => '用户名',
  50. 'password' => '密码',
  51. ];
  52. }
  53. /**
  54. * Logs in a user using the provided username and password.
  55. *
  56. * @return boolean whether the user is logged in successfully
  57. */
  58. public function login()
  59. {
  60. if ($this->validate()) {
  61. $this->trigger(self::GET_API_TOKEN);
  62. return $this->_user;
  63. } else {
  64. return null;
  65. }
  66. }
  67. /**
  68. * 根据用户名获取用户的认证信息
  69. *
  70. * @return User|null
  71. */
  72. protected function getUser()
  73. {
  74. if ($this->_user === null) {
  75. $this->_user = User::findByUsername($this->username);
  76. }
  77. return $this->_user;
  78. }
  79. /**
  80. * 登录校验成功后,为用户生成新的token
  81. * 如果token失效,则重新生成token
  82. */
  83. public function onGenerateApiToken ()
  84. {
  85. if (!User::apiTokenIsValid($this->_user->api_token)) {
  86. $this->_user->generateApiToken();
  87. $this->_user->save(false);
  88. }
  89. }
  90. }
复制代码

我们回过头来看一下,当我们在UserController的login操作中调用LoginForm的login操作后都发生了什么

1、调用LoginForm的login方法

2、调用validate方法,随后对rules进行校验

3、rules校验中调用validatePassword方法,对用户名和密码进行校验

4、validatePassword方法校验的过程中调用LoginForm的getUser方法,通过common\models\User类的findByUsername获取用户,找不到或者common\models\User的validatePassword对密码校验失败则返回error

5、触发LoginForm::GENERATE_API_TOKEN事件,调用LoginForm的onGenerateApiToken方法,通过common\models\User的apiTokenIsValid校验token的有效性,如果无效,则调用User的generateApiToken方法重新生成

注意:common\models\User类必须是用户的认证类,如果不知道如何创建完善该类,请围观这里 用户管理之user组件的配置

下面补充本节增加的common\models\User的相关方法

  1. /**
  2. * 生成 api_token
  3. */
  4. public function generateApiToken()
  5. {
  6. $this->api_token = Yii::$app->security->generateRandomString() . '_' . time();
  7. }
  8. /**
  9. * 校验api_token是否有效
  10. */
  11. public static function apiTokenIsValid($token)
  12. {
  13. if (empty($token)) {
  14. return false;
  15. }
  16. $timestamp = (int) substr($token, strrpos($token, '_') + 1);
  17. $expire = Yii::$app->params['user.apiTokenExpire'];
  18. return $timestamp + $expire >= time();
  19. }
复制代码

继续补充apiTokenIsValid方法中涉及到的token有效期,在api\config\params.php文件内增加即可

  1. <?php
  2. return [
  3. // ...
  4. // token 有效期默认1天
  5. 'user.apiTokenExpire' => 1*24*3600,
  6. ];
复制代码

到这里呢,客户端登录 服务端返回token给客户端就完成了。

按照文中一开始的分析,客户端应该把获取到的token存到本地,比如cookie中。以后再需要token校验的接口访问中,从本地读取比如从cookie中读取并访问接口即可。

根据token请求用户的认证操作

假设我们已经把获取到的token保存起来了,我们再以访问用户信息的接口为例。

yii\filters\auth\QueryParamAuth类认定的token参数是 access-token,我们可以在行为中修改下

  1. public function behaviors()
  2. {
  3. return ArrayHelper::merge (parent::behaviors(), [
  4. 'authenticator' => [
  5. 'class' => QueryParamAuth::className(),
  6. 'tokenParam' => 'token',
  7. 'optional' => [
  8. 'login',
  9. 'signup-test'
  10. ],
  11. ]
  12. ] );
  13. }
复制代码

这里将默认的access-token修改为token。

我们在配置文件的urlManager组件中增加对userProfile操作

  1. 'extraPatterns' => [
  2. 'POST login' => 'login',
  3. 'GET signup-test' => 'signup-test',
  4. 'GET user-profile' => 'user-profile',
  5. ]
复制代码

我们用postman模拟请求访问下 /v1/users/user-profile?token=apeuT9dAgH072qbfrtihfzL6qDe_l4qz_1479626145发现,抛出了一个异常

\"findIdentityByAccessToken\" is not implemented.

这是怎么回事呢?

我们找到 yii\filters\auth\QueryParamAuth 的authenticate方法,发现这里调用了 common\models\User类的loginByAccessToken方法,有同学疑惑了,common\models\User类没实现loginByAccessToken方法为啥说findIdentityByAccessToken方法没实现?如果你还记得common\models\User类实现了yii\web\user类的接口的话,你应该会打开yii\web\User类找答案。没错,loginByAccessToken方法在yii\web\User中实现了,该类中调用了common\models\User的findIdentityByAccessToken,但是我们看到,该方法中通过throw抛出了异常,也就是说这个方法要我们自己手动实现!

这好办了,我们就来实现下common\models\User类的findIdentityByAccessToken方法吧

  1. public static function findIdentityByAccessToken($token, $type = null)
  2. {
  3. // 如果token无效的话,
  4. if(!static::apiTokenIsValid($token)) {
  5. throw new \yii\web\UnauthorizedHttpException("token is invalid.");
  6. }
  7. return static::findOne(['api_token' => $token, 'status' => self::STATUS_ACTIVE]);
  8. // throw new NotSupportedException('"findIdentityByAccessToken" is not implemented.');
  9. }
复制代码

验证完token的有效性,下面就要开始实现主要的业务逻辑部分了。

  1. /**
  2. * 获取用户信息
  3. */
  4. public function actionUserProfile ($token)
  5. {
  6. // 到这一步,token都认为是有效的了
  7. // 下面只需要实现业务逻辑即可,下面仅仅作为案例,比如你可能需要关联其他表获取用户信息等等
  8. $user = User::findIdentityByAccessToken($token);
  9. return [
  10. 'id' => $user->id,
  11. 'username' => $user->username,
  12. 'email' => $user->email,
  13. ];
  14. }
复制代码

服务端返回的数据类型定义

在postman中我们可以以何种数据类型输出的接口的数据,但是,有些人发现,当我们把postman模拟请求的地址copy到浏览器地址栏,返回的又却是xml格式了,而且我们明明在UserProfile操作中返回的是属组,怎么回事呢?

这其实是官方捣的鬼啦,我们一层层源码追下去,发现在yii\rest\Controller类中,有一个 contentNegotiator行为,该行为指定了允许返回的数据格式formats是json和xml,返回的最终的数据格式根据请求头中Accept包含的首先出现在formats中的为准,你可以在yii\filters\ContentNegotiator的negotiateContentType方法中找到答案。

你可以在浏览器的请求头中看到

Accept:

text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,*/*;q=0.8

即application/xml首先出现在formats中,所以返回的数据格式是xml类型,如果客户端获取到的数据格式想按照json进行解析,只需要设置请求头的Accept的值等于application/json即可

有同学可能要说,这样太麻烦了,啥年代了,谁还用xml,我就想服务端输出json格式的数据,怎么做?

办法就是用来解决问题滴,来看看怎么做。api\config\main.php文件中增加对response的配置

  1. 'response' => [
  2. 'class' => 'yii\web\Response',
  3. 'on beforeSend' => function ($event) {
  4. $response = $event->sender;
  5. $response->format = yii\web\Response::FORMAT_JSON;
  6. },
  7. ],
复制代码

如此,不管你客户端传什么,服务端最终输出的都会是json格式的数据了。

自定义错误处理机制

再来看另外一个比较常见的问题:

你看我们上面几个方法哈,返回的结果是各式各样的,这样就给客户端解析增加了困扰,而且一旦有异常抛出,返回的代码还都是一堆一堆的,头疼,怎么办?

说到这个问题之前呢,我们先说一下yii中先关的异常处理类,当然,有很多哈。比如下面常见的一些,其他的自己去挖掘

  1. yii\web\BadRequestHttpException
  2. yii\web\ForbiddenHttpException
  3. yii\web\NotFoundHttpException
  4. yii\web\ServerErrorHttpException
  5. yii\web\UnauthorizedHttpException
  6. yii\web\TooManyRequestsHttpException
复制代码

实际开发中各位要善于去利用这些类去捕获异常,抛出异常。说远了哈,我们回到重点,来说如何自定义接口异常响应或者叫自定义统一的数据格式,比如向下面这种配置,统一响应客户端的格式标准。

  1. 'response' => [
  2. 'class' => 'yii\web\Response',
  3. 'on beforeSend' => function ($event) {
  4. $response = $event->sender;
  5. $response->data = [
  6. 'code' => $response->getStatusCode(),
  7. 'data' => $response->data,
  8. 'message' => $response->statusText
  9. ];
  10. $response->format = yii\web\Response::FORMAT_JSON;
  11. },
  12. ],
复制代码

说道了那么多,本文就要结束了,刚开始接触的同学可能有一些蒙,不要蒙,慢慢消化,先知道这么个意思,了解下restful api接口在整个过程中是怎么用token授权的就好。这样真正实际用到的时候,你也能举一反三!

总结

以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作能带来一定的帮助,如果有疑问大家可以留言交流,谢谢大家对程序员之家的支持。



回复

使用道具 举报