规则说明
读取配置
-
of::config($name = null, $default = null, $action = 0)
-
$name配置名以"."为分隔符,如:_of.debug读取debug状态
-
$default默认值未找到配置信息时返回值
-
$action功能操作, 可叠加, 如设置 1 | 4 则代表同时进行 1 和 4 的操作
0=无任何操作 1=读取到的数据格式化成磁盘路径 2=读取到的数据格式化成网络路径 4=本次使用实时配置读取数据
echo of::config('_of.data', null, 1); //打印磁盘可写路径 /** * 如果 _of.data = '/data' //那么静态结果是 ROOT_DIR . '/data' * 如果 _of.data = array( //那么动态结果是 ROOT_DIR . '/test' * 'asCall' => create_function('$params, $arg', 'return $arg ? $params["prefix"] . "/test" : "";'), * 'params' => array('_' => null, true) * ) */ -
预先加载
在一些情况下, 我们需要在系统正式运行前加载必要功能, 如错误日志, 访问监控等, 这时我们可以在框架配置下的 "preloaded" 中设置对应的伪类(仅加载类对应的路径不会实例化), 例如: 下面使用 "composer"(依赖管理工具) 的设置方法
<?php
//修改框架配置文件中的 preloaded 项
return array(
//预先装载类
'preloaded' => array(
//在这里引用以下划线分割的 composer 路径下的 autoload.php 文件
'include_composer_vendor_autoload'
)
);
全局配置
全局配置文件的路径由框架配置中的config指定, 在全局配置里自定义各种配置和修改框架配置
<?php
//修改框架配置文件中的 config 指定的路径文件
//可以通过 $of 遍历直接修改框架配置
unset($of['error']);
//可以通过被继承的方式修改框架
return array(
//修改框架配置
'_of' => array(
//设置系统为测试模式
'debug' => null
),
//自定义配置项
'item' => 'abc'
);
动态配置
在一些系统中, 部分配置文件可能很大又不常用, 这时我们可以将"config"变成数组, 将其中一些参数配置成动态路径, 当需要时自动加载
<?php
//修改框架配置文件中的 config 项
return array(
//配置文件路径, 数组=动态配置{动态键 : 配置路径}, 字符串=等同{"0" : 全局配置}
'config' => array(
//全局配置文件路径, "全局配置._of" === "框架配置"
'/demo/config.php',
//动态配置文件, 当调用 of::config('test.demo.xxx'); 时会动态加载
'test.demo' => '/demo/test.php'
)
);
框架配置 以下配置均有默认值, 可酌情删除
<?php
return array(
//用__FILE__表示的站点根目录, 修改substr的第二参数即可, null=通过磁盘遍历寻找(建议仅框架文件夹为链接时使用)
'rootDir' => strtr(substr(__FILE__, 0, -22), '\\', '/'),
//域名到产品根目录地址, 根路径为空字符串, null=尝试自动计算
'rootUrl' => null,
//配置文件路径, 数组=动态配置{动态键"."分隔 : 配置路径}, 字符串=等同{"0" : 全局配置}
'config' => '/demo/config/config.php',
//节点名称, 区别分布式不同节点, ""=不执行计划及队列等后台任务(用来分流后台任务与用户访问)
'nodeName' => $_SERVER['SERVER_ADDR'] . php_uname(),
//系统时区, 设置php支持的时区(如: Europe/London 支持夏令时)
'timezone' => 'PRC',
//统一调试模式, true=开发模式, null=测试模式, false=生产模式, 字符串=切换开发模式密码
'debug' => true,
//可写目录, 上传, 缓存等路径都将写入该文件夹
'dataDir' => '/data',
//框架目录, 影响OF_DIR,OF_URL 和 rootDir为null时的ROOT_DIR
'ofDir' => '/include/of',
//用户群体的系统字符集
'charset' => 'GB18030',
//视图层文件夹结构 {'/img' : 图片, '/js' : 脚本, '/css' : 样式, '/tpl' : 模板}
'view' => array(
//视图模板文件扩展名
'tplExt' => '.tpl.php',
//默认视图模板模板路径
'tplPath' => '/view',
//全局标题
'title' => ' OF 框架 http://phpof.net/',
),
//数据库连接池
'db' => array(
#单数据库混合写法
//*
//数据库连接方式(mysqlPdo, mysqli, mysql, polar, tidb, mssqlPdo)
'adapter' => 'mysqli',
//数据库连接参数
'params' => array(
#mysql, tidb 模式
//*
'host' => '127.0.0.1',
'port' => 3306,
'user' => 'root',
'password' => 'admin',
'database' => 'test',
//mysql >= 5.5.3 可配置utf8mb4存储emoji表情
'charset' => 'utf8mb4',
//数据库时区, 配合timestamp类型实现跨时区同步, 默认true=框架时区, false=数据库时区, "±00:00"=指定时区
'timezone' => true,
//设置隔离级别, ""=跟随系统, "READ UNCOMMITTED", "READ COMMITTED", "REPEATABLE READ", "SERIALIZABLE"
'isolation' => 'READ COMMITTED',
//跟踪死锁与超时(需mysql >= 5.5, PROCESS权限)
'errorTrace' => array(
//默认n=0关闭, n>0记录前n条加锁SQL, n<0不记录SQL
0,
//正则匹配加锁SQL, 针对性跟踪表有利于提升系统性能
'@.@'
),
//是否长连接
'persistent' => false
// */
#mssql 模式
/*
'host' => '127.0.0.1',
'port' => 1433,
'user' => 'root',
'password' => 'admin',
'database' => 'test',
//设置隔离级别, ""=跟随系统, "READ UNCOMMITTED", "READ COMMITTED", "REPEATABLE READ", "SERIALIZABLE"
'isolation' => 'READ COMMITTED',
//是否长连接
'persistent' => false
// */
)
// */
#多数据库混合写法
/*
array(数据库连接信息),
array(数据库连接信息),
// */
#双数据库读写分离写法
/*
'write' => array(数据库连接信息),
'read' => array(数据库连接信息),
// */
#多数据库读写分离写法
/*
'write' => array(
array(数据库连接信息),
array(数据库连接信息),
),
'read' => array(
array(数据库连接信息),
array(数据库连接信息),
),
// */
#多数据库读写分离写法
/*
//'default'为默认连接源
'default' => array(以上单连接池写法),
'非默认连接池' => array(以上单连接池写法),
// */
),
//预先装载类
'preloaded' => array(
//快捷集成
'of_base_link_setup',
//错误日志
'of_base_error_writeLog',
//session块
'of_base_session_base',
//语言包支持
//'of_base_language_packs',
//防火墙
'of_base_firewall_main',
//xss 防御
'of_base_xssFilter_main',
//扩展支持
//'of_base_extension_match',
//html模板引擎, 实现UI, 开发人员分离
'of_base_htmlTpl_engine',
//非生产模式检查最新版本
'of_base_version_check',
//加载 composer
//'include_composer_vendor_autoload'
),
//快捷集成
'link' => array(
//集成插件
'addin' => array(
//php插件配置文件路径
'pConfig' => '/include/application/config.php',
//js 插件配置文件路径
'jConfig' => '/include/application/config.js',
),
//视图层相关
'view' => array(
/*在head中默认插入的html
'head' => array(
//加载 jquery.js, 执行中相同的非数字key可覆盖
'jQuery' => '<script src="/include/of/att/link/jquery.js" ></script>',
)
// */
)
),
//错误日志
'error' => array(
//日志有效时间(天), 0=不清理
'gcTime' => 30,
//相同错误最多记录次数, 大于0时起用
'repeat' => 999,
//sql日志路径, false=关闭
'sqlLog' => '/data/error/sqlLog',
//php日志路径, false=关闭
'phpLog' => '/data/error/phpLog',
//js日志路径, false=关闭
'jsLog' => '/data/error/jsLog',
//日志时区, 默认系统时区
//'logTz' => _of.timezone
),
//会话封装
'session' => array(
//存储方式, files=文件存储, kv=_of.com.kv方式, mysql=数据库方式
'adapter' => 'files',
//禁止 js 读取 session_id
'httpOnly' => true,
//正则匹配"调度类名::方法名"判断是否自动开启, 不启动除of_base_com_com的框架类
'autoStart' => '@^(?!(serv|of)(_|\b))|of_base_com_com@',
//最大生存时间(分钟)
'maxLifeTime' => 60,
//各调度参数
'params' => array(
#files 模式, 文件存储方式
//*
//存储的文件路径
'path' => '/data/_of/of_accy_session_files'
// */
#mysql 模式, mysql存储表信息(推荐Innodb, MEM
/*
//数据库连接池
'dbPool' => 'default',
// */
#k-v 模式
/*
//k-v 连接池
'kvPool' => 'default',
// */
)
),
//防火墙
'firewall' => array(
/**
* 访问限制, 字符串=指定配置路径(结构同数组), 数组={
* "clientIp" :o从"$_SERVER"获取访问IP顺序, 如 "HTTP_X_REAL_IP", 默认["REMOTE_ADDR"]
* "control" : 匹配规则, 按顺序通过"matches"匹配来验证客户IP是否有效 {
* 匹配规则说明 : {
* "matches" : 匹配调度信息, 调度格式为"class::action" {
* 注释信息 : 其它过滤信息 {
* "action" : 匹配调度信息, 以"@"开始的字符串=按正则处理, "类名::方法"=全等匹配调度格式
* "values" :o匹配全局变量$GLOBALS中的字符串数据 {
* 以"."作为分隔符匹配深度数组 : 以"@"开始按正则, 否则全等对比,
* ...
* }
* "method" :o通过回调方法({"action" : 调度方法})判断匹配, 返回 true=匹配, false=未匹配
* }, ...
* },
* "ipList" : 验证IP列表, 支持IP v4 v6, 字符串=指定配置路径(结构同数组), 数组={
* "blocklist" :o黑名单, 在范围内会被拦截 [
* 字符串=为固定IP,
* [小IP, 大IP]=IP范围,
* ...
* ],
* "allowlist" :o白名单, 不在范围内且不为空会被拦截, 结构同"blocklist"
* }
* }, ...
* }
* }
*/
'network' => ''
),
//多语言包
'language' => array(
//语言包路径
'path' => '/data/_of/of_base_language_packs',
//局部翻译匹配规则, 注意需兼容js, 第一个不为空的子组作为翻译文本, 匹配失败时, 开发模式报错, 其它模式备注
'match' => '/^([\w "\'-,]+)$|^(\W+)$|^(.+?)(?:: |[.!?]+$)/',
//默认语言
'default' => 'base'
),
//扩展管理
'extension' => array(
//扩展程序存储路径
'path' => '/include/extensions',
//扩展执行存储路径
'save' => '/data/_of/of_base_extension/save',
//设置独享页的类名
'exclusive' => 'of_ex'
),
//html模板解析引擎
'htmlTpl' => array(
//编译模版存储路径
'path' => '/data/_of/of_base_htmlTpl_engine',
//自动更新变动模板, true=检查模板修改时间自动更新, false=通过控制台手动更新
'dynamic' => true,
//注释脚本标识 <!--标识[0] php代码 标识[1]-->, [2]脚本匹配正则如'(?:\<\?|_)(.*?)(?:\?\>|)'
'tagKey' => array('<?', '?>'),
//属性的前缀 _value 相当于 value
'attrPre' => '_',
//功能的前缀 __del 代表删除 当前标签
'funcPre' => '__'
),
//测试用例库
'test' => array(
//测试案例配置存在目录, 无限分级, ''=关闭
'cPath' => '',
),
//单点登录
'sso' => array(
//键为以"@"开头的正则, 空间使用首次匹配的配置
'@.@' => array(
#服务端配置(非服务端删掉)
//单点登录所使用的数据库
'dbPool' => 'default',
//用户密码有效期(天), 0=不限制, 期满必须修改
'expiry' => 90,
//开放注册, 单点登录系统使用
'openReg' => true,
#客户端配置(非客户端删掉)
//对接网址, 工具包使用, 默认本机接口
'url' => '',
//对接帐号, 工具包使用
'name' => 'sso',
//对接密码, 工具包使用
'key' => '123456'
)
),
//系统组件
'com' => array(
//组件分页设置
'com::paging' => array(
//默认展示数量
'size' => 10,
//检查是否有权限调用分页, @开头的字符串=正则验证, 否则=遵循回调规则(返回true=通过)
'check' => '@paging$@i'
),
//数据操作
'data' => array(
//数据锁
'lock' => array(
//适配文件 of_accy_com_data_lock_xxx
'adapter' => 'files',
//对应的配置
'params' => array(
#files 模式
//*
//锁文件存储路径, 单机linux可以设置到内存文件系统下, "/dev/shm/..."
'path' => '/data/_of/of_accy_com_data_lock_files',
//slot > 0, 多网盘挂在"path/n"下, 0<= n < slot
'slot' => 1,
// */
#swooleRedis 模式
/*
//k-v redis连接池, 建议关闭持久化
'kvPool' => 'default',
//自动解锁时间(s), 报错时可适当调大, 谨慎强杀Swoole进程, 可能导致锁无法及时释放
'unlock' => 15,
//续签锁间隔时间(s), 须小于"unlock", 更大可以支持更多的锁
'renew' => 5
// */
)
)
),
//网络请求
'net' => array(
//异步回调方式, null=自动判断, true=命令方式, false=网络方式
'isCli' => null,
//网络异步方式的网址, ""=当前网址, url=带端口的网址, 如: 'http://127.0.0.1:80/'
'async' => ''
),
//计划任务
'timer' => array(
//存储的文件路径
'path' => '/data/_of/of_base_com_timer',
//动态任务
'task' => array(
//存储方式, files=文件模式, mysql=数据库模式
'adapter' => 'files',
'params' => array(
#mysql 模式, mysql存储表信息(推荐Innodb)
/*
//数据库连接池
'dbPool' => 'default',
// */
)
),
//静态任务
'cron' => array(
//静态计划任务文件
'path' => ''
),
//启动异步任务方式
'fork' => array(
//调用of_accy_com_timer_xxx, 支持default和swoole
'adapter' => 'default',
'params' => array()
)
),
//key-value 数据存储 可像db分连接池, 'default'为默认连接池
'kv' => array(
'default' => array(
//适配文件 of_accy_com_kv_xxx
'adapter' => 'files',
//对应的配置
'params' => array(
#files 模式
//*
//files 存储路径
'path' => '/data/_of/of_accy_com_kv_files'
// */
#memcache 对应的配置, 可以使用二维数组连接集群
/*
//地址
'host' => '127.0.0.1',
'port' => 11211,
// */
#redis 单点模式
/*
//单点模式
'type' => 'single',
//地址
'host' => '127.0.0.1:6379',
//密码
'auth' => '',
//数据库
'db' => 0,
//是否长连接
'persistent' => false
// */
#redis 多点模式, redis扩展 >= 4.3.0
/*
//多点模式 "cluster"=集群模式, "distributed"=分布模式
'type' => 'cluster',
//地址
'host' => array(
'127.0.0.1:6379'
),
//密码
'auth' => '',
//数据库, 集群不支持选择数据库
'db' => 0,
//是否长连接
'persistent' => false
// */
)
)
),
//消息队列
'mq' => array(
/**
* 消息队列池名 : {
* "adapter" : 适配器(mysql, redis),
* "params" : 调度参数 {
* "vHost" : 虚拟主机, 不同主机下的同名队列互不冲突, 默认=""
*
* #mysql 模式
* "dbPool" : _of.db 的连接池
* #redis 模式
* "kvPool" : _of.com.kv 的redis连接池, 建议使用混合型持久化
* "mqSlot" : 包含两项>0的一维数组, 如[生产分槽[0, 1], 消费分槽[0, 1, 2]]
* 其作用是将消息均衡分布到各节点, 每项对应一个分槽
* 选择合适的数字或字符串让每个节点有一个分槽就是最优的方式
* 第0项数组代表生产分槽, 总个数代表总分槽数;
* 第1项数组代表消费分槽, 要覆盖生产分槽所有项
* 当生产分槽调整时, 要包含调整前所有项, 待分槽自动调整完后, 改为生产分槽
* 注意: 真实节点变动时(含域名), 必须须使用"moveMq"进行迁移, 否则会丢消息
* },
* "moveMq" :o迁移队列时设置, 若迁移的新旧队列池服务有交集, 注意用vHost区别
* 原队列池名P改oP, 配置新队列池P.moveMq = oP, 直到oP清空时移除
* "bindDb" : 事务数据库连接池名, 跟其提交或回滚, 默认=""
* "queues" : 队列配置文件数组或路径, 消息会同时发给这些队列, 结构如下 {
* 队列名 : {
* "mode" : 队列模式, null=生产及消费, false=仅生产, true=仅消费,
* "check" : 自动重载消息队列触发函数,
* true=(默认)校验"消费回调"加载的文件变动,
* false=仅校验队列配置文件变动,
* 字符串=以"@"开头的正则忽略路径(软链接使用真实路径), 如: "@/ctrl/@i"
* "memory" : 单个并发分配内存积累过高后自动重置, 单位M, 默认50, 0=不限制
* "keys" : 消费消息时回调结构 {
* 消息键 : 不存在的键将被抛弃 {
* "lots" : 批量消费, 1=单条消费, >1=一次消费最多数量(消息变成一维数组)
* "cNum" : 并发数量, 数字=每台分布系统相同, 数组=指定不同分布系统并发数 {
* 数字键(分布系统自动排序从0开始小于等于键时生效) : 生效的并发数, 例如:
* 3(首先0-3四台分布系统生效) : 1(这四台分布系统启动一个并发),
* 6(接着4-6三台分布系统生效) : 0(这三台分布系统不启动),
* 7(最后仅7这台分布系统生效) : 2(这台分布系统启动两并发, 之后都不启动)
* }
* "call" : 回调结构
* }, ...
* }
* }, ...
* }
* }, ...
*/
)
),
//系统插件
'addin' => array(
'oUpload' => array(
//禁止上传的扩展文件, 白名单写法 "@^(?!(exe|php|html|htm|js|css)$)@"
'filtExt' => '@^(?:exe|php|html|htm|js|css|)$@',
//允许上传的文件夹(仅可匹配文件夹)
'folder' => '@^/data/upload/@'
)
)
);