代码重构:优化复杂函数与消除Switch语句

代码重构:优化复杂函数与消除Switch语句

本文旨在探讨如何通过应用SOLID原则和清洁代码实践,对包含复杂条件逻辑和switch语句的函数进行重构。我们将重点介绍如何利用提前返回、数据映射以及单一职责原则来简化代码结构、提高可读性与可维护性,从而消除冗余的switch语句,并使函数职责更加清晰。

优化复杂函数的策略与实践

在软件开发中,我们经常会遇到包含复杂条件逻辑、多重判断以及冗长switch语句的函数。这类函数通常难以阅读、理解和维护,并且容易违反单一职责原则(srp)和开放/封闭原则(ocp)。本教程将以一个具体的php函数为例,演示如何通过一系列重构技巧来提升代码质量。

原始函数execute存在以下主要问题:

冗长的switch语句: 根据饮品类型判断价格并进行校验,导致代码重复且难以扩展。多层嵌套的条件判断: if语句和switch语句的组合导致代码层级深,可读性差。职责不明确: 函数内部既处理饮品类型校验,又处理金额校验,还处理糖量校验和输出信息。

我们的目标是使函数更简洁、更易于理解和修改。

1. 采用提前返回(Guard Clauses)简化条件逻辑

原始代码中存在多层嵌套的if语句,例如检查饮品类型是否合法。通过使用“提前返回”(Guard Clauses)模式,我们可以将不符合条件的逻辑提前终止,从而减少代码的嵌套深度,使主流程更加清晰。

重构前:

if (in_array($this->drinkType, $this->allowedDrinkTypes)) {    // ... 大量业务逻辑 ...} else {    $output->writeln('The drink type should be tea, coffee or chocolate');    return 0;}

重构后:

if (!in_array($this->drinkType, $this->allowedDrinkTypes)) {    $output->writeln('The drink type should be tea, coffee or chocolate');    return 0; // 不符合条件,立即返回}// ... 主流程代码,无需嵌套 ...

这种模式使得代码的阅读者能够更快地理解函数的退出条件,而无需深入到多层嵌套中。

2. 消除Switch语句:利用数据结构进行映射

原始函数中最大的痛点是根据饮品类型判断价格的switch语句。这种结构违反了开放/封闭原则(OCP),因为每当需要添加新的饮品类型时,都必须修改这个switch语句。更好的做法是使用数据结构(如关联数组或映射表)来存储这些关系。

重构前(Switch语句):

switch ($this->drinkType) {    case 'tea':        if ($money < 0.4) { /* ... */ } break;    case 'coffee':        if ($money < 0.5) { /* ... */ } break;    case 'chocolate':        if ($money < 0.6) { /* ... */ } break;}

重构后(使用映射表):

$drinkCosts = [    'tea' => 0.4,    'coffee' => 0.5,    'chocolate' => 0.6];// 可以将 $drinkCosts 作为类成员变量或通过依赖注入管理// $drinkCost = $this->drinkCosts[$this->drinkType]; // 如果是类成员变量$drinkCost = $drinkCosts[$this->drinkType];if ($money writeln('The ' . $this->drinkType . ' costs ' . $drinkCost);    return 0;}

通过将饮品类型和其价格的映射关系提取到一个数组中,我们实现了以下好处:

可扩展性: 添加新的饮品类型只需修改$drinkCosts数组,而无需改动核心逻辑。可读性: 价格信息集中管理,一目了然。单一职责: execute函数不再负责“知道”每种饮品的具体价格,它只负责“查询”价格。

3. 明确函数职责与单一职责原则(SRP)

在原始代码中,hasCorrectSugars用于校验糖量,而checkSugars用于输出订单信息。虽然它们都与“糖”相关,但职责不同。hasCorrectSugars是一个纯粹的校验函数,返回布尔值;而checkSugars是一个副作用函数,负责输出。这种分离是符合单一职责原则的良好实践。

原始hasCorrectSugars的优化:

原函数已经很简洁,但可以进一步简化返回语句:

protected function hasCorrectSugars($input): bool{    $sugars = $input->getArgument('sugars');    // 直接返回布尔表达式的结果    return ($sugars >= $this->minSugars && $sugars maxSugars);}

在execute函数中,同样应用提前返回来处理糖量校验:

if (!$this->hasCorrectSugars($input)) {    $output->writeln('The number of sugars should be between 0 and 2');    return 0;}// 校验通过后,再调用输出函数$this->checkSugars($input, $output);

通过这种方式,execute函数在调用checkSugars之前,已经确保了糖量的合法性,逻辑流更加清晰。

4. 完整的重构示例

结合上述策略,重构后的execute函数将变得更加简洁、可读且易于维护:

use SymfonyComponentConsoleInputInputInterface;use SymfonyComponentConsoleOutputOutputInterface;// 假设这是某个Command类或类似结构中的方法class DrinkOrderProcessor{    protected string $drinkType;    protected array $allowedDrinkTypes = ['tea', 'coffee', 'chocolate']; // 示例    protected int $minSugars = 0; // 示例    protected int $maxSugars = 2; // 示例    // 假设 setDrinkType, isExtraHot 等方法已存在    protected function setDrinkType(InputInterface $input): void    {        $this->drinkType = $input->getArgument('drinkType'); // 假设有此参数    }    protected function hasCorrectSugars(InputInterface $input): bool    {        $sugars = $input->getArgument('sugars');        return ($sugars >= $this->minSugars && $sugars maxSugars);    }    protected function checkSugars(InputInterface $input, OutputInterface $output): void    {        $sugars = $input->getArgument('sugars');        $output->write('You have ordered a ' . $this->drinkType);        // 假设 isExtraHot 负责输出额外信息        // $this->isExtraHot($input, $output);        $output->write(' with ' . $sugars . ' sugars');        if ($sugars > 0) {            $output->write(' (stick included)');        }        $output->writeln('');    }    /**     * 执行饮品订单处理的主方法     *     * @param InputInterface $input     * @param OutputInterface $output     * @return int 返回0表示失败或退出,返回1表示成功(根据实际CLI规范)     */    protected function execute(InputInterface $input, OutputInterface $output): int    {        $this->setDrinkType($input);        // 1. 校验饮品类型,不合法则提前返回        if (!in_array($this->drinkType, $this->allowedDrinkTypes)) {            $output->writeln('The drink type should be tea, coffee or chocolate');            return 0;        }        // 2. 使用映射表管理饮品价格,消除switch语句        $drinkCosts = [            'tea' => 0.4,            'coffee' => 0.5,            'chocolate' => 0.6        ];        // 检查饮品类型是否存在于价格表中,避免访问不存在的键        if (!isset($drinkCosts[$this->drinkType])) {            $output->writeln('Error: Price for ' . $this->drinkType . ' is not defined.');            return 0;        }        $money = (float)$input->getArgument('money'); // 确保金额是浮点数        $drinkCost = $drinkCosts[$this->drinkType];        // 3. 校验金额,不足则提前返回        if ($money writeln('The ' . $this->drinkType . ' costs ' . $drinkCost);            return 0;        }        // 4. 校验糖量,不合法则提前返回        if (!$this->hasCorrectSugars($input)) {            $output->writeln('The number of sugars should be between 0 and 2');            return 0;        }        // 5. 所有校验通过,执行订单确认输出        $this->checkSugars($input, $output);        // 根据命令行工具的惯例,通常0表示成功,非0表示失败。        // 如果这里表示成功完成,则应返回0。如果0表示失败,则应返回1。        // 根据原始代码,所有错误路径都返回0,因此这里也保持返回0。        // 但更规范的做法是,成功返回0,失败返回非0。        return 0; // 假设0表示成功执行并退出    }}

注意事项与进一步优化

返回值约定: 在命令行工具中,return 0通常表示成功,非零值表示错误。原始代码中所有错误和成功路径都返回0,这可能会引起混淆。建议根据实际CLI规范进行调整,例如成功返回0,失败返回1或其他错误码,或者抛出异常来处理错误。依赖注入: drinkCosts可以作为类的一个成员变量,甚至通过构造函数注入,以提高灵活性和可测试性。错误处理: 对于更复杂的应用,仅仅通过writeln输出错误信息可能不足。可以考虑使用日志系统或抛出更具体的异常。策略模式: 对于不同饮品类型有更复杂、差异化的逻辑时(例如,不同饮品有不同的配料、制作流程),可以考虑引入策略模式来进一步解耦,而不是简单地通过映射表来处理。

总结

通过上述重构,我们成功地将一个复杂且难以维护的函数转化为一个结构清晰、职责明确、易于扩展和理解的代码段。核心技巧包括:

使用提前返回(Guard Clauses) 减少嵌套,提高代码可读性利用数据结构(如映射表)替代switch语句,遵循开放/封闭原则,使代码更易于扩展。坚持单一职责原则(SRP),确保每个函数只做一件事,提高代码模块化程度。

这些实践不仅提升了当前代码的质量,也为未来的功能迭代和维护奠定了坚实的基础。

以上就是代码重构:优化复杂函数与消除Switch语句的详细内容,更多请关注创想鸟其它相关文章!

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容, 请发送邮件至 chuangxiangniao@163.com 举报,一经查实,本站将立刻删除。
发布者:程序猿,转转请注明出处:https://www.chuangxiangniao.com/p/1319763.html

(0)
打赏 微信扫一扫 微信扫一扫 支付宝扫一扫 支付宝扫一扫
PHP函数重构实践:优化条件逻辑与提升可维护性
上一篇 2025年12月12日 05:42:47
如何重构PHP函数:消除Switch语句与优化验证逻辑
下一篇 2025年12月12日 05:42:59

相关推荐

  • composer require-dev和require有什么不同_Composer Require与Require-Dev区别解析

    require用于声明项目运行必需的依赖,如框架、数据库组件和第三方SDK,这些包会随项目部署到生产环境;2. require-dev用于声明仅在开发和测试阶段需要的工具,如PHPUnit、PHPStan、Faker等,不会默认部署到生产环境;3. 安装时composer install根据环境决定…

    2026年5月10日
    1000
  • Matplotlib 地图中多类型图例的创建与优化

    Matplotlib 地图中多类型图例的创建与优化Matplotlib 地图中多类型图例的创建与优化Matplotlib 地图中多类型图例的创建与优化Matplotlib 地图中多类型图例的创建与优化

    本教程旨在解决matplotlib地图可视化中,如何在一个图例中同时展示颜色块(如区域分类)和自定义标记(如特定兴趣点)的问题。文章详细介绍了当传统`patch`对象无法正确显示标记时,如何利用`matplotlib.lines.line2d`创建标记图例句柄,并将其与颜色块图例句柄合并,从而生成一…

    2026年5月10日 用户投稿
    100
  • 利用海象运算符简化条件赋值:Python教程与最佳实践

    本文旨在探讨Python中海象运算符(:=)在条件赋值场景下的应用。通过对比传统if/else语句与海象运算符,以及条件表达式,分析海象运算符在简化代码、提高可读性方面的优势与局限性。并通过具体示例,展示如何在列表推导式等场景下合理使用海象运算符,同时强调其潜在的复杂性及替代方案,帮助开发者更好地掌…

    2026年5月10日
    100
  • Debian syslog性能优化技巧有哪些

    提升Debian系统syslog (通常基于rsyslog)性能,关键在于精简配置和高效处理日志。以下策略能有效优化日志管理,提升系统整体性能: 精简配置,高效加载: 在rsyslog配置文件中,仅加载必要的输入、输出和解析模块。 使用全局指令设置日志级别和格式,避免不必要的处理。 自定义模板: 创…

    2026年5月10日
    000
  • c++中的SFINAE技术是什么_c++模板编程中的SFINAE原理与应用

    SFINAE 是“替换失败不是错误”的原则,指模板实例化时若参数替换导致错误,只要存在其他合法候选,编译器不报错而是继续重载决议。它用于条件启用模板、类型检测等场景,如通过 decltype 或 enable_if 控制函数重载,实现类型特征判断。尽管 C++20 引入 Concepts 简化了部分…

    2026年5月10日
    000
  • RichHandler与Rich Progress集成:解决显示冲突的教程

    在使用rich库的`richhandler`进行日志输出并同时使用`progress`组件时,可能会遇到显示错乱或溢出问题。这通常是由于为`richhandler`和`progress`分别创建了独立的`console`实例导致的。解决方案是确保日志处理器和进度条组件共享同一个`console`实例…

    2026年5月10日
    000
  • 理解编程指令:当结果正确,但实现方式不符要求时

    本文探讨了在编程实践中,即使程序输出了正确的结果,但若其实现方式未能严格遵循既定指令,仍可能被视为“不正确”的问题。我们将通过具体示例,对比直接求和与累加求和两种实现策略,强调理解和遵守编程规范的重要性,以确保代码的健壮性、可维护性及符合项目要求。 在软件开发过程中,我们经常会遇到这样的情况:编写的…

    2026年5月10日
    000
  • Golang goroutine与channel调试技巧

    使用go run -race检测数据竞争,结合runtime.NumGoroutine监控协程数量,通过pprof分析阻塞调用栈,利用select超时避免永久阻塞,有效排查goroutine泄漏、死锁和数据竞争问题。 Go语言的goroutine和channel是并发编程的核心,但它们也带来了调试上…

    2026年5月10日
    000
  • 使用 Jupyter Notebook 进行探索性数据分析

    Jupyter Notebook通过单元格实现代码与Markdown结合,支持数据导入(pandas)、清洗(fillna)、探索(matplotlib/seaborn可视化)、统计分析(describe/corr)和特征工程,便于记录与分享分析过程。 Jupyter Notebook 是进行探索性…

    2026年5月10日
    000
  • 网站标题关键词更新后,搜索引擎为何仍显示旧标题?

    网站标题更新后,搜索引擎为何显示旧标题? 网站SEO优化中,站长常修改网站标题关键词,期望搜索结果显示自定义标题。然而,即使更新标签、meta keywords、meta description和结构化数据中的name属性后,搜索结果仍显示旧标题,这令人费解。本文将对此进行解释。 问题:站长修改了网…

    2026年5月10日
    100
  • Python命令怎样使用profile分析脚本性能 Python命令性能分析的基础教程

    使用Python的cProfile模块分析脚本性能最直接的方式是通过命令行执行python -m cProfile your_script.py,它会输出每个函数的调用次数、总耗时、累积耗时等关键指标,帮助定位性能瓶颈;为进一步分析,可将结果保存为文件python -m cProfile -o ou…

    2026年5月10日
    000
  • 使用 WebCodecs VideoDecoder 实现精确逐帧回退

    本文档旨在解决在使用 WebCodecs VideoDecoder 进行视频解码时,实现精确逐帧回退的问题。通过比较帧的时间戳与目标帧的时间戳,可以避免渲染中间帧,从而提高用户体验。本文将提供详细的解决方案和示例代码,帮助开发者实现精确的视频帧控制。 在使用 WebCodecs VideoDecod…

    2026年5月10日
    000
  • 如何插入查询结果数据_SQL插入Select查询结果方法

    如何插入查询结果数据_SQL插入Select查询结果方法如何插入查询结果数据_SQL插入Select查询结果方法如何插入查询结果数据_SQL插入Select查询结果方法如何插入查询结果数据_SQL插入Select查询结果方法

    使用INSERT INTO…SELECT语句可高效插入数据,通过NOT EXISTS、LEFT JOIN、MERGE语句或唯一约束避免重复;表结构不一致时可通过别名、类型转换、默认值或计算字段处理;结合存储过程可提升可维护性,支持参数化与动态SQL。 将查询结果数据插入到另一个表中,可以…

    2026年5月10日 用户投稿
    300
  • python中zip函数详解 python多序列压缩zip函数应用场景

    zip函数的应用场景包括:1) 同时遍历多个序列,2) 合并多个列表的数据,3) 数据分析和科学计算中的元素运算,4) 处理csv文件,5) 性能优化。zip函数是一个强大的工具,能够简化代码并提高处理多个序列时的效率。 在Python中,zip函数是一个非常有用的工具,它能够将多个可迭代对象打包成…

    2026年5月10日
    000
  • html5怎么画实线_HTML5用CSS border-style:solid画元素实线边框【绘制】

    可通过CSS的border-style属性设为solid添加实线边框:一、内联样式用border:2px solid #000;二、内部样式表统一设置如div{border:1px solid #333};三、外部CSS文件定义.my-box{border:3px solid red}并引入;四、单…

    2026年5月10日
    400
  • 谷歌浏览器如何截图 谷歌浏览器页面截图技巧

    谷歌浏览器如何截图 谷歌浏览器页面截图技巧谷歌浏览器如何截图 谷歌浏览器页面截图技巧谷歌浏览器如何截图 谷歌浏览器页面截图技巧谷歌浏览器如何截图 谷歌浏览器页面截图技巧

    使用谷歌浏览器的开发者工具截图步骤:1. 按ctrl+shift+i(windows/linux)或cmd+option+i(mac)打开开发者工具。2. 点击右上角三个点,选择”更多工具”,再选择”截图”。3. 选择截取整个页面。推荐的谷歌浏览器扩展…

    2026年5月10日 用户投稿
    100
  • Python中怎样使用pymongo?

    在python中使用pymongo可以轻松地与mongodb数据库进行交互。1)安装pymongo:pip install pymongo。2)连接到mongodb:from pymongo import mongoclient; client = mongoclient(‘mongod…

    2026年5月10日
    000
  • JavaScript函数中插入加载动画(Spinner)的正确方法

    本文旨在解决在JavaScript函数中插入加载动画(Spinner)时遇到的异步问题。通过引入async/await和Promise.all,确保在数据处理完成前后正确显示和隐藏加载动画,提升用户体验。我们将提供两种实现方案,并详细解释其原理和优势。 在Web开发中,当执行耗时操作时,显示加载动画…

    2026年5月10日
    100
  • JS如何实现迭代器?迭代器协议

    JavaScript中实现迭代器需遵循可迭代协议和迭代器协议,通过定义[Symbol.iterator]方法返回具备next()方法的迭代器对象,从而支持for…of和展开运算符;该机制统一了数据结构的遍历接口,实现惰性求值,适用于自定义对象、树、图及无限序列等复杂场景,提升代码通用性与…

    2026年5月10日
    100
  • Golang空接口如何应用在项目中

    空接口可用于接收任意类型值,常见于日志函数、通用数据结构、JSON动态解析及配置驱动逻辑,提升代码灵活性,但需配合类型断言确保安全,避免滥用以降低维护成本。 空接口 interface{} 在 Go 语言中是一个非常灵活的类型,它可以存储任何类型的值。虽然它牺牲了一部分类型安全,但在实际项目中合理使…

    2026年5月10日
    100

发表回复

登录后才能评论
关注微信