PHP函数重构：优化复杂逻辑与消除Switch语句的实践

本文旨在指导如何通过应用SOLID原则和清洁代码实践，对包含复杂条件判断和switch语句的PHP函数进行重构。我们将重点探讨如何利用提前返回机制提升代码可读性，以及如何使用数据映射（Data Map）模式优雅地替代冗余的switch结构，从而提高代码的可维护性和扩展性。通过具体的代码示例，展示如何构建更清晰、更专业的函数。

在软件开发中，随着业务逻辑的增长，函数内部的条件判断和分支逻辑往往会变得复杂，导致代码难以理解和维护。特别是当出现多层嵌套的if语句或冗长的switch语句时，代码的可读性和扩展性会受到严重影响。本教程将以一个典型的php函数为例，展示如何运用重构技巧，使其符合清洁代码和设计模式的原则。

原始函数的问题分析

我们首先来看一个典型的、存在改进空间的execute函数。该函数负责处理饮料订单的逻辑，包括验证饮料类型、检查金额、验证糖量等。

protected function execute(InputInterface $input, OutputInterface $output): int
{
$this->setDrinkType($input);
if (in_array($this->drinkType, $this->allowedDrinkTypes)) {
/**
* Tea       --> 0.4
* Coffee    --> 0.5
* Chocolate --> 0.6
*/
$money = $input->getArgument('money');
switch ($this->drinkType) {
case 'tea':
if ($money < 0.4) {
$output->writeln('The tea costs 0.4');
return 0;
}
break;
case 'coffee':
if ($money < 0.5) {
$output->writeln('The coffee costs 0.5');
return 0;
}
break;
case 'chocolate':
if ($money < 0.6) {
$output->writeln('The chocolate costs 0.6');
return 0;
}
break;
}
if ($this->hasCorrectSugars($input)) {
$this->checkSugars($input, $output);
return 0;
}
$output->writeln('The number of sugars should be between 0 and 2');
return 0;
}
$output->writeln('The drink type should be tea, coffee or chocolate');
return 0;
}

该函数存在以下几个主要问题：

1. 深层嵌套： 多个if和switch语句导致代码层级过深，难以追踪逻辑流。
2. 冗余的switch语句： 用于检查饮料价格的switch语句重复性高，且每次添加新饮料类型都需要修改此结构，不符合开闭原则（Open/Closed Principle）。
3. 职责不明确： hasCorrectSugars和checkSugars虽然分离，但execute函数内部的逻辑仍然混杂了验证、输出和流程控制。
4. 提前返回缺失： 很多错误条件没有立即返回，而是嵌套在主逻辑中。

重构策略与实践

我们将采用以下策略来改进上述函数：

1. 采用提前返回（Early Return）机制

提前返回是一种有效的重构技巧，它通过在函数入口处或条件不满足时立即返回，来减少代码的嵌套层级，使正常逻辑流更加清晰。

立即学习“PHP免费学习笔记（深入）”；

改进前：

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;
}
// 接下来是正常逻辑，不再需要嵌套

对糖量验证也采用相同的策略：

// 验证糖量，不符合则立即返回
if (!$this->hasCorrectSugars($input)) {
$output->writeln('The number of sugars should be between 0 and 2');
return 0;
}

2. 使用数据映射（Data Map）替代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
];
$money = $input->getArgument('money');
$drinkCost = $drinkCosts[$this->drinkType]; // 直接通过键获取价格
// 检查金额，不符合则立即返回
if ($money < $drinkCost) {
$output->writeln('The ' . $this->drinkType . ' costs ' . $drinkCost);
return 0;
}

这种方法使得价格查找变得简单高效，并且极大地提高了代码的扩展性。

3. 明确辅助函数的职责

原始代码中，hasCorrectSugars和checkSugars这两个函数可能让人混淆。通过重构，我们明确它们各自的职责：

• hasCorrectSugars($input)：仅负责验证糖量是否在允许范围内，返回布尔值。
• checkSugars($input, $output)：仅负责根据糖量输出订单信息，不进行验证。

hasCorrectSugars的重构如下，使其更简洁：

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

完整的重构函数

将上述所有改进应用到execute函数中，得到以下更清晰、更专业的代码：

use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
// 假设这是某个命令类或服务类
class DrinkOrderProcessor
{
protected string $drinkType;
protected array $allowedDrinkTypes = ['tea', 'coffee', 'chocolate'];
protected int $minSugars = 0;
protected int $maxSugars = 2;
// 假设 setDrinkType 已经存在并正确设置 $this->drinkType
protected function setDrinkType(InputInterface $input): void
{
$this->drinkType = $input->getArgument('drinkType'); // 示例：假设 drinkType 是一个参数
}
// 假设 isExtraHot 已经存在
protected function isExtraHot(InputInterface $input, OutputInterface $output): void
{
// 示例实现：根据输入判断是否额外加热并输出
if ($input->getOption('extraHot')) { // 假设有 extraHot 选项
$output->write(' extra hot');
}
}
/**
* 执行饮料订单处理逻辑。
*
* @param InputInterface $input 输入接口
* @param OutputInterface $output 输出接口
* @return int 返回状态码，0表示成功或处理完毕
*/
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('Internal error: Drink cost not defined for ' . $this->drinkType);
return 0;
}
$money = (float)$input->getArgument('money'); // 确保金额是浮点数
$drinkCost = $drinkCosts[$this->drinkType];
// 3. 提前返回：验证金额是否足够
if ($money < $drinkCost) {
$output->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);
// 如果所有验证通过并成功处理，通常返回1表示成功，0表示退出或失败
// 具体返回值取决于您的应用约定，这里沿用原有的0
return 0;
}
/**
* 检查糖量是否在允许范围内。
*
* @param InputInterface $input 输入接口
* @return bool 如果糖量正确则返回 true，否则返回 false
*/
protected function hasCorrectSugars(InputInterface $input): bool
{
$sugars = (int)$input->getArgument('sugars'); // 确保糖量是整数
return ($sugars >= $this->minSugars && $sugars <= $this->maxSugars);
}
/**
* 根据糖量输出订单信息。
* 注意：此函数不进行糖量验证，仅负责输出。
*
* @param InputInterface $input 输入接口
* @param OutputInterface $output 输出接口
*/
protected function checkSugars(InputInterface $input, OutputInterface $output): void
{
$sugars = (int)$input->getArgument('sugars');
$output->write('You have ordered a ' . $this->drinkType);
$this->isExtraHot($input, $output); // 调用辅助函数输出是否额外加热
$output->write(' with ' . $sugars . ' sugars');
if ($sugars > 0) {
$output->write(' (stick included)');
}
$output->writeln('');
}
}

总结与注意事项

通过本次重构，我们显著提升了execute函数的质量：

1. 可读性增强： 提前返回减少了嵌套，使代码流更加线性，易于理解。
2. 可维护性提高： switch语句被数据映射取代，添加或修改饮料类型不再需要修改核心逻辑，符合开闭原则。
3. 职责更清晰： hasCorrectSugars专注于验证，checkSugars专注于输出，遵循单一职责原则（Single Responsibility Principle）。
4. 专业性体现： 代码结构更加整洁，符合现代软件开发的最佳实践。

进一步的思考：

• 错误处理： 当前示例中，所有错误都返回0。在实际应用中，更专业的做法是抛出特定的异常，或者返回不同的错误码，以便上层调用者能够更细致地处理错误。
• 配置管理： drinkCosts这样的映射关系可以从类内部提取到配置文件或服务容器中，使其更加灵活和可配置。
• 策略模式： 如果每种饮料的逻辑（不仅仅是价格）变得更加复杂，可以考虑引入策略模式，为每种饮料定义一个独立的类来处理其特有行为，从而彻底消除switch语句。
• 输入验证： 在实际应用中，应始终对$input->getArgument()获取到的数据进行严格的类型转换和验证，以防止潜在的类型错误或安全问题。

通过持续的重构和对清洁代码原则的实践，我们可以构建出更健壮、更易于扩展和维护的软件系统。