react + Laravel Debugbar API 除錯

yanthink發表於2018-09-14
ReactLaravelAPI除錯

一、Debugbar 安裝與配置

1、使用 Composer 安裝該擴充套件包：

composer require barryvdh/laravel-debugbar --dev

2、接下來執行以下命令生成此擴充套件包的配置檔案 config/debugbar.php :

php artisan vendor:publish --provider="Barryvdh\Debugbar\ServiceProvider"

3、開啟 config/debugbar.php 檔案，修改如下配置：

return [
    ...
    'capture_ajax' => false,
    'inject' => false,
    ...
],

4、開啟 app/Providers/RouteServiceProvider.php 檔案，在 boot 方法裡新增一條渲染路由

public function boot()
{
    if ($this->app->environment('local')) {
        Route::group(['prefix' => config('debugbar.route_prefix')], function () {
            Route::get('render', function () {
                $debugBar = debugbar();
                $renderer = $debugBar->getJavascriptRenderer();
                $renderer->setOpenHandlerUrl('/' . config('debugbar.route_prefix') . '/open');
                $script = $renderer->render();
                preg_match('/(?:<script[^>]*>)(.*)<\/script>/isU', $script, $matches);

                $js = $matches[1];

                $jsRetryFn = "function retry(times, fn, sleep) {
                                 if (!times) times = 1;
                                 if (!sleep) sleep = 50;
                                 --times;
                                 try {
                                     return fn();
                                 } catch (e) {
                                     if (!times) throw e;
                                     if (sleep) {
                                         setTimeout(function() {
                                             retry(times, fn, sleep);
                                         }, sleep);
                                     }
                                 }
                              }\n";

                // sleep(1);
                echo "${jsRetryFn}\nretry(50, function() {\n${js}\nwindow.phpdebugbar = phpdebugbar\n}, 200);";
                exit;
            });
        });
    }

    parent::boot();
}

5、開啟 app/Providers/AppServiceProvider.php 檔案，在 boot 方法裡新增如下程式碼：

public function boot()
{
    if (app()->environment('local') && request()->isJson()) {
        $debugbar = debugbar();
        $debugbar->sendDataInHeaders(true);
    }
}

二、react 配置

1、在入口模板檔案 document.ejs 載入 js 和 css 檔案，並且渲染debugbar

<% if(context.env !== 'production') { %>
    <link rel="stylesheet" href="/_debugbar/assets/stylesheets">
    <script src="/_debugbar/assets/javascript"></script>
    <script src="/_debugbar/render"></script>
<% } %>

模板基於 ejs 渲染，可以參考 https://github.com/mde/ejs 檢視具體使用。

2、api 請求自動重新整理debugbar渲染

/**
 * request 網路請求工具
 * 更詳細的 api 文件: https://github.com/umijs/umi-request
 */
import { extend } from 'umi-request';
import { notification } from 'antd';
import cookie from 'cookie';
import { getToken } from '@/utils/authority';

const codeMessage = {
  200: '伺服器成功返回請求的資料。',
  201: '新建或修改資料成功。',
  202: '一個請求已經進入後臺排隊（非同步任務）。',
  204: '刪除資料成功。',
  400: '發出的請求有錯誤，伺服器沒有進行新建或修改資料的操作。',
  401: '使用者沒有許可權（令牌、使用者名稱、密碼錯誤）。',
  403: '使用者得到授權，但是訪問是被禁止的。',
  404: '發出的請求針對的是不存在的記錄，伺服器沒有進行操作。',
  406: '請求的格式不可得。',
  410: '請求的資源被永久刪除，且不會再得到的。',
  422: '當建立一個物件時，發生一個驗證錯誤。',
  500: '伺服器發生錯誤，請檢查伺服器。',
  502: '閘道器錯誤。',
  503: '服務不可用，伺服器暫時過載或維護。',
  504: '閘道器超時。',
};

/**
 * 異常處理程式
 */
const errorHandler = async (error: { response: Response }): Promise<void> => {
  const { response } = error;
  if (response && response.status) {
    const { status, url } = response;

    if (status === 401) {
      // @ts-ignore https://umijs.org/zh/guide/with-dva.html#faq
      window.g_app._store.dispatch({ type: 'login/logout' });
    }

    const errorText = codeMessage[response.status] || response.statusText;
    const { message: msg } = await response.json();

    notification.error({
      message: `請求錯誤 ${status}: ${url}`,
      description: msg || errorText,
    });

    const error: any = new Error(msg || errorText);
    error.response = response;
    throw error;
  }
};

/**
 * 配置request請求時的預設引數
 */
const request = extend({
  prefix: '/api',
  errorHandler, // 預設錯誤處理
  credentials: 'include', // 預設請求是否帶上cookie
  headers: {
    Accept: `application/x.sheng.${API_VERSION || 'v1'}+json`, // eslint-disable-line
    'Content-Type': 'application/json; charset=utf-8',
  },
});

// request攔截器, 改變url 或 options.
/* eslint no-param-reassign:0 */
request.interceptors.request.use((url, options) => {
  const { headers } = options;

  options.headers = {
    ...headers,
    Authorization: getToken(),
    'X-XSRF-TOKEN': cookie.parse(document.cookie)['XSRF-TOKEN'],
  };

  return { url, options };
});

// response攔截器, 處理response
request.interceptors.response.use(response => {
  /* eslint no-undef:0, valid-typeof:0 */
  if (typeof phpdebugbar !== undefined) {
    try {
      const {
        ajaxHandler: { headerName },
      } = phpdebugbar;
      const debugBarData = response.headers.get(headerName);
      const debugBarId = response.headers.get(`${headerName}-id`);
      if (debugBarData) {
        const { id, data } = JSON.parse(decodeURIComponent(debugBarData));
        phpdebugbar.addDataSet(data, id);
      } else if (debugBarId && phpdebugbar.openHandler) {
        phpdebugbar.loadDataSet(debugBarId, '(ajax)');
      }
    } catch (e) {
      //
    }
  }
  return response;
});

export default request;

react + Laravel Debugbar API 除錯

本作品採用《CC 協議》，轉載必須註明作者和本文連結

相關文章