您好,登錄后才能下訂單哦!
這篇文章將為大家詳細講解有關(guān)Yii2框架RESTfulAPI中格式化響應(yīng)和授權(quán)認證以及速率限制的示例分析,文章內(nèi)容質(zhì)量較高,因此小編分享給大家做個參考,希望大家閱讀完這篇文章后對相關(guān)知識有一定的了解。
一、目錄結(jié)構(gòu)
先列出需要改動的文件。目錄如下:
web ├─ common │ └─ models │ └ User.php └─ frontend ├─ config │ └ main.php └─ controllers └ BookController.php
二、格式化響應(yīng)
Yii2 RESTful支持JSON和XML格式,如果想指定返回數(shù)據(jù)的格式,需要配置yii\filters\ContentNegotiator::formats屬性。例如,要返回JSON格式,修改frontend/controllers/BookController.php,加入紅色標記代碼:
namespace frontend\controllers; use yii\rest\ActiveController; use yii\web\Response; class BookController extends ActiveController { public $modelClass = 'frontend\models\Book'; public function behaviors() { $behaviors = parent::behaviors(); $behaviors['contentNegotiator']['formats']['text/html'] = Response::FORMAT_JSON; return $behaviors; } }
返回XML格式:FORMAT_XML。formats屬性的keys支持MIME類型,而values必須在yii\web\Response::formatters中支持被響應(yīng)格式名稱。
三、授權(quán)認證
RESTful APIs通常是無狀態(tài)的,因此每個請求應(yīng)附帶某種授權(quán)憑證,即每個請求都發(fā)送一個access token來認證用戶。
1.配置user應(yīng)用組件(不是必要的,但是推薦配置):
設(shè)置yii\web\User::enableSession屬性為false(因為RESTful APIs為無狀態(tài)的,當yii\web\User::enableSession為false,請求中的用戶認證狀態(tài)就不能通過session來保持)
設(shè)置yii\web\User::loginUrl屬性為null(顯示一個HTTP 403 錯誤而不是跳轉(zhuǎn)到登錄界面)
具體方法,修改frontend/config/main.php,加入紅色標記代碼:
'components' => [ ... 'user' => [ 'identityClass' => 'common\models\User', 'enableAutoLogin' => true, 'enableSession' => false, 'loginUrl' => null, ], ... ]
2.在控制器類中配置authenticator行為來指定使用哪種認證方式,修改frontend/controllers/BookController.php,加入紅色標記代碼:
namespace frontend\controllers; use yii\rest\ActiveController; use yii\web\Response; use yii\filters\auth\CompositeAuth; use yii\filters\auth\QueryParamAuth; class BookController extends ActiveController { public $modelClass = 'frontend\models\Book'; public function behaviors() { $behaviors = parent::behaviors(); $behaviors['authenticator'] = [ 'class' => CompositeAuth::className(), 'authMethods' => [ /*下面是三種驗證access_token方式*/ //1.HTTP 基本認證: access token 當作用戶名發(fā)送,應(yīng)用在access token可安全存在API使用端的場景,例如,API使用端是運行在一臺服務(wù)器上的程序。 //HttpBasicAuth::className(), //2.OAuth 2: 使用者從認證服務(wù)器上獲取基于OAuth3協(xié)議的access token,然后通過 HTTP Bearer Tokens 發(fā)送到API 服務(wù)器。 //HttpBearerAuth::className(), //3.請求參數(shù): access token 當作API URL請求參數(shù)發(fā)送,這種方式應(yīng)主要用于JSONP請求,因為它不能使用HTTP頭來發(fā)送access token //http://localhost/user/index/index?access-token=123 QueryParamAuth::className(), ], ]; $behaviors['contentNegotiator']['formats']['text/html'] = Response::FORMAT_JSON; return $behaviors; } }
3.創(chuàng)建一張user表
-- ---------------------------- -- Table structure for user -- ---------------------------- DROP TABLE IF EXISTS `user`; CREATE TABLE `user` ( `id` int(10) unsigned NOT NULL AUTO_INCREMENT, `username` varchar(20) NOT NULL DEFAULT '' COMMENT '用戶名', `password_hash` varchar(100) NOT NULL DEFAULT '' COMMENT '密碼', `password_reset_token` varchar(50) NOT NULL DEFAULT '' COMMENT '密碼token', `email` varchar(20) NOT NULL DEFAULT '' COMMENT '郵箱', `auth_key` varchar(50) NOT NULL DEFAULT '', `status` tinyint(3) unsigned NOT NULL DEFAULT '0' COMMENT '狀態(tài)', `created_at` int(10) unsigned NOT NULL DEFAULT '0' COMMENT '創(chuàng)建時間', `updated_at` int(10) unsigned NOT NULL DEFAULT '0' COMMENT '更新時間', `access_token` varchar(50) NOT NULL DEFAULT '' COMMENT 'restful請求token', `allowance` int(10) unsigned NOT NULL DEFAULT '0' COMMENT 'restful剩余的允許的請求數(shù)', `allowance_updated_at` int(10) unsigned NOT NULL DEFAULT '0' COMMENT 'restful請求的UNIX時間戳數(shù)', PRIMARY KEY (`id`), UNIQUE KEY `username` (`username`), UNIQUE KEY `access_token` (`access_token`) ) ENGINE=InnoDB DEFAULT CHARSET=utf8; -- ---------------------------- -- Records of user -- ---------------------------- INSERT INTO `user` VALUES ('1', 'admin', '$2y$13$1KWwchqGvxDeORDt5pRW.OJarf06PjNYxe2vEGVs7e5amD3wnEX.i', '', '', 'z3sM2KZvXdk6mNXXrz25D3JoZlGXoJMC', '10', '1478686493', '1478686493', '123', '4', '1478686493');
在common/models/User.php類中實現(xiàn) yii\web\IdentityInterface::findIdentityByAccessToken()方法。修改common/models/User.php,加入紅色標記代碼::
public static function findIdentityByAccessToken($token, $type = null) { //findIdentityByAccessToken()方法的實現(xiàn)是系統(tǒng)定義的 //例如,一個簡單的場景,當每個用戶只有一個access token, 可存儲access token 到user表的access_token列中, 方法可在User類中簡單實現(xiàn),如下所示: return static::findOne(['access_token' => $token]); //throw new NotSupportedException('"findIdentityByAccessToken" is not implemented.'); }
四、速率限制
為防止濫用,可以增加速率限制。例如,限制每個用戶的API的使用是在60秒內(nèi)最多10次的API調(diào)用,如果一個用戶同一個時間段內(nèi)太多的請求被接收,將返回響應(yīng)狀態(tài)代碼 429 (這意味著過多的請求)。
1.Yii會自動使用yii\filters\RateLimiter為yii\rest\Controller配置一個行為過濾器來執(zhí)行速率限制檢查。如果速度超出限制,該速率限制器將拋出一個yii\web\TooManyRequestsHttpException。
修改frontend/controllers/BookController.php,加入紅色標記代碼:
namespace frontend\controllers; use yii\rest\ActiveController; use yii\web\Response; use yii\filters\auth\CompositeAuth; use yii\filters\auth\QueryParamAuth; use yii\filters\RateLimiter; class BookController extends ActiveController { public $modelClass = 'frontend\models\Book'; public function behaviors() { $behaviors = parent::behaviors(); $behaviors['rateLimiter'] = [ 'class' => RateLimiter::className(), 'enableRateLimitHeaders' => true, ]; $behaviors['authenticator'] = [ 'class' => CompositeAuth::className(), 'authMethods' => [ /*下面是三種驗證access_token方式*/ //1.HTTP 基本認證: access token 當作用戶名發(fā)送,應(yīng)用在access token可安全存在API使用端的場景,例如,API使用端是運行在一臺服務(wù)器上的程序。 //HttpBasicAuth::className(), //2.OAuth 2: 使用者從認證服務(wù)器上獲取基于OAuth3協(xié)議的access token,然后通過 HTTP Bearer Tokens 發(fā)送到API 服務(wù)器。 //HttpBearerAuth::className(), //3.請求參數(shù): access token 當作API URL請求參數(shù)發(fā)送,這種方式應(yīng)主要用于JSONP請求,因為它不能使用HTTP頭來發(fā)送access token //http://localhost/user/index/index?access-token=123 QueryParamAuth::className(), ], ]; $behaviors['contentNegotiator']['formats']['text/html'] = Response::FORMAT_JSON; return $behaviors; } }
2.在user表中使用兩列來記錄容差和時間戳信息。為了提高性能,可以考慮使用緩存或NoSQL存儲這些信息。
修改common/models/User.php,加入紅色標記代碼:
namespace common\models; use Yii; use yii\base\NotSupportedException; use yii\behaviors\TimestampBehavior; use yii\db\ActiveRecord; use yii\web\IdentityInterface; use yii\filters\RateLimitInterface; class User extends ActiveRecord implements IdentityInterface, RateLimitInterface { .... // 返回在單位時間內(nèi)允許的請求的最大數(shù)目,例如,[10, 60] 表示在60秒內(nèi)最多請求10次。 public function getRateLimit($request, $action) { return [5, 10]; } // 返回剩余的允許的請求數(shù)。 public function loadAllowance($request, $action) { return [$this->allowance, $this->allowance_updated_at]; } // 保存請求時的UNIX時間戳。 public function saveAllowance($request, $action, $allowance, $timestamp) { $this->allowance = $allowance; $this->allowance_updated_at = $timestamp; $this->save(); } .... public static function findIdentityByAccessToken($token, $type = null) { //throw new NotSupportedException('"findIdentityByAccessToken" is not implemented.'); //findIdentityByAccessToken()方法的實現(xiàn)是系統(tǒng)定義的 //例如,一個簡單的場景,當每個用戶只有一個access token, 可存儲access token 到user表的access_token列中, 方法可在User類中簡單實現(xiàn),如下所示: return static::findOne(['access_token' => $token]); } .... }
關(guān)于Yii2框架RESTfulAPI中格式化響應(yīng)和授權(quán)認證以及速率限制的示例分析就分享到這里了,希望以上內(nèi)容可以對大家有一定的幫助,可以學到更多知識。如果覺得文章不錯,可以把它分享出去讓更多的人看到。
免責聲明:本站發(fā)布的內(nèi)容(圖片、視頻和文字)以原創(chuàng)、轉(zhuǎn)載和分享為主,文章觀點不代表本網(wǎng)站立場,如果涉及侵權(quán)請聯(lián)系站長郵箱:is@yisu.com進行舉報,并提供相關(guān)證據(jù),一經(jīng)查實,將立刻刪除涉嫌侵權(quán)內(nèi)容。