Yii2 模块参数配置最佳实践详解

// 错误的模块参数加载方式示例
public function init()
{
    parent::init();

    // 尝试从外部文件加载配置
    \Yii::configure($this, require __DIR__ . '/config/main.php');
}

// 模块目录下的 config/main.php (不推荐用于模块参数)
<?php

$params = ['data' => ['default_value']]; // 初始参数

if (YII_ENV == 'dev') {
    // 开发环境合并更多参数
    $params = array_merge(
        require __DIR__ . '/../../../../common/config/params.php',
        require __DIR__ . '/../../../../common/config/params-local.php',
        require __DIR__ . '/params.php' // 模块自身的参数文件
    );
} else {
    // 生产环境合并参数
    $params = array_merge(
        require __DIR__ . '/../../../../common/config/params.php',
        require __DIR__ . '/params.php'
    );
}

return [
    'params' => $params, // 返回一个包含 'params' 键的数组
];

// modules/your_module_id/Module.php
namespace app\modules\your_module_id;

class Module extends \yii\base\Module
{
    /**
     * @var array 模块的自定义参数
     */
    public $params = [];

    // ... 其他属性或方法
}

// modules/your_module_id/Module.php
namespace app\modules\your_module_id;

class Module extends \yii\base\Module
{
    /**
     * @var array 模块的自定义参数
     */
    public $params = [];

    /**
     * {@inheritdoc}
     */
    public function init()
    {
        parent::init();

        // 1. 定义模块自身的默认参数
        $moduleParams = [
            'data' => ['item1', 'item2'],
            'setting1' => 'value1',
        ];

        // 2. 加载模块特有的本地参数文件（可选，推荐使用params.php）
        // 例如：modules/your_module_id/config/params.php
        $localModuleParamsFile = __DIR__ . '/config/params.php';
        if (file_exists($localModuleParamsFile)) {
            $moduleParams = array_merge($moduleParams, require $localModuleParamsFile);
        }

        // 3. 根据环境合并应用公共参数（如果需要）
        $commonParams = [];
        $commonConfigFile = \Yii::getAlias('@common/config/params.php');
        if (file_exists($commonConfigFile)) {
            $commonParams = require $commonConfigFile;
        }

        $commonLocalConfigFile = \Yii::getAlias('@common/config/params-local.php');
        if (YII_ENV_DEV && file_exists($commonLocalConfigFile)) {
            $commonParams = array_merge($commonParams, require $commonLocalConfigFile);
        }

        // 4. 将所有参数合并到模块的 $params 属性中
        $this->params = array_merge($commonParams, $moduleParams);

        // 如果模块还需要进行其他配置，例如组件注册等
        // \Yii::configure($this, require __DIR__ . '/config/web.php'); // 例如加载模块的组件配置
    }
}

<?php
// 这个文件可以存放模块特有的、可能需要环境区分的参数
return [
    'data' => ['specific_item_a', 'specific_item_b'],
    'api_key' => YII_ENV_DEV ? 'dev_api_key' : 'prod_api_key',
    'setting2' => 'module_specific_value',
];

// 在控制器中访问模块参数
namespace app\modules\your_module_id\controllers;

use yii\web\Controller;
use Yii;

class DefaultController extends Controller
{
    public function actionIndex()
    {
        // 假设模块ID为 'payment'
        $module = Yii::$app->getModule('payment');

        // 访问 'data' 参数
        if (isset($module->params['data'])) {
            $data = $module->params['data'];
            \yii\helpers\VarDumper::dump($data, 10, true);
        } else {
            echo "Parameter 'data' not found in module 'payment'.";
        }

        // 访问 'api_key' 参数
        if (isset($module->params['api_key'])) {
            $apiKey = $module->params['api_key'];
            echo "<br>API Key: " . $apiKey;
        }
    }
}