項目介紹
Yaconf是一個高性能的配置管理擴展 ，是由PHP核心開發者鳥哥惠新宸發布的PHP7下的擴展套用。主要目標是簡化讀取項目配置檔案, 增強了配置檔案的可讀性和可維護性.。
據Yaconf開發者惠新宸在其部落格上說 ，這個項目是其在來微博以後, 第一個最佳化項目中順手做的一個小工具, 本身叫做Weibo_Conf. 但是因為Weibo_Conf是屬於Weibo擴展的, 裡面還有一些其他功能是專門為Weibo定製的. 所以不適合直接開源.隨著PHP7的發布, 新增了很多持久化類型的支持比如IS_IMMUTABLE_ARRAY, 於是就在PHP7下重新開發了Yaconf, 開源出來, 方便大家使用。
項目簡介
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. 最重要的是, 它很簡單.
YaconfAPI
Yaconf 只提供了倆個方法,
mixed Yaconf::get(string $name, mixed $default = NULL)
這個是獲取一個配置, 名字是配置的名字, 一般來說如果你有一個ini檔案叫做foo.ini, 那么$name使用foo的話就會獲取到這個檔案內的所有內容, 以數組形式返回. default是當配置不存在的時候返回的默認值.
bool Yaconf::has(string $name)
這個是檢測一個配置是否存在.
配置項
yaconf.directory
配置檔案目錄, 這個配置不能通過ini_set指定, 因為必須在PHP啟動的時候就確定好.
yaconf.check_delay
多久(秒)檢測一次檔案變動, 如果是0就是不檢測, 也就是說如果是0的時候, 檔案變更只能通過重啟PHP重新載入
配置的格式
Yaconf採用ini檔案作為配置檔案, 這是因為我一直覺得ini是最適合做配置檔案的, key-value格式, 清晰可讀.
簡單的配置寫起來如下(以下全部假設ini檔案的名字是test):
如上所示, 對於一般的配置我們都用引號引起來. 而對於沒有引起來的, 會嘗試以PHP的常量做解釋, 也就是說我們可以直接在配置裡面寫PHP的常量.
另外你也看到了, 我們可以直接在配置中寫環境變數, 比如上面的env:
如上面所示, 你可以看到, 假設對於foo的值, 你可以通過如下代碼訪問:
Yaconf也支持數組類型的配置, 寫法如下:
如上面所示你可以直接使用foo[]這種形式來定義數組, 也可以使用arr.1, arr.2來指定key定義.
對於數組的第二個值, 你可以通過如下代碼訪問:
或者你可以通過獲取整個arr數組之後訪問:
Yaconf也支持map類型的配置, 寫法如下:
你可以使用分號來寫注釋
對於map2的foo子map的name值可以通過如下形式訪問:
並且, 配置檔案還可以分節, 和分節繼承:
請注意配置的分節繼承的語法 children:(冒號)parent, 這的意思是children節繼承全部base的配置項. 然後你在children節裡面定義的和parent節中同名的配置, 會覆蓋掉parent中定義的內容.
對於chidlren節的children配置的值可以通過如下形式訪問:
