《PHP學習:yii2 resetful 授權驗證詳解》要點:
本文介紹了PHP學習:yii2 resetful 授權驗證詳解,希望對您有用。如果有疑問,可以聯系我們。
相關主題:YII框架
PHP應用什么是restful風格的api呢?我們之前有寫過大篇的文章來介紹其概念以及基本操作.
PHP應用既然寫過了,那今天是要說點什么嗎?
PHP應用這篇文章主要針對實際場景中api的部署來寫.
PHP應用我們今天就來大大的侃侃那些年api遇到的授權驗證問題!獨家干活,如果看完有所受益,記得不要忘記給我點贊哦.
PHP應用業務分析
PHP應用我們先來了解一下整個邏輯
PHP應用1.用戶在客戶端填寫登錄表單
2.用戶提交表單,客戶端請求登錄接口login
3.服務端校驗用戶的帳號密碼,并返回一個有效的token給客戶端
4.客戶端拿到用戶的token,將之存儲在客戶端比如cookie中
5.客戶端攜帶token訪問需要校驗的接口比如獲取用戶個人信息接口
6.服務端校驗token的有效性,校驗通過,反正返回客戶端需要的信息,校驗失敗,需要用戶重新登錄
PHP應用本文我們以用戶登錄,獲取用戶的個人信息為例進行詳細的完整版說明.
PHP應用以上,便是我們本篇文章要實現的重點.先別激動,也別緊張,分析好了之后,細節部分我們再一步一個腳印走下去.
PHP應用準備工作
PHP應用1.你應該有一個api應用.
2.對于客戶端,我們準備采用postman進行模擬,如果你的google瀏覽器還沒有安裝postman,請先自行下載
3.要測試的用戶表需要有一個api_token的字段,沒有的請先自行添加,并保證該字段足夠長度
4.api應用開啟了路由美化,并先配置post類型的login操作和get類型的signup-test操作
5.關閉了user組件的session會話
PHP應用關于上面準備工作的第4點和第5點,我們貼一下代碼方便理解
PHP應用
'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',
]
],
]
],
// ......
],
PHP應用signup-test操作我們后面添加測試用戶,為登錄操作提供便利.其他類型的操作后面看需要再做添加.
PHP應用認證類的選擇
PHP應用我們在api\modules\v1\controllers\UserController中設定的model類指向 common\models\User類,為了說明重點這里我們就不單獨拿出來重寫了,看各位需要,有必要的話再單獨copy一個User類到api\models下.
PHP應用校驗用戶權限我們以 yii\filters\auth\QueryParamAuth 為例
PHP應用
use yii\filters\auth\QueryParamAuth;
public function behaviors()
{
return ArrayHelper::merge (parent::behaviors(), [
'authenticator' => [
'class' => QueryParamAuth::className()
]
] );
}
PHP應用如此一來,那豈不是所有訪問user的操作都需要認證了?那不行,客戶端第一個訪問login操作的時候哪來的token,yii\filters\auth\QueryParamAuth對外提供一個屬性,用于過濾不需要驗證的action.我們將UserController的behaviors方法稍作修改
PHP應用
public function behaviors()
{
return ArrayHelper::merge (parent::behaviors(), [
'authenticator' => [
'class' => QueryParamAuth::className(),
'optional' => [
'login',
'signup-test'
],
]
] );
}
PHP應用這樣login操作就無需權限驗證即可訪問了.
PHP應用添加測試用戶
PHP應用為了避免讓客戶端登錄失敗,我們先寫一個簡單的方法,往user表里面插入兩條數據,便于接下來的校驗.?
PHP應用UserController增加signupTest操作,注意此方法不屬于講解范圍之內,我們僅用于方便測試.
PHP應用
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
];
}
PHP應用如上,我們添加了一個username是111,密碼是123456的用戶
PHP應用登錄操作
PHP應用假設用戶在客戶端輸入用戶名和密碼進行登錄,服務端login操作其實很簡單,大部分的業務邏輯處理都在api\models\loginForm上,來先看看login的實現
PHP應用
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;
}
}
PHP應用登錄成功后這里給客戶端返回了用戶的token,再來看看登錄的具體邏輯的實現
PHP應用新建api\models\LoginForm.PHP
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);
}
}
}
PHP應用我們回過頭來看一下,當我們在UserController的login操作中調用LoginForm的login操作后都發生了什么
PHP應用1、調用LoginForm的login方法
PHP應用2、調用validate方法,隨后對rules進行校驗
PHP應用3、rules校驗中調用validatePassword方法,對用戶名和密碼進行校驗
PHP應用4、validatePassword方法校驗的過程中調用LoginForm的getUser方法,通過common\models\User類的findByUsername獲取用戶,找不到或者common\models\User的validatePassword對密碼校驗失敗則返回error
PHP應用5、觸發LoginForm::GENERATE_API_TOKEN事件,調用LoginForm的onGenerateApiToken方法,通過common\models\User的apiTokenIsValid校驗token的有效性,如果無效,則調用User的generateApiToken方法重新生成
PHP應用注意common\models\User類必須是用戶的認證類.
PHP應用下面補充本節增加的common\models\User的相關方法
PHP應用
/**
* 生成 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();
}
PHP應用繼續補充apiTokenIsValid方法中涉及到的token有效期,在api\config\params.php文件內增加即可
PHP應用
<?php
return [
// ...
// token 有效期默認1天
'user.apiTokenExpire' => 1*24*3600,
];
PHP應用到這里呢,客戶端登錄 服務端返回token給客戶端就完成了.
PHP應用按照文中一開始的分析,客戶端應該把獲取到的token存到本地,比如cookie中.以后再需要token校驗的接口訪問中,從本地讀取比如從cookie中讀取并訪問接口即可.
PHP應用根據token請求用戶的認證操作
PHP應用假設我們已經把獲取到的token保存起來了,我們再以訪問用戶信息的接口為例.
PHP應用yii\filters\auth\QueryParamAuth類認定的token參數是 access-token,我們可以在行為中修改下
PHP應用
public function behaviors()
{
return ArrayHelper::merge (parent::behaviors(), [
'authenticator' => [
'class' => QueryParamAuth::className(),
'tokenParam' => 'token',
'optional' => [
'login',
'signup-test'
],
]
] );
}
PHP應用這里將默認的access-token修改為token.
PHP應用我們在配置文件的urlManager組件中增加對userProfile操作
PHP應用
'extraPatterns' => [
'POST login' => 'login',
'GET signup-test' => 'signup-test',
'GET user-profile' => 'user-profile',
]
PHP應用我們用postman模擬請求訪問下 /v1/users/user-profile?token=apeuT9dAgH072qbfrtihfzL6qDe_l4qz_1479626145發現,拋出了一個異常
PHP應用\"findIdentityByAccessToken\" is not implemented.
PHP應用這是怎么回事呢?
PHP應用我們找到 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拋出了異常,也就是說這個方法要我們自己手動實現!
PHP應用這好辦了,我們就來實現下common\models\User類的findIdentityByAccessToken方法吧
PHP應用
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.');
}
PHP應用驗證完token的有效性,下面就要開始實現主要的業務邏輯部分了.
PHP應用
/**
* 獲取用戶信息
*/
public function actionUserProfile ($token)
{
// 到這一步,token都認為是有效的了
// 下面只需要實現業務邏輯即可,下面僅僅作為案例,比如你可能需要關聯其他表獲取用戶信息等等
$user = User::findIdentityByAccessToken($token);
return [
'id' => $user->id,
'username' => $user->username,
'email' => $user->email,
];
}
PHP應用服務端返回的數據類型定義
PHP應用在postman中我們可以以何種數據類型輸出的接口的數據,但是,有些人發現,當我們把postman模擬請求的地址copy到瀏覽器地址欄,返回的又卻是xml格式了,而且我們明明在UserProfile操作中返回的是屬組,怎么回事呢?
PHP應用這其實是官方搗的鬼啦,我們一層層源碼追下去,發現在yii\rest\Controller類中,有一個 contentNegotiator行為,該行為指定了允許返回的數據格式formats是json和xml,返回的最終的數據格式根據請求頭中Accept包含的首先出現在formats中的為準,你可以在yii\filters\ContentNegotiator的negotiateContentType方法中找到答案.
PHP應用你可以在瀏覽器的請求頭中看到
PHP應用Accept:
PHP應用text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,*/*;q=0.8
PHP應用即application/xml首先出現在formats中,所以返回的數據格式是xml類型,如果客戶端獲取到的數據格式想按照json進行解析,只需要設置請求頭的Accept的值等于application/json即可
PHP應用有同學可能要說,這樣太麻煩了,啥年代了,誰還用xml,我就想服務端輸出json格式的數據,怎么做?
PHP應用辦法就是用來解決問題滴,來看看怎么做.api\config\main.php文件中增加對response的配置
PHP應用
'response' => [
'class' => 'yii\web\Response',
'on beforeSend' => function ($event) {
$response = $event->sender;
$response->format = yii\web\Response::FORMAT_JSON;
},
],
PHP應用如此,不管你客戶端傳什么,服務端最終輸出的都會是json格式的數據了.
PHP應用自定義錯誤處理機制
PHP應用再來看另外一個比較常見的問題:
PHP應用你看我們上面幾個方法哈,返回的結果是各式各樣的,這樣就給客戶端解析增加了困擾,而且一旦有異常拋出,返回的代碼還都是一堆一堆的,頭疼,怎么辦?
PHP應用說到這個問題之前呢,我們先說一下yii中先關的異常處理類,當然,有很多哈.比如下面常見的一些,其他的自己去挖掘
PHP應用
yii\web\BadRequestHttpException
yii\web\ForbiddenHttpException
yii\web\NotFoundHttpException
yii\web\ServerErrorHttpException
yii\web\UnauthorizedHttpException
yii\web\TooManyRequestsHttpException
PHP應用實際開發中各位要善于去利用這些類去捕獲異常,拋出異常.說遠了哈,我們回到重點,來說如何自定義接口異常響應或者叫自定義統一的數據格式,比如向下面這種配置,統一響應客戶端的格式標準.
PHP應用
'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;
},
],
PHP應用說道了那么多,本文就要結束了,剛開始接觸的同學可能有一些蒙,不要蒙,慢慢消化,先知道這么個意思,了解下restful api接口在整個過程中是怎么用token授權的就好.這樣真正實際用到的時候,你也能舉一反三!
PHP應用以上就是本文的全部內容,希望對大家的學習有所幫助,也希望大家多多支持維易PHP.