thinkphp源碼分析（五）—配置篇

HitenDev 發(fā)布于2019-07-01 11:22 / 1365人閱讀

摘要：對于這兩種不同形式的參數(shù)，處理方式也不一樣，為字符串形式字符串則表示單個配置設(shè)置二維數(shù)組判斷字符串中是否帶沒有直接把的小寫形式作為，作為值設(shè)置到配置中如果帶，只處理前面兩項，即把字符串通過分割成數(shù)組，取數(shù)組的前面兩項，把設(shè)置到配置中。

源碼分析---入口篇 源碼分析 全局配置加載類

全局配置類的主要代碼如下：

class Config
{
    /**
     * @var array 配置參數(shù)
     */
    private static $config = [];

    /**
     * @var string 參數(shù)作用域
     */
    private static $range = "_sys_";

    /**
     * 設(shè)定配置參數(shù)的作用域
     * @access public
     * @param  string $range 作用域
     * @return void
     */
    public static function range($range)
    {
       ....
    }

    /**
     * 解析配置文件或內(nèi)容
     * @access public
     * @param  string $config 配置文件路徑或內(nèi)容
     * @param  string $type   配置解析類型
     * @param  string $name   配置名（如設(shè)置即表示二級配置）
     * @param  string $range  作用域
     * @return mixed
     */
    public static function parse($config, $type = "", $name = "", $range = "")
    {
        ....
    }

    /**
     * 加載配置文件（PHP格式）
     * @access public
     * @param  string $file  配置文件名
     * @param  string $name  配置名（如設(shè)置即表示二級配置）
     * @param  string $range 作用域
     * @return mixed
     */
    public static function load($file, $name = "", $range = "")
    {
        ....
    }

    /**
     * 檢測配置是否存在
     * @access public
     * @param  string $name 配置參數(shù)名（支持二級配置 . 號分割）
     * @param  string $range  作用域
     * @return bool
     */
    public static function has($name, $range = "")
    {
        ....
    }

    /**
     * 獲取配置參數(shù) 為空則獲取所有配置
     * @access public
     * @param  string $name 配置參數(shù)名（支持二級配置 . 號分割）
     * @param  string $range  作用域
     * @return mixed
     */
    public static function get($name = null, $range = "")
    {
        ....
    }

    /**
     * 設(shè)置配置參數(shù) name 為數(shù)組則為批量設(shè)置
     * @access public
     * @param  string|array $name  配置參數(shù)名（支持二級配置 . 號分割）
     * @param  mixed        $value 配置值
     * @param  string       $range 作用域
     * @return mixed
     */
    public static function set($name, $value = null, $range = "")
    {
        ....
    }

    /**
     * 重置配置參數(shù)
     * @access public
     * @param  string $range 作用域
     * @return void
     */
    public static function reset($range = "")
    {
        ....
    }
}

添加配置

添加配置用的是thinkConfig::set($name, $value = null, $range = "")方法;當$name是字符串時候value是要設(shè)置的值，$name為數(shù)組時候，批量設(shè)置配置。

    /**
     * 設(shè)置配置參數(shù) name 為數(shù)組則為批量設(shè)置
     * @access public
     * @param  string|array $name  配置參數(shù)名（支持二級配置 . 號分割）
     * @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] = [];

        // 字符串則表示單個配置設(shè)置
        if (is_string($name)) {
            if (!strpos($name, ".")) {
                self::$config[$range][strtolower($name)] = $value;
            } else {
                // 二維數(shù)組
                $name = explode(".", $name, 2);
                self::$config[$range][strtolower($name[0])][$name[1]] = $value;
            }

            return $value;
        }

        // 數(shù)組則表示批量設(shè)置
        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];
    }

設(shè)置配置時候主要分了兩種情況：

1. $name是字符串
2. $name是二維數(shù)組（目前只支持二維數(shù)組）

配置會先判斷配置的作用域，不設(shè)置就用默認的_sys_作用域，并且判斷該作用域是否存在，不存在就初始化為數(shù)組。對于$name這兩種不同形式的參數(shù)，處理方式也不一樣，

$name為字符串形式

    // 字符串則表示單個配置設(shè)置
    if (is_string($name)) {
        if (!strpos($name, ".")) {
            self::$config[$range][strtolower($name)] = $value;
        } else {
            // 二維數(shù)組
            $name = explode(".", $name, 2);
            self::$config[$range][strtolower($name[0])][$name[1]] = $value;
        }

        return $value;
    }

判斷字符串中是否帶., 沒有直接把$name的小寫形式作為key，$value作為值設(shè)置到配置(self::$config)中.
如果帶.，只處理前面兩項，即把字符串通過.分割成數(shù)組，取數(shù)組的前面兩項，把$value設(shè)置到配置中。

$name為數(shù)組形式

    // 數(shù)組則表示批量設(shè)置
    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)
        );
    }

如果設(shè)置了$value的值，那么把$value作為配置的鍵，再把$name的配置設(shè)置到配置中（如果原來已經(jīng)有值，數(shù)組合并用傳入的值替換原來的值，如果原來沒有值，直接賦值），如果沒有設(shè)置$value的值，那么把數(shù)組的每一項設(shè)置到該作用域下。

備注： array_change_key_case( $array, [ int $case = CASE_LOWER ] ) : array 把數(shù)組的鍵設(shè)置為大寫或小寫，默認是小寫。

獲取配置

看完了上面的分析，對于獲取配置應(yīng)該也有了一個大致的思路了，就是設(shè)置配置的反向。

    /**
     * 獲取配置參數(shù) 為空則獲取所有配置
     * @access public
     * @param  string $name 配置參數(shù)名（支持二級配置 . 號分割）
     * @param  string $range  作用域
     * @return mixed
     */
    public static function get($name = null, $range = "")
    {
        $range = $range ?: self::$range;

        // 無參數(shù)時獲取所有
        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;
        }

        // 二維數(shù)組設(shè)置和獲取支持
        $name    = explode(".", $name, 2);
        $name[0] = strtolower($name[0]);

        if (!isset(self::$config[$range][$name[0]])) {
            // 動態(tài)載入額外配置
            $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;
    }

看了代碼，應(yīng)該對于無參獲取和非二級獲取已經(jīng)懂了，那二維數(shù)組有個需要注意的地方，就是會動態(tài)加載額外的配置。

$module = Request::instance()->module();

該方法的實現(xiàn)如下：

    /**
     * 設(shè)置或者獲取當前的模塊名
     * @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 ?: "";
        }
    }

該方法就是獲取當前請求的模塊。

    //二維數(shù)組處理邏輯
    if (!isset(self::$config[$range][$name[0]])) {
        // 動態(tài)載入額外配置
        $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目錄總是否存在以為數(shù)組中鍵為名字的配置文件，存在就加載進來，再進行返回，動態(tài)加載通過thinkConfig::load($file)來進行加載。

    /**
     * 加載配置文件（PHP格式）
     * @access public
     * @param  string $file  配置文件名
     * @param  string $name  配置名（如設(shè)置即表示二級配置）
     * @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方法解析成數(shù)據(jù)再set配置。其他的通過固定的驅(qū)動來解析，業(yè)務(wù)邏輯再thinkConfig::parse()方法中。

    /**
     * 解析配置文件或內(nèi)容
     * @access public
     * @param  string $config 配置文件路徑或內(nèi)容
     * @param  string $type   配置解析類型
     * @param  string $name   配置名（如設(shè)置即表示二級配置）
     * @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 :
            "	hinkconfigdriver" . ucwords($type);

        return self::set((new $class())->parse($config), $name, $range);
    }

通過pathinfo()方法獲取到路徑信息，第二個參數(shù)設(shè)置返回擴展名，判斷擴展名中是否帶有如果有即傳入的是一個類。直接通過類的parse方法解析配置，如果是一個文件擴展名稱，即通過 hinkconfigdriver下對應(yīng)的驅(qū)動來解析配置，再set到配置中。

總結(jié)

thinkphp中主要的配置加載方式有兩種，

1.加載框架內(nèi)部預(yù)設(shè)的配置
2.動態(tài)加載用戶配置

對于第一中方式，由于默認的配置是php類型的，是直接通過set方法執(zhí)行配置的，第二中方式是通過load方法，判斷文件的擴展名來進行不同的驅(qū)動解析，其中php和yaml有直接的方式可以解析成數(shù)組，xml，json，ini則是通過對應(yīng)的驅(qū)動來解析再set配置的，通過調(diào)用parse方法自動判斷擴展，再進行解析。至于Config類中其他的方法比較簡單，可以直接查看代碼獲取相關(guān)信息。