如果做API的話，如何使別人再呼叫你的介面時能夠有一個統(tǒng)一標(biāo)準(zhǔn)的json或jsonp格式，然而json回應(yīng)的格式和內(nèi)容，每個人的約定都是有差異的，所以我們必須再數(shù)據(jù)出去之前做一定的處理。

1.首先我們需要初始化去呼叫beforeSend，因為我們需要對beforesend做一些處理，以下是init初始化處理程式碼：

/**
 * (non-PHPdoc)
 * @see \yii\base\Object::init()
 */
public function init()
{       
    parent::init();	//綁定beforeSend事件，更改數(shù)據(jù)輸出格式
    Yii::$app->getResponse()->on(Response::EVENT_BEFORE_SEND, [$this, 'beforeSend']);
}

#2.然後我們就需要對beforesend進(jìn)行處理，處理點(diǎn)有下面幾個重點(diǎn)：?

1>更改資料輸出格式

2>預(yù)設(shè)輸出Json資料

#3>如果客戶端請求時有傳遞$_GET['callback']參數(shù)，輸出Jsonp格式

4>請求正確時資料為{"success":true,"data":{.. .}}

5>請求錯誤時資料為{"success":false,"data":{"name":"Not Found","message":"頁面找不到。","code ":0,"status":404}}?

6>具體程式碼如下：

/**
     * 更改數(shù)據(jù)輸出格式
     * 默認(rèn)情況下輸出Json數(shù)據(jù)
     * 如果客戶端請求時有傳遞$_GET['callback']參數(shù)，輸入Jsonp格式
     * 請求正確時數(shù)據(jù)為  {"success":true,"data":{...}}
     * 請求錯誤時數(shù)據(jù)為  {"success":false,"data":{"name":"Not Found","message":"頁面未找到。","code":0,"status":404}}
     * @param \yii\base\Event $event
     */
    public function beforeSend($event)
    {        /* @var $response \yii\web\Response */
        $response = $event->sender;
        $isSuccessful = $response->isSuccessful;        if ($response->statusCode>=400) {            //異常處理
            if (true && $exception = Yii::$app->getErrorHandler()->exception) {
                $response->data = $this->convertExceptionToArray($exception);
            }            //Model出錯了
            if ($response->statusCode==422) {
                $messages=[];                foreach ($response->data as $v) {
                    $messages[] = $v['message'];
                }                //請求錯誤時數(shù)據(jù)為  {"success":false,"data":{"name":"Not Found","message":"頁面未找到。","code":0,"status":404}}
                $response->data = [                    'name'=> 'valide error',                    'message'=> implode("  ", $messages),                    'info'=>$response->data
                ];
            }
            $response->statusCode = 200;
        }        elseif ($response->statusCode>=300) {
            $response->statusCode = 200;
            $response->data = $this->convertExceptionToArray(new ForbiddenHttpException(Yii::t('yii', 'Login Required')));
        }        //請求正確時數(shù)據(jù)為  {"success":true,"data":{...}}
        $response->data = [            'success' => $isSuccessful,            'data' => $response->data,
        ];
        $response->format = Response::FORMAT_JSON;
        \Yii::$app->getResponse()->getHeaders()->set('Access-Control-Allow-Origin', '*');
        \Yii::$app->getResponse()->getHeaders()->set('Access-Control-Allow-Credentials', 'true');       //jsonp 格式輸出
        if (isset($_GET['callback'])) {
            $response->format = Response::FORMAT_JSONP;
            $response->data = [                'callback' => $_GET['callback'],                'data'=>$response->data,
            ];
        }
    }

3.針對請求可能會發(fā)生一些異常，同樣我們也需要對異常進(jìn)行一些標(biāo)準(zhǔn)化處理，將異常轉(zhuǎn)換為array輸出，具體程式碼如下：

/**
     * 將異常轉(zhuǎn)換為array輸出
     * @see \yii\web\ErrorHandle
     * @param \Exception $exception
     * @return multitype:string NULL Ambigous <string, \yii\base\string> \yii\web\integer \yii\db\array multitype:string NULL Ambigous <string, \yii\base\string> \yii\web\integer \yii\db\array
     */
    protected function convertExceptionToArray($exception)
    {        if (!YII_DEBUG && !$exception instanceof UserException && !$exception instanceof HttpException) {
            $exception = new HttpException(500, Yii::t(&#39;yii&#39;, &#39;An internal server error occurred.&#39;));
        }
        $array = [            &#39;name&#39; => ($exception instanceof Exception || $exception instanceof ErrorException) ? $exception->getName() : &#39;Exception&#39;,            &#39;message&#39; => $exception->getMessage(),            &#39;code&#39; => $exception->getCode(),
        ];        if ($exception instanceof HttpException) {
            $array[&#39;status&#39;] = $exception->statusCode;
        }        if (YII_DEBUG) {
            $array[&#39;type&#39;] = get_class($exception);            if (!$exception instanceof UserException) {
                $array[&#39;file&#39;] = $exception->getFile();
                $array[&#39;line&#39;] = $exception->getLine();
                $array[&#39;stack-trace&#39;] = explode("\n", $exception->getTraceAsString());                if ($exception instanceof \yii\db\Exception) {
                    $array[&#39;error-info&#39;] = $exception->errorInfo;
                }
            }
        }        if (($prev = $exception->getPrevious()) !== null) {
            $array[&#39;previous&#39;] = $this->convertExceptionToArray($prev);
        }        return $array;
    }

好了，這樣我們就有了標(biāo)準(zhǔn)同一個的api介面回傳資料格式了，在呼叫介面的人員也不用為了格式不統(tǒng)一感到煩惱

推薦：《Yii2.0框架開發(fā)實戰(zhàn)影片教學(xué)》

以上是Yii2 API介面輸出統(tǒng)一Json和jsonp格式方法的詳細(xì)內(nèi)容。更多資訊請關(guān)注PHP中文網(wǎng)其他相關(guān)文章！