Yaconf —— 高性能的 PHP 配置管理擴充

這個項目其實不是我新的idea, 這個是我在來微網誌以後, 第一個優化項目中順手做的一個小工具, 本身叫做weibo_conf. 但是因為weibo_conf是屬于weibo擴充的, 裡面還有一些其他功能是專門為weibo定制的. 是以不适合直接開源.

随着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重新加載