Yii2中Restful API原理實例分析

更新時間：2016年07月25日 10:47:42 作者：wjtlht928

這篇文章主要介紹了Yii2中Restful API原理,基于rest部分源碼分析了Restful的原理、使用方法與相關注意事項,需要的朋友可以參考下

本文實例分析了Yii2中Restful API原理。分享給大家供大家參考，具體如下：

Yii2 有個很重要的特性是對 Restful API的默認支持，通過短短的幾個配置就可以實現簡單的對現有Model的RESTful API

這里通過分析rest部分源碼，簡單剖析下yii2 實現 restful 的原理，并通過一些定制實現對關聯模型的RESTful api 操作。

~ 代表 extends from 的關系

1. rest/Controller ~ \yii\web\Controller

Controller是 RESTful API 控制器類的基類

它在一個API請求的控制周期中一次實現了下面的步驟 1~5：

① 解析響應的內容格式
② 校驗請求方法
③ 檢驗用戶權限
④ 限制速度
⑤ 格式化響應數據

use yii\filters\auth\CompositeAuth;
use yii\filters\ContentNegotiator;
use yii\filters\RateLimiter;
use yii\web\Response;
use yii\filters\VerbFilter;
/**
 * Controller is the base class for RESTful API controller classes.
 *
 * Controller implements the following steps in a RESTful API request handling cycle
 * 1. Resolving response format (see [[ContentNegotiator]]);
 * 2. Validating request method (see [[verbs()]]).
 * 3. Authenticating user (see [[\yii\filters\auth\AuthInterface]]);
 * 4. Rate limiting (see [[RateLimiter]]);
 * 5. Formatting response data (see [[serializeData()]])
behaviors
  contentNegotiator
  verbFilter
  authenticator
  rateLimiter
afterAction
  serializeData Yii::createObject($this->serializer)->serialize($data)
verbs []
*/
class Controller extends \yii\web\Controller
{
  public $serializer = 'yii\rest\Serializer';
  public $enableCsrfValidation = false;
  public function behaviors()
  {
    return [
      'contentNegotiator' => [
        'class' => ContentNegotiator::className(),
        'formats' => [
          'application/json' => Response::FORMAT_JSON,
          'application/xml' => Response::FORMAT_XML,
        ],
      ],
      'verbFilter' => [
        'class' => VerbFilter::className(),
        'actions' => $this->verbs(),
      ],
      'authenticator' => [
        'class' => CompositeAuth::className(),
      ],
      'rateLimiter' => [
        'class' => RateLimiter::className(),
      ],
    ]
  }
  public function verbs()
  {
    return [];
  }
  public function serializeData($data)
  {
    return Yii::createObject($this->serializer)->serialize($data);
  }
  public function afterAction($action, $result)
  {
    $result = parent::afterAction($action, $result);
    return $this->serializeData($result);
  }
}

2. rest/ActiveController ~ rest/Controller

ActiveController 實現了一系列的和 ActiveRecord 互通數據的RESTful方法

ActiveRecord 的類名由 modelClass 變量指明， yii\db\ActiveRecordInterface ???

默認的，支持下面的方法：

* - `index`: list of models
* - `view`: return the details of a model
* - `create`: create a new model
* - `update`: update an existing model
* - `delete`: delete an existing model
* - `options`: return the allowed HTTP methods

可以通過覆蓋 actions() 并且 unsetting 響應的 action 來禁用這些默認的動作。

要增加一個新的動作，覆蓋 actions() 向其末尾增加一個新的 action class 或者是一個新的 action method

注意一點，確保你同時也覆蓋了 verbs() 方法來聲明這個新的動作支持那些HTTP Method

也需要覆蓋checkAccess() 來檢查當前用戶是否有權限來執(zhí)行響應的某個動作。

根據上面的說明再寫一遍 Controller

class ActiveController extends Controller
{
  public #modelClass;
  public $updateScenario = Model::SCENARIO_DEFAULT;
  public $createScenario = Model::SCENARIO_DEFAULT;
  public function init()
  {
    parent::init();
    if($this->modelClass == null){
      throw new InvalidConfigException('The "modelClass" property must be set.');
    }
  }
  public function actions()
  {
    return [
      'index' => [
        'class' => 'app\controllers\rest\IndexAction',
        'modelClass' => $this->modelClass,
        'checkAccess' => [$this, 'checkAccess'],
      ],
      'view'...
      'create'...
      'update'...
      'delete'...
      'options'...
    ];
  }
  protected function verbs()
  {
    return [
      'index' => ['GET', 'HEAD'],
      'view' =>['GET', 'HEAD'],
      'create' =>['POST'],
      'update' =>['PUT', 'PATCH'],
      'delete' =>['DELETE'],
    ];
  }
  public function checkAccess($action, $model=null, $params = [])
  {
  }
}

下面來實現一個繼承自這個rest\ActiveController的 News 控制器：

namespace app\controllers;
use app\controllers\rest\ActiveController; #剛才這個AC，我從yii/rest下面拷貝了一份出來
class NewsController extends ActiveController
{
  public $modelClass ='app\models\News';
}

定義到這里就足夠實現 rest\ActiveController 里面的默認方法了
下面來覆蓋下，實現一些定制的方法

class NewsController extends ActiveController
{
  public $modelClass = 'app\models\News';
  #定制serializer
  #public $serializer = 'yii\rest\Serializer';
  public $serializer = [
    'class' => 'app\controllers\rest\Serializer',
    'collectionEnvelope' => 'items',
  ];
  public function behaviors()
  {
    $be = ArrayHelper::merge(
      parent::behaviors(),
      [
        'verbFilter' => [
          'class' => VerbFilter::className(),
          'actions' => [
            'index' => ['get'],
            ...
          ]
        ],
        'authenticator' => [
          'class' => CompositeAuth::className(),
          'authMethods' => [
            HttpBasicAuth::className(),
            HttpBearerAuth::className(),
            QueryParamAuth::className(),
          ]
        ],
        'contentNegotiator' => [
          'class' => ContentNegotiator::className(),
          'formats' => [
            'text/html' => Response::FORMAT_HTML,
          ]
        ],
        'access' => [
          'class' => AccessControl::className(),
          'only' => ['view'],
          'rules' => [
            [
             'actions' => ['view'],
             'allow' => false,
             'roles' => ['@'],
            ],
         ],
        ]
      ],
    );
    return $be;
  }
  public function checkAccess()
  {
  }
}

3. 定制Actions

如果要對 Actions 進行大的改動，建議拷貝一份出來，不要使用原始的 yii\rest\XXXAction命名空間

我這里以要實現對related models進行 CURD 操作為目標進行大的改動

Action

在定制各個action之前，先看看它們的基類 rest\Action, 主要是一個 findModel的方法

class Action extend \yii\base\Action
{
  public $modelClass;
  public $findModel;
  public $checkAccess;
  public function init()
  {
    if($this->modelClass == null) {
      throw new InvalidConfigException(get_class($this). '::$modelClass must be set');
    }
  }
  public function findModel($id)
  {
    if($this->findModel !== null) {
      return call_user_func($this->findModel, $id, $this);
    }
    $modelClass = $this->modelClass;
    $keys = $modelClass::primaryKey();
    if(count($keys) > 1) {
      $values = explode(',', $id);
      if..
    } elseif($id !== null) {
      $model = $modelClass::findOne($id);
    }
    if(isset($model)){
      return $model;
    }else {
      throw new NotFoundHttpException("Object not found: $id");
    }
  }
}

view

view 動作不需要改動，因為 model 有 getRelated 的自有機制

class ViewAction extend Action
{
  public function run($id)
  {
    $model = $this->findModel($id);
    if($this->checkAccess) {
      call_user_func($this->checkAccess, $this->id, $model);
    }
  }
}

update

public function run($id)
{
  /* @var $model ActiveRecord */
  $model = $this->findModel($id);
  if ($this->checkAccess) {
   call_user_func($this->checkAccess, $this->id, $model);
  }
  $model->scenario = $this->scenario;
  $model->load(Yii::$app->getRequest()->getBodyParams(), '');
  $model->save();
  return $model;
}

經過改造后，需要滿足對關聯模型的update動作

public function run($id)
{
  /* @var $model ActiveRecord */
  $model = $this->findModel($id);
  if ($this->checkAccess) {
   call_user_func($this->checkAccess, $this->id, $model);
  }
  $model->scenario = $this->scenario;
    /*
     *
     * x-www-form-urlencoded key=>value
     * image mmmmmmmm
     * link nnnnnnnnnn
     * newsItem[title]=>ttttttttttt , don't use newsItem["title"]
     * newsItem[body]=>bbbbbbbbbbb
     * don't use newsItem=>array("title":"tttttt","body":"bbbbbbb")
     * don't use newsItem=>{"title":"ttttttt","body":"bbbbbbbb"}
     *
     */
    $newsItem = Yii::$app->getRequest()->getBodyParams()['newsItem'];
    /*
      Array
      (
        [title] => ttttttttttt
        [body] => bbbbbbbbbbb
      )
     */
    $model->newsItem->load($newsItem, '');
    #$model->newsItem->load(Yii::$app->getRequest()->getBodyParams(), '');
    #print_R($model->newsItem);exit;
    #print_R($model->newsItem);exit;
    if($model->save())
    {
      $model->load(Yii::$app->getRequest()->getBodyParams(), '');
      $model->newsItem->save();
    }
  return $model;
}

這里還應該對 newsItem save 失敗的情況進行處理，暫且不處理。

更多關于Yii相關內容感興趣的讀者可查看本站專題：《Yii框架入門及常用技巧總結》、《php優(yōu)秀開發(fā)框架總結》、《smarty模板入門基礎教程》、《php面向對象程序設計入門教程》、《php字符串(string)用法總結》、《php+mysql數據庫操作入門教程》及《php常見數據庫操作技巧匯總》

希望本文所述對大家基于Yii框架的PHP程序設計有所幫助。

您可能感興趣的文章:

YII2框架中自定義用戶認證模型，完成登陸和注冊操作示例
這篇文章主要介紹了YII2框架中自定義用戶認證模型，完成登陸和注冊操作,結合實例形式分析了YII2通過自定義用戶認證模型完成登陸和注冊相關操作步驟與實現技巧,需要的朋友可以參考下
2020-03-03
php使用curl訪問https示例分享
curl是利用URL語法在命令行方式下工作的開源文件傳輸工具,下面介紹一下php使用curl訪問https的示例,大家參考使用吧
2014-01-01
Yii2增加驗證碼步驟詳解
這篇文章主要介紹了Yii2增加驗證碼步驟詳解的相關資料,需要的朋友可以參考下
2016-04-04
PHP給文字內容中的關鍵字進行套紅處理
本文介紹了一個PHP中的函數，可以對內容的關鍵字進行套紅，高亮突出顯示關鍵字，分享給大家，希望對大家有所幫助。
2016-04-04
PHP永久登錄、記住我功能實現方法和安全做法
這篇文章主要介紹了PHP永久登錄、記住我功能實現方法和安全做法,本文著重講解用數據庫實現更安全的永久登錄、記住我功能,需要的朋友可以參考下
2015-04-04
php 寫入緩存文件、讀取緩存文件的函數代碼
有時候我們需要將一些配置文件保存到靜態(tài)文件中，方便后期調用，這里就為大家分享兩個函數，需要的朋友可以參考一下
2017-08-08
PHP 獲取指定地區(qū)的天氣實例代碼
這篇文章主要介紹了PHP 獲取指定地區(qū)的天氣實例代碼的相關資料,需要的朋友可以參考下
2017-02-02
Symfony2框架學習筆記之HTTP Cache用法詳解
這篇文章主要介紹了Symfony2框架HTTP Cache用法,結合實例形式分析了Symfony框架HTTP緩存的相關使用技巧,需要的朋友可以參考下
2016-03-03
PHP仿微信發(fā)紅包領紅包效果
最近項目開發(fā)要求實現紅包功能，仿微信（不含留言），但只能使用余額發(fā)紅包。下面小編給大家分享PHP仿微信發(fā)紅包領紅包效果，感興趣的朋友一起看看吧
2016-10-10
php 變量定義方法
對于php下一些常見的靜態(tài) 常量等的定義說明。
2009-06-06