函数中使用require_once问题深入探讨 优雅的配置文件定义方法推荐
背景
在项目中很多人喜欢在配置文件使用数组来配置各个配置项，如等级的配置level.config.php：
<?php
$g_levelConfig=array(
'1'=>'新手',
'2'=>'进阶',
);
因为项目不同模块经常会相互调用方法，会出现重复包含一个文件的情况，为了避免错误，大家一般都会用require_one，而且经常会在函数里包含文件，如：
functiongetNameByLeval($level){
$level=intval($level);
require_onceCONFIG_PATH.'level.config.php';
if(!isset($g_levelConfig[$level])){
returnfalse;
}else{
return$g_levelConfig[$level];
}
}
问题
那么这样会有什么问题呢？先看如下代码的输出,level.config.php即是上文提到的配置文件
<?php
functiongetNameByLeval($level){
$level=intval($level);
require_once'level.config.php';
if(!isset($g_levelConfig[$level])){
returnfalse;
}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';//新增代码
functiongetNameByLeval($level){
global$g_levelConfig;//新增代码
$level=intval($level);
if(!isset($g_levelConfig[$level])){
returnfalse;
}else{
return$g_levelConfig[$level];
}
}
var_dump(getNameByLeval(1));
var_dump(getNameByLeval(2)); 这样的话，无论用不用getNameByLeval函数，都要把level.config.php配置文件包含进来，有点不划算。
2.在函数中包含、应用
<?php
functiongetNameByLeval($level){
$level=intval($level);
global$g_levelConfig;//新增代码
require_once'level.config.php';
if(!isset($g_levelConfig[$level])){
returnfalse;
}else{
return$g_levelConfig[$level];
}
}
var_dump(getNameByLeval(1));
var_dump(getNameByLeval(2));这样也感觉很不整洁美观
3.配置文件使用静态class
<?php
classlevelConfig{
publicstatic$level=array(
'1'=>'新手',
'2'=>'进阶',
);
}
使用的时候
functiongetNameByLeval($level){
$level=intval($level);
require_once'level.config.php';
if(!isset(levelConfig::$level[$level])){
returnfalse;
}else{
returnlevelConfig::$level[$level];
}
}
我个人非常推崇这个方式来定义配置文件，用起来优雅而且不容易覆盖变量。