使用laravel怎么返回統一格式的錯誤碼

使用laravel怎么返回統一格式的錯誤碼？相信很多沒有經驗的人對此束手無策，為此本文總結了問題出現的原因和解決方法，通過這篇文章希望你能解決這個問題。

問題一：訪問接口返回頁面代碼

最典型的就是laravel new 一個項目后，在瀏覽器直接訪問localhost會進入laravel框架模版的默認歡迎頁，這個沒有太大的問題，問題就是你用postman把這個地址當接口

調用，返回的就是頁面的代碼，你在安卓端調用返回的還是頁面的代碼，其實實際使用不會去調用/跟接口，但是調用接口的時候一些其他的錯誤比如4xx,5xx都會返回html代碼。

安卓端只能通過判斷狀態碼來判斷請求的成功失敗，而且極難拿到錯誤信息。其實這里可以在安卓端統一加header，但是...... 于是網上查了下怎么處理

第一種辦法解決postman調試的是可以在postman的請求中設置headers X-Requested-With:XMLHttpRequest來模擬ajax請求

第二種辦法使項目僅返回JSON格式的需要新建一個Middleware

namespace App\Http\Middleware;
use Closure;
class JsonApplication
{
  public function handle($request, Closure $next)
  {
    $request->headers->set('Accept', 'application/json');
    return $next($request);
  }
}

然后在Kernel中全局注冊Middleware并應用所有的api請求（這里因為項目是web-api項目，所以將routes/api.php的namespace去掉了，所以$middlewareGroups中的key是api）

namespace App\Http;
use Illuminate\Foundation\Http\Kernel as HttpKernel;
class Kernel extends HttpKernel
{
  protected $middlewareGroups = [
    'api' => [
      ......
      'json_application',
    ],
  ];
  protected $routeMiddleware = [
    ......
    'json_application' => \App\Http\Middleware\JsonApplication::class,
  ];
}

這樣配置好后就再也不用擔心調用接口，給你返回的是頁面代碼。

問題二: 接口返回統一的JSON格式

通過上面的配置接口返回數據都是JSON的格式了，但是繼續開發會發現，還是需要通過HTTP狀態碼來判斷是否成功，然后返回的JSON里面的key不同的接口差異特別大，即使同一個接口在成功和出錯的時候也會返回不同的KEY。

這個問題多采用返回同一格式的問題，由于之前給vue寫過很多接口，所以還是沿用之前的key的模式

{
  "code": "0",
  "msg": "ok",
  "data": ""
}

但是在laravel中怎么返回這個格式成了一個問題，網上查了好幾次，都沒有太好的解決辦法，多是覆蓋的情況不全，再有就是錯誤碼錯誤信息都寫在邏輯層，新加的完全不知道有沒有沖突。

后來又在BD和GG搜索好久，自己也嘗試用laravel自帶的異常機制和Middleware處理，始終不是太滿意。

用過JAVA的都知道，在java中處理錯誤碼很方便，直接定義一個枚舉把所有的錯誤代碼都寫在里面，拋出異常的時候枚舉當做參數傳遞進去。類似于這樣

枚舉

package *.*.*
public enum ErrorCode {
  OK("ok", 0),
  PARAM_ERROR("param error", 88888),
  UNKNOWN_ERROR("unknown error", 99999);
  ErrorCode(String value, Integer key) {
    this.value = value;
    this.key = key;
  }
  private String value;
  private Integer key;
  public String getValue() {
    return value;
  }
  public Integer getKey() {
    return key;
  }
}

異常類

package *.*.*;
import *.*.*.ErrorCode;
public class ApiException extends Exception {
  public int code = 0;
  public ApiException(ErrorCode errorCode) {
    super(errorCode.getValue());
    this.code = errorCode.getKey();
  }
  ......
}

使用

throw new ApiException(ErrorCode.UNKNOWN_ERROR);

于是查了下PHP的枚舉，還真支持，但仔細一研究才發現，PHP的枚舉不僅要安裝開啟SPL，然而提供的方法也并沒有什么卵用

于是仿照JAVA寫了一個

基類

namespace App\Enums;
abstract class Enum
{
  public static function __callStatic($name, $arguments)
  {
    return new static(constant('static::' . $name));
  }
}

錯誤碼 這里因為用到了魔術方法，所以要在注視中標注

namespace App\Enums;
/**
 * @method static CodeEnum OK
 * @method static CodeEnum ERROR
 */
class CodeEnum extends Enum
{
  public const OK = ['0', 'ok'];
  public const ERROR = ['99999', 'fail'];
  private $code;
  private $msg;
  public function __construct($param)
  {
    $this->code = reset($param);
    $this->msg = end($param);
  }
  public function getCode()
  {
    return $this->code;
  }
  public function getMsg()
  {
    return $this->msg;
  }
}

自定義異常類

namespace App\Exceptions;
use App\Enums\CodeEnum;
use Exception;
use Illuminate\Support\Facades\Log;
class ApiException extends Exception
{
  public function __construct(CodeEnum $enum)
  {
    parent::__construct($enum->getMsg(), $enum->getCode());
  }
  public function report()
  {
    Log::error("ApiException {$this->getFile()}({$this->getLine()}): code({$this->getCode()}) msg({$this->getMessage()})");
  }
  public function render($request)
  {
    return response([
      'code' => $this->getCode(),
      'msg' => $this->getMessage(),
      'data' => ''
    ]);
  }
}

調用

throw new ApiException(new CodeEnum(CodeEnum::ERROR)); // 這樣調總感覺不太好看
throw new ApiException(CodeEnum::OK()); // 這樣調用和java的調用方式就很像了

看完上述內容，你們掌握使用laravel怎么返回統一格式的錯誤碼的方法了嗎？如果還想學到更多技能或想了解更多相關內容，歡迎關注億速云行業資訊頻道，感謝各位的閱讀！