Thinkphp3.2———配置模块
一、配置格式
Thinkphp框架中的所有配置都是数组形式定义的的格式为:
//项目配置 return array( 'DEFAULT_MODULE'=>'Index',//默认模块 'URL_MODEL'=>'2',//URL模式 'SESSION_AUTH_START'=>true,//是否开启session )
配置参数不区分大小写(无论大小写都会被转换成小写),但是还是建议保持大写的配置格式
还可以配置文件中使用二维数组的模式来配置:
//项目配置文件 return array( 'DEFAULT_MODULE' => 'Index', //默认模块 'URL_MODEL' => '2', //URL模式 'SESSION_AUTO_START' => true, //是否开启session 'USER_CONFIG' => array( 'USER_AUTH' => true, 'USER_TYPE' => 2, ), //更多配置参数 //... );
注意:二级配置是区分大小写的,读取时请保持一致
其他格式配置
3.2.2版本开始,配置文件增加yaml/json/xml/ini
以及自定义格式支持。
我们可以在应用入口文件中定义应用的配置文件的后缀,例如:
define('CONF_EXT','.ini');
定义后,应用的配置(包括模块的配置文件)的后缀都统一采用.ini;该配置不会影响框架的内部的配置文件加载,只对自定义配置文件生效
ini配置格式如下:
DEFAULT_MODULE=Index ;默认模块 URL_MODEL=2 ;URL模式 SESSION_AUTO_START=on ;是否开启session
XML格式配置如下:
<config> <default_module>Index</default_module> <url_model>2</url_model> <session_auto_start>1</session_auto_start> </config>
yaml格式配置如下:
default_module:Index #默认模块 url_model:2 #URL模式 session_auto_start:True #是否开启session
JSON格式配置如下:
{ "default_module":"Index", "url_model":2, "session_auto_start":True }
除了yaml/json/xml/ini
格式之外,我们还可以自定义配置格式,定义如下:
define('CONF_EXT','.test'); // 配置自定义配置格式(后缀) define('CONF_PARSE','parse_test'); // 对应的解析函数
CONF_PARSE定义的解析函数返回值是一个配置数组。
二、配置加载
在Thinkphp中,一般来说应用的配置文件是自动加载的,加载的顺序为:
惯例配置->应用配置->模式配置->调试配置->状态配置->模块配置->扩展配置->动态配置
以上是配置文件的加载顺序,因为后面的配置会覆盖之前的同名配置(在没有生效的前提下),所以配置的优先顺序从右到左。
下面说明不同的配置文件的区别和位置
1、惯例配置
惯例重于配置是系统遵循的一个重要思想,框架内置有一个惯例配置文件(位于:Thinkphp/Conf/convention.php),按照大多往往只需要配置和惯例配置不同的或者新增的配置项,如果完全采用默认配置,则不需要定义任何配置文件
<?php // +---------------------------------------------------------------------- // | ThinkPHP [ WE CAN DO IT JUST THINK IT ] // +---------------------------------------------------------------------- // | Copyright (c) 2006-2014 http://thinkphp.cn All rights reserved. // +---------------------------------------------------------------------- // | Licensed ( http://www.apache.org/licenses/LICENSE-2.0 ) // +---------------------------------------------------------------------- // | Author: liu21st <[email protected]> // +---------------------------------------------------------------------- /** * ThinkPHP惯例配置文件 * 该文件请不要修改,如果要覆盖惯例配置的值,可在应用配置文件中设定和惯例不符的配置项 * 配置名称大小写任意,系统会统一转换成小写 * 所有配置参数都可以在生效前动态改变 */ defined('THINK_PATH') or exit(); return array( /* 应用设定 */ 'APP_USE_NAMESPACE' => true, // 应用类库是否使用命名空间 'APP_SUB_DOMAIN_DEPLOY' => false, // 是否开启子域名部署 'APP_SUB_DOMAIN_RULES' => array(), // 子域名部署规则 'APP_DOMAIN_SUFFIX' => '', // 域名后缀 如果是com.cn net.cn 之类的后缀必须设置 'ACTION_SUFFIX' => '', // 操作方法后缀 'MULTI_MODULE' => true, // 是否允许多模块 如果为false 则必须设置 DEFAULT_MODULE 'MODULE_DENY_LIST' => array('Common','Runtime'), 'CONTROLLER_LEVEL' => 1, 'APP_AUTOLOAD_LAYER' => 'Controller,Model', // 自动加载的应用类库层 关闭APP_USE_NAMESPACE后有效 'APP_AUTOLOAD_PATH' => '', // 自动加载的路径 关闭APP_USE_NAMESPACE后有效 /* Cookie设置 */ 'COOKIE_EXPIRE' => 0, // Cookie有效期 'COOKIE_DOMAIN' => '', // Cookie有效域名 'COOKIE_PATH' => '/', // Cookie路径 'COOKIE_PREFIX' => '', // Cookie前缀 避免冲突 'COOKIE_SECURE' => false, // Cookie安全传输 'COOKIE_HTTPONLY' => '', // Cookie httponly设置 /* 默认设定 */ 'DEFAULT_M_LAYER' => 'Model', // 默认的模型层名称 'DEFAULT_C_LAYER' => 'Controller', // 默认的控制器层名称 'DEFAULT_V_LAYER' => 'View', // 默认的视图层名称 'DEFAULT_LANG' => 'zh-cn', // 默认语言 'DEFAULT_THEME' => '', // 默认模板主题名称 'DEFAULT_MODULE' => 'Home', // 默认模块 'DEFAULT_CONTROLLER' => 'Index', // 默认控制器名称 'DEFAULT_ACTION' => 'index', // 默认操作名称 'DEFAULT_CHARSET' => 'utf-8', // 默认输出编码 'DEFAULT_TIMEZONE' => 'PRC', // 默认时区 'DEFAULT_AJAX_RETURN' => 'JSON', // 默认AJAX 数据返回格式,可选JSON XML ... 'DEFAULT_JSONP_HANDLER' => 'jsonpReturn', // 默认JSONP格式返回的处理方法 'DEFAULT_FILTER' => 'htmlspecialchars', // 默认参数过滤方法 用于I函数... /* 数据库设置 */ 'DB_TYPE' => '', // 数据库类型 'DB_HOST' => '', // 服务器地址 'DB_NAME' => '', // 数据库名 'DB_USER' => '', // 用户名 'DB_PWD' => '', // 密码 'DB_PORT' => '', // 端口 'DB_PREFIX' => '', // 数据库表前缀 'DB_PARAMS' => array(), // 数据库连接参数 'DB_DEBUG' => TRUE, // 数据库调试模式 开启后可以记录SQL日志 'DB_FIELDS_CACHE' => true, // 启用字段缓存 'DB_CHARSET' => 'utf8', // 数据库编码默认采用utf8 'DB_DEPLOY_TYPE' => 0, // 数据库部署方式:0 集中式(单一服务器),1 分布式(主从服务器) 'DB_RW_SEPARATE' => false, // 数据库读写是否分离 主从式有效 'DB_MASTER_NUM' => 1, // 读写分离后 主服务器数量 'DB_SLAVE_NO' => '', // 指定从服务器序号 /* 数据缓存设置 */ 'DATA_CACHE_TIME' => 0, // 数据缓存有效期 0表示永久缓存 'DATA_CACHE_COMPRESS' => false, // 数据缓存是否压缩缓存 'DATA_CACHE_CHECK' => false, // 数据缓存是否校验缓存 'DATA_CACHE_PREFIX' => '', // 缓存前缀 'DATA_CACHE_TYPE' => 'File', // 数据缓存类型,支持:File|Db|Apc|Memcache|Shmop|Sqlite|Xcache|Apachenote|Eaccelerator 'DATA_CACHE_PATH' => TEMP_PATH,// 缓存路径设置 (仅对File方式缓存有效) 'DATA_CACHE_KEY' => '', // 缓存文件KEY (仅对File方式缓存有效) 'DATA_CACHE_SUBDIR' => false, // 使用子目录缓存 (自动根据缓存标识的哈希创建子目录) 'DATA_PATH_LEVEL' => 1, // 子目录缓存级别 /* 错误设置 */ 'ERROR_MESSAGE' => '页面错误!请稍后再试~',//错误显示信息,非调试模式有效 'ERROR_PAGE' => '', // 错误定向页面 'SHOW_ERROR_MSG' => false, // 显示错误信息 'TRACE_MAX_RECORD' => 100, // 每个级别的错误信息 最大记录数 /* 日志设置 */ 'LOG_RECORD' => false, // 默认不记录日志 'LOG_TYPE' => 'File', // 日志记录类型 默认为文件方式 'LOG_LEVEL' => 'EMERG,ALERT,CRIT,ERR',// 允许记录的日志级别 'LOG_FILE_SIZE' => 2097152, // 日志文件大小限制 'LOG_EXCEPTION_RECORD' => false, // 是否记录异常信息日志 /* SESSION设置 */ 'SESSION_AUTO_START' => true, // 是否自动开启Session 'SESSION_OPTIONS' => array(), // session 配置数组 支持type name id path expire domain 等参数 'SESSION_TYPE' => '', // session hander类型 默认无需设置 除非扩展了session hander驱动 'SESSION_PREFIX' => '', // session 前缀 //'VAR_SESSION_ID' => 'session_id', //sessionID的提交变量 /* 模板引擎设置 */ 'TMPL_CONTENT_TYPE' => 'text/html', // 默认模板输出类型 'TMPL_ACTION_ERROR' => THINK_PATH.'Tpl/dispatch_jump.tpl', // 默认错误跳转对应的模板文件 'TMPL_ACTION_SUCCESS' => THINK_PATH.'Tpl/dispatch_jump.tpl', // 默认成功跳转对应的模板文件 'TMPL_EXCEPTION_FILE' => THINK_PATH.'Tpl/think_exception.tpl',// 异常页面的模板文件 'TMPL_DETECT_THEME' => false, // 自动侦测模板主题 'TMPL_TEMPLATE_SUFFIX' => '.html', // 默认模板文件后缀 'TMPL_FILE_DEPR' => '/', //模板文件CONTROLLER_NAME与ACTION_NAME之间的分割符 // 布局设置 'TMPL_ENGINE_TYPE' => 'Think', // 默认模板引擎 以下设置仅对使用Think模板引擎有效 'TMPL_CACHFILE_SUFFIX' => '.php', // 默认模板缓存后缀 'TMPL_DENY_FUNC_LIST' => 'echo,exit', // 模板引擎禁用函数 'TMPL_DENY_PHP' => false, // 默认模板引擎是否禁用PHP原生代码 'TMPL_L_DELIM' => '{', // 模板引擎普通标签开始标记 'TMPL_R_DELIM' => '}', // 模板引擎普通标签结束标记 'TMPL_VAR_IDENTIFY' => 'array', // 模板变量识别。留空自动判断,参数为'obj'则表示对象 'TMPL_STRIP_SPACE' => true, // 是否去除模板文件里面的html空格与换行 'TMPL_CACHE_ON' => true, // 是否开启模板编译缓存,设为false则每次都会重新编译 'TMPL_CACHE_PREFIX' => '', // 模板缓存前缀标识,可以动态改变 'TMPL_CACHE_TIME' => 0, // 模板缓存有效期 0 为永久,(以数字为值,单位:秒) 'TMPL_LAYOUT_ITEM' => '{__CONTENT__}', // 布局模板的内容替换标识 'LAYOUT_ON' => false, // 是否启用布局 'LAYOUT_NAME' => 'layout', // 当前布局名称 默认为layout // Think模板引擎标签库相关设定 'TAGLIB_BEGIN' => '<', // 标签库标签开始标记 'TAGLIB_END' => '>', // 标签库标签结束标记 'TAGLIB_LOAD' => true, // 是否使用内置标签库之外的其它标签库,默认自动检测 'TAGLIB_BUILD_IN' => 'cx', // 内置标签库名称(标签使用不必指定标签库名称),以逗号分隔 注意解析顺序 'TAGLIB_PRE_LOAD' => '', // 需要额外加载的标签库(须指定标签库名称),多个以逗号分隔 /* URL设置 */ 'URL_CASE_INSENSITIVE' => true, // 默认false 表示URL区分大小写 true则表示不区分大小写 'URL_MODEL' => 1, // URL访问模式,可选参数0、1、2、3,代表以下四种模式: // 0 (普通模式); 1 (PATHINFO 模式); 2 (REWRITE 模式); 3 (兼容模式) 默认为PATHINFO 模式 'URL_PATHINFO_DEPR' => '/', // PATHINFO模式下,各参数之间的分割符号 'URL_PATHINFO_FETCH' => 'ORIG_PATH_INFO,REDIRECT_PATH_INFO,REDIRECT_URL', // 用于兼容判断PATH_INFO 参数的SERVER替代变量列表 'URL_REQUEST_URI' => 'REQUEST_URI', // 获取当前页面地址的系统变量 默认为REQUEST_URI 'URL_HTML_SUFFIX' => 'html', // URL伪静态后缀设置 'URL_DENY_SUFFIX' => 'ico|png|gif|jpg', // URL禁止访问的后缀设置 'URL_PARAMS_BIND' => true, // URL变量绑定到Action方法参数 'URL_PARAMS_BIND_TYPE' => 0, // URL变量绑定的类型 0 按变量名绑定 1 按变量顺序绑定 'URL_PARAMS_FILTER' => false, // URL变量绑定过滤 'URL_PARAMS_FILTER_TYPE'=> '', // URL变量绑定过滤方法 如果为空 调用DEFAULT_FILTER 'URL_ROUTER_ON' => false, // 是否开启URL路由 'URL_ROUTE_RULES' => array(), // 默认路由规则 针对模块 'URL_MAP_RULES' => array(), // URL映射定义规则 /* 系统变量名称设置 */ 'VAR_MODULE' => 'm', // 默认模块获取变量 'VAR_ADDON' => 'addon', // 默认的插件控制器命名空间变量 'VAR_CONTROLLER' => 'c', // 默认控制器获取变量 'VAR_ACTION' => 'a', // 默认操作获取变量 'VAR_AJAX_SUBMIT' => 'ajax', // 默认的AJAX提交变量 'VAR_JSONP_HANDLER' => 'callback', 'VAR_PATHINFO' => 's', // 兼容模式PATHINFO获取变量例如 ?s=/module/action/id/1 后面的参数取决于URL_PATHINFO_DEPR 'VAR_TEMPLATE' => 't', // 默认模板切换变量 'VAR_AUTO_STRING' => false, // 输入变量是否自动强制转换为字符串 如果开启则数组变量需要手动传入变量修饰符获取变量 'HTTP_CACHE_CONTROL' => 'private', // 网页缓存控制 'CHECK_APP_DIR' => true, // 是否检查应用目录是否创建 'FILE_UPLOAD_TYPE' => 'Local', // 文件上传方式 'DATA_CRYPT_TYPE' => 'Think', // 数据加密方式 );
2、应用配置
应用配置文件也就是调用所有模块之前都会首先加载的公共配置文件(默认:Application/Common/Conf/config.php)
注意:如果改变了公共模块名称的话,公共配置文件的位置应相对应
3、模式配置
如果使用了普通应用模式之外的应用模式的话,还可以为应用模式单独定义配置文件,文件名规范是:Application/Common/Conf/config_应用模式名称.php
(仅在运行该模式下面才会加载)。
4、调试配置
如果开启调试模式的话,则会自动加载框架的调试配置文件(位于:ThinkPHP/Conf/debug.php)和应用配置调试文件(位于:Application/Common/Conf/debug.php)
5、状态配置
每个应用都可以在不同的情况下设置自己的状态(或者说是应用场景),并且加载不同的配置文件。
举个例子,你需要在公司和家里分别设置不同的数据库测试环境。那么可以这样处理,在公司中,我们的入口文件中定义:
define('APP_STATUS','office');
那么就会自动加载改状态对应的配置文件(位于Application/Common/Conf/office.php)
如果回到家,我们修改定义为:
define('APP_STATUS','home');
那么就会自动加载该状态对应的配置文件(位于Application/Common/Conf/home.php)
状态配置是可选的
6、模块配置
每个模块会自动加载自己的配置文件(位于Application/当前模块/Conf/conf.php).
如果使用了普通模式之外的其他应用模式,你还可以为应用模式单独定义配置文件,命名规范为:Application/当前模块/Conf/conf_应用模式名称.php
模块还可以支持独立的状态配置文件,命名规范为:Application/当前模块/Conf/应用状态.php
三、读取配置
无论何种配置文件,定义了配置文件后,都统一使用系统提供的C方法( 可以借助Config单词帮助记忆)来读取已有的配置。
获取已经设置的参数值:C('参数名称')
例如:
C('URL_MODEL')
可以读取到系统的调试模式的设置值,同样,由于配置参数 不区分大小写。因此C方法中的参数名称也不分大小写,但是建议规范还是使用大写
注意:配置参数中不能含有"."和特殊字符,允许字母下划线和数字
如果参数名称为定义配置的话,则返回null值
C方法也可以用于读取二维配置
C('USER_CONFIG.USER_TYPE');
因为配置参数是全局有效的,因此C方法可以在任何地方读取任何配置,即使某个设置参数已经生效过期了。
四、动态配置
之前的方式都是通过预定配置文件的方式,而在具体的操作方法里面,我们仍然可以对某一些参数进行动态配置(或者增加新的配置),主要是指那些还没有被使用的参数。
设置新的值:C('参数名称','参数数据')
例如,我们需要修改动态改变数据缓存的有效期,可以使用
// 动态改变缓存有效期 C('DATA_CACHE_TIME',60); // 获取已经设置的参数值 C('USER_CONFIG.USER_TYPE'); //设置新的值 C('USER_CONFIG.USER_TYPE',1);
五、扩展配置
扩展配置可以支持自动加载额外的自定义配置文件,并且配置格式和项目配置一样。 设置扩展配置的方式如下(多个文件用逗号分隔):
// 加载扩展配置文件 'LOAD_EXT_CONFIG' => 'user,db',
假设扩展配置文件user.php
和db.php
分别用于用户配置和数据库配置,这样做的好处是哪怕以后关闭调试模式,你修改db配置文件后依然会自动生效。
如果在应用公共设置文件中配置的话,那么会自动加载应用公共配置目录下面的配置文件Application/Common/Conf/user.php
和Application/Common/Conf/db.php
。
如果在模块(假设是Home模块)的配置文件中配置的话,则会自动加载模块目录下面的配置文件 Application/Home/Conf/user.php
和Application/Home/Conf/db.php
。
默认情况下,扩展配置文件中的设置参数会并入项目配置文件中。也就是默认都是一级配置参数,例如user.php中的配置参数如下:
<?php //用户配置文件 return array( 'USER_TYPE' => 2, //用户类型 'USER_AUTH_ID' => 10, //用户认证ID 'USER_AUTH_TYPE' => 2, //用户认证模式 );
那么,最终获取用户参数的方式是:
C('USER_AUTH_ID');
如果配置文件改成:
// 加载扩展配置文件 'LOAD_EXT_CONFIG' => array('USER'=>'user','DB'=>'db'),
那么读取的方法
C('USER.USER_AUTH_ID');
六、批量配置
C配置方法支持批量配置,例如:
$config = array('WEB_SITE_TITLE'=>'ThinkPHP','WEB_SITE_DESCRIPTION'=>'开源PHP框架'); C($config);
$config数组中的配置参数会合并到现有的全局配置中。
我们可以通过这种方式读取数据库中的配置参数,例如:
// 读取数据库中的配置(假设有一个config表用于保存配置参数) $config = M('Config')->getField('name,value'); // config是一个关联数组 键值就是配置参数 值就是配置值 // 例如: array('config1'=>'val1','config2'=>'val2',...) C($config); // 合并配置参数到全局配置
合并之后,我们就可以和前面读取普通配置参数一样,读取数据库中的配置参数了,当然也可以动态改变。
// 读取合并到全局配置中的数据库中的配置参数 C('CONFIG1'); // 动态改变配置参数(当前请求有效,不会自动保存到数据库) C('CONFIG2','VALUE_NEW');