上下文

简介

Laravel 的"上下文"功能使你能够在应用程序中执行的请求、任务和命令之间捕获、检索和共享信息。此捕获的信息也包含在应用程序编写的日志中，让你能够更深入地了解日志条目写入之前发生的周围代码执行历史，并允许你在分布式系统中追踪执行流程。

工作原理

理解 Laravel 上下文功能的最佳方式是使用内置的日志功能来观察它的实际运作。首先，你可以使用 Context facade 将信息添加到上下文。在这个示例中，我们将使用一个 middleware 在每个传入请求上将请求 URL 和唯一的追踪 ID 添加到上下文中：

<?php

namespace App\Http\Middleware;

use Closure;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Context;
use Illuminate\Support\Str;
use Symfony\Component\HttpFoundation\Response;

class AddContext
{
    /**
     * Handle an incoming request.
     */
    public function handle(Request $request, Closure $next): Response
    {
        Context::add('url', $request->url());
        Context::add('trace_id', Str::uuid()->toString());

        return $next($request);
    }
}

添加到上下文的信息会自动作为元数据附加到整个请求期间编写的任何日志条目中。将上下文作为元数据附加允许将传递给各个日志条目的信息与通过 Context 共享的信息区分开来。例如，假设我们编写以下日志条目：

Log::info('User authenticated.', ['auth_id' => Auth::id()]);

写入的日志将包含传递给日志条目的 auth_id，但它还将包含上下文的 url 和 trace_id 作为元数据：

User authenticated. {"auth_id":27} {"url":"https://example.com/login","trace_id":"e04e1a11-e75c-4db3-b5b5-cfef4ef56697"}

添加到上下文的信息也可用于分发到队列的任务。例如，假设我们在向上下文添加一些信息后，将 ProcessPodcast 任务分发到队列：

// 在我们的 middleware 中...
Context::add('url', $request->url());
Context::add('trace_id', Str::uuid()->toString());

// 在我们的 controller 中...
ProcessPodcast::dispatch($podcast);

当任务被分发时，当前存储在上下文中的所有信息都会被捕获并与任务共享。然后在任务执行时，捕获的信息会被注入回当前上下文。因此，如果我们任务的 handle 方法要写入日志：

class ProcessPodcast implements ShouldQueue
{
    use Queueable;

    // ...

    /**
     * 执行任务。
     */
    public function handle(): void
    {
        Log::info('Processing podcast.', [
            'podcast_id' => $this->podcast->id,
        ]);

        // ...
    }
}

生成的日志条目将包含在最初分发任务的请求期间添加到上下文中的信息：

Processing podcast. {"podcast_id":95} {"url":"https://example.com/login","trace_id":"e04e1a11-e75c-4db3-b5b5-cfef4ef56697"}

虽然我们关注的是 Laravel 上下文的内置日志相关功能，但以下文档将说明上下文如何允许你跨 HTTP 请求/队列任务边界共享信息，甚至如何添加不随日志条目写入的隐藏上下文数据。

捕获上下文

你可以使用 Context facade 的 add 方法将信息存储在当前上下文中：

use Illuminate\Support\Facades\Context;

Context::add('key', 'value');

要一次添加多个项，你可以将关联数组传递给 add 方法：

Context::add([
    'first_key' => 'value',
    'second_key' => 'value',
]);

add 方法将覆盖具有相同键的任何现有值。如果你只想在键不存在时才向上下文添加信息，可以使用 addIf 方法：

Context::add('key', 'first');

Context::get('key');
// "first"

Context::addIf('key', 'second');

Context::get('key');
// "first"

Context 还提供了方便的方法来递增或递减给定键。这两个方法都至少接受一个参数：要跟踪的键。可以提供第二个参数来指定键应递增或递减的量：

Context::increment('records_added');
Context::increment('records_added', 5);

Context::decrement('records_added');
Context::decrement('records_added', 5);

条件上下文

when 方法可用于根据给定条件向上下文添加数据。如果给定条件计算为 true，则会调用提供给 when 方法的第一个闭包，如果条件计算为 false，则会调用第二个闭包：

use Illuminate\Support\Facades\Auth;
use Illuminate\Support\Facades\Context;

Context::when(
    Auth::user()->isAdmin(),
    fn ($context) => $context->add('permissions', Auth::user()->permissions),
    fn ($context) => $context->add('permissions', []),
);

作用域上下文

scope 方法提供了一种在给定回调执行期间临时修改上下文，并在回调执行完毕时将上下文恢复到原始状态的方式。此外，你可以传递额外的数据（作为第二个和第三个参数），这些数据应在闭包执行时合并到上下文中。

use Illuminate\Support\Facades\Context;
use Illuminate\Support\Facades\Log;

Context::add('trace_id', 'abc-999');
Context::addHidden('user_id', 123);

Context::scope(
    function () {
        Context::add('action', 'adding_friend');

        $userId = Context::getHidden('user_id');

        Log::debug("Adding user [{$userId}] to friends list.");
        // Adding user [987] to friends list.  {"trace_id":"abc-999","user_name":"taylor_otwell","action":"adding_friend"}
    },
    data: ['user_name' => 'taylor_otwell'],
    hidden: ['user_id' => 987],
);

Context::all();
// [
//     'trace_id' => 'abc-999',
// ]

Context::allHidden();
// [
//     'user_id' => 123,
// ]

WARNING

如果在作用域闭包内修改了上下文中的对象，该修改将反映在作用域之外。

栈

Context 提供了创建"栈"的能力，栈是按添加顺序存储的数据列表。你可以通过调用 push 方法向栈中添加信息：

use Illuminate\Support\Facades\Context;

Context::push('breadcrumbs', 'first_value');

Context::push('breadcrumbs', 'second_value', 'third_value');

Context::get('breadcrumbs');
// [
//     'first_value',
//     'second_value',
//     'third_value',
// ]

栈可用于捕获有关请求的历史信息，例如在整个应用程序中发生的事件。例如，你可以创建一个事件监听器，在每次执行查询时向栈中推送，捕获查询 SQL 和持续时间作为元组：

use Illuminate\Support\Facades\Context;
use Illuminate\Support\Facades\DB;

// 在 AppServiceProvider.php 中...
DB::listen(function ($event) {
    Context::push('queries', [$event->time, $event->sql]);
});

你可以使用 stackContains 和 hiddenStackContains 方法来确定值是否在栈中：

if (Context::stackContains('breadcrumbs', 'first_value')) {
    //
}

if (Context::hiddenStackContains('secrets', 'first_value')) {
    //
}

stackContains 和 hiddenStackContains 方法还接受闭包作为其第二个参数，允许对值比较操作进行更多控制：

use Illuminate\Support\Facades\Context;
use Illuminate\Support\Str;

return Context::stackContains('breadcrumbs', function ($value) {
    return Str::startsWith($value, 'query_');
});

检索上下文

你可以使用 Context facade 的 get 方法从上下文中检索信息：

use Illuminate\Support\Facades\Context;

$value = Context::get('key');

only 和 except 方法可用于检索上下文中信息的子集：

$data = Context::only(['first_key', 'second_key']);

$data = Context::except(['first_key']);

pull 方法可用于从上下文中检索信息并立即将其从上下文中删除：

$value = Context::pull('key');

如果上下文数据存储在栈中，你可以使用 pop 方法从栈中弹出项：

Context::push('breadcrumbs', 'first_value', 'second_value');

Context::pop('breadcrumbs');
// second_value

Context::get('breadcrumbs');
// ['first_value']

remember 和 rememberHidden 方法可用于从上下文中检索信息，如果请求的信息不存在，则将上下文值设置为给定闭包返回的值：

$permissions = Context::remember(
    'user-permissions',
    fn () => $user->permissions,
);

如果你想检索存储在上下文中的所有信息，可以调用 all 方法：

$data = Context::all();

确定项是否存在

你可以使用 has 和 missing 方法来确定上下文是否为给定键存储了任何值：

use Illuminate\Support\Facades\Context;

if (Context::has('key')) {
    // ...
}

if (Context::missing('key')) {
    // ...
}

has 方法将返回 true，无论存储的值是什么。因此，例如，值为 null 的键将被视为存在：

Context::add('key', null);

Context::has('key');
// true

删除上下文

forget 方法可用于从当前上下文中删除键及其值：

use Illuminate\Support\Facades\Context;

Context::add(['first_key' => 1, 'second_key' => 2]);

Context::forget('first_key');

Context::all();

// ['second_key' => 2]

你可以通过向 forget 方法提供数组来一次忘记多个键：

Context::forget(['first_key', 'second_key']);

隐藏上下文

Context 提供了存储"隐藏"数据的能力。此隐藏信息不会附加到日志中，也无法通过上面记录的数据检索方法访问。Context 提供了一组不同的方法来与隐藏上下文信息交互：

use Illuminate\Support\Facades\Context;

Context::addHidden('key', 'value');

Context::getHidden('key');
// 'value'

Context::get('key');
// null

"hidden" 方法与上面记录的非隐藏方法的功能相同：

Context::addHidden(/* ... */);
Context::addHiddenIf(/* ... */);
Context::pushHidden(/* ... */);
Context::getHidden(/* ... */);
Context::pullHidden(/* ... */);
Context::popHidden(/* ... */);
Context::onlyHidden(/* ... */);
Context::exceptHidden(/* ... */);
Context::allHidden(/* ... */);
Context::hasHidden(/* ... */);
Context::missingHidden(/* ... */);
Context::forgetHidden(/* ... */);

事件

Context 分发两个事件，允许你挂钩到上下文的注入和脱水过程中。

为了说明这些事件如何使用，假设在应用程序的 middleware 中，你根据传入 HTTP 请求的 Accept-Language 头设置 app.locale 配置值。Context 的事件允许你在请求期间捕获此值并在队列上恢复它，确保在队列上发送的通知具有正确的 app.locale 值。我们可以使用 context 的事件和隐藏数据来实现这一点，以下文档将进行说明。

脱水

每当任务被分发到队列时，上下文中的数据会被"脱水"并与任务的有效负载一起捕获。Context::dehydrating 方法允许你注册一个闭包，该闭包将在脱水过程中被调用。在此闭包中，你可以对将与队列任务共享的数据进行更改。

通常，你应该在应用程序的 AppServiceProvider 类的 boot 方法中注册 dehydrating 回调：

use Illuminate\Log\Context\Repository;
use Illuminate\Support\Facades\Config;
use Illuminate\Support\Facades\Context;

/**
 * 引导任何应用程序服务。
 */
public function boot(): void
{
    Context::dehydrating(function (Repository $context) {
        $context->addHidden('locale', Config::get('app.locale'));
    });
}

NOTE

你不应该在 dehydrating 回调中使用 Context facade，因为这会更改当前进程的上下文。确保只对传递给回调的 repository 进行更改。

注入

每当队列任务开始在队列上执行时，与该任务共享的任何上下文都将被"注入"回当前上下文。Context::hydrated 方法允许你注册一个闭包，该闭包将在注入过程中被调用。

通常，你应该在应用程序的 AppServiceProvider 类的 boot 方法中注册 hydrated 回调：

use Illuminate\Log\Context\Repository;
use Illuminate\Support\Facades\Config;
use Illuminate\Support\Facades\Context;

/**
 * 引导任何应用程序服务。
 */
public function boot(): void
{
    Context::hydrated(function (Repository $context) {
        if ($context->hasHidden('locale')) {
            Config::set('app.locale', $context->getHidden('locale'));
        }
    });
}

NOTE

你不应该在 hydrated 回调中使用 Context facade，而应确保只对传递给回调的 repository 进行更改。