laravel返回统一格式错误码问题


Posted in PHP onNovember 04, 2019

背景

最近在学习开发一个安卓项目,后端接口项目开始用PHP的Yii2.0框架新启了个项目,后换成laravel5.5,最近看到laravel升级了新版本,于是又将项目更新到laravel6.4

在使用yii和laravel的过程中,两个框架对web-api都非常友好,也都对restful做了不同程度的支持,但是还是遇到了一些问题,下面以laravel6.4为例,简单描述下我遇到的问题。

问题一:访问接口返回页面代码

最典型的就是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返回统一格式错误码问题,希望对大家有所帮助,如果大家有任何疑问请给我留言,小编会及时回复大家的。在此也非常感谢大家对三水点靠木网站的支持!
如果你觉得本文对你有帮助,欢迎转载,烦请注明出处,谢谢!

PHP 相关文章推荐
提升PHP执行速度全攻略(上)
Oct 09 PHP
无需重新编译php加入ftp扩展的解决方法
Feb 07 PHP
关于PHP内存溢出问题的解决方法
Jun 25 PHP
php判断是否为json格式的方法
Mar 04 PHP
PHP将字符分解为多个字符串的方法
Nov 22 PHP
如何使用Gitblog和Markdown建自己的博客
Jul 31 PHP
ThinkPHP路由机制简介
Mar 23 PHP
Laravel5.1数据库连接、创建数据库、创建model及创建控制器的方法
Mar 29 PHP
php array_values 返回数组的所有值详解及实例
Nov 12 PHP
详解php实现页面静态化原理
Jun 21 PHP
PHP使用微信开发模式实现搜索已发送图文及匹配关键字回复的方法
Sep 13 PHP
Ajax中的JSON格式与php传输过程全面解析
Nov 14 PHP
php 中self,this的区别和操作方法实例分析
Nov 04 #PHP
PHP 文件写入和读取操作实例详解【必看篇】
Nov 04 #PHP
PHP连接MySQL数据库的三种方式实例分析【mysql、mysqli、pdo】
Nov 04 #PHP
php ZipArchive实现多文件打包下载实例
Oct 31 #PHP
Laravel框架实现抢红包功能示例
Oct 31 #PHP
laravel框架实现后台登录、退出功能示例
Oct 31 #PHP
TP5框架简单登录功能实现方法示例
Oct 31 #PHP
You might like
解析Win7 XAMPP apache无法启动的问题
2013/06/26 PHP
Yii2.0预定义的别名功能小结
2016/07/04 PHP
php array_slice 取出数组中的一段序列实例
2016/11/04 PHP
PHP常用操作类之通信数据封装类的实现
2017/07/16 PHP
laravel框架中路由设置,路由参数和路由命名实例分析
2019/11/23 PHP
Discuz! 6.1_jQuery兼容问题
2008/09/23 Javascript
关于B/S判断浏览器断开的问题讨论
2008/10/29 Javascript
图片onload事件触发问题解决方法
2011/07/31 Javascript
jquery 按钮状态效果 正常、移上、按下
2013/08/12 Javascript
js Array操作的最简短最容易理解方法
2013/12/09 Javascript
深入理解JavaScript系列(34):设计模式之命令模式详解
2015/03/03 Javascript
Angular实现跨域(搜索框的下拉列表)
2017/02/16 Javascript
基于Vue2的独立构建与运行时构建的差别(详解)
2017/12/06 Javascript
p5.js实现斐波那契螺旋的示例代码
2018/03/22 Javascript
详解webpack import()动态加载模块踩坑
2018/07/17 Javascript
在vue中给列表中的奇数行添加class的实现方法
2018/09/05 Javascript
详解Ubuntu安装angular-cli遇到的坑
2018/09/08 Javascript
如何优雅地取消 JavaScript 异步任务
2020/03/22 Javascript
Python中的pprint折腾记
2015/01/21 Python
python删除过期文件的方法
2015/05/29 Python
Python的socket模块源码中的一些实现要点分析
2016/06/06 Python
python 实现网上商城,转账,存取款等功能的信用卡系统
2016/07/15 Python
python 请求服务器的实现代码(http请求和https请求)
2018/05/25 Python
Django使用详解:ORM 的反向查找(related_name)
2018/05/30 Python
Django框架模板文件使用及模板文件加载顺序分析
2019/05/23 Python
Python使用指定端口进行http请求的例子
2019/07/25 Python
matplotlib交互式数据光标mpldatacursor的实现
2021/02/03 Python
汽车技术服务与营销专业在籍生自荐信
2013/09/28 职场文书
志愿者个人总结
2015/03/03 职场文书
退税申请报告怎么写
2015/05/18 职场文书
党员证明模板
2015/06/19 职场文书
尊师重教主题班会
2015/08/14 职场文书
关于公司年会的开幕词
2016/03/04 职场文书
正能量励志演讲稿三分钟(范文)
2019/07/11 职场文书
js中Map和Set的用法及区别实例详解
2022/02/15 Javascript
angular4实现带搜索的下拉框
2022/03/25 Javascript