代码重构：整合多参数重载方法为单一通用方法

本文探讨了在面对具有相同业务逻辑但接受不同参数类型的多个重载方法时，如何进行有效重构以消除代码重复。我们将深入介绍两种主要的解决方案：通过引入通用接口实现多态性，以及利用辅助方法封装核心逻辑。通过这些策略，可以显著提升代码的可维护性、可读性，并降低未来修改的风险。

在软件开发中，我们经常会遇到这样的场景：多个方法执行着几乎完全相同的业务逻辑，唯一的区别在于它们接受的输入参数类型不同。这种模式通常会导致大量的代码重复，使得维护变得困难，并且在业务逻辑需要变更时，必须修改多处代码，增加了出错的风险。

考虑以下Java代码示例，三个calculateAmount方法分别接受QRequest、CState和RState三种不同类型的参数，但内部的计算逻辑几乎完全一致：

public static String calculateAmount(QRequest qRequest) {
  if (qRequest.getValue() == null) {
    return "300_VALUE"; // 假设常量
  }
  // 核心逻辑
  return commonCalculation(qRequest.getValue());
}

public static String calculateAmount(CState cState) {
  if (cState.getValue() == null) {
    return "300_VALUE"; // 假设常量
  }
  // 核心逻辑
  return commonCalculation(cState.getValue());
}

public static String calculateAmount(RState rState) {
  if (rState.getValue() == null) {
    return "EXCESS_300_VALUE"; // 注意这里与前两个方法返回值不同
  }
  // 核心逻辑
  return commonCalculation(rState.getValue());
}

// 假设 commonCalculation 是一个私有辅助方法，用于处理 ValueType
private static String commonCalculation(ValueType value) {
  if (value.getOptionalCodes().contains(125) && value.getOptionalCodes().contains(600)) {
    throw new ServiceException("Multiple options received"); // 假设ServiceException
  }
  if (value.getOptionalCodes().contains(125)) {
    return "125_VALUE";
  } else if (value.getOptionalCodes().contains(600)) {
    return "600_VALUE";
  } else {
    return "300_VALUE";
  }
}

// 假设 ValueType 是一个公共接口或基类，QRequest/CState/RState 的 getValue() 返回此类型
interface ValueType {
  Set<Integer> getOptionalCodes();
}

（注：为了简化示例，上述代码中的常量如300_VALUE、125_CODE等已被替换为字符串或整数，并假设存在ServiceException和ValueType接口。）

尽管这三个方法在获取初始值和最终返回默认值上略有差异，但其核心的条件判断逻辑是完全重复的。为了解决这种代码冗余问题，我们可以采用以下两种主要的重构策略。

策略一：引入通用接口

当不同参数类型（如QRequest, CState, RState）都包含一个相同类型且具有相同行为的内部对象（如ValueType）时，引入一个通用接口是最佳实践。这个接口可以定义一个方法，用于获取这个共同的内部对象。

实施步骤

1. 定义通用接口： 创建一个接口，例如HasValue，其中包含一个返回共同内部对象类型（例如ValueType）的方法getValue()。

   interface HasValue {
       ValueType getValue();
   }

   登录后复制

2. 实现接口： 让所有相关的类（QRequest, CState, RState）实现这个新定义的HasValue接口。

   // 假设原始类定义
   class QRequest implements HasValue {
       private ValueType value;
       // ... 构造函数及其他方法
       @Override
       public ValueType getValue() {
           return value;
       }
   }
   
   class CState implements HasValue {
       private ValueType value;
       // ...
       @Override
       public ValueType getValue() {
           return value;
       }
   }
   
   class RState implements HasValue {
       private ValueType value;
       // ...
       @Override
       public ValueType getValue() {
           return value;
       }
   }

   登录后复制

3. 重构单一方法： 创建一个单一的calculateAmount方法，它接受HasValue接口类型的参数。这样，无论传入的是QRequest、CState还是RState的实例，都可以通过多态性调用getValue()方法来获取共同的ValueType对象，并执行核心逻辑。

   

   降重鸟

   要想效果好，就用降重鸟。AI改写智能降低AIGC率和重复率。

   113

   查看详情

   public static String calculateAmount(HasValue hasValue) {
       ValueType value = hasValue.getValue();
   
       // 处理 RState 特有的默认值逻辑
       if (hasValue instanceof RState && value == null) {
           return "EXCESS_300_VALUE";
       }
   
       // 其他类型的默认值
       if (value == null) {
           return "300_VALUE";
       }
   
       // 核心业务逻辑
       if (value.getOptionalCodes().contains(125) && value.getOptionalCodes().contains(600)) {
           throw new ServiceException("Multiple options received");
       }
   
       if (value.getOptionalCodes().contains(125)) {
           return "125_VALUE";
       } else if (value.getOptionalCodes().contains(600)) {
           return "600_VALUE";
       } else {
           return "300_VALUE";
       }
   }

   登录后复制

注意事项

• 修改现有类： 这种方法要求修改QRequest、CState、RState等类的定义，使其实现HasValue接口。如果这些类是第三方库或无法修改，则此方法不适用。
• 处理差异： 示例中RState在value == null时返回的默认值与其他类型不同。在通用方法中，可以通过instanceof操作符来识别特定类型并应用其特有的逻辑。虽然这引入了一点点类型耦合，但相比完全重复核心逻辑，仍是更优解。

策略二：引入辅助方法（Wrapper Pattern）

如果由于某些限制（例如无法修改现有类或不想引入新的接口）而不能采用策略一，那么可以考虑引入一个私有的辅助方法来封装核心逻辑。原有的重载方法则作为“包装器”，负责提取各自参数中的共同数据，然后调用这个辅助方法。

实施步骤

1. 创建私有辅助方法： 编写一个私有静态方法，它接受共同的内部对象类型（例如ValueType）作为参数，并包含所有重复的业务逻辑。

   private static String calculateAmountCore(ValueType value, boolean isRState) {
       // 根据是否是 RState 决定默认值
       if (value == null) {
           return isRState ? "EXCESS_300_VALUE" : "300_VALUE";
       }
   
       if (value.getOptionalCodes().contains(125) && value.getOptionalCodes().contains(600)) {
           throw new ServiceException("Multiple options received");
       }
   
       if (value.getOptionalCodes().contains(125)) {
           return "125_VALUE";
       } else if (value.getOptionalCodes().contains(600)) {
           return "600_VALUE";
       } else {
           return "300_VALUE";
       }
   }

   登录后复制

   这里为了处理RState特有的默认值，辅助方法增加了一个isRState布尔参数。

2. 重构原有重载方法： 将原有的三个calculateAmount方法修改为简单的包装器，它们各自从传入的参数中提取ValueType对象，然后调用新的辅助方法。

   public static String calculateAmount(QRequest qRequest) {
       return calculateAmountCore(qRequest.getValue(), false);
   }
   
   public static String calculateAmount(CState cState) {
       return calculateAmountCore(cState.getValue(), false);
   }
   
   public static String calculateAmount(RState rState) {
       return calculateAmountCore(rState.getValue(), true); // RState 传递 true
   }

   登录后复制

注意事项

• 仍有多个入口： 尽管核心逻辑得到了集中，但外部调用者仍然需要通过三个不同的重载方法来访问功能。这在某些情况下可能是可以接受的，例如当这些重载方法是API的一部分，且不能轻易改变其签名时。
• 参数传递： 如果不同类型在核心逻辑上存在细微差异（如本例中RState的默认值），可能需要向辅助方法传递额外的参数来区分这些情况。

总结

无论是采用引入通用接口还是辅助方法，核心目标都是将重复的业务逻辑集中到一个地方，从而提高代码的可维护性和可读性。

• 引入接口是更面向对象的解决方案，它利用多态性实现单一入口点，代码结构更优雅，是首选方案，尤其适用于可以控制相关类定义的情况。
• 引入辅助方法则是一种更实用的折衷方案，它避免了修改现有类的需要，但仍然能够有效消除核心逻辑的重复。

在实际项目中，应根据具体情况（如类的可修改性、对现有API的影响、逻辑差异的复杂程度等）权衡利弊，选择最合适的重构策略。通过这些方法，我们可以构建出更健壮、更易于管理的软件系统。

以上就是代码重构：整合多参数重载方法为单一通用方法的详细内容，更多请关注php中文网其它相关文章！