最近常使用Yii2寫接口，但是有時(shí)候前端反應(yīng)某個(gè)接口有問(wèn)題，如何能快速定位問(wèn)題呢？
特別是那種很難復(fù)現(xiàn)的問(wèn)！每當(dāng)這個(gè)時(shí)候，總是感覺有個(gè)接口日志記錄就太好了；

對(duì)接口日志有以下需求

• 1.配置簡(jiǎn)單、使用簡(jiǎn)單
• 2.對(duì)現(xiàn)有的業(yè)務(wù)代碼無(wú)污染
• 3.記錄信息全面，包括接口的執(zhí)行市場(chǎng)
• 4.支持指定哪些接口使用哪些不使用（大部分查詢接口都不需要,比如默認(rèn)指定 create,update,delete）
• 5.支持寫入到數(shù)據(jù)庫(kù)（MySQL、Elasticsearch），方便查詢
• 6.當(dāng)程序拋異常的時(shí)候，也能記錄異常信息

于是自己寫了一個(gè)小組件，支持上面需求！
當(dāng)前是基于 Yii的事件處理機(jī)制寫的組件！

配置 config/web.php

  components = [
    ...
    'apiRequestLogs' => [
            'class' => 'app\core\events\ApiRequestLogs',
            'remark' => '',//日志的備注,可以在程序中指定備注信息，方便在線調(diào)試
        ],
    ...
  ]

上代碼 app\core\events\ApiRequestLogs

<?php
/**
 * 接口請(qǐng)求事件
 * 1.記錄接口請(qǐng)求信息
 * 2.接口運(yùn)行時(shí)間
 * 3.支持運(yùn)行中的備注信息
 * 4.記錄返回的數(shù)據(jù)
 * @author  jason <jasonwang1211@gmail.com>
 */

namespace app\core\events;

use app\models\ApiLog;
use Jsyqw\Utils\IPHelper;
use Jsyqw\Utils\RuntimeHelper;
use yii\base\Event;
use yii\helpers\Json;
use yii\web\Application;
use Yii;

class ApiRequestLogs extends Event
{
    public $remark = '';

    /**
     * 是否需要日志
     */
    public function isStartApiLog()
    {
        //注意；要在 BaseApiController 中有配置
        $startApiLog = Yii::$app->controller->startApiLog();
        if (!$startApiLog) {
            return false;
        }
        if (in_array('*', $startApiLog)) {
            return true;
        }
        $action = Yii::$app->controller->action->id;
        if (in_array($action, $startApiLog)) {
            return true;
        }
        return false;
    }


    /**
     * 開始執(zhí)行
     */
    public function run()
    {
        //1.Action 開始的時(shí)候，執(zhí)行事件
        Yii::$app->on(Application::EVENT_BEFORE_ACTION, function ($event) {
            if ($this->isStartApiLog()) {
                //計(jì)時(shí)開始
                RuntimeHelper::instance()->start();
            }
        });

        //2.請(qǐng)求結(jié)束的時(shí)候，記錄日志
        Yii::$app->on(Application::EVENT_AFTER_REQUEST, function ($event) {
            if ($this->isStartApiLog()) {
                //計(jì)時(shí)結(jié)束
                RuntimeHelper::instance()->stop();
                $responseData = Yii::$app->response->data;
                $request = Yii::$app->request;
                $userId = Yii::$app->user->id;
                $route = Yii::$app->controller->route;
                $code = isset($responseData['code']) ? $responseData['code'] : null;
                $msg = isset($responseData['msg']) ? $responseData['msg'] : null;
                $data = isset($responseData['data']) ? $responseData['data'] : null;
                $responseContent = is_array($responseData) ? Json::encode($responseData) : $responseData;

                $log = new ApiLog();
                $log->user_id = $userId;
                $log->time_consuming = RuntimeHelper::instance()->consumeTime();
                $log->type = 1;
                $log->ip = IPHelper::remoteIp();
                $log->token = $request->getHeaders()->get('Authorization');
                $log->route_name = $route;
                $log->request_method = RequestHelper::instance()->getMethod();
                $log->request_header = Json::encode($request->getHeaders());
                $log->request_get = Json::encode($request->get());
                $log->request_post = Json::encode($request->post());
                $log->response_content = $responseContent;
                $log->code = $code;
                $log->msg = $msg;
                $log->data = is_string($data) ? $data : Json::encode($data);
                $log->remark = $this->remark;
                $log->create_time = date('Y-m-d H:i:s');
                $log->save(false);
            }
        });
    }
}

在模塊初始化的時(shí)候，開啟日志監(jiān)聽

<?php

namespace app\modules\api;

use app\models\UserIdentity;
use yii\web\Response;

/**
 * api module definition class
 */
class Module extends \yii\base\Module
{
    /**
     * {@inheritdoc}
     */
    public $controllerNamespace = 'app\modules\api\controllers';

    /**
     * {@inheritdoc}
     */
    public function init()
    {
        parent::init();

        //指定是 API用戶模塊
        \Yii::$app->user->module_user = UserIdentity::MODULE_USER_API;
        //初始化從參數(shù)
        \Yii::$app->user->enableSession = false;
        \Yii::$app->user->enableAutoLogin = false;
        \Yii::$app->user->loginUrl = '';
        \Yii::$app->response->format = Response::FORMAT_JSON;

        \Yii::$app->apiRequestLogs->run();
    }
}

在接口的 BaseApiController 中配置哪些需要記錄

    /**
     * 開啟接口日志，繼承當(dāng)前Controller的控制器，可以自定義配置
     * eg: ['*']  or ['login']
     * @return array
     */
    public function startApiLog()
    {
        return ['create', 'update', 'delete'];
    }

配置 ErrorHandler （可選）主要是記錄捕獲異常后的日志

   protected function renderException($exception){
      ...
      //觸發(fā)事件
      Yii::$app->trigger(Application::EVENT_AFTER_REQUEST);
  }

具體UserController中應(yīng)用，樣例

class UserController extends BaseApiController
{
    public function ignoreCheckToken()
    {
        return ['login', 'logout'];
    }

    public function startApiLog()
    {
        return ['login', 'logout', 'change-pwd'];
    }

    public function actionLogin()
    {
        ...
        //可在請(qǐng)求任意節(jié)點(diǎn)，添加當(dāng)前備注；
        Yii::$app->apiRequestLogs->remark = '備注信息' . date('Y-m-d H:i:s');
        ....
        return $this->asJson($model);
    }
}

入庫(kù)的截圖如下，當(dāng)然同樣操作，可以寫入 ES 等數(shù)據(jù)庫(kù)

日志信息

其他Yii2自帶的日志

關(guān)于框架自帶的日志，在本地調(diào)試，或者測(cè)試環(huán)境還是比較方便的；但是在正式環(huán)境的時(shí)候，就不方便了！
Yii2框架的日志配置很簡(jiǎn)單，使用也很容易，這里就不做深入講解！