Symfony 使用 PsySHBundle 的最佳实践教程-CSDN博客

Symfony 使用 PsySHBundle 的最佳实践教程

PsyshBundle A command line REPL bundle for Symfony using PsySH. 项目地址: https://gitcode.com/gh_mirrors/ps/PsyshBundle

1. 项目介绍

PsyshBundle 是一个为 Symfony 框架设计的命令行 REPL（读取-执行-打印循环）bundle，它集成了 PsySH，这是一个 PHP 的交互式命令行调试工具。通过PsyshBundle，开发者可以在 Symfony 应用中方便地使用 PsySH 功能，进行代码调试和探索。

2. 项目快速启动

首先，确保你已经安装了 Symfony 应用，并且可以正常运行。

安装 PsyshBundle

在 Symfony 项目的根目录下运行以下命令来安装 PsyshBundle：

composer require --dev theofidry/psysh-bundle

配置PsyshBundle

接下来，需要在你的 app/AppKernel.php 文件中注册PsyshBundle（如果是 Symfony 5，这一步可以省略，因为bundle会自动注册）：

// app/AppKernel.php

public function registerBundles()
{
    // ...
    if (in_array($this->getEnvironment(), ['dev', 'test'])) {
        // ...
        $bundles[] = new Fidry\PsyshBundle\PsyshBundle();
    }
    // ...
}

使用Psysh

安装并配置完成后，就可以通过以下命令启动 PsySH：

bin/console psysh

或者在代码中使用 PsySH：

use function psysh;

class X
{
    function foo()
    {
        psysh(get_defined_vars(), $this);
        // 在当前上下文中进行调试
    }
}

3. 应用案例和最佳实践

添加自定义命令

你可以为 PsySH 添加自定义命令，只需定义一个服务并添加 psysh.command 标签：

# config/services.yaml

services:
    my_psysh_command:
        class: Acme\Shell\MyCommand
        tags:
            - { name: psysh.command }

如果使用 Symfony 3.3 或更高版本，可以利用自动配置简化这一步骤：

# config/services.yaml

services:
    _defaults:
        autoconfigure: true
        autowire: true
        public: false
    Acme\Shell\MyCommand:
        ~

确保自定义命令继承自 Psy\Command\ReflectingCommand 或 Psy\Command\Command。

添加自定义变量

可以在配置文件中添加自定义变量，使其在 PsySH 中可用：

# app/config/config_dev.yml

psysh:
    variables:
        foo: bar
        router: "@router"
        some: [thing, else]
        debug: "%kernel.debug%"

启动 PsySH 后，可以使用这些变量。