这是重用/共享方法的好方法吗？

Question

我遇到了这段代码，其中 3 个控制器正在使用方法调用，例如 ClassA.search(a, b, flag)。这是该方法的简化版本：

public List<Result> search(Object a, Object b, boolean flag) {
   //do some code logic here, common to the 3 controllers
   //at the middle there is:
   if (flag) {
      //code that affects 2 Controllers
   } else {
      //code affects only 1
   }
   //some more common code
   //some more code with the flag if else
}

这是一个好主意吗，因为代码被重用了？或者是否有更好的方法仍然能够重用代码，但不为方法调用者（客户端）代码自定义引入此标志（例如可能将其拆分为 3 个不同的方法，但仍然能够声明通用代码重构方法）？

Answer 1

首先，用函数提取注释行：

public void search(Object a, Object b, boolean flag)
{
    commonToThree();
    if (flag)
    {
        affectTwoControllers();
    }
    else
    {
        affectsOnlyOne();
    }
    alsoCommon();
}

现在去掉 flag 布尔参数，这是一种代码味道：

public void searchWithTrueFlag(Object a, Object b) {
    commonToThree();
    affectTwoControllers();
    alsoCommon();
}

public void searchWithFalseFlag(Object a, Object b) {
    commonToThree();
    affectsOnlyOne();
    alsoCommon();
}

Answer 2

这很好，但不是很好。一个布尔值是有意义的，但如果你开始添加更多的布尔值，你就不会朝着正确的方向前进。

这并不总是可能的，但通常会产生更好的代码：

functionOne:
  sharedCodeOne()
  specificCode
  sharedCodeTwo()

functionTwo:
  sharedCodeOne()
  specificCode
  sharedCodeTwo()

一如既往，很难做出概括性的声明：这显然并不总是可能/实用的。

Answer 3

这是一种相对简单的方法。有一些替代方案，但它们可能更复杂。 （例如传递访问者或调用控制器的方法来说明该控制器要执行的操作）

如果您在代码的三个部分之间共享局部变量并且必须使用字段，则此方法是最好的。

Answer 4

我会采取不同的方法尝试以一般方式回答这个问题：

主要目标应该是干净代码。这具体是什么，当然要看具体情况。但可以肯定的是，在多个地方复制粘贴代码是不好的，因为如果必须更改，这需要更改多个位置 - 同样，尝试在多个部分使用的地方提取公共部分也是不好的他们在所有情况下。

总是想象有人必须阅读您的代码（或者您自己必须在几周后执行此操作）并且必须尽快了解那里发生了什么。因此，这取决于特殊情况，是复制一些行还是用通用方法提取它们更好。

标志本身并不是坏事，但它并不是真正应该在 java 方法中过度使用的东西。通常，这种情况可以通过重载一个方法并在另一个方法中使用一个方法来很好地解决，这样常见的情况在一个方法中完成，特殊的添加在另一个方法中完成。或者，您可以拥有多个子方法，并通过对它们的多次调用来组成您的方法，但这仅在您不需要传递太多参数时才有意义。

我可以给你一条规则（完全主观，但基于从许多项目中吸取的经验教训）：优先采用通用方法的具体实现。它们可能会产生更多的代码，并且可能显得不那么聪明，但它们更容易理解、扩展和调试。