如何重构 PHP 函数以提升可读性与可维护性

千丽酱_5382

千丽酱_5382

2026-07-04

181人浏览

原创

如何重构 PHP 函数以提升可读性与可维护性

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

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

在实际开发中,一个看似简单的 getTotalProductsNumber() 方法,若长期承载数据源初始化、条件组装、SQL 聚合与类型转换等多重职责,会逐渐演变为难以调试、难以复用、难以单元测试的“上帝函数”。重构的核心目标不是“让代码更短”,而是明确边界、分离关注点、增强可测性

以下是一个专业、可持续的重构方案:

PHP
PHP

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

下载

✅ 重构原则

  • 单一职责:每个函数只做一件事(如“构造查询器”、“执行求和查询”、“提取首行结果”);
  • 无副作用:私有辅助方法不修改外部状态,仅接收参数并返回结果;
  • 类型安全:全程保持 PHP 7.4+ 类型声明,避免运行时隐式转换风险。

✅ 重构后代码

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); // 防御性处理:空结果返回 0
}

private function queryBuilderFirstRow(array $qb, string $select): array
{
    return $qb['dbm']->findFirstSimple($qb['where'], $select, $qb['opt']);
}

? 关键改进说明

  • getTotalProductsNumber():仅负责协调——准备数据源与条件,委托给专用方法,自身不再触碰 SQL 或类型转换;
  • sumOfProductQuantities():专注业务语义——“对产品数量求和”,并封装空值兜底逻辑(?? 0),避免 (int)null 返回 0 的隐式行为引发歧义;
  • queryBuilderFirstRow():抽象数据访问层——统一封装 Dbm_Supplier::findFirstSimple() 调用,未来切换 ORM 或添加日志/缓存时只需修改此处。

⚠️ 注意事项

  • 确保 getConditionsAndOptions() 始终返回含 'where' 和 'opt' 键的数组,建议为其添加返回类型声明 : array 并做键存在性校验;
  • 若项目已引入 Doctrine DBAL 或 Laravel Eloquent,强烈建议逐步迁移至标准 ORM 查询构建器,从根本上消除手写 SQL 字符串带来的 SQL 注入与可维护性风险;
  • 所有私有方法均应补充 PHPDoc 注释,明确参数含义与返回约定,例如 @param array{dbm: Dbm_Supplier, where: string, opt: array} $qb。

该重构不仅使原函数行数减少、逻辑清晰,更为后续扩展(如支持按品类统计、分页汇总)打下坚实基础——只需新增类似 countByCategory() 方法,复用相同的 queryBuilderFirstRow 底层能力即可。

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

相关文章

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

9044

6

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

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

2023.10.11

5501

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

3408

4

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

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

2023.10.23

4074

6

html怎么上传
html怎么上传

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

2023.11.03

3191

9

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

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

2023.11.09

4517

8

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

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

2023.11.13

3522

8

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

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

2023.11.27

11582

4

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
PHP函数string字符串函数视频讲解
PHP函数string字符串函数视频讲解

共80课时 | 29.5万人学习

PHP函数之array数组函数视频讲解
PHP函数之array数组函数视频讲解

共76课时 | 28.7万人学习

墨刀帮助中心
墨刀帮助中心

共0课时 | 0人学习