如何重构PHP函数：消除Switch语句与优化验证逻辑

本文将深入探讨如何对一个包含复杂条件逻辑和switch语句的PHP函数进行重构，以提升其可读性、可维护性，并使其更好地遵循SOLID原则。我们将重点介绍如何利用数据结构替代switch语句，应用卫语句（Early Return）简化控制流，并优化参数验证与信息输出的职责划分，从而构建更清晰、更专业的代码。

理解原始代码的问题

在软件开发中，随着业务逻辑的增长，函数可能会变得臃肿和难以理解。原始的execute函数展示了一些常见的问题：

1. 多重职责（Single Responsibility Principle, SRP违背）：execute函数不仅负责验证饮料类型、验证金额，还负责验证糖量并输出信息。这使得函数过于庞大，难以维护和测试。
2. switch语句的复杂性：switch语句根据饮料类型处理不同的金额验证逻辑，这在未来新增饮料类型时需要修改此函数，违背了开闭原则（Open/Closed Principle, OCP）。此外，硬编码的饮料价格也降低了灵活性。
3. 嵌套条件语句：多层if和switch的嵌套使得代码的控制流难以追踪，增加了认知负担。
4. 重复的返回语句：在多个错误路径中都返回0，虽然在Symfony命令中0通常表示成功，但在错误情况下返回0可能引起混淆。更合理的做法是，如果表示错误，应返回非零值。
5. 职责不清晰的辅助函数：hasCorrectSugars和checkSugars虽然试图解耦，但checkSugars除了检查外还负责输出，职责边界不够明确。

重构策略与实践

针对上述问题，我们可以采用以下策略进行重构：

1. 卫语句（Early Return）

卫语句是一种通过提前返回来简化复杂条件逻辑的技术。它能有效减少嵌套层级，使代码路径更清晰。

重构前：

protected function execute(InputInterface $input, OutputInterface $output): int
{
$this->setDrinkType($input);
if (in_array($this->drinkType, $this->allowedDrinkTypes)) {
// ... 核心逻辑 ...
}
$output->writeln('The drink type should be tea, coffee or chocolate');
return 0;
}

重构后：

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

protected function execute(InputInterface $input, OutputInterface $output): int
{
$this->setDrinkType($input);
// 如果饮料类型不被允许，立即返回并输出错误信息
if (!in_array($this->drinkType, $this->allowedDrinkTypes)) {
$output->writeln('The drink type should be tea, coffee or chocolate');
return 0; // 或者返回1表示错误
}
// ... 后续逻辑 ...
}

通过将主逻辑包裹在一个if语句中，然后在其外部处理错误情况，不如直接在条件不满足时返回。这种“先检查错误，再执行主逻辑”的模式使得正常流程的代码更靠前，更易读。

2. 使用数据结构替代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;
}

重构后：

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

// 定义饮料成本映射，可以作为类成员变量或配置项
$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; // 或者返回1表示错误
}

这种方法不仅消除了switch语句，使得新增饮料类型时只需修改$drinkCosts数组（或外部配置），而无需修改execute函数的核心逻辑，从而更好地遵循了开闭原则。

3. 优化糖量验证与输出逻辑

hasCorrectSugars负责验证糖量是否在有效范围内，而checkSugars负责根据糖量输出信息。它们职责明确，但execute函数中对它们的调用顺序和错误处理可以进一步优化。

重构前：

if ($this->hasCorrectSugars($input)) {
$this->checkSugars($input, $output);
return 0;
}
$output->writeln('The number of sugars should be between 0 and 2');
return 0;

重构后：

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

// 如果糖量不正确，立即返回并输出错误信息
if (!$this->hasCorrectSugars($input)) {
$output->writeln('The number of sugars should be between 0 and 2');
return 0; // 或者返回1表示错误
}
// 糖量正确，则调用checkSugars进行信息输出
$this->checkSugars($input, $output);
return 0; // 如果是成功完成，返回0

hasCorrectSugars的实现保持简洁，只负责验证：

protected function hasCorrectSugars($input): bool
{
$sugars = $input->getArgument('sugars');
// 假设 $this->minSugars 和 $this->maxSugars 已定义
return ($sugars >= $this->minSugars && $sugars <= $this->maxSugars);
}

checkSugars则专注于输出用户订单信息：

protected function checkSugars($input, $output): void
{
$sugars = $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函数将变得更加清晰和易于维护：

use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
// 假设这是一个Command类的一部分
class DrinkOrderCommand
{
protected string $drinkType;
protected array $allowedDrinkTypes = ['tea', 'coffee', 'chocolate'];
protected float $minSugars = 0;
protected float $maxSugars = 2;
// 假设 setDrinkType 和 isExtraHot 等方法已定义
protected function setDrinkType(InputInterface $input): void
{
$this->drinkType = $input->getArgument('drinkType'); // 假设有drinkType参数
}
protected function isExtraHot(InputInterface $input, OutputInterface $output): void
{
// 示例：根据输入判断是否额外加热并输出
if ($input->getOption('extra-hot')) { // 假设有extra-hot选项
$output->write(' (extra hot)');
}
}
protected function hasCorrectSugars(InputInterface $input): bool
{
$sugars = $input->getArgument('sugars');
return ($sugars >= $this->minSugars && $sugars <= $this->maxSugars);
}
protected function checkSugars(InputInterface $input, OutputInterface $output): void
{
$sugars = $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('');
}
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 1; // 错误返回非0
}
// 2. 使用映射替代switch：验证金额
$drinkCosts = [
'tea' => 0.4,
'coffee' => 0.5,
'chocolate' => 0.6
];
$money = (float)$input->getArgument('money'); // 确保金额是浮点数
// 检查是否存在该饮料类型的成本，虽然in_array已检查，但这里更严谨
if (!isset($drinkCosts[$this->drinkType])) {
$output->writeln('Error: Unknown drink type cost configuration.');
return 1;
}
$drinkCost = $drinkCosts[$this->drinkType];
if ($money < $drinkCost) {
$output->writeln('The ' . $this->drinkType . ' costs ' . $drinkCost);
return 1; // 错误返回非0
}
// 3. 卫语句：验证糖量
if (!$this->hasCorrectSugars($input)) {
$output->writeln('The number of sugars should be between 0 and 2');
return 1; // 错误返回非0
}
// 4. 执行成功后的输出逻辑
$this->checkSugars($input, $output);
return 0; // 成功返回0
}
}

注意事项与进一步优化

1. 返回值的语义：在Symfony命令中，return 0通常表示命令成功执行，而return 非0表示执行失败。原始代码在错误情况下也返回0，这可能导致外部脚本误判命令状态。重构后的代码已改为在错误时返回1，这更符合惯例。
2. 职责分离：尽管重构已经改善了代码结构，execute函数仍然承担了验证和协调的职责。对于更复杂的系统，可以考虑引入更高级的设计模式，例如：
   • 命令模式（Command Pattern）：为每种饮料类型创建一个独立的命令或处理类，将各自的成本、验证和输出逻辑封装起来。
   • 策略模式（Strategy Pattern）：定义一个饮料处理策略接口，每种饮料实现一个具体策略，execute函数根据饮料类型选择并执行相应的策略。
3. 配置管理：将饮料成本、允许的饮料类型以及糖量限制等“魔术数字”和字符串提取为类常量、配置项或外部配置文件，进一步提高灵活性和可维护性。
4. 异常处理：对于更严重的错误（如配置缺失），可以考虑抛出异常而不是简单地返回错误码，让调用者决定如何处理。
5. 类型提示和参数验证：确保所有函数参数和返回值的类型提示都已正确声明，这有助于静态分析和减少运行时错误。例如，$money参数应明确转换为float。

总结

通过应用卫语句、利用数据结构替代switch语句，并明确函数职责，我们成功地重构了一个复杂且难以维护的PHP函数。重构后的代码不仅提高了可读性和可维护性，也更好地遵循了SOLID原则，为未来的功能扩展和代码演进奠定了坚实的基础。在实际开发中，持续的代码审查和重构是提升软件质量的关键实践。