ThinkPHP5文档学习——配置
创始人
2024-02-28 03:31:52

文章目录

  • 一、配置目录
  • 二、配置格式
    • PHP数组定义
    • 其它格式的支持
    • 二级配置
  • 三、配置加载
    • 惯例配置
    • 应用配置
    • 拓展配置
    • 场景配置
  • 四、读取配置参数
  • 五、动态配置
    • 设置配置参数
  • 六、独立配置
    • 独立配置文件V5.0.1版本已经废除该写法
    • 自动读取扩展配置
  • 七、配置作用域
  • 八、环境变量配置

一、配置目录

系统默认的配置文件目录就是应用目录(APP_PATH),也就是默认的application下面,并分为应用配置(整个应用有效)和模块配置(仅针对该模块有效)。

├─application         应用目录
│  ├─config.php       应用配置文件
│  ├─database.php     数据库配置文件
│  ├─route.php        路由配置文件
│  ├─index            index模块配置文件目录
│  │  ├─config.php    index模块配置文件
│  │  └─database.php  index模块数据库配置文件
  • 扩展配置目录(V5.0.1)

    5.0.1开始增加了扩展配置目录的概念,在应用配置目录或者模块配置目录下面增加extra子目录,下面的配置文件都会自动加载无需任何配置
    在这里插入图片描述

  • 自定义配置目录位置:

// 定义配置文件目录和应用目录同级    __DIR__:当前文件所在的目录
define('CONF_PATH', __DIR__.'/../config/');

修改后,如下:

├─application         应用目录
├─config              配置目录
│  ├─config.php       应用配置文件
│  ├─database.php     数据库配置文件
│  ├─route.php        路由配置文件
│  ├─index            index模块配置文件目录
│  │  ├─config.php    index模块配置文件
│  │  └─database.php  index模块数据库配置文件

二、配置格式

ThinkPHP支持多种格式的配置格式,但最终都是解析为PHP数组的方式。

PHP数组定义

返回PHP数组是默认的配置格式,例如:

//项目配置文件
return [// 默认模块名'default_module'        => 'index',// 默认控制器名'default_controller'    => 'Index',// 默认操作名'default_action'        => 'index',//更多配置参数//...
];

配置参数名不区分大小写(因为无论大小写定义都会转换成小写),新版的建议是使用小写定义配置参数的规范。

还可以在配置文件中可以使用二维数组来配置更多的信息,例如:

//项目配置文件
return ['cache'                 => ['type'   => 'File','path'   => CACHE_PATH,'prefix' => '','expire' => 0,],
];

其它格式的支持

默认方式为PHP数组方式定义配置文件,你可以在入口文件定义CONF_EXT常量来更改为其它的配置类型:

// 更改配置格式为ini格式
define('CONF_EXT', '.ini');

配置后,会自动解析支持的配置类型,包括.ini.xml.json.php 在内的格式支持。

二级配置

配置参数支持二级,例如,下面是一个二级配置的设置和读取示例:

$config = ['user'  =>  ['type'  =>  1,'name'  =>  'thinkphp',],'db'    =>  ['type'      =>  'mysql','user'      =>  'root','password'  =>  '',],
];
// 设置配置参数
Config::set($config);
// 读取二级配置参数
echo Config::get('user.type');
// 或者使用助手函数
echo config('user.type');

三、配置加载

在ThinkPHP中,一般来说应用的配置文件是自动加载的,加载的顺序是:

惯例配置->应用配置->扩展配置->场景配置->模块配置->动态配置

以上是配置文件的加载顺序,因为后面的配置会覆盖之前的同名配置(在没有生效的前提下),所以配置的优先顺序从右到左

惯例配置

对常用得我参数做配置,在thinkphp中内置了一个惯例配置(thinkphp/convention.php)。

应用配置

应用初始化的时候,首先会加载的配置文件,位于application\cnfig.php

拓展配置

扩展配置文件是由extra_config_list配置参数定义的额外的配置文件,默认会加载databasevalidate两个扩展配置文件。

V5.0.1开始,取消了该配置参数,扩展配置文件直接放入application/extra目录会自动加载

场景配置

每个应用都可以在不同的情况下设置自己的状态(或者称之为应用场景),并且加载不同的配置文件。

  • 如果应用配置文件过大,想分成几个单独的模块,可以采用动态配置或拓展配置。
Config::load('配置文件名');
  • 配置格式默认是 php数组格式;如果是其它格式,可以使用parse方法来导入:
Config::parse(APP_PATH.'my_config.ini','ini');
Config::parse(APP_PATH.'my_config.xml','xml');

四、读取配置参数

设置完配置参数后,就可以使用get来读取了:

echo Config::get("配置参数");

系统定义了一个助手函数,也可以读取配置,可简化以上操作:

echo config("配置参数");

tp5提供的config助手函数

读取所有的配置参数:

dump(Config::get());
//或者dump(config());

thinkphp还提供了一个dump()提供给开发者在浏览器中可友好的变量输出。
在这里插入图片描述
判断某个参数是否存在:

Config::has("配置参数");
//或者 config("?配置参数")

如果需要读取二级配置,可以使用:

echo Config::get("配置参数.二级参数");
echo config("配置参数.二级参数");

五、动态配置

设置配置参数

使用set方法设置参数:

Config::set("配置参数","配置值");
//或者使用助手函数
config("配置参数","配置值");

也可进行批量设置:

Config::set(['配置参数1' => '配置值1','配置参数2' => '配置值2'
]);
config(['配置参数1' => '配置值1','配置参数2' => '配置值2'
]);

六、独立配置

独立配置文件V5.0.1版本已经废除该写法

自动读取扩展配置

版本要求V5.0.1
5.0.1以上版本支持自动读取扩展配置文件(extra_config_list配置参数废弃),只需要将扩展配置文件放入application/extra目录,即可自动读取。

自动读取的配置文件都是二级配置参数,一级配置名称就是扩展配置的文件名。
模块也可以支持自己的扩展配置文件,只需要放入 application/模块名/extra下面就可以自动加载

系统默认加载的独立配置文件不在此列,包括:

文件名描述
config应用或者模块配置文件
database数据库配置文件
tags场景配置文件
场景名应用场景配置文件

如果你更改了CONF_PATH,那么扩展配置文件目录应该是CONF_PATH/extra,模块配置目录则变成 CONF_PATH/module/,模块的扩展配置目录则变成CONF_PATH/module/extra

defined('CONF_PATH') or define('CONF_PATH', APP_PATH); // 配置文件目录

七、配置作用域

配置参数支持作用域的概念,默认情况下,所有参数都在同一个系统默认作用域下面。如果你的配置参数需要用于不同的项目或者相互隔离,那么就可以使用作用域功能,作用域的作用好比是配置参数的命名空间一样。

可以使用range()切换作用域:

Config::range('test');

八、环境变量配置

ThinkPHP5.0支持使用环境变量配置。
可以在根路径下的.env配置文件中采用ini的方式进行配置。
环境变量配置模板
获取环境变量:

Env::get('database.username');
Env::get('database.password');
// 同时下面的方式也可以获取
Env::get('database_username');
Env::get('database_password');

可以支持默认值,例如:

// 获取环境变量   如果不存在则使用默认值root
Env::get('database.username','root');

可以在应用配置中使用环境变量:
app中使用环境变量

相关内容

热门资讯

埃菲尔铁塔在哪 中国仿建埃菲尔... 2019年4月26日,广西南宁市,街头惊现一座巨型山寨版埃菲尔铁塔,高约20米,白色塔身,造型逼真,...
苗族的传统节日 贵州苗族节日有... 【岜沙苗族芦笙节】岜沙,苗语叫“分送”,距从江县城7.5公里,是世界上最崇拜树木并以树为神的枪手部落...
北京的名胜古迹 北京最著名的景... 北京从元代开始,逐渐走上帝国首都的道路,先是成为大辽朝五大首都之一的南京城,随着金灭辽,金代从海陵王...
应用未安装解决办法 平板应用未... ---IT小技术,每天Get一个小技能!一、前言描述苹果IPad2居然不能安装怎么办?与此IPad不...
脚上的穴位图 脚面经络图对应的... 人体穴位作用图解大全更清晰直观的标注了各个人体穴位的作用,包括头部穴位图、胸部穴位图、背部穴位图、胳...
长白山自助游攻略 吉林长白山游... 昨天介绍了西坡的景点详细请看链接:一个人的旅行,据说能看到长白山天池全凭运气,您的运气如何?今日介绍...
demo什么意思 demo版本... 618快到了,各位的小金库大概也在准备开闸放水了吧。没有小金库的,也该向老婆撒娇卖萌服个软了,一切只...
猫咪吃了塑料袋怎么办 猫咪误食... 你知道吗?塑料袋放久了会长猫哦!要说猫咪对塑料袋的喜爱程度完完全全可以媲美纸箱家里只要一有塑料袋的响...
世界上最漂亮的人 世界上最漂亮... 此前在某网上,选出了全球265万颜值姣好的女性。从这些数量庞大的女性群体中,人们投票选出了心目中最美...
埃菲尔铁塔在哪 中国仿建埃菲尔... 2019年4月26日,广西南宁市,街头惊现一座巨型山寨版埃菲尔铁塔,高约20米,白色塔身,造型逼真,...
苗族的传统节日 贵州苗族节日有... 【岜沙苗族芦笙节】岜沙,苗语叫“分送”,距从江县城7.5公里,是世界上最崇拜树木并以树为神的枪手部落...
北京的名胜古迹 北京最著名的景... 北京从元代开始,逐渐走上帝国首都的道路,先是成为大辽朝五大首都之一的南京城,随着金灭辽,金代从海陵王...
应用未安装解决办法 平板应用未... ---IT小技术,每天Get一个小技能!一、前言描述苹果IPad2居然不能安装怎么办?与此IPad不...