源碼分析---入口篇
源碼分析
全局配置加載類
全局配置類的主要代碼如下:
class Config
{
/**
* @var array 配置參數
*/
private static $config = [];
/**
* @var string 參數作用域
*/
private static $range = '_sys_';
/**
* 設定配置參數的作用域
* @access public
* @param string $range 作用域
* @return void
*/
public static function range($range)
{
....
}
/**
* 解析配置文件或內容
* @access public
* @param string $config 配置文件路徑或內容
* @param string $type 配置解析類型
* @param string $name 配置名(如設置即表示二級配置)
* @param string $range 作用域
* @return mixed
*/
public static function parse($config, $type = '', $name = '', $range = '')
{
....
}
/**
* 加載配置文件(PHP格式)
* @access public
* @param string $file 配置文件名
* @param string $name 配置名(如設置即表示二級配置)
* @param string $range 作用域
* @return mixed
*/
public static function load($file, $name = '', $range = '')
{
....
}
/**
* 檢測配置是否存在
* @access public
* @param string $name 配置參數名(支持二級配置 . 號分割)
* @param string $range 作用域
* @return bool
*/
public static function has($name, $range = '')
{
....
}
/**
* 獲取配置參數 爲空則獲取所有配置
* @access public
* @param string $name 配置參數名(支持二級配置 . 號分割)
* @param string $range 作用域
* @return mixed
*/
public static function get($name = null, $range = '')
{
....
}
/**
* 設置配置參數 name 爲數組則爲批量設置
* @access public
* @param string|array $name 配置參數名(支持二級配置 . 號分割)
* @param mixed $value 配置值
* @param string $range 作用域
* @return mixed
*/
public static function set($name, $value = null, $range = '')
{
....
}
/**
* 重置配置參數
* @access public
* @param string $range 作用域
* @return void
*/
public static function reset($range = '')
{
....
}
}
添加配置
添加配置用的是thinkConfig::set($name, $value = null, $range = '')方法;當$name是字符串時候value是要設置的值,$name爲數組時候,批量設置配置。
/**
* 設置配置參數 name 爲數組則爲批量設置
* @access public
* @param string|array $name 配置參數名(支持二級配置 . 號分割)
* @param mixed $value 配置值
* @param string $range 作用域
* @return mixed
*/
public static function set($name, $value = null, $range = '')
{
$range = $range ?: self::$range;
if (!isset(self::$config[$range])) self::$config[$range] = [];
// 字符串則表示單個配置設置
if (is_string($name)) {
if (!strpos($name, '.')) {
self::$config[$range][strtolower($name)] = $value;
} else {
// 二維數組
$name = explode('.', $name, 2);
self::$config[$range][strtolower($name[0])][$name[1]] = $value;
}
return $value;
}
// 數組則表示批量設置
if (is_array($name)) {
if (!empty($value)) {
self::$config[$range][$value] = isset(self::$config[$range][$value]) ?
array_merge(self::$config[$range][$value], $name) :
$name;
return self::$config[$range][$value];
}
return self::$config[$range] = array_merge(
self::$config[$range], array_change_key_case($name)
);
}
// 爲空直接返回已有配置
return self::$config[$range];
}
設置配置時候主要分了兩種情況:
1. $name是字符串
2. $name是二維數組(目前只支持二維數組)
配置會先判斷配置的作用域,不設置就用默認的_sys_
作用域,並且判斷該作用域是否存在,不存在就初始化爲數組。對於$name這兩種不同形式的參數,處理方式也不一樣,
$name爲字符串形式
// 字符串則表示單個配置設置
if (is_string($name)) {
if (!strpos($name, '.')) {
self::$config[$range][strtolower($name)] = $value;
} else {
// 二維數組
$name = explode('.', $name, 2);
self::$config[$range][strtolower($name[0])][$name[1]] = $value;
}
return $value;
}
判斷字符串中是否帶.
, 沒有直接把$name的小寫形式作爲key,$value作爲值設置到配置(self::$config)中.
如果帶.
,只處理前面兩項,即把字符串通過.
分割成數組,取數組的前面兩項,把$value設置到配置中。
$name爲數組形式
// 數組則表示批量設置
if (is_array($name)) {
if (!empty($value)) {
self::$config[$range][$value] = isset(self::$config[$range][$value]) ?
array_merge(self::$config[$range][$value], $name) :
$name;
return self::$config[$range][$value];
}
return self::$config[$range] = array_merge(
self::$config[$range], array_change_key_case($name)
);
}
如果設置了$value的值,那麼把$value作爲配置的鍵,再把$name的配置設置到配置中(如果原來已經有值,數組合並用傳入的值替換原來的值,如果原來沒有值,直接賦值),如果沒有設置$value的值,那麼把數組的每一項設置到該作用域下。
備註: array_change_key_case( $array, [ int $case = CASE_LOWER ] ) : array 把數組的鍵設置爲大寫或小寫,默認是小寫。
獲取配置
看完了上面的分析,對於獲取配置應該也有了一個大致的思路了,就是設置配置的反向。
/**
* 獲取配置參數 爲空則獲取所有配置
* @access public
* @param string $name 配置參數名(支持二級配置 . 號分割)
* @param string $range 作用域
* @return mixed
*/
public static function get($name = null, $range = '')
{
$range = $range ?: self::$range;
// 無參數時獲取所有
if (empty($name) && isset(self::$config[$range])) {
return self::$config[$range];
}
// 非二級配置時直接返回
if (!strpos($name, '.')) {
$name = strtolower($name);
return isset(self::$config[$range][$name]) ? self::$config[$range][$name] : null;
}
// 二維數組設置和獲取支持
$name = explode('.', $name, 2);
$name[0] = strtolower($name[0]);
if (!isset(self::$config[$range][$name[0]])) {
// 動態載入額外配置
$module = Request::instance()->module();
$file = CONF_PATH . ($module ? $module . DS : '') . 'extra' . DS . $name[0] . CONF_EXT;
is_file($file) && self::load($file, $name[0]);
}
return isset(self::$config[$range][$name[0]][$name[1]]) ?
self::$config[$range][$name[0]][$name[1]] :
null;
}
看了代碼,應該對於無參獲取和非二級獲取已經懂了,那二維數組有個需要注意的地方,就是會動態加載額外的配置。
$module = Request::instance()->module();
該方法的實現如下:
/**
* 設置或者獲取當前的模塊名
* @access public
* @param string $module 模塊名
* @return string|Request
*/
public function module($module = null)
{
if (!is_null($module)) {
$this->module = $module;
return $this;
} else {
return $this->module ?: '';
}
}
該方法就是獲取當前請求的模塊。
//二維數組處理邏輯
if (!isset(self::$config[$range][$name[0]])) {
// 動態載入額外配置
$module = Request::instance()->module();
$file = CONF_PATH . ($module ? $module . DS : '') . 'extra' . DS . $name[0] . CONF_EXT;
is_file($file) && self::load($file, $name[0]);
}
return isset(self::$config[$range][$name[0]][$name[1]]) ?
self::$config[$range][$name[0]][$name[1]] :
null;
從代碼中可以看出,通過request獲取到當前訪問的模塊,判斷當前模塊中的或者配置目錄中的extra目錄總是否存在以爲數組中鍵爲名字的配置文件,存在就加載進來,再進行返回,動態加載通過thinkConfig::load($file)來進行加載。
/**
* 加載配置文件(PHP格式)
* @access public
* @param string $file 配置文件名
* @param string $name 配置名(如設置即表示二級配置)
* @param string $range 作用域
* @return mixed
*/
public static function load($file, $name = '', $range = '')
{
$range = $range ?: self::$range;
if (!isset(self::$config[$range])) self::$config[$range] = [];
if (is_file($file)) {
$name = strtolower($name);
$type = pathinfo($file, PATHINFO_EXTENSION);
if ('php' == $type) {
return self::set(include $file, $name, $range);
}
if ('yaml' == $type && function_exists('yaml_parse_file')) {
return self::set(yaml_parse_file($file), $name, $range);
}
return self::parse($file, $type, $name, $range);
}
return self::$config[$range];
}
該加載配置的方法主要的邏輯是處理php,yaml,ini,json,xml格式的配置。
php類型的是直接include再set配置即可,yaml則是通過yaml_parse_file方法解析成數據再set配置。其他的通過固定的驅動來解析,業務邏輯再thinkConfig::parse()方法中。
/**
* 解析配置文件或內容
* @access public
* @param string $config 配置文件路徑或內容
* @param string $type 配置解析類型
* @param string $name 配置名(如設置即表示二級配置)
* @param string $range 作用域
* @return mixed
*/
public static function parse($config, $type = '', $name = '', $range = '')
{
$range = $range ?: self::$range;
if (empty($type)) $type = pathinfo($config, PATHINFO_EXTENSION);
$class = false !== strpos($type, '\\') ?
$type :
'\\think\\config\\driver\\' . ucwords($type);
return self::set((new $class())->parse($config), $name, $range);
}
通過pathinfo()方法獲取到路徑信息, 第二個參數設置返回擴展名,判斷擴展名中是否帶有\
如果有即傳入的是一個類。直接通過類的parse方法解析配置,如果是一個文件擴展名稱,即通過\\think\\config\\driver\\
下對應的驅動來解析配置,再set到配置中。
總結
thinkphp中主要的配置加載方式有兩種,
1.加載框架內部預設的配置
2.動態加載用戶配置
對於第一中方式,由於默認的配置是php類型的,是直接通過set方法執行配置的,第二中方式是通過load方法,判斷文件的擴展名來進行不同的驅動解析,其中php和yaml有直接的方式可以解析成數組,xml,json,ini則是通過對應的驅動來解析再set配置的,通過調用parse方法自動判斷擴展,再進行解析。至於Config類中其他的方法比較簡單,可以直接查看代碼獲取相關信息。