第七章 配置管理组件
配置管理组件是 WangStruct Framework 基础架构中的重要组成部分,负责统一管理框架运行过程中使用的配置数据。框架启动、应用初始化、模块加载、组件注册和扩展程序运行,都需要读取相应的配置参数。如果不同程序分别读取配置文件,就会造成配置来源分散、访问方式不统一、参数覆盖关系不明确等问题。因此,需要建立独立的配置管理组件,将配置文件组织、配置加载、配置解析、配置合并和配置访问集中管理。
本章以实际工程建设为主线,设计配置管理组件的目录结构、配置文件格式、配置加载类、配置管理类和统一访问接口,明确框架配置、应用配置、模块配置与运行环境配置之间的关系,使框架内部程序和扩展组件能够通过统一接口获取所需的运行参数。
7.1 配置管理组件的工程定位
配置管理组件负责为框架提供统一的配置数据管理能力。它不直接执行应用业务,也不负责决定模块功能,而是将不同来源的配置文件加载到框架运行环境中,按照规定的管理范围组织配置数据,并向其他程序提供统一的访问接口。
配置管理组件需要处理配置文件定位、文件读取、数据解析、配置合并、配置访问和配置修改等工作。配置文件保存参数数据,配置加载类负责读取文件,配置管理类负责管理解析后的配置数据,框架其他组件通过配置接口获取运行参数。
配置管理组件在整体架构中的位置如下:
配置管理组件需要与框架启动机制协同工作。启动程序负责确定运行环境和初始化顺序,配置管理组件负责完成配置数据的加载与组织,其他组件在初始化完成后通过统一接口读取配置。
7.2 配置管理组件的目录结构
配置管理组件需要同时包含配置文件目录和配置管理程序。配置文件按照所属范围进行组织,管理程序则放置在框架核心程序目录中,使配置数据与配置处理程序保持职责分离。
本章设计的配置目录结构如下:
WangStruct/
│
├── config/ # 框架配置文件目录
│ ├── framework.php # 框架基础配置
│ ├── application.php # 应用默认配置
│ ├── environment.php # 运行环境配置
│ └── database.php # 数据库连接配置
│
├── app/ # 应用程序目录
│ ├── config/ # 应用配置目录
│ │ └── application.php # 应用运行配置
│ │
│ └── modules/ # 应用模块目录
│ └── ModuleA/ # ModuleA模块目录
│ └── config/ # 模块配置目录
│ └── module.php # 模块运行配置
│
├── framework/ # 框架核心程序目录
│ └── Config/ # 配置管理程序目录
│ ├── ConfigLoader.php # 配置文件加载类
│ └── Config.php # 配置数据管理类
│
└── public/ # Web访问入口目录
└── index.php # 框架启动入口
config 目录用于保存框架级配置文件,app/config 用于保存应用自身的配置,模块目录下的 config 用于保存对应模块的配置文件。framework/Config 则负责实现配置加载和配置管理程序。
上述目录是本章配置管理组件的工程设计结构。后续实现时,目录和文件的实际创建应以整个框架已经确定的目录规范为依据,不应在未确认的情况下擅自扩展其他配置目录。
7.3 配置文件格式设计
配置文件需要采用统一的数据表达形式,使配置加载程序能够读取并转换为配置管理类可以处理的数据结构。
本章采用 PHP 数组作为基础配置文件格式。PHP 数组能够表达配置名称与配置值之间的对应关系,也能够通过嵌套数组组织多层参数,适合当前 PHP 框架的工程实现。
框架基础配置文件 framework.php:
<?php
return array(
'debug' => true,
'timezone' => 'Asia/Shanghai',
'charset' => 'UTF-8',
'default_module' => 'Index'
);
应用配置文件 application.php:
<?php
return array(
'name' => 'WangStruct Application',
'default_language' => 'zh-cn',
'default_timezone' => 'Asia/Shanghai'
);
模块配置文件 module.php:
<?php
return array(
'module_name' => 'ModuleA',
'enabled' => true,
'page_size' => 20
);
对于具有多层关系的配置,可以使用嵌套数组表达。
<?php
return array(
'cache' => array(
'enabled' => true,
'driver' => 'file',
'path' => 'runtime/cache'
),
'session' => array(
'enabled' => true,
'lifetime' => 3600
)
);
配置加载程序读取配置文件后,将返回的数组交给配置管理类统一管理。配置项名称作为数据索引,配置值作为对应的参数内容。
配置文件应当只保存配置数据,不应将业务处理逻辑写入配置文件。由于 PHP 配置文件通过 require 加载时会执行其中的 PHP 代码,因此配置文件必须来自可信任的工程目录,不能将外部上传的文件直接作为 PHP 配置文件加载。
7.4 配置加载类设计
配置加载类负责读取指定路径下的配置文件,并将配置文件中的数据返回给配置管理程序。
配置加载类不负责配置访问,也不负责不同配置之间的优先级判断。它只处理文件定位、文件加载和返回数据格式验证,使配置读取过程具有统一的程序入口。
配置加载类文件为:
framework/Config/ConfigLoader.php
其基础实现如下:
<?php
class ConfigLoader
{
/**
* 加载配置文件
*/
public function load($file)
{
if (!is_file($file)) {
throw new RuntimeException(
'Configuration file not found: ' . $file
);
}
$config = require $file;
if (!is_array($config)) {
throw new RuntimeException(
'Invalid configuration format: ' . $file
);
}
return $config;
}
}
load() 方法接收配置文件的完整路径,首先检查文件是否存在,然后通过 require 加载文件内容,最后检查文件是否返回数组。
当配置文件不存在、无法加载或返回格式不正确时,程序通过异常报告错误。这样可以避免配置数据缺失后,框架仍然使用不完整的配置进入运行阶段。
7.5 配置管理类设计
配置管理类负责保存和管理已经加载的配置数据,是其他框架组件访问配置的统一入口。
配置加载类解决文件读取问题,配置管理类解决数据管理问题。两者分别承担不同职责,通过明确的程序调用关系完成配置加载和配置访问。
配置数据可以组织为嵌套数组:
其中,\(C_f\) 表示框架配置,\(C_a\) 表示应用配置,\(C_m\) 表示模块配置,\(C_e\) 表示运行环境配置。
配置管理类文件为:
framework/Config/Config.php
基础实现如下:
<?php
class Config
{
protected $items = array();
/**
* 设置配置数据
*/
public function set($name, $value)
{
$this->items[$name] = $value;
}
/**
* 获取配置数据
*/
public function get($name, $default = null)
{
$keys = explode('.', $name);
$value = $this->items;
foreach ($keys as $key) {
if (!is_array($value) ||
!array_key_exists($key, $value)) {
return $default;
}
$value = $value[$key];
}
return $value;
}
/**
* 判断配置是否存在
*/
public function has($name)
{
$marker = new stdClass();
return $this->get($name, $marker) !== $marker;
}
/**
* 删除配置数据
*/
public function remove($name)
{
$keys = explode('.', $name);
$lastKey = array_pop($keys);
$target = &$this->items;
foreach ($keys as $key) {
if (!isset($target[$key]) ||
!is_array($target[$key])) {
return false;
}
$target = &$target[$key];
}
if (!array_key_exists($lastKey, $target)) {
return false;
}
unset($target[$lastKey]);
return true;
}
/**
* 获取全部配置数据
*/
public function all()
{
return $this->items;
}
}
该类通过 $items 保存配置数据。set() 用于设置配置项,get() 用于读取配置项,has() 用于检查配置项是否存在,remove() 用于删除配置项,all() 用于获取当前管理的全部配置数据。
配置名称支持点号形式的层级访问。例如:
$config->get('database.host');
$config->get('cache.enabled');
$config->get('session.lifetime');
这样,调用程序不需要直接处理多层数组,也不需要了解配置文件的实际存储位置。
上述代码为配置管理类的基础实现。配置数据的初始化、配置来源合并和修改权限仍需由后续程序负责,不能将基础数据访问类等同于完整的配置管理系统。
7.6 配置加载与管理程序的协同
配置加载类和配置管理类需要通过明确的调用关系协同工作。
框架启动程序首先确定配置文件所在目录,然后创建配置加载对象。配置加载对象依次读取所需的配置文件,并将读取结果交给配置管理对象。配置管理对象保存配置数据,供框架核心程序和应用组件访问。
其调用过程如下:
在这一过程中,配置文件不直接向业务组件提供数据,业务组件也不需要自行加载配置文件。配置管理类作为统一入口,负责向调用程序返回相应参数。
这种方式可以减少配置读取代码的重复,使框架核心程序、应用程序和扩展模块使用相同的配置访问机制。
7.7 配置作用范围与优先级
配置管理组件需要明确不同配置的作用范围。框架配置服务于框架核心程序,应用配置服务于当前应用,模块配置服务于对应模块,运行环境配置则用于描述当前运行环境及其对应参数。
配置作用范围不能仅依靠配置名称判断,还需要结合配置来源和调用程序的实际权限进行管理。
在允许覆盖的普通配置项中,可以采用以下优先级:
该优先级表示同一配置项在允许覆盖的前提下,后加载的高优先级配置可以覆盖低优先级配置。
例如,框架默认配置可以定义默认分页数量,应用配置可以根据应用需要修改分页数量,模块配置也可以在自身范围内设置模块分页数量。模块自己的配置不应自动覆盖其他模块的同名配置。
配置管理还必须区分普通参数和受保护参数。框架核心目录、关键安全参数等配置不能仅凭加载顺序就允许应用或模块覆盖。是否允许覆盖,应由配置项本身的管理规则决定。
配置合并可以表示为:
其中,\(C_r\) 表示最终形成的配置数据,\(C_f\)、\(C_a\)、\(C_m\)、\(C_e\) 分别表示不同范围的配置来源。
对于嵌套数组,合并程序需要明确处理规则。属于配置对象的关联数组可以按照层级进行合并;属于普通列表的数据则需要根据配置定义决定整体替换还是采用其他处理方式,不能将所有数组一律递归合并。
同时,配置管理程序应当能够识别配置来源,以便发生参数冲突时确定具体来源和覆盖过程。
7.8 配置修改与持久化管理
配置修改需要区分内存数据修改和配置文件持久化修改。
通过配置管理类的 set() 方法修改配置,只会改变当前配置对象保存的数据。它不会自动修改原始配置文件,也不会自动影响其他独立运行的程序实例。
如果需要将修改后的配置长期保存,就需要增加独立的配置保存程序,负责数据格式验证、文件备份、写入权限检查和保存结果验证。
配置持久化过程可以表示为:
其中,\(C_0\) 表示原始配置数据,\(C_1\) 表示修改后的配置数据。新配置通过验证后,才允许执行保存操作。
配置文件写入过程中还需要考虑并发修改问题。多个程序同时修改同一文件时,应采用文件锁或版本校验等方式避免相互覆盖。保存失败时,应保留原始配置,不能让文件处于不完整状态。
配置修改权限也需要受到管理。普通扩展组件可以根据授权读取所需参数,但不能默认拥有修改框架级配置和其他模块配置的权限。
7.9 配置管理与框架启动机制的集成
配置管理组件需要纳入 WangStruct Framework 的启动流程。框架启动时,首先确定运行环境和基础目录,然后初始化配置加载类,读取框架默认配置和应用配置,再根据模块加载过程读取相应模块配置,最后形成供其他组件使用的配置管理对象。
整体启动关系如下:
这里需要区分框架级配置和模块级配置的加载时机。框架启动阶段需要先完成核心运行所需配置的加载,模块配置则应在模块被发现和初始化时读取,不能假定所有模块配置在框架启动入口执行时都已经确定。
配置管理对象注册后,框架核心组件和应用模块通过统一接口获取配置数据。配置管理组件不直接决定组件的初始化顺序,而是向启动程序提供所需的配置参数。
7.10 配置管理组件的工程验证
配置管理组件需要围绕配置文件加载、配置数据管理、层级访问、优先级处理和修改管理开展工程验证。
配置文件加载验证需要检查文件是否存在、是否能够读取以及返回数据格式是否符合约定。对于不存在的文件和格式错误的文件,应当能够准确报告错误。
配置数据访问验证需要检查普通配置项和嵌套配置项是否能够正确读取。对于不存在的配置项,需要验证默认值返回机制;对于值为 null 的已存在配置项,也需要与配置项不存在的情况区分开来。
配置优先级验证需要准备多个来源具有同名参数的配置文件,检查配置合并结果是否符合已经确定的覆盖规则。对于受保护参数,还需要验证低权限配置来源不能越权覆盖。
配置修改验证需要确认 set()、remove() 和 get() 之间的数据变化关系,并确认内存修改不会被误认为持久化修改。若实现配置文件保存功能,还需要独立检查保存成功、保存失败、文件备份和并发写入等情况。
最后,需要将配置管理组件纳入框架启动测试,检查核心组件是否在必要配置加载完成后才开始初始化,以及配置加载失败时框架是否能够停止启动并报告具体错误。
这些验证需要在实际工程实现后执行。代码示例本身不代表已经完成本地语法检查、功能测试或服务器运行验证。
7.11 配置管理组件的工程边界
配置管理组件只负责配置数据的组织、加载、访问和管理,不负责推断业务参数,也不负责自动创建应用功能。配置项的名称、含义、类型、默认值、作用范围和修改权限,需要在框架设计阶段明确。
配置文件负责保存参数,配置加载类负责读取数据,配置管理类负责统一访问。三者之间应保持清晰的职责边界。业务组件通过配置接口读取参数,不应重复实现配置文件解析逻辑。
配置数据存在也不代表对应服务已经正常运行。例如,数据库配置文件中存在主机地址、用户名和密码,并不能证明数据库连接成功。数据库连接是否可用,应由数据库连接组件实际建立连接并验证。
同样,缓存路径配置正确不代表缓存服务已经可用,模块启用配置为真也不代表模块已经成功初始化。配置管理组件只提供运行参数,不替代其他组件的运行检查。
通过本章的工程设计,WangStruct Framework 建立了由配置文件、配置加载类、配置管理类和统一访问接口组成的配置管理基础结构,为后续组件注册、路由管理、应用调度和扩展组件运行提供统一的配置数据管理机制。


