应用配置

bean配置

应用配置数据是由一个bean对象管理的,可以在 app/bean.php 文件设置应用配置参数

return [
    'config'   => [
        'path' => __DIR__ . '/../config',
    ],
];

可配置项:

  • path 自定配置文件路径
  • base 主文件名称,默认 base (其他文件的数据都会按文件名为key合并到主文件数据中)
  • type 配置文件类型,默认 php 同时也支持 yaml 格式
  • parser 配置解析器,默认已经配置 php/yaml 解析器。
  • env 配置当前环境比如 dev/test/pre/pro

数据格式

配置目录所有配置文件会解析成一个数组,但是不会递归合并数据,只会合并当前目录文件数据,以它的文件名称为数组 key 进行合并数组。比如 config 目录配置文件如下

|-- base.php
|-- data.php
`-- pro
    |-- base.php
    `-- data.php

只会解析当前目录文件数据,不会递归解析数据。当前使用 env 配置时,环境目录里面的配置信息会覆盖最外层文件名称相同的数据。提醒:配置文件里面可以使用 env()函数读取环境配置。

base.php

return [
    'key' => 'value'
];

data.php

return [
    'dkey' => [
        'dvalue'
    ],
    'key' => 'value'
];

/pro/base.php

return [
    'key' => 'valuePro'
];

/pro/data.php

return [
    'key' => 'valuePro'
];

如上配置文件,当不配置 env 参数,合并的数据格式如下:

return [
    'key' => 'value',
    'data' => [
        'dkey' => [
            'dvalue'
        ],
        'key' => 'value'
    ]
];

当配置 env=pro 参数,合并的数据格式如下:

return [
    'key' => 'valuePro',
    'data' => [
        'dkey' => [
            'dvalue'
        ],
        'key' => 'valuePro'
    ]
];

获取配置

框架提全局函数、注解、config 对象多种方式,使用应用配置数据。

函数

全局函数使用 config()

config(string $key = null, mixed $default = null):mixed
  • key 配置参数 key,子数组可以使用 . 分割,比如上面的例子 data.dkey 可以获取到 ["dvalue"], 当key=null 获取所有配置参数
  • default 默认参数,如果 key 参数不存在,返回默认值,默认值可以是任意类型

注解

通过容器使用注解的方式,注入配置到属性值。

use Swoft\Bean\Annotation\Mapping\Bean;
use Swoft\Config\Annotation\Mapping\Config;

/**
* @Bean()
*/
class Demo
{
    /**
    * @Config("data.dkey")
    */
    private $dvalue = [];

    // ...
}

此例子和上面功能一样,都是读取相同的数据,两种不同的方式。

使用注解,一定要保证类是一个bean对象(通过其它注解注入到容器)

对象

如果上面两种方式还不能满足你的业务需求,你可以从容器里面获取配置对象,里面自带很多方式操作配置数据。

use Swoft\Bean\BeanFactory;

$config = BeanFactory::getBean('config');

config 对象常用方法

  • get(string $key, $default = null) 获取参数
  • offsetGet($key) 获取参数
  • ....
/docs/2.x/zh-CN/config/config.html
progress-bar