怎么在yii2項目中使用restful api進行授權驗證

這篇文章將為大家詳細講解有關怎么在yii2項目中使用restful api進行授權驗證，文章內容質量較高，因此小編分享給大家做個參考，希望大家閱讀完這篇文章后對相關知識有一定的了解。

'components' => [
 'user' => [ 
 'identityClass' => 'common\models\User',
 'enableAutoLogin' => true,
 'enableSession' => false,
 ],
 'urlManager' => [
 'enablePrettyUrl' => true,
 'showScriptName' => false,
 'enableStrictParsing' => true,
 'rules' => [
  [
  'class' => 'yii\rest\UrlRule',
  'controller' => ['v1/user'],
  'extraPatterns' => [
   'POST login' => 'login',
   'GET signup-test' => 'signup-test',
  ]
  ],
 ]
 ],
 // ......
],

signup-test操作我們后面添加測試用戶，為登錄操作提供便利。其他類型的操作后面看需要再做添加。

認證類的選擇

我們在api\modules\v1\controllers\UserController中設定的model類指向 common\models\User類，為了說明重點這里我們就不單獨拿出來重寫了，看各位需要，有必要的話再單獨copy一個User類到api\models下。

校驗用戶權限我們以 yii\filters\auth\QueryParamAuth 為例

use yii\filters\auth\QueryParamAuth;

public function behaviors() 
{
 return ArrayHelper::merge (parent::behaviors(), [ 
  'authenticator' => [ 
  'class' => QueryParamAuth::className() 
  ] 
 ] );
}

如此一來，那豈不是所有訪問user的操作都需要認證了？那不行，客戶端第一個訪問login操作的時候哪來的token，yii\filters\auth\QueryParamAuth對外提供一個屬性，用于過濾不需要驗證的action。我們將UserController的behaviors方法稍作修改

public function behaviors() 
{
 return ArrayHelper::merge (parent::behaviors(), [ 
  'authenticator' => [ 
  'class' => QueryParamAuth::className(),
  'optional' => [
   'login',
   'signup-test'
  ],
  ] 
 ] );
}

這樣login操作就無需權限驗證即可訪問了。

添加測試用戶

為了避免讓客戶端登錄失敗，我們先寫一個簡單的方法，往user表里面插入兩條數據，便于接下來的校驗。

UserController增加signupTest操作，注意此方法不屬于講解范圍之內，我們僅用于方便測試。

use common\models\User;
/**
 * 添加測試用戶
 */
public function actionSignupTest ()
{
 $user = new User();
 $user->generateAuthKey();
 $user->setPassword('123456');
 $user->username = '111';
 $user->email = '111@111.com';
 $user->save(false);

 return [
 'code' => 0
 ];
}

如上，我們添加了一個username是111，密碼是123456的用戶

登錄操作

假設用戶在客戶端輸入用戶名和密碼進行登錄，服務端login操作其實很簡單，大部分的業務邏輯處理都在api\models\loginForm上，來先看看login的實現

use api\models\LoginForm;

/**
 * 登錄
 */
public function actionLogin ()
{
 $model = new LoginForm;
 $model->setAttributes(Yii::$app->request->post());
 if ($user = $model->login()) {
 if ($user instanceof IdentityInterface) {
  return $user->api_token;
 } else {
  return $user->errors;
 }
 } else {
 return $model->errors;
 }
}

登錄成功后這里給客戶端返回了用戶的token，再來看看登錄的具體邏輯的實現

新建api\models\LoginForm.PHP

<?php
namespace api\models;

use Yii;
use yii\base\Model;
use common\models\User;

/**
 * Login form
 */
class LoginForm extends Model
{
 public $username;
 public $password;

 private $_user;

 const GET_API_TOKEN = 'generate_api_token';

 public function init ()
 {
 parent::init();
 $this->on(self::GET_API_TOKEN, [$this, 'onGenerateApiToken']);
 }


 /**
 * @inheritdoc
 * 對客戶端表單數據進行驗證的rule
 */
 public function rules()
 {
 return [
  [['username', 'password'], 'required'],
  ['password', 'validatePassword'],
 ];
 }

 /**
 * 自定義的密碼認證方法
 */
 public function validatePassword($attribute, $params)
 {
 if (!$this->hasErrors()) {
  $this->_user = $this->getUser();
  if (!$this->_user || !$this->_user->validatePassword($this->password)) {
  $this->addError($attribute, '用戶名或密碼錯誤.');
  }
 }
 }
 /**
 * @inheritdoc
 */
 public function attributeLabels()
 {
 return [
  'username' => '用戶名',
  'password' => '密碼',
 ];
 }
 /**
 * Logs in a user using the provided username and password.
 *
 * @return boolean whether the user is logged in successfully
 */
 public function login()
 {
 if ($this->validate()) {
  $this->trigger(self::GET_API_TOKEN);
  return $this->_user;
 } else {
  return null;
 }
 }

 /**
 * 根據用戶名獲取用戶的認證信息
 *
 * @return User|null
 */
 protected function getUser()
 {
 if ($this->_user === null) {
  $this->_user = User::findByUsername($this->username);
 }

 return $this->_user;
 }

 /**
 * 登錄校驗成功后，為用戶生成新的token
 * 如果token失效，則重新生成token
 */
 public function onGenerateApiToken ()
 {
 if (!User::apiTokenIsValid($this->_user->api_token)) {
  $this->_user->generateApiToken();
  $this->_user->save(false);
 }
 }
}

我們回過頭來看一下，當我們在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的相關方法

/**
 * 生成 api_token
 */
public function generateApiToken()
{
 $this->api_token = Yii::$app->security->generateRandomString() . '_' . time();
}

/**
 * 校驗api_token是否有效
 */
public static function apiTokenIsValid($token)
{
 if (empty($token)) {
 return false;
 }

 $timestamp = (int) substr($token, strrpos($token, '_') + 1);
 $expire = Yii::$app->params['user.apiTokenExpire'];
 return $timestamp + $expire >= time();
}

繼續補充apiTokenIsValid方法中涉及到的token有效期，在api\config\params.php文件內增加即可

<?php
return [
 // ...
 // token 有效期默認1天
 'user.apiTokenExpire' => 1*24*3600,
];

到這里呢，客戶端登錄 服務端返回token給客戶端就完成了。

按照文中一開始的分析，客戶端應該把獲取到的token存到本地，比如cookie中。以后再需要token校驗的接口訪問中，從本地讀取比如從cookie中讀取并訪問接口即可。

根據token請求用戶的認證操作

假設我們已經把獲取到的token保存起來了，我們再以訪問用戶信息的接口為例。

yii\filters\auth\QueryParamAuth類認定的token參數是 access-token，我們可以在行為中修改下

public function behaviors() 
{
 return ArrayHelper::merge (parent::behaviors(), [ 
   'authenticator' => [ 
    'class' => QueryParamAuth::className(),
    'tokenParam' => 'token',
    'optional' => [
     'login',
     'signup-test'
    ],
   ] 
 ] );
}

這里將默認的access-token修改為token。

我們在配置文件的urlManager組件中增加對userProfile操作

'extraPatterns' => [
 'POST login' => 'login',
 'GET signup-test' => 'signup-test',
 'GET user-profile' => 'user-profile',
]

我們用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方法吧

public static function findIdentityByAccessToken($token, $type = null)
{
 // 如果token無效的話，
 if(!static::apiTokenIsValid($token)) {
  throw new \yii\web\UnauthorizedHttpException("token is invalid.");
 }

 return static::findOne(['api_token' => $token, 'status' => self::STATUS_ACTIVE]);
 // throw new NotSupportedException('"findIdentityByAccessToken" is not implemented.');
}

驗證完token的有效性，下面就要開始實現主要的業務邏輯部分了。

/**
 * 獲取用戶信息
 */
public function actionUserProfile ($token)
{
 // 到這一步，token都認為是有效的了
 // 下面只需要實現業務邏輯即可，下面僅僅作為案例，比如你可能需要關聯其他表獲取用戶信息等等
 $user = User::findIdentityByAccessToken($token);
 return [
  'id' => $user->id,
  'username' => $user->username,
  'email' => $user->email,
 ];
}

服務端返回的數據類型定義

在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的配置

'response' => [
 'class' => 'yii\web\Response',
 'on beforeSend' => function ($event) {
  $response = $event->sender;
  $response->format = yii\web\Response::FORMAT_JSON;
 },
],

如此，不管你客戶端傳什么，服務端最終輸出的都會是json格式的數據了。

自定義錯誤處理機制

再來看另外一個比較常見的問題：

你看我們上面幾個方法哈，返回的結果是各式各樣的，這樣就給客戶端解析增加了困擾，而且一旦有異常拋出，返回的代碼還都是一堆一堆的，頭疼，怎么辦？

說到這個問題之前呢，我們先說一下yii中先關的異常處理類，當然，有很多哈。比如下面常見的一些，其他的自己去挖掘

yii\web\BadRequestHttpException
yii\web\ForbiddenHttpException
yii\web\NotFoundHttpException
yii\web\ServerErrorHttpException
yii\web\UnauthorizedHttpException
yii\web\TooManyRequestsHttpException

實際開發中各位要善于去利用這些類去捕獲異常，拋出異常。說遠了哈，我們回到重點，來說如何自定義接口異常響應或者叫自定義統一的數據格式，比如向下面這種配置，統一響應客戶端的格式標準。

'response' => [
 'class' => 'yii\web\Response',
 'on beforeSend' => function ($event) {
  $response = $event->sender;
  $response->data = [
   'code' => $response->getStatusCode(),
   'data' => $response->data,
   'message' => $response->statusText
  ];
  $response->format = yii\web\Response::FORMAT_JSON;
 },
],

關于怎么在yii2項目中使用restful api進行授權驗證就分享到這里了，希望以上內容可以對大家有一定的幫助，可以學到更多知識。如果覺得文章不錯，可以把它分享出去讓更多的人看到。