如何使用PHP7的Yaconf

更新時(shí)間：2021年05月31日 08:39:09 作者：八重櫻

Yaconf是一個高性能的PHP配置容器，它在PHP啟動的時(shí)候把格式為INI的配置文件Parse后存儲在PHP的常駐內(nèi)存中，不需要每次請求的時(shí)候都來分析配置文件，并且在獲取配置項(xiàng)的時(shí)候"zero-copy"。

簡介

我見過很多的項(xiàng)目中, 用PHP文件做配置的, 一個config目錄下可能有十幾個甚至數(shù)十個.php配置文件, 里面都是各種各樣的array, 還有甚者會把一些詞典文件(比如中文/英文對照)也放到配置中去. 這就導(dǎo)致配置文件的解析耗費(fèi)了很大的性能(誠然, 用了opcache能好點(diǎn), 但是實(shí)際上還是有執(zhí)行的過程).

除了PHP的, 還有用json的, yaml的, 一個共同的特點(diǎn)就是這些配置的可讀性比較差. 另外, 他們也都要runtime解析.

config目錄往往和代碼在一起, 首先會有安全隱患(配置中往往有敏感信息), 其次如果配置和代碼屬于一個項(xiàng)目, 這就會導(dǎo)致配置的修改也要走代碼上線的流程.

一些資源配置文件, 比如mysql/memcache的配置信息, 這些內(nèi)容本來是應(yīng)該對開發(fā)透明的, 運(yùn)維直接負(fù)責(zé)即可. 但是放到了代碼中就會導(dǎo)致, 運(yùn)維如果要發(fā)起一些變更, 也要開發(fā)配合修改配置文件上線.

所以, Yaconf就是為了解決這些問題而生的一個工具.

它使用單獨(dú)的一個配置目錄(在yaconf.directory指定), 不和代碼在一起.

它在PHP啟動的時(shí)候, 處理所有的要處理的配置, 然后這些配置就會常駐內(nèi)存, 隨著PHP的生命周期存亡. 避免了每次請求的時(shí)候解析配置文件.

所有的配置內(nèi)容都是immutable的, 這就可以借助于Fork的COW, 降低內(nèi)存占用, 并且在訪問配置的時(shí)候, 幾乎不需要任何的內(nèi)存Copy, 也不會有無謂的引用計(jì)數(shù)增減

最重要的, 配置目錄和代碼分離以后, 可以借助一個配置管理后臺, 來實(shí)現(xiàn)配置的統(tǒng)一化管理.

它支持(對于非ZTS)配置變更重新加載, 也就是說配置如果有變化(建議更改配置一定使用mv, 不要使用cp), 它會reload, 不需要重啟(檢測的頻率由yaconf.check_delay控制).

它支持豐富的配置類型, 包括字符串, 數(shù)組, 分節(jié), 分節(jié)繼承, 并且還可以在配置中直接寫PHP的常量和環(huán)境變量等.

最重要的是, 它很簡單.

API

Yaconf 只提供了倆個方法,

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

這個是獲取一個配置, 名字是配置的名字, 一般來說如果你有一個ini文件叫做foo.ini, 那么$name使用foo的話就會獲取到這個文件內(nèi)的所有內(nèi)容, 以數(shù)組形式返回. default是當(dāng)配置不存在的時(shí)候返回的默認(rèn)值.

bool Yaconf::has(string $name)

這個是檢測一個配置是否存在.

Yaconf的配置項(xiàng)

yaconf.directory

配置文件目錄, 這個配置不能通過ini_set指定, 因?yàn)楸仨氃赑HP啟動的時(shí)候就確定好.

yaconf.check_delay

多久(秒)檢測一次文件變動, 如果是0就是不檢測, 也就是說如果是0的時(shí)候, 文件變更只能通過重啟PHP重新加載

配置的格式

Yaconf采用ini文件作為配置文件, 這是因?yàn)槲乙恢庇X得ini是最適合做配置文件的, key-value格式, 清晰可讀.

簡單的配置寫起來如下(以下全部假設(shè)ini文件的名字是test):

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

如上所示, 對于一般的配置我們都用引號引起來. 而對于沒有引起來的, 會嘗試以PHP的常量做解釋, 也就是說我們可以直接在配置里面寫PHP的常量.

另外你也看到了, 我們可以直接在配置中寫環(huán)境變量, 比如上面的env:

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

如上面所示, 你可以看到, 假設(shè)對于foo的值, 你可以通過如下代碼訪問:

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

Yaconf也支持?jǐn)?shù)組類型的配置, 寫法如下:

arr.0=1
arr.1=2

如果是連續(xù)的數(shù)組，你也可以直接寫:

arr[]=1
arr[]=2

那對于數(shù)組的值，你可以通過如下代碼獲取:

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

這就獲取到了test配置文件中的arr數(shù)組，當(dāng)然你也可以直接獲取數(shù)組中的一個具體的值，比如你要直接獲取test配置文件中arr數(shù)組的第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是配置文件名字

并且, 配置文件還可以分節(jié), 和分節(jié)繼承:

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

請注意配置的分節(jié)繼承的語法 children:(冒號)parent, 這的意思是children節(jié)繼承全部base的配置項(xiàng). 然后你在children節(jié)里面定義的和parent節(jié)中同名的配置, 會覆蓋掉parent中定義的內(nèi)容.

對于chidlren節(jié)的children配置的值可以通過如下形式訪問:

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

樣例

首先, 假設(shè)我們的所有的配置文件都放置在/tmp/yaconf中, 那么我們就需要在php.ini中增加如下配置:

yaconf.directory=/tmp/yaconf

這樣yaconf在PHP啟動的時(shí)候, 就會在這個目錄下找所有的*.ini文件, 然后嘗試處理他們. 這里要注意的是不支持多級目錄, 也就是說, yaconf只會處理yaconf.directory內(nèi)的*.ini文件, 不會處理子目錄里面的(這主要是為了簡單考慮, 因?yàn)橛蟹止?jié), 你就可以一個項(xiàng)目定義一個ini文件).

假設(shè)/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的內(nèi)容:

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的內(nèi)容:

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"
 }
}
*/

當(dāng)然你可以用 (.)鏈接語法精確訪問任何一個特定的值.