15. 实践练习——版本 7
版本 7 在版本 6 的基础上,把主脚本中使用的常量——即数据文件的名称和要加载的 PHP 文件列表——外部化到一个配置文件中。与版本 6 一样,它不包含任何新类,使用的是版本 5 的类:
| version-07
├── Data
│ ├── config.json
│ ├── database-mysql.json
│ ├── database-pgsql.json
│ ├── errors.json
│ ├── results.json
│ ├── taxadmindata.json
│ └── taxpayersdata.json
├── Main
│ ├── MainCalculateTaxWithTaxAdminDataInDatabase.php
│ └── MainTransferAdminDataFromJsonFile2Database.php
└── Tests
├── BusinessTest.php
└── DaoTest.php
|
[Data] 文件夹包含两个 [dbtaxes-2019] 数据库的描述:版本 5 的 MySQL 数据库([database-mysql.json]) 和版本 6 的 PostgreSQL 数据库([database-pgsql.json])。在后一个文件中,表名不再带有模式 [public] 前缀(["tableBrackets": "tbbrackets"])。
15.1. 实现
配置文件是如下的 JSON 文件 [Data/config.json]:
| {
"databaseFilename": "Data/database-pgsql.json",
"taxAdminDataFilename": "Data/taxadmindata.json",
"taxPayersDataFilename": "Data/taxpayersdata.json",
"resultsFilename": "Data/results.json",
"errorsFilename": "Data/errors.json",
"dependencies": {
"TaxException": "../version-05/Entities/TaxException.php",
"TaxAdminData": "../version-05/Entities/TaxAdminData.php",
"TaxPayerData": "../version-05/Entities/TaxPayerData.php",
"Database": "../version-05/Entities/Database.php",
"Utilities": "../version-05/Utilities/Utilities.php",
"InterfaceDao": "../version-05/Dao/InterfaceDao.php",
"TraitDao": "../version-05/Dao/TraitDao.php",
"DaoTaxWithTaxAdminDataInDatabase": "../version-05/Dao/DaoTaxWithTaxAdminDataInDatabase.php",
"InterfaceDao4TransferAdminData2Database": "../version-05/Dao/InterfaceDao4TransferAdminData2Database.php",
"DaoTransferAdminDataFromJsonFile2Database": "../version-05/Dao/DaoTransferAdminDataFromJsonFile2Database.php",
"InterfaceBusiness": "../version-05/Business/InterfaceBusiness.php",
"Business": "../version-05/Business/Business.php"
},
"dependencies4calculate": [
"TaxException",
"TaxAdminData",
"TaxPayerData",
"Database",
"Utilities",
"InterfaceDao",
"TraitDao",
"DaoTaxWithTaxAdminDataInDatabase",
"InterfaceBusiness",
"Business"
],
"dependencies4transfer": [
"TaxException",
"TaxAdminData",
"Database",
"Utilities",
"InterfaceDao4TransferAdminData2Database",
"DaoTransferAdminDataFromJsonFile2Database"
]
}
|
在这个配置中:
- 第 2–6 行:应用程序中所有 JSON 文件的路径。所用的数据库是 PostgreSQL;
- 第 7–20 行:应用程序中所有 PHP 文件的路径,形式为 [key => path]。这些是版本 5 的文件;
- 第 21–32 行:税款计算的依赖项,形式为 [dependencies] 字典中的键列表;
- 第 33–40 行:把数据从 JSON 文件 [taxadmindata.json] 传送到数据库的依赖项,格式相同。
所有路径都相对于 [version-07] 文件夹。PHP 7 课程在该文件中添加了一个名为 [rootDirectory] 的键,指定版本文件夹在作者机器上的绝对路径(["C:/Data/st-2019/dev/php7/poly/scripts-console/impots/version-07"]):每换一台新机器都必须修改它。现在脚本根据常量 [__DIR__] 自己计算该文件夹的路径。因此 [php8-oct-2026] 文件夹可以放在任何位置。
把税务管理数据传送到数据库的脚本 [Main/MainTransferAdminDataFromJsonFile2Database.php],现在如下:
| <?php
// 严格遵守所声明的函数参数和结果的类型
declare(strict_types=1);
// 命名空间
namespace Application;
// 版本 7 的根文件夹:配置文件的路径相对于此文件夹
const ROOT_DIRECTORY = __DIR__ . "/..";
// 配置文件的路径
const CONFIG_FILENAME = ROOT_DIRECTORY . "/Data/config.json";
// 获取配置
$config = json_decode(file_get_contents(CONFIG_FILENAME), true, flags: JSON_THROW_ON_ERROR);
// 引入脚本所需的依赖
foreach ($config["dependencies4transfer"] as $dependency) {
require_once ROOT_DIRECTORY . "/" . $config["dependencies"][$dependency];
}
// 数据文件的路径
$databaseFilename = ROOT_DIRECTORY . "/" . $config["databaseFilename"];
$taxAdminDataFilename = ROOT_DIRECTORY . "/" . $config["taxAdminDataFilename"];
try {
// 创建 [dao] 层
$dao = new DaoTransferAdminDataFromJsonFile2Database($databaseFilename, $taxAdminDataFilename);
// 将数据传输到数据库
$dao->transferAdminData2Database();
print "The data of the tax administration have been transferred into the database described by [{$config["databaseFilename"]}]\n";
} catch (TaxException $ex) {
// 我们显示错误
print "Error no. {$ex->getCode()}: {$ex->getMessage()}\n";
}
// 结束
print "Done\n";
|
说明
代码与版本 6 中保持一致。唯一的区别是使用文件 [config.json] 代替常量:
- 第 10 行:版本 7 的根目录,配置文件中的路径都是相对于它度量的。[__DIR__] 是脚本所在的 [Main] 文件夹;[__DIR__ . "/.."] 是它的父文件夹 [version-07];
- 第 12 行:配置文件的路径;
- 第 15 行:[file_get_contents] 函数将文件 [config.json] 转换为字符串。随后 [json_decode] 函数使用该字符串构造关联数组 [$config]。[json_decode] 函数的第二个参数 [true] 指定想要得到关联数组而不是对象。使用 [JSON_THROW_ON_ERROR] 选项时,文件中的语法错误会触发 [JsonException] 异常。我们在这里不尝试处理配置文件的读取错误:该文件是应用程序的一部分,这一层的错误属于编程错误,由 PHP 自己报告。数据错误(JSON 数据文件、数据库)则总是由 [TaxException] 报告;
- 第 18–20 行:包含传送脚本所需的依赖项:
- [$config["dependencies4transfer"]] 是传送脚本所需依赖项的表。它是一个键的列表;
- 要包含的文件的路径可在字典 [$config["dependencies"]] 中找到,并加上根目录作为前缀。例如,键 [TaxException] 指向文件 [version-07/../version-05/Entities/TaxException.php];
- [require_once] (而不是 PHP 7 课程中的 [require] )确保文件不会被加载两次,否则会导致致命错误“Cannot redeclare class … (previously declared in …)”;
- 第 23–24 行:数据文件的完整路径。PHP 7 课程把它们存放在由 [define] 函数创建的常量中。变量就足够了;
- 第 31 行:显示所用数据库的描述文件的名称。在用双引号括起的字符串中,数组元素 [$config["databaseFilename"]] 必须用花括号括起来。
结果:
| > php MainTransferAdminDataFromJsonFile2Database.php
The data of the tax administration have been transferred into the database described by [Data/database-pgsql.json]
Done
|
同样,税款计算脚本变为如下的 [Main/MainCalculateTaxWithTaxAdminDataInDatabase.php]:
| <?php
// 严格遵守所声明的函数参数和结果的类型
declare(strict_types=1);
// 命名空间
namespace Application;
// 版本 7 的根文件夹:配置文件的路径相对于此文件夹
const ROOT_DIRECTORY = __DIR__ . "/..";
// 配置文件的路径
const CONFIG_FILENAME = ROOT_DIRECTORY . "/Data/config.json";
// 获取配置
$config = json_decode(file_get_contents(CONFIG_FILENAME), true, flags: JSON_THROW_ON_ERROR);
// 引入脚本所需的依赖
foreach ($config["dependencies4calculate"] as $dependency) {
require_once ROOT_DIRECTORY . "/" . $config["dependencies"][$dependency];
}
// 数据文件的路径
$databaseFilename = ROOT_DIRECTORY . "/" . $config["databaseFilename"];
$taxPayersDataFilename = ROOT_DIRECTORY . "/" . $config["taxPayersDataFilename"];
$resultsFilename = ROOT_DIRECTORY . "/" . $config["resultsFilename"];
$errorsFilename = ROOT_DIRECTORY . "/" . $config["errorsFilename"];
try {
// 创建 [dao] 层
$dao = new DaoTaxWithTaxAdminDataInDatabase($databaseFilename);
// 创建 [business] 层
$business = new Business($dao);
// 批处理模式下的税款计算
$business->executeBatchTaxes($taxPayersDataFilename, $resultsFilename, $errorsFilename);
print "The results have been saved in the file [{$config["resultsFilename"]}]\n";
} catch (TaxException $ex) {
// 我们显示错误
print "Error no. {$ex->getCode()}: {$ex->getMessage()}\n";
}
// 结束
print "Done\n";
|
- 第 18–20 行:这一次,包含的是税款计算的依赖项;
- 第 23–26 行:应用程序 JSON 文件的路径;
- 第 28–39 行:其余代码与版本 6 中相同。
结果:
| > php MainCalculateTaxWithTaxAdminDataInDatabase.php
The results have been saved in the file [Data/results.json]
Done
|
生成的 [Data/results.json] 文件与版本 5 和 6 中的 [results.json] 文件 完全相同。
这两个脚本的名称已经改变。在 PHP 7 课程中,它们指明了 PostgreSQL([MainTransferAdminDataFromFile2PostgresSQLDatabase.php]、[MainCalculateImpotsWithTaxAdminDataInPostgresDatabase.php])。然而,这些脚本不再依赖任何特定的 DBMS:DBMS 由配置文件中的 [databaseFilename] 键选择。如果在该文件中把 ["Data/database-pgsql.json"] 替换为 ["Data/database-mysql.json"] ,传送脚本就会使用 MySQL 数据库,而无需改动任何一行 PHP 代码:
| > php MainTransferAdminDataFromJsonFile2Database.php
The data of the tax administration have been transferred into the database described by [Data/database-mysql.json]
Done
|
这就是配置文件的好处:无需触碰代码,就可以使应用程序适应其环境(DBMS、文件位置等)。我们将在应用程序的后续版本中再次见到这个配置文件。
15.2. [PHPUnit] 测试
与之前的版本一样,这个版本也由 [PHPUnit] 测试来验证。它们的环境同样基于配置文件构建。
15.2.1. [dao] 层的测试
[dao] 层的测试将使用 [Data] 文件夹中的两个数据库描述:这样我们就用同一套测试来验证 [dao] 层既能用于 MySQL,也能用于 PostgreSQL。[Tests/DaoTest.php] 测试如下:
| <?php
// 严格遵守所声明的函数参数和结果的类型
declare(strict_types=1);
// 测试的命名空间
namespace Application\Tests;
// 被测试的类
use Application\DaoTaxWithTaxAdminDataInDatabase;
use Application\DaoTransferAdminDataFromJsonFile2Database;
use Application\TaxAdminData;
// PHPUnit 的类
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\TestCase;
final class DaoTest extends TestCase
{
// 版本 7 的根文件夹
private const string ROOT_DIRECTORY = __DIR__ . "/..";
// 应用程序的配置
private static array $config;
// 在类的第一个测试之前执行一次
#[\Override]
public static function setUpBeforeClass(): void
{
// 获取配置
self::$config = json_decode(file_get_contents(self::ROOT_DIRECTORY . "/Data/config.json"), true, flags: JSON_THROW_ON_ERROR);
// 引入税款计算的依赖以及数据传输的依赖
$dependencies = array_unique([...self::$config["dependencies4calculate"], ...self::$config["dependencies4transfer"]]);
foreach ($dependencies as $dependency) {
require_once self::ROOT_DIRECTORY . "/" . self::$config["dependencies"][$dependency];
}
}
// 两个数据库
public static function databases(): array
{
// [数据库描述文件]
return [
"MySQL" => ["Data/database-mysql.json"],
"PostgreSQL" => ["Data/database-pgsql.json"],
];
}
// 从数据库读取的税务管理部门数据
#[DataProvider("databases")]
public function testTaxAdminData(string $databaseFilename): void
{
$dao = new DaoTaxWithTaxAdminDataInDatabase(self::ROOT_DIRECTORY . "/$databaseFilename");
$taxAdminData = $dao->getTaxAdminData();
// 计算常量
$this->assertSame(1551.0, $taxAdminData->halfShareQfCeiling);
$this->assertSame(21037.0, $taxAdminData->singleIncomeCeilingForReduction);
$this->assertSame(42074.0, $taxAdminData->coupleIncomeCeilingForReduction);
$this->assertSame(3797.0, $taxAdminData->halfShareReductionValue);
$this->assertSame(1196.0, $taxAdminData->singleDiscountCeiling);
$this->assertSame(1970.0, $taxAdminData->coupleDiscountCeiling);
$this->assertSame(1595.0, $taxAdminData->singleTaxCeilingForDiscount);
$this->assertSame(2627.0, $taxAdminData->coupleTaxCeilingForDiscount);
$this->assertSame(12502.0, $taxAdminData->tenPercentAllowanceMax);
$this->assertSame(437.0, $taxAdminData->tenPercentAllowanceMin);
// 税率档
$this->assertSame([9964.0, 27519.0, 73779.0, 156244.0, 0.0], $taxAdminData->limits);
$this->assertSame([0.0, 0.14, 0.30, 0.41, 0.45], $taxAdminData->coeffR);
$this->assertSame([0.0, 1394.96, 5798.0, 13913.69, 20163.45], $taxAdminData->coeffN);
}
// 将 JSON 文件传输到数据库,然后重新读取数据库
#[DataProvider("databases")]
public function testTransfer(string $databaseFilename): void
{
// JSON 文件
$databaseFilename = self::ROOT_DIRECTORY . "/$databaseFilename";
$taxAdminDataFilename = self::ROOT_DIRECTORY . "/" . self::$config["taxAdminDataFilename"];
// 传输
(new DaoTransferAdminDataFromJsonFile2Database($databaseFilename, $taxAdminDataFilename))->transferAdminData2Database();
// 通过 [dao] 层重新读取数据库
$dao = new DaoTaxWithTaxAdminDataInDatabase($databaseFilename);
// 数据库包含 JSON 文件的数据
$this->assertEquals(TaxAdminData::fromJsonFile($taxAdminDataFilename), $dao->getTaxAdminData());
}
}
|
说明
- 第 10–12 行:导入被测试的类。[use] 语句并不加载这些类;它只是允许用它们的短名称来引用它们;
- 第 22 行:应用程序配置存放在一个静态(类)属性中;
- 第 26–35 行:[TestCase] 的静态方法 [setUpBeforeClass] 在类的第一个测试之前执行一次。它读取配置文件并加载应用程序文件。PHP 7 课程是在测试文件的顶层、类的外部完成这项任务的。使用 PHPUnit 时,这段代码在 PHPUnit 加载文件时执行,其时机不在我们的控制之下;[setUpBeforeClass] 方法正是为此目的而设计的;
- 第 31 行:[dao] 层的测试既需要税款计算的依赖项(用于类 [DaoTaxWithTaxAdminDataInDatabase]),也需要传送的依赖项(用于类 [DaoTransferAdminDataFromJsonFile2Database])。这两个列表被合并,然后函数 [array_unique] 去除重复项;
- 第 38–45 行:数据源:两个数据库的描述文件;
- 第 48–49 行:版本 5 的 [testTaxAdminData] 测试对这两个数据库各运行一次;
- 第 71–83 行:从 JSON 文件向数据库传送数据的测试也是如此。
15.2.2. [business] 层的测试
[Tests/BusinessTest.php] 测试是版本 5 的测试,其环境根据配置文件构建:
| <?php
// 严格遵守所声明的函数参数和结果的类型
declare(strict_types=1);
// 测试的命名空间
namespace Application\Tests;
// 被测试的类
use Application\DaoTaxWithTaxAdminDataInDatabase;
use Application\InterfaceBusiness;
use Application\Business;
// PHPUnit 的类
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\TestCase;
final class BusinessTest extends TestCase
{
// 版本 7 的根文件夹
private const string ROOT_DIRECTORY = __DIR__ . "/..";
// 应用程序的配置
private static array $config;
// 被测试的 [business] 层
private InterfaceBusiness $business;
// 在类的第一个测试之前执行一次
#[\Override]
public static function setUpBeforeClass(): void
{
// 获取配置
self::$config = json_decode(file_get_contents(self::ROOT_DIRECTORY . "/Data/config.json"), true, flags: JSON_THROW_ON_ERROR);
// 引入税款计算的依赖
foreach (self::$config["dependencies4calculate"] as $dependency) {
require_once self::ROOT_DIRECTORY . "/" . self::$config["dependencies"][$dependency];
}
}
// 在每个测试之前执行
#[\Override]
protected function setUp(): void
{
// 在配置的数据库上创建 [dao] 层
$dao = new DaoTaxWithTaxAdminDataInDatabase(self::ROOT_DIRECTORY . "/" . self::$config["databaseFilename"]);
// 创建 [business] 层
$this->business = new Business($dao);
}
|
说明
- 第 28–36 行:读取配置文件并加载税款计算的依赖项,就像主脚本 [MainCalculateTaxWithTaxAdminDataInDatabase] 所做的那样;
- 第 43 行:[dao] 层使用配置文件所指定的数据库;
- 数据提供者 [taxpayers] 和方法 [testCalculateTax](此处未列出)与版本 4 中的相同。
15.2.3. 运行测试
MySQL 和 PostgreSQL 这两个 DBMS 都必须启动。测试结果如下:
| > php vendor/bin/phpunit scripts-console/tax/version-07/Tests --testdox
PHPUnit 12.5.37 by Sebastian Bergmann and contributors.
Runtime: PHP 8.5.11
Configuration: .../php8-oct-2026/phpunit.xml
............... 15 / 15 (100%)
Time: 00:00.602, Memory: 16.00 MB
Business (Application\Tests\Business)
✔ Calculate tax with data set "couple, 2 children, 55555"
✔ Calculate tax with data set "couple, 2 children, 50000"
✔ Calculate tax with data set "couple, 3 children, 50000"
✔ Calculate tax with data set "single, 2 children, 100000"
✔ Calculate tax with data set "single, 3 children, 100000"
✔ Calculate tax with data set "couple, 3 children, 100000"
✔ Calculate tax with data set "couple, 5 children, 100000"
✔ Calculate tax with data set "single, 0 children, 100000"
✔ Calculate tax with data set "couple, 2 children, 30000"
✔ Calculate tax with data set "single, 0 children, 200000"
✔ Calculate tax with data set "couple, 3 children, 200000"
Dao (Application\Tests\Dao)
✔ Tax admin data with data set "MySQL"
✔ Tax admin data with data set "PostgreSQL"
✔ Transfer with data set "MySQL"
✔ Transfer with data set "PostgreSQL"
OK (15 tests, 50 assertions)
|
- 第 12–15 行:[dao] 层的测试分别用两个数据库各运行了一次;
- 第 18–28 行:[business] 层的 11 个测试。
至此,我们已经完成了税款计算应用程序的控制台版本。版本 8 将把它改造成客户端/服务器应用程序:数据库和税款计算将位于 Web 服务器上,由客户端查询。它将整合版本 5 的类和版本 7 的配置文件技术。