Laravel 源码解读：PHP artisan down

0回复惨案？

消灭0回复

这个功能相对api应用来说比较鸡肋

@jacobsun 炉门 已经砍了！

嘿嘿

@jacobsun 这个不应该是 api 的应用场景

@JellyBool 会有需求因为某些原因临时维护服务器呀，php artisan down 其实也是这个需求 不过只考虑到了 MVC 的场景 没有考虑到 API 的场景... 那这时候只能自己实现 还要 php artisan down 不就是鸡肋了嘛

楼方这个字体是啥 ide的字段看起来 蛮苗条的

我的 laravel 项目是api场景，我在中间件CheckForMaintenanceMode里找到一个 MaintenanceModeException异常类，所以想到了在App\Exceptions\Handler中这样写

use Illuminate\Foundation\Http\Exceptions\MaintenanceModeException;

if ($e instanceof MaintenanceModeException) {
            return response()->json([
                'code'    => '1000',
                'status'  => 'error',
                'message' => $e->getMessage(),
            ], 400);
}

这样前端拿到code 为1000时就知道api暂时不能用了，刚接触laravel，也不知道这样写合不合适，目前实现效果倒是可以了

@renqun Laravel8 在默认情况下，执行 php artisan down 以后，不论访问 WEB 还是 API 都不再抛出 MaintenanceModeException 异常，而是 HttpException 异常。这时我们访问 API 就会报错：

// api 请求结果：
{
    "message": "Service Unavailable",
    // 看这里是 HttpException
    "exception": "Symfony\\Component\\HttpKernel\\Exception\\HttpException",
    "file": "/var/www/learn-laravel/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/PreventRequestsDuringMaintenance.php",
    "line": 79,
    "trace": [
        {
            "file": "/var/www/learn-laravel/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 167,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\PreventRequestsDuringMaintenance",
            "type": "->"
        },
       .
       .
    ]
}

这样的结果对于客户端显然是不能忍的 。那么如何能给客户端返回正确的 JSON 格式数据呢？

解决办法是：在 App\Http\Middleware\PreventRequestsDuringMaintenance 中间件里做手脚，因为这个文件在 App\Http\Kernel 中已经被引入到了全局的中间件数组中。“全局的中间件”意思就是不论访问 WEB 还是 API 都会把这个数组中的中间件走一遍。

我们可以在 handle() 方法中，检测 uri 是否为 api 开头。是的话就返回一个正常的 json 响应，不是的话，就由父类继续执行：

<?php

namespace App\Http\Middleware;

use Illuminate\Foundation\Http\Middleware\PreventRequestsDuringMaintenance as Middleware;

class PreventRequestsDuringMaintenance extends Middleware
{
    public function handle($request, \Closure $next)
    {
        // $uri = $request->path();

        if($this->app->isDownForMaintenance() && $request->is('api/*')){
          return response()->json([
            'code' => '4444',
            'message' => '服务器维护中...',
            'data' => [],
          ]);
        }

        return parent::handle($request, $next);
    }
}

这样，所有的 API 请求都会返回正常的 json 格式数据了：

// api 请求结果：
{
    "code": "4444",
    "message": "服务器维护中...",
    "data": []
}