一分钟laravel8-给接口加上日志记录功能

无聊D木木

已于 2023-07-24 11:03:36 修改

阅读量1k

点赞数

CC 4.0 BY-SA版权

文章标签： php laravel

于 2023-07-13 11:14:27 首次发布

本文链接：https://blog.csdn.net/u011647720/article/details/131697652

1、先创建一个中间件。

php artisan make:middleware LogApiMiddleware

2、然后修改该中间件为以下内容：

<?php

namespace App\Http\Middleware;

use Closure;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Log;

class LogApiMiddleware
{
    /**
     * Handle an incoming request.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  \Closure(\Illuminate\Http\Request): (\Illuminate\Http\Response|\Illuminate\Http\RedirectResponse)  $next
     * @return \Illuminate\Http\Response|\Illuminate\Http\RedirectResponse
     */
    public function handle(Request $request, Closure $next)
    {
        if (config('app.env') === 'local') {
            $startTime = now();
            $requestData = [
                'url' => $request->fullUrl(),
                'method' => $request->method(),
                'parameters' => $request->all(),
            ];
            $response = $next($request);
            $endTime = now();
            $executionTime = $endTime->diffInMilliseconds($startTime);
            // 记录响应内容
            Log::info('log.api', ['request' => $requestData,'body' => json_decode($response->getContent(),true), 'execution_time' => $executionTime.' milliseconds']);
            return $response;
        }
        return $next($request);
    }
}

3、然后在app/Http/Kernel.php文件的middlewareGroups的api数组里加入日志记录中间件的数据记录。

protected $middlewareGroups = [
        'web' => [
            \App\Http\Middleware\EncryptCookies::class,
            \Illuminate\Cookie\Middleware\AddQueuedCookiesToResponse::class,
            \Illuminate\Session\Middleware\StartSession::class,
            // \Illuminate\Session\Middleware\AuthenticateSession::class,
            \Illuminate\View\Middleware\ShareErrorsFromSession::class,
            // \App\Http\Middleware\VerifyCsrfToken::class,
            \Illuminate\Routing\Middleware\SubstituteBindings::class,
        ],

        'api' => [
            // \Laravel\Sanctum\Http\Middleware\EnsureFrontendRequestsAreStateful::class,
            'throttle:api',
            \Illuminate\Routing\Middleware\SubstituteBindings::class,
            \App\Http\Middleware\LogApiMiddleware::class, // 日志记录中间件
        ],
    ];

为什么添加在api的数组里就可以使路由生效？

可以看一下app\Providers\RouteServiceProvider.php的文件内容，里面的调用方法->middleware('api')就是代指的是该kernel.php下的api路由分组。

<?php

namespace App\Providers;

use Illuminate\Cache\RateLimiting\Limit;
use Illuminate\Foundation\Support\Providers\RouteServiceProvider as ServiceProvider;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\RateLimiter;
use Illuminate\Support\Facades\Route;

class RouteServiceProvider extends ServiceProvider
{
    /**
     * The path to the "home" route for your application.
     *
     * This is used by Laravel authentication to redirect users after login.
     *
     * @var string
     */