如何重构 PHP 中计算发票商品总数的函数以提升可读性与可维护性

阿枫小哥_6255

阿枫小哥_6255

2026-07-04

518人浏览

原创

如何重构 PHP 中计算发票商品总数的函数以提升可读性与可维护性

本文介绍如何将一个职责混杂的 php 函数拆分为多个高内聚、低耦合的私有方法,通过提取查询构建逻辑、聚合操作和数据获取职责,显著提升代码可读性、可测试性与复用性。

本文介绍如何将一个职责混杂的 php 函数拆分为多个高内聚、低耦合的私有方法,通过提取查询构建逻辑、聚合操作和数据获取职责,显著提升代码可读性、可测试性与复用性。

原始 getTotalProductsNumber() 方法存在多个问题:职责过重(同时处理数据源初始化、条件组装、SQL 查询、类型转换)、可读性低、难以单元测试,且硬编码了表连接逻辑与字段名。重构目标是遵循单一职责原则(SRP),将不同关注点分离。

✅ 重构策略与分层设计

我们将原函数拆解为三层逻辑:

PHP
PHP

编写健壮的PHP代码,规避类型转换陷阱、数组怪癖及常见安全漏洞。

下载
  • 入口层(getTotalProductsNumber):仅负责协调流程,声明数据源与查询上下文;
  • 业务逻辑层(sumOfProductQuantities):专注“求商品数量总和”这一语义化操作;
  • 数据访问层(queryBuilderFirstRow):封装底层 ORM/DBM 调用,屏蔽实现细节。
public function getTotalProductsNumber(): int
{
    $dataset = 'supplier_invoice_products INNER JOIN supplier_invoices AS si USING (supplier_invoice_id)';
    $extras = $this->getConditionsAndOptions();

    $queryBuilder = [
        'dbm'   => new Dbm_Supplier($dataset),
        'where' => $extras['where'] ?? [],
        'opt'   => $extras['opt'] ?? []
    ];

    return $this->sumOfProductQuantities($queryBuilder);
}

private function sumOfProductQuantities(array $queryBuilder): int
{
    $select = 'SUM(product_quantity) AS sumTotal';
    $row = $this->queryBuilderFirstRow($queryBuilder, $select);
    return (int)($row['sumTotal'] ?? 0);
}

private function queryBuilderFirstRow(array $qb, string $select): array
{
    // 显式校验依赖项,增强健壮性
    if (!isset($qb['dbm']) || !method_exists($qb['dbm'], 'findFirstSimple')) {
        throw new InvalidArgumentException('Invalid query builder: missing or invalid Dbm_Supplier instance.');
    }

    return $qb['dbm']->findFirstSimple($qb['where'], $select, $qb['opt']);
}

? 关键改进点说明

  • 防御性编程:在 queryBuilderFirstRow 中加入参数校验,避免运行时致命错误;
  • 空值安全:sumOfProductQuantities 使用 ?? 0 防止 NULL 导致 (int)null 返回 0(虽符合预期,但显式更清晰);
  • 语义命名:sumOfProductQuantities 比 getTotalProductsNumber 更准确表达“聚合求和”行为,避免与计数(COUNT(*))混淆;
  • 可扩展性预留:若后续需支持其他聚合(如平均值、最大值),只需新增类似 avgOfProductPrice() 方法,复用 queryBuilderFirstRow。

⚠️ 注意事项

  • 确保 getConditionsAndOptions() 始终返回包含 'where' 和 'opt' 键的数组(建议为其添加 PHPDoc 类型注解或返回类型声明);
  • 若项目已引入 Doctrine、Eloquent 等 ORM,应优先迁移至其 Query Builder 或 Repository 模式,而非封装原始 DBM 类;
  • Dbm_Supplier 若非领域专用类,建议抽象为接口(如 InvoiceProductRepositoryInterface),便于未来替换数据源或 Mock 测试。

该重构不仅简化了主函数,更使每部分职责清晰、边界明确,为后续添加缓存、日志、权限校验等横切关注点提供了干净的扩展入口。

php免费学习视频:立即使用
踏上前端学习之旅,开启通往精通之路!从前端基础到项目实战,循序渐进,一步一个脚印,迈向巅峰!

相关文章

PHP速学教程(入门到精通)
PHP速学教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

php

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

2023.09.01

9204

6

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

5581

5

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

2015

5

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

2023.10.23

3468

4

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

2023.10.23

4134

6

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.03

3231

9

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.09

4597

8

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.13

3582

8

sprintf函数用法详解
sprintf函数用法详解

sprintf函数的用法:1、格式化字符串;2、指定输出宽度和精度;3、返回值。更多关于sprintf函数用法详解的内容,大家可以阅读下面的文章。

2023.11.27

11622

4

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
墨刀帮助中心
墨刀帮助中心

共0课时 | 0人学习

MyEclipse学习中心
MyEclipse学习中心

共0课时 | 0人学习

Apache Subversion 官方手册
Apache Subversion 官方手册

共0课时 | 0人学习