Lumen 中对 Dingo API 异常接管并自定义响应结果

MaxSky 等级 648 0 0

场景描述

比如我们需要对 API 限流抛出的异常进行接管,并重写响应消息,首先应用中间件:

use Dingo\Api\Routing\Router;

$api->group([
    'middleware' => 'api.throttle', // 限流中间件
    'expires' => 1, // 时间范围,单位“分”
    'limit' => 2, // 时间范围内请求次数
], function (Router $api) {

    $api->post('auth/login', 'LoginController@login');
});

使用 Postman 进行接口调试,我们会发现在正常请求阶段会多出三个响应头:

X-RateLimit-Limit      # 时间范围内可请求次数
X-RateLimit-Remaining  # 时间范围内剩余可请求次数
X-RateLimit-Reset      # 到期时间戳

继续重复请求两次后会得到类似如下结果(修改过):

{
    "message": "You have exceeded your rate limit.",
    "result": 0,
    "status_code": 429
}

异常接管

这里有两种接管方式

  1. 单一异常接管:

    建议在 App\Providers\AppServiceProvider 文件中的 register() 方法内进行编写:

     $this->app->make(Dingo\Api\Exception\Handler::class)->register(function (RateLimitExceededException $e) {
        return response([
             'message' => '当前请求太过频繁',
             'result' => 0,
             'status_code' => 429
         ])->setStatusCode($e->getStatusCode())->withHeaders($e->getHeaders());
     });
     如果无需使用状态码,可去掉 setStatusCode 方法,仅保留 withHeaders 即可。去掉后 HTTP 状态码响应为 200。
  2. 多异常接管:

    顾名思义,单一异常接管仅适用于单一的服务场景,而 Dingo API 提供了多项服务,如果应用多项时,上述方式就不适用了。

    首先,我们在 app/Exceptions 目录内创建名为 DingoExceptionHandler 的类文件,同样我们以限流异常示例,内容如下:

     <?php
    
     namespace App\Exceptions;
    
     use Dingo\Api\Contract\Debug\ExceptionHandler;
     use Dingo\Api\Exception\Handler as DingoHandler;
     use Dingo\Api\Exception\RateLimitExceededException;
     use Exception;
    
     class DingoExceptionHandler extends DingoHandler implements ExceptionHandler {
    
         public function handle(Exception $exception) {
             if ($exception instanceof RateLimitExceededException) {
                 return response([
                     'message' => '当前请求太过频繁',
                     'result' => 0,
                     'status_code' => 429
                 ])->withHeaders($exception->getHeaders());
             }
    
             // TODO: 此处可对其它异常进行同样方式的处理
    
             return parent::handle($exception);
         }
     }

    上方类文件还未应用,此时应当将其注入到框架容器中。

    打开 App\Providers\AppServiceProvider 文件,在 register() 方法中添加:

     $this->app->singleton('api.exception', function () {
         return new App\Exceptions\DingoExceptionHandler(
             $this->app['Illuminate\Contracts\Debug\ExceptionHandler'],
             config('api.errorFormat'),
             config('api.debug')
         );
     });

    至此接管完成,再次进行请求测试,响应结果变更为:

     {
         "message": "当前请求太过频繁",
         "result": 0,
         "status_code": 429
     }

    响应头中会多出一项 Retry-After,值为剩余可请求时间,单位秒,即 n 秒后允许请求。


说句题外话,之前看到网上很多人在 Lumen 框架中对服务的注册都是通过 $app->register() 写在 bootstrap/app.php 文件内,

个人建议不要这么做,应当统一写在 app\Providers\AppServiceProvider.php 文件内,因为在 app.php 中人家已经注册了这玩意儿

$app->register(App\Providers\AppServiceProvider::class);

那何不规范的写在 Providers 里面呢?例如:

<?php

namespace App\Providers;

use App\Exceptions\DingoExceptionHandler;
use App\Http\DingoAPI\StrictHeaderAccept;
use Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider;
use Dingo\Api\Http\Validation\Accept;
use Dingo\Api\Provider\LumenServiceProvider as DingoAPI;
use Illuminate\Redis\RedisServiceProvider;
use Illuminate\Support\ServiceProvider;

class AppServiceProvider extends ServiceProvider {

    /**
     * Register any application services.
     *
     * @return void
     */
    public function register() {
        // Dingo API
        $this->app->register(DingoAPI::class);

        // Overwrite request header Accept verify
        $this->app->singleton(Accept::class, function () { // Dingo API Accept 严格头的简易白名单方式,StrictHeaderAccept 类参考下方
            return new Accept(new StrictHeaderAccept(
                config('api.standardsTree'),
                config('api.subtype'),
                config('api.version'),
                config('api.defaultFormat')),
                config('api.strict'));
        });

        // Overwrite rate limit exception render
        $this->app->singleton('api.exception', function () {
            return new DingoExceptionHandler(
                $this->app['Illuminate\Contracts\Debug\ExceptionHandler'],
                config('api.errorFormat'),
                config('api.debug')
            );
        });

        // Redis
        $this->app->register(RedisServiceProvider::class);

        // IDE Helper
        if ($this->app->environment() !== 'production') {
            $this->app->register(IdeHelperServiceProvider::class);
        }
    }
}

StrictHeaderAccept.php 内容:

<?php

namespace App\Http\DingoAPI;

use Dingo\Api\Http\Parser\Accept;
use Illuminate\Http\Request;

class StrictHeaderAccept extends Accept {

    public function parse(Request $request, $strict = false) {
        if (in_array($request->getPathInfo(), config('whitelist.request.header'))) {
            $strict = false;
        }

        return parent::parse($request, $strict);
    }
}
收藏
评论区

相关推荐

php指的是什么?
PHP(全称:Hypertext Preprocessor,即“PHP:超文本预处理器”)是一种开源的通用计算机脚本语言,尤其适用于网络开发并可嵌入H
PHP对时间轮算法的简单实现
什么是时间轮算法? 把任务放到它需要被执行的时刻,然后等待时针转到这个时刻,取出该时刻的任务,执行并将任务从该时刻删除(消费)。 解决了什么问题? 以商品为例,如何实现商品的过保质期自动失效? 1:我们可以每分钟执行一个定时任务,扫描全表过期时间大于当前时间的商品,进行失效处理。(当然,也可以将该任务细化成秒级的) 2:商品添加时,将该商品的
2017最新PHP经典面试题目汇总(上篇)
2017最新PHP经典面试题目汇总(上篇) 2017最新PHP经典面试题目汇总(上篇) 本文章将持续更新,希望能在评论区发表自己的见解和认为比较经典的题目,后续笔者会在适当的节点对本文章进行分类和层次
nginx安全配置
安全是一个重要的问题,必须引起注意。 1. nginx介绍 nginx本身不能处理PHP(http://www.ttlsa.com/php/ "php"),它只是个web服务器,当接收到请求后,如果是php请求,则发给php解释器处理,并把结果返回给客户端。nginx一般是把请求发fastcgi管理进程处理,fastcgi管理进程选择cgi子
为什么很多公司都转型go语言开发?Go语言能做什么
Go语言能做什么一、我们为什么选择Go语言选择Go语言的原因可能会有很多,关于Go语言的特性、优势等,我们在之前的文档中也已经介绍了很多了。但是最主要的原因,应该是基于以下两方面的考虑:执行性能缩短API的响应时长,解决批量请求访问超时的问题。在Uwork的业务场景下,一次API批量请求,往往会涉及对另外接口服务的多次调用,而在之前的PHP实现模式下,要做到
PHP学习笔记之PHP的函数应用
目录一、函数的定义 二、自定义函数 三、函数的工作原理和结构化编程 四、PHP变量的范围 五、声明及应用各种形式的PHP函数 六、递归函数 七、使用自定义函数库 一、函数的定义一个被命名的、独立的代码段,它执行特定的任务,并可能给调用它的程序返回一个值。定义中的各部分如下: 函数是被命名的:每个函数都
PHP 微信公众号消息加解密
公众号配置根据提示设置即可:【图中信息均为无意义数据,仅供参考。注意服务器地址需可接收 GET/POST 两种请求】 AESKey 直接点一下随机生成即可,Token 可以生成一个 UUID 再把 UUID 进行 MD5 一次即可。 接收关注事件消息示例 请求参数校验这一步根据项目情况,可供参考:(Lumen 框架)php$valida
Windows 下编译 PHP Redis 扩展并支持 Igbinary 序列器
这是 PHP 下扩展的下载地址:当然,通过这个地址我们能够轻松的获取到 Redis 和 Igbinary 扩展并启用,但是,我们可以在页面上打开 phpinfo() 瞧瞧上方截图为重编译的 Redis 扩展,默认情况下通过上方网站下载的 Redis 扩展在 Available serializers 中只有 php 一项。目前仅编译了
Windows 下关于 CURL SSL 证书的放置说明
首先,我们从这个地址摸到 cacert.pem 文件:在 PHP 的配置文件 php.ini 中我们可以搜索 curl.cainfo 并通过填写正确的路径指向使得 Composer、CURL 能够正常请求不过还有一个全局的更合理的方式,通过该链接:在其中搜索 CURL_CA_BUNDLE 我们可以得知:If you're
Lumen 中对 Dingo API 异常接管并自定义响应结果
场景描述比如我们需要对 API 限流抛出的异常进行接管,并重写响应消息,首先应用中间件:phpuse Dingo\Api\Routing\Router;$apigroup( 'middleware' 'api.throttle', // 限流中间件 'expires' 1, // 时间范围,单位“分” 'lim
Lumen 消息队列传递自定义数据的两种方式
根据官方文档,所有自己编写的 任务类 需继承抽象类 app/Jobs/Job.php,内容如下:php<?phpnamespace App\Jobs;use Illuminate\Bus\Queueable;use Illuminate\Contracts\Queue\ShouldQueue;use Illuminate\Queue\{In
PHP 中 firebase/php-jwt RS256 公私钥生成指南
所有关于 openssl_sign(): supplied key param cannot be coerced into a private/public key、Algorithm not allowed 等错误按照文章来一遍,基本就能解决了GitHub 用多了,第一反应用 puttygen.exe 这个程序来生成,得到 id_rsa
Lumen 中配置邮件发送并使用不同发件人发信实例
Intro阿里网易企业邮发件可参考另一篇: 基本配置Composer 安装 illuminate/mail 组件后将下方内容保存为 mail.php 放置于 Project/config 目录php<?phpreturn / |
列举一些糟糕的PHP代码
10例糟糕的PHP代码 10例糟糕的PHP代码 这篇文章在很早以前就看到了,由于最近要自己做一些主题方面的东西,代码需要更加规范,用这些反面的例子来约束自己,告诉自己代码不应该这样写,虽然它也能实现功能,但那样做并不明智,
为什么很多公司都转型go语言开发?Go语言能做什么 ?
Go语言能做什么一、我们为什么选择Go语言选择Go语言的原因可能会有很多,关于Go语言的特性、优势等,我们在之前的文档中也已经介绍了很多了。但是最主要的原因,应该是基于以下两方面的考虑:执行性能缩短API的响应时长,解决批量请求访问超时的问题。在Uwork的业务场景下,一次API批量请求,往往会涉及对另外接口服务的多次调用,而在之前的PHP实现模式下,要做到