異常處理

配置

config/exception.php

return [
    // 這裡配置異常處理類
    '' => support\exception\Handler::class,
];

多應用模式時，你可以為每個應用單獨配置異常處理類，參見多應用

預設異常處理類

webman 中異常預設由 support\exception\Handler 類來處理。可修改配置文件 config/exception.php 來更改預設異常處理類。異常處理類必須實現 Webman\Exception\ExceptionHandlerInterface 接口。

interface ExceptionHandlerInterface
{
    /**
     * 記錄日誌
     * @param Throwable $e
     * @return mixed
     */
    public function report(Throwable $e);

    /**
     * 渲染返回
     * @param Request $request
     * @param Throwable $e
     * @return Response
     */
    public function render(Request $request, Throwable $e) : Response;
}

渲染響應

異常處理類中的 render 方法是用來渲染響應的。

如果配置文件 config/app.php 中 debug 值為 true（以下簡稱 app.debug=true），將返回詳細的異常信息，否則將返回簡略的異常信息。

如果請求期待是json返回，則返回的異常信息將以json格式返回，類似

{
    "code": "500",
    "msg": "異常信息"
}

如果 app.debug=true，json數據裡會額外增加一個 trace 欄位返回詳細的呼叫堆疊。

你可以編寫自己的異常處理類來更改預設異常處理邏輯。

業務異常 BusinessException

有時候我們想在某個嵌套函數裡終止請求並返回一個錯誤信息給客戶端，這時可以通過拋出 BusinessException 來做到這點。
例如：

<?php
namespace app\controller;

use support\Request;
use support\exception\BusinessException;

class FooController
{
    public function index(Request $request)
    {
        $this->chackInpout($request->post());
        return response('hello index');
    }

    protected function chackInpout($input)
    {
        if (!isset($input['token'])) {
            throw new BusinessException('參數錯誤', 3000);
        }
    }
}

以上示例會返回一個

{"code": 3000, "msg": "參數錯誤"}

注意
業務異常 BusinessException 不需要業務 try 捕獲，框架會自動捕獲並根據請求類型返回合適的輸出。

自訂業務異常

如果以上響應不符合你的需求，例如想把 msg 要改為 message，可以自訂一個 MyBusinessException

新建 app/exception/MyBusinessException.php 內容如下

<?php

namespace app\exception;

use support\exception\BusinessException;
use Webman\Http\Request;
use Webman\Http\Response;

class MyBusinessException extends BusinessException
{
    public function render(Request $request): ?Response
    {
        // json請求返回json數據
        if ($request->expectsJson()) {
            return json(['code' => $this->getCode() ?: 500, 'message' => $this->getMessage()]);
        }
        // 非json請求則返回一個頁面
        return new Response(200, [], $this->getMessage());
    }
}

這樣當業務調用

use app\exception\MyBusinessException;

throw new MyBusinessException('參數錯誤', 3000);

json請求將收到一個類似如下的json返回

{"code": 3000, "message": "參數錯誤"}

提示
因為 BusinessException 異常屬於業務異常（例如用戶輸入參數錯誤），它是可預知的，所以框架並不會認為它是致命錯誤，並不會記錄日誌。

總結

在任何想中斷當前請求並返回信息給客戶端的時候可以考慮使用 BusinessException 異常。