隨著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.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才能用
推薦教學：《PHP7》
以上就是PHP7的Yaconf使用教學的詳細內容，更多請關注TW511.COM其它相關文章！