函數中使用require_once問題深入探討 優雅的配置文件定義方法推薦

背景

在項目中很多人喜歡在配置文件使用數組來配置各個配置項，如等級的配置level.config.php：
復制代碼 代碼如下:
<?php
$g_levelConfig = array(
                    '1'=>'新手',
                    '2'=>'進階',
                );

因為項目不同模塊經常會相互調用方法，會出現重復包含一個文件的情況，為了避免錯誤，大家一般都會用require_one，而且經常會在函數裡包含文件，如：
復制代碼 代碼如下:
function getNameByLeval($level){
    $level = intval($level);
    require_once CONFIG_PATH.'level.config.php';
    if(!isset($g_levelConfig[$level])){
        return false;
    }else{
        return $g_levelConfig[$level];
    }
}

問題

那麼這樣會有什麼問題呢？先看如下代碼的輸出,level.config.php即是上文提到的配置文件
復制代碼 代碼如下:
<?php
function getNameByLeval($level){
    $level = intval($level);
    require_once 'level.config.php';
    if(!isset($g_levelConfig[$level])){
        return false;
    }else{
        return $g_levelConfig[$level];
    }
}
var_dump(getNameByLeval(1));
var_dump(getNameByLeval(2));

輸出是：
復制代碼 代碼如下:
string(6) "新手"
bool(false)

很多人覺得很奇怪，為什麼第二次輸出的是false，其實很簡單：

require_once只包含一次文件，如果該文件已經被包含了，則不會再次包含。

1.第一次執行getNameByLeval(1)時因為之前沒包含level.config.php配置文件，所以本次會包含level.config.php文件並編譯，所有函數裡有$g_levelConfig變量;

2.當第二次執行getNameByLeval(1)時，因為之前包含過level.config.php配置文件，本次不再包含，所以就沒有$g_levelConfig變量，自然返回false；

解決辦法

1.在全局作用於包含，在函數中引用
復制代碼 代碼如下:
<?php
require_once 'level.config.php';//新增代碼
function getNameByLeval($level){
    global $g_levelConfig;//新增代碼
    $level = intval($level);
    if(!isset($g_levelConfig[$level])){
        return false;
    }else{
        return $g_levelConfig[$level];
    }
}
var_dump(getNameByLeval(1));
var_dump(getNameByLeval(2));   
這樣的話，無論用不用getNameByLeval函數，都要把level.config.php配置文件包含進來，有點不劃算。

2.在函數中包含、應用
復制代碼 代碼如下:
<?php
function getNameByLeval($level){
    $level = intval($level);
    global $g_levelConfig;//新增代碼
    require_once 'level.config.php';
    if(!isset($g_levelConfig[$level])){
        return false;
    }else{
        return $g_levelConfig[$level];
    }
}
var_dump(getNameByLeval(1));
var_dump(getNameByLeval(2));
這樣也感覺很不整潔美觀

3.配置文件使用靜態class
復制代碼 代碼如下:
<?php
class levelConfig{
    public static $level = array(
                                '1'=>'新手',
                                '2'=>'進階',
                            );
}

使用的時候

復制代碼 代碼如下:
function getNameByLeval($level){
    $level = intval($level);
    require_once 'level.config.php';
    if(!isset(levelConfig::$level[$level])){
        return false;
    }else{
        return levelConfig::$level[$level];
    }
}

我個人非常推崇這個方式來定義配置文件，用起來優雅而且不容易覆蓋變量。