摘要：隨著的發布新增了很多持久化類型的支持比如于是我就在下重新開發了開源出來方便大家使用簡介首先說說這個是干啥的我見過很多的項目中用文件做配置的一個目錄下可能有十幾個甚至數十個配置文件里面都是各種各樣的還有甚者會把一些詞典文件比如中文英文對照也放

隨著PHP7的發布, 新增了很多持久化類型的支持比如IS_IMMUTABLE_ARRAY, 于是我就在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[]=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的地方, 那么對你來說就可以用, 不是么? )