如何在将要在生产中呈现的模板中使用“dump()”twig 函数？

Question

我想在我们的测试环境中实现一个调试输出，我想在其中输出应用程序发送的服务请求。

为此，我想使用 symfony/twig 函数 dump()，因为这里的输出针对所有类型的变量进行了精美的格式化，并且还提供了打开和关闭结构的选项。

伪代码是这样的

{% if debugEnabled %}
     {{dump (debugInfos)}}
{% endif %}

不幸的是，“dump”是 Symfony DebugBundle 的一部分，出于充分的原因，它没有在 Prod 环境中加载，应该保持这种状态：

Symfony\Bundle\DebugBundle\DebugBundle::class => ['dev' => true, 'test' => true],

在 Symfony 文档中说：

根据设计，dump() 函数仅在开发和测试中可用 环境，以避免在生产中泄露敏感信息。在 事实上，尝试在 prod 环境中使用 dump() 函数会 导致 PHP 错误。

我根本不想在生产环境中使用dump()，而只想在本地输出我们的服务请求。

但是，我无法实现上述代码，因为生产中总是会出现错误（未定义函数dump()）当然，因为根本没有加载dump()。

Answer 1

您可以创建自己的函数来测试扩展是否已加载。 正如您在source 中看到的那样，函数twig_var_dump 已注册，因此您可以测试该函数是否存在以确定是否加载了调试扩展。

只要你的扩展在调试扩展之后被加载

，你应该可以将你自己的函数注册为dump

namespace App\Twig;

use Twig\Extension\AbstractExtension;
use Twig\TwigFunction;
use Twig\Environment;

class AppExtension extends AbstractExtension
{
    public function getFunctions()
    {
        return [
            new TwigFunction('dump', [$this, 'dump'] , ['needs_context' => true, 'needs_environment' => true, ]),
        ];
    }

    public function dump(Environment $env, $context, ...$vars)
    {
        if (!function_exists('\twig_var_dump')) return;
        return \twig_var_dump($env, $context, ...$vars);
    }
}

---

旁注：未对此进行测试，但应该可以使用

Answer 2

创建您自己的仅在生产中加载的扩展。

在您的 src 目录中创建一个文件夹（例如 Twig）。 如果您使用默认值，则将该文件夹排除在自动装配之外：

    App\:
        resource: '../src/'
        exclude:
            - '../src/DependencyInjection/'
            - '../src/Entity/'
            - '../src/Kernel.php'
            - '../src/Tests/'
            - '../src/Twig/' # This is the directory excluded from autowiring

然后用这个内容创建一个config/services_prod.yaml 文件：

services:
    App\Twig\FakeDebugExtension: # replace with your class name
        tags:
            - twig.extension # not needed if you use autoconfiguration

然后用这个内容创建一个类：

<?php

namespace App\Twig;

use Twig\Extension\AbstractExtension;
use Twig\TwigFunction;

final class FakeDebugExtension extends AbstractExtension
{
    public function getFunctions(): array
    {
        return [
            new TwigFunction('dump', [$this, 'fakeDump']),
        ];
    }

    public function fakeDump(...$arguments): void
    {
    }
}