RuntimeConfigBundle 技术文档

1. 安装指南

步骤 1: 使用 Composer 下载 OpenSkyRuntimeConfigBundle

首先，使用 Composer 安装该 Bundle：

$ composer require opensky/runtime-config-bundle

步骤 2: 启用 Bundle

在 Symfony 的 AppKernel.php 文件中启用该 Bundle：

<?php

// app/AppKernel.php

public function registerBundles()
{
    return [
        new OpenSky\Bundle\RuntimeConfigBundle\OpenSkyRuntimeConfigBundle(),
    ];
}

步骤 3: 配置 config.yml

在 config.yml 中配置 RuntimeParameterBag：

# app/config/config.yml

opensky_runtime_config:
    provider: parameter.provider.service
    cascade:  true
    logging:
        enabled: true
        level:   debug

配置项说明：

• provider: 实现 ParameterProviderInterface 的服务。如果使用 Doctrine ORM 作为数据源，可以是 EntityRepository。
• cascade: 如果为 true，调用 get() 时会从服务容器中获取未定义的参数。
• logging.enabled: 是否启用日志记录访问未定义参数的行为。
• logging.level: 日志级别。

2. 项目的使用说明

注入参数

假设 my.service 依赖一个动态参数 my.service.enabled，可以使用 Symfony 的表达式语言语法注入参数：

XML 配置

推荐在 Bundle 中定义服务时使用 XML：

<?xml version="1.0" ?>

<!-- src/AppBundle/Resources/config/services.xml -->

<services>
    <service id="my.service" class="MyService">
        <argument type="expression">service('opensky.runtime_config').get('my.service.enabled')</argument>
    </service>
</services>

YAML 配置

推荐在应用全局服务中使用 YAML：

# app/config/services.yml

services:

    my.service:
        class: MyService
        arguments:
            - "@=service('opensky.runtime_config').get('my.service.enabled')"

级联模式

如果启用了级联模式，get() 方法会尝试从服务容器中获取未定义的运行时参数：

<?xml version="1.0" ?>

<!-- src/AppBundle/Resources/config/services.xml -->

<parameters>
    <parameter key="my.service.enabled">false</parameter>
</parameters>

<services>
    <service id="my.service" class="MyService">
        <argument type="expression">service('opensky.runtime_config').get('my.service.enabled')</argument>
    </service>
</services>

在这个例子中，即使 my.service.enabled 未在运行时配置中定义，get('my.service.enabled') 也会返回 false。

3. 项目 API 使用文档

RuntimeParameterBag 服务

RuntimeParameterBag 服务提供了以下方法：

• get(string $name): 获取指定名称的参数值。
• has(string $name): 检查是否存在指定名称的参数。
• all(): 获取所有参数。

参数提供者

参数提供者是一个实现 ParameterProviderInterface 的服务，通常是一个 EntityRepository。它负责从数据源中获取参数。

日志记录

如果启用了日志记录，访问未定义参数的行为将被记录。日志将发送到 opensky.runtime_config 通道。

4. 项目安装方式

项目的安装方式已经在“安装指南”部分详细说明。总结如下：

1. 使用 Composer 安装 Bundle。
2. 在 AppKernel.php 中启用 Bundle。
3. 在 config.yml 中配置 RuntimeParameterBag。

通过以上步骤，您可以成功安装并配置 RuntimeConfigBundle，并开始使用其提供的动态参数注入功能。