Press "Enter" to skip to content

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

这个项目其实不是我新的idea, 这个是我在来微博以后, 第一个优化项目中顺手做的一个小工具, 本身叫做Weibo_Conf. 但是因为Weibo_Conf是属于Weibo扩展的, 里面还有一些其他功能是专门为Weibo定制的. 所以不适合直接开源.
随着PHP7的发布, 新增了很多持久化类型的支持比如IS_IMMUTABLE_ARRAY, 于是我就在PHP7下重新开发了Yaconf, 开源出来, 方便大家使用.

项目地址

代码已经提交到了Github: https://github.com/laruence/yaconf , 欢迎大家提交Issue

简介

首先说说, 这个是干啥的.
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的地方, 那么对你来说就可以用, 不是么? ) 🙂

50 Comments

  1. boxnovel
    boxnovel September 30, 2019

    Introducing the project is quite interesting and interesting. I appreciate this project.

  2. doudou
    doudou July 1, 2019

    鸟哥,win10平台怎么进行安装php-devel,进行使用phpinze模块呢。

  3. qwe
    qwe June 26, 2019

    各位大佬,请教个问题。我一个项目的时候这样配置yaconf.directory=/tmp/yaconf。多个项目的时候配置文件目录肯定也是不一样的,这时候怎么配置呢?

    • 饭汤小国王
      饭汤小国王 December 27, 2019

      不支持多级目录,的确是个缺陷。
      第一,不可能把各种配置参数全部写在一个文件里。这样一个文件会越来越大。
      第二,即便把配置分门别类,多个项目无法共用同一个目录。只能用前缀的形式解决。
      1,使用项目前缀的形式,例如:
      项目 A: abc-app.ini,abc-mime.ini。
      项目 B: xyz-app.ini,xyz-mime.ini。
      2,不同的项目,启用不同的 PHP-FPM 实例。

  4. neo
    neo March 13, 2019

    Yaconf 是否可以支持多行配置啊
    例如:
    [default]
    ‘—–BEGIN PUBLIC KEY—–
    MIGfMAssfafeKFUIIVKLKKLLKKJGHJKaNh
    —–END PUBLIC KEY—–‘

  5. happy wheels
    happy wheels February 12, 2019

    感谢分享,虽然我还在学习当中,但是有大师们的提点我想我能学会的!!

  6. jim
    jim December 10, 2018

    2. 它在PHP启动的时候, 处理所有的要处理的配置, 然后这些配置就会常驻内存, 随着PHP的生命周期存亡. 避免了每次请求的时候解析配置文件.
    想知道php-fpm模式下,是启动每个进程时都会重新加载吗 还是多个进程也只会加载一次

  7. nuance
    nuance November 14, 2018

    这个和yaf里的配置设计相似啊,直接用yaf多方便

  8. dennlian
    dennlian November 7, 2018

    windows PHP 7.2 如果为directory设置一个不存在的目录,PHP可以启动,如果一个存在的目录,不管是空目录还是有INI文件,PHP都启动不起来, 7.1.x没发现这问题

    • madnesslin
      madnesslin November 19, 2018

      我也遇到了相同的问题

    • lyj
      lyj June 30, 2019

      我也遇见过这个问题,请问你现在解决了么?

    • hyj
      hyj July 11, 2019

      请问解决了吗

    • zxw
      zxw August 28, 2019

      我也是这种情况

    • renxiaotu
      renxiaotu January 3, 2020

      好消息,1.0.8版本解决了

  9. neo
    neo August 20, 2018

    Yaf_Config_Ini 这个会用到opcode缓存么?
    如果没用到,是不是还不如读取php原生数组的配置文件好?

  10. 何忠利
    何忠利 July 27, 2018

    无意听朋友说到这个扩展,解决了我思考一周左右的配置文件问题

  11. jackZer
    jackZer December 11, 2017

    There’s certainly a great deal to know about this issue. I like all of the points you have made.

  12. […] 最近鸟哥于2015-6-12日又搞出来了一个高性能的配置管理扩展Yaconf ,目前只支持php7,如果感兴趣的话,可以试试,见:http://www.laruence.com/2015/06/12/3051.html […]

  13. kaysen
    kaysen September 4, 2017

    使用PHP内置函数auto_prepend_file()就可以

  14. ian
    ian August 27, 2016

    你这框架封装的太深了,我在入口做POST,GET什么脏词过滤,最后用_request拿出来,什么都没过滤掉。 都不知道要在哪里改,总不能一个个单独过滤。提倡人性封装。

  15. 口コミで高評価!業界最高級品質のスーパーコピーブランド激安通販専門店!スーパーコピーのブランド時計などブランドコピー品買取やブランドバッグ、ブランド財布の格安販売!まずはお気軽にお問い合わせください。信用第一、送料無料。スーパーコピーブランドなら当店で!スーパーコピー時計などブランドコピー品買取や ブランドバッグ、ブランド財布を低価でお客様に提供します。偽物ブランドと言っても なんと本物と見分けがつかないぐらい!まずはお気軽にお問い合わせください。ネットワークの時代の中の極めて優秀な人、ブランドコピー、スーパーコピーブランドN品 超人気専門サイト問屋 !!精巧に作られたブランドコピーバッグ当サイト販売したブランド コピーなので正規品と同等品質提供した格安で完璧な品質のをご承諾します、2016ー2016の新素材-新作!人気 スーパーコピーブランド,スーパーコピー時計,スーパーコピー激安販売,ブランドスーパーコピー専門!
    エルメス メドール 安い http://www.ooowatch.com/tokei/fm/index_10.html

  16. 许文强
    许文强 July 24, 2016

    现在php的主流还是5.+系列,7还是使用的比较少。觉得这个不错,但是项目本身是php5的,就有点遗憾

  17. 蛋疼
    蛋疼 June 24, 2016

    我测试在FPM模式好使,配置确实会自动加载更新,但是在删除配置文件时有问题,比如我原本有一个配置文件foo.ini。
    在phpinfo的parsed filename中可以看到foo.ini这个文件,但是如果我执行mv foo.ini foo2.ini后,就会出现问题,parsed filename中有时只有foo2.ini一个文件,有时foo.ini foo2.ini同时存在,重启FPM才能恢复正常。不过实际很少会删除配置文件,问题不大。
    而且在CLI模式是不是不能自动更新配置啊。

  18. 汽车门窗密封条
    汽车门窗密封条 June 20, 2016

    感觉很好用,谢谢分享,对我们学习PHP知识有很大的帮助。楼主好样的

  19. Young
    Young May 30, 2016

    感觉像可配版的auto_prepend_file功能

  20. Novopo
    Novopo December 21, 2015

    在php7.0.1上已经测试过,非常好用。

  21. jetking
    jetking October 10, 2015

    看上去很不错的东东,唯一遗憾的是公司服务器仍然使用的是5.6系列,而且近期不能升级到PHP 7 -_-!

  22. alewater
    alewater September 25, 2015

    请问鸟哥,我在php7.0.0RC3下把check_delay设为0,然后启动php-fpm,页面代码就是var_dump,然后我修改了配置文件内容,为什么再刷新页面,内容就变化了呢,按理说check_delay为0应该不检查更新吧,不知道是不是我哪里的理解有偏差。

  23. newbmiao
    newbmiao September 7, 2015

    这个和yaf里的配置设计相似啊,直接用yaf多方便

  24. Anonymous
    Anonymous September 3, 2015

    配置文件分开固然很好,但是不是多了一份维护的成本呢?
    如果是根据环境变量区分的不同环境的变量,这个扩展可以加以区分的加载不?

  25. qmore
    qmore August 25, 2015

    菜鸟一枚,来围观,看来必须学c哈。。。

  26. 逍遥
    逍遥 July 31, 2015

    这个不错,不看这文章以前还没发现。

  27. Anonymous
    Anonymous July 6, 2015

    rwer

  28. Anonymous
    Anonymous July 6, 2015

    ty

  29. Mr.Cong
    Mr.Cong June 26, 2015

    感觉很好用,但是好像也有一个问题,就是每次修改完配置文件后,修需要重启apache,才能重新加载PHP

  30. Laruence
    Laruence June 17, 2015

    @littlehz 这个不行, 因为yaconf不是基于共享内存的, 所以如果你调用invalid, 只是invalid了当前进程的部分…

  31. littlehz
    littlehz June 13, 2015

    能不能和opcache一样,如果配置了 yaconf.check_delay = 0,不自动检测文件变更,但是可以有相应的API手动更新,比如 Yaconf::reload(),这样提高生产环境的性能,并且只在发布代码/运维需要的时候变更配置。

  32. 投河自尽的鱼
    投河自尽的鱼 June 12, 2015

    应该介绍下php7的扩展api

  33. 摩西
    摩西 June 12, 2015

    看了下代码,每次yaconf实例化后检查上次检测配置时间和当前时间间隔,超过间隔再检查文件修改时间,判断是否重新加载配置。不错不错~ 赞赞赞
    不过能出个兼容老版本php的就更好了~

  34. sada
    sada June 12, 2015

    鸟哥这是逼着我们尽早升级到php7

  35. Lancer
    Lancer June 12, 2015

    不错。太好了,唯一不足就是没有PHP5。

  36. mlboy
    mlboy June 12, 2015

    不错。太好了,唯一不足就是要用在php7。。

  37. hecha
    hecha June 12, 2015

    沙发。。。。。。

Leave a Reply to dwnldmedia Cancel reply

Your email address will not be published. Required fields are marked *