上下文

• 介绍
  • 工作原理
• 捕获上下文
  • 堆栈
• 检索上下文
  • 确定项目存在
• 移除上下文
• 隐藏上下文
• 事件
  • 脱水
  • 水合

介绍

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

工作原理

了解 Laravel 上下文功能的最佳方法是使用内置日志功能查看其实际操作。要开始，您可以使用 Context facade 将信息添加到上下文中。在此示例中，我们将使用 中间件 在每个传入请求上将请求 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
{
    /**
     * 处理传入请求。
     */
    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('用户已认证。', ['auth_id' => Auth::id()]);

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

用户已认证。 {"auth_id":27} {"url":"https://example.com/login","trace_id":"e04e1a11-e75c-4db3-b5b5-cfef4ef56697"}

添加到上下文中的信息也可以用于调度到队列的作业。例如，假设我们在将一些信息添加到上下文后调度一个 ProcessPodcast 作业到队列：

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

// 在我们的控制器中...
ProcessPodcast::dispatch($podcast);

当作业被调度时，当前存储在上下文中的任何信息都会被捕获并与作业共享。捕获的信息随后在作业执行时被重新水合到当前上下文中。因此，如果我们的作业的 handle 方法要写入日志：

class ProcessPodcast implements ShouldQueue
{
    use Queueable;

    // ...

    /**
     * 执行作业。
     */
    public function handle(): void
    {
        Log::info('处理播客。', [
            'podcast_id' => $this->podcast->id,
        ]);

        // ...
    }
}

生成的日志条目将包含在最初调度作业的请求期间添加到上下文中的信息：

处理播客。 {"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::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("将用户 [{$userId}] 添加到好友列表。");
        // 将用户 [987] 添加到好友列表。  {"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

如果上下文中的对象在作用域闭包内被修改，则该变更将在作用域外反映出来。

堆栈

上下文提供了创建“堆栈”的能力，这些堆栈是按添加顺序存储的数据列表。您可以通过调用 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;

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 方法可用于检索上下文中的信息子集：

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

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

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

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

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

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

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

如果您想检索存储在上下文中的所有信息，可以调用 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']);

隐藏上下文

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

use Illuminate\Support\Facades\Context;

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

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

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

“隐藏”方法镜像上面记录的非隐藏方法的功能：

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

事件

上下文调度两个事件，允许您挂钩到上下文的水合和脱水过程。

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

脱水

每当作业被调度到队列时，上下文中的数据就会被“脱水”并与作业的负载一起捕获。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，因为这会更改当前进程的上下文。确保您只对传递给回调的存储库进行更改。

水合

每当队列上的作业开始执行时，与作业共享的任何上下文都会被“水合”回当前上下文。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，而应确保只对传递给回调的存储库进行更改。