PHP7的Yaconf使用教程

简介

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

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

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

config目录往往和代码在一起,首先会有安全隐患(配置中往往有敏感信息),其次如果配置和代码属于一个项目,这就会导致配置的修改也要走代码上线的流程.

一些资源配置文件,比如MysqL/memcache的配置信息,这些内容本来是应该对开发透明的,运维直接负责即可. 但是放到了代码中就会导致,运维如果要发起一些变更,也要开发配合修改配置文件上线.

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

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

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

所有的配置内容都是immutable的,这就可以借助于Fork的COW,降低内存占用,并且在访问配置的时候,几乎不需要任何的内存copy,也不会有无谓的引用计数增减

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

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

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

最重要的是,它很简单.

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.0=1
arr.1=2

如果是连续的数组，你也可以直接写:

arr[]=1
arr[]=2

那对于数组的值，你可以通过如下代码获取:

Yaconf::get("test.arr");

这就获取到了test配置文件中的arr数组，当然你也可以直接获取数组中的一个具体的值，比如你要直接获取test配置文件中arr数组的第0号元素：

$arr = Yaconf::get("test.arr.0");

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才能用

以上内容希望帮助到大家，很多PHPer在进阶的时候总会遇到一些问题和瓶颈，业务代码写多了没有方向感，不知道该从那里入手去提升，对此我整理了一些资料，包括但不限于：分布式架构、高可扩展、高性能、高并发、服务器性能调优、TP6，laravel，YII2，Redis，Swoole、Swoft、Kafka、MysqL优化、shell脚本、Docker、微服务、Nginx等多个知识点高级进阶干货需要的可以免费分享给大家，需要的可以加入我的官方群点击此处。

PHP7的Yaconf使用教程

相关推荐