Yaconf – 一个高性能的配置管理扩展

随着PHP7的发布, 新增了不少持久化类型的支持好比IS_IMMUTABLE_ARRAY, 因而我就在PHP7下从新开发了Yaconf, 开源出来, 方便你们使用.
简介

首先说说, 这个是干啥的.

1. 我见过不少的项目中, 用PHP文件作配置的, 一个config目录下可能有十几个甚至数十个.php配置文件, 里面都是各类各样的array, 还有甚者会把一些词典文件(好比中文/英文对照)也放到配置中去. 这就致使配置文件的解析耗费了很大的性能(诚然, 用了opcache能好点, 可是实际上仍是有执行的过程).

2. 除了PHP的, 还有用json的, yaml的, 一个共同的特色就是这些配置的可读性比较差. 另外, 他们也都要runtime解析.

3. config目录每每和代码在一块儿, 首先会有安全隐患(配置中每每有敏感信息), 其次若是配置和代码属于一个项目, 这就会致使配置的修改也要走代码上线的流程.

4. 一些资源配置文件, 好比mysql/memcache的配置信息, 这些内容原本是应该对开发透明的, 运维直接负责便可. 可是放到了代码中就会致使, 运维若是要发起一些变动, 也要开发配合修改配置文件上线.

因此, Yaconf就是为了解决这些问题而生的一个工具.

1. 它使用单独的一个配置目录(在yaconf.directory指定), 不和代码在一块儿.

2. 它在PHP启动的时候, 处理全部的要处理的配置, 而后这些配置就会常驻内存, 随着PHP的生命周期存亡. 避免了每次请求的时候解析配置文件.

3. 全部的配置内容都是immutable的, 这就能够借助于Fork的COW, 下降内存占用, 而且在访问配置的时候, 几乎不须要任何的内存Copy, 也不会有无谓的引用计数增减

4. 最重要的, 配置目录和代码分离之后, 能够借助一个配置管理后台, 来实现配置的统一化管理.

5. 它支持(对于非ZTS)配置变动从新加载, 也就是说配置若是有变化(建议更改配置必定使用mv, 不要使用cp), 它会reload, 不须要重启(检测的频率由yaconf.check_delay控制).

6. 它支持丰富的配置类型, 包括字符串, 数组, 分节, 分节继承, 而且还能够在配置中直接写PHP的常量和环境变量等.

7. 最重要的是, 它很简单.
   API

Yaconf 只提供了俩个方法,

mixed Yaconf::get(string $name, mixed $default = NULL)

这个是获取一个配置, 名字是配置的名字, 通常来讲若是你有一个ini文件叫作foo.ini, 那么$name使用foo的话就会获取到这个文件内的全部内容, 以数组形式返回. default是当配置不存在的时候返回的默认值.
bool Yaconf::has(string $name)

这个是检测一个配置是否存在.

Yaconf的配置项

yaconf.directory

配置文件目录, 这个配置不能经过ini_set指定, 由于必须在PHP启动的时候就肯定好.
yaconf.check_delay

多久(秒)检测一次文件变更, 若是是0就是不检测, 也就是说若是是0的时候, 文件变动只能经过重启PHP从新加载

配置的格式

Yaconf采用ini文件做为配置文件, 这是由于我一直以为ini是最适合作配置文件的, key-value格式, 清晰可读.

简单的配置写起来以下(如下所有假设ini文件的名字是test):

foo="bar"
phpversion=PHP_VERSION
env=${HOME}

如上所示, 对于通常的配置咱们都用引号引发来. 而对于没有引发来的, 会尝试以PHP的常量作解释, 也就是说咱们能够直接在配置里面写PHP的常量.

另外你也看到了, 咱们能够直接在配置中写环境变量, 好比上面的env:

Yaconf::get("test.env"); //test是配置文件名字
//string(16) "/home/huixinchen"

如上面所示, 你能够看到, 假设对于foo的值, 你能够经过以下代码访问:

Yaconf::get("test.foo"); //test是配置文件名字

Yaconf也支持数组类型的配置, 写法以下:

arr[]=1
arr.1=2

如上面所示你能够直接使用foo[]这种形式来定义数组, 也可使用arr.1, arr.2来指定key定义.

对于数组的第二个值, 你能够经过以下代码访问:

Yaconf::get("test.arr.1"); //test是配置文件名字

或者你能够经过获取整个arr数组以后访问:

$arr = Yaconf::get("test.arr"); //test是配置文件名字
echo $arr[1];

Yaconf也支持map类型的配置, 写法以下:

map.foo=bar
map.bar=foo
 
;你可使用分号来写注释
map2.foo.name=yaconf
map2.foo.year=2015

对于map2的foo子map的name值能够经过以下形式访问:

Yaconf::get("test.map2.foo.name"); //test是配置文件名字

而且, 配置文件还能够分节, 和分节继承:

[parent]
parent="base"
children="NULL"
 
[children : parent]
children="children"

请注意配置的分节继承的语法 children:(冒号)parent, 这的意思是children节继承所有base的配置项. 而后你在children节里面定义的和parent节中同名的配置, 会覆盖掉parent中定义的内容.

对于chidlren节的children配置的值能够经过以下形式访问:

Yaconf::get("test.children.children"); //test是配置文件名字

样例

首先, 假设咱们的全部的配置文件都放置在/tmp/yaconf中, 那么咱们就须要在php.ini中增长以下配置:

yaconf.directory=/tmp/yaconf

这样yaconf在PHP启动的时候, 就会在这个目录下找全部的.ini文件, 而后尝试处理他们. 这里要注意的是不支持多级目录, 也就是说, yaconf只会处理yaconf.directory内的.ini文件, 不会处理子目录里面的(这主要是为了简单考虑, 由于有分节, 你就能够一个项目定义一个ini文件).

假设/tmp/yaconf下有俩个ini文件, 分别是:

foo.ini

name="yaconf"
year=2015
features[]="fast"
features.1="light"
features.plus="zero-copy"
features.constant=PHP_VERSION

bar.ini

[base]
parent="yaconf"
children="NULL"
 
[children:base]
children="set"

而后对于foo的内容:

php7 -r 'var_dump(Yaconf::get("foo"));'
/*
array(3) {
  ["name"]=>
  string(6) "yaconf"
  ["year"]=>
  string(4) "2015"
  ["features"]=>
  array(4) {
    [0]=>
    string(4) "fast"
    [1]=>
    string(5) "light"
    ["plus"]=>
    string(9) "zero-copy"
    ["constant"]=>
    string(9) "7.0.0-dev"
  }
}
*/

对于bar的内容:

php7 -r 'var_dump(Yaconf::get("bar"));'
/*
array(2) {
  ["base"]=>
  array(2) {
    ["parent"]=>
    string(6) "yaconf"
    ["children"]=>
    string(4) "NULL"
  }
  ["children"]=>
  array(2) {
    ["parent"]=>
    string(6) "yaconf"
    ["children"]=>
    string(3) "set"
  }
}
*/

固然你能够用 (.)连接语法精确访问任何一个特定的值.
最后

个人Ya系列扩展今后又多了一个新成员, 算上以前的Yaf(PHP框架), Yar(PHP RPC框架), Yac(PHP单机缓存), 你们就能够很容易搭建一套高性能的LAMP应用解决方案出来.最后: Yaconf要求PHP7才能用, 而PHP7的alpha1版本今天已经发布了, 欢迎你们测试(关于alpha不alpha, 只要你的项目没有触发到有bug的地方, 那么对你来讲就能够用, 不是么? )