重构简介

提取变量

提取变量是一种影响较小的更改，可以使您的代码实现自我记录。它还可以用于减少代码重复。

假设您遇到以下代码

static String getUsernameFromMessage(String message) {
    return message.substring(message.indexOf("\"screen_name\":\"") + 15,
    message.indexOf("\"", message.indexOf("\"screen_name\":\"") + 15));
}

• 删除重复的message.indexOf("\"screen_name\":\"") + 15)

• 引入变量来描述每个indexOf调用代表的内容

• 删除神奇的数字 15

1. 首先，让我们减少重复并引入一个变量来描述此操作正在执行的操作。将插入符号放在表达式中的任意位置message.indexOf("\"screen_name\":\"") + 15)并按。IntelliJ IDEA 将建议此重构的上下文，您需要选择封装此表达式的上下文：CtrlAlt0V

   

   接下来，如果 IntelliJ IDEA 检测到该表达式多次出现，您可以选择替换所有出现的表达式或仅替换您选择的表达式。

   

   提取变量后，IntelliJ IDEA 会根据表达式所使用的参数等内容建议可能的名称。

   

   我们将使用我们自己的名字indexOfFieldValue来描述它真正代表的含义。请注意，您可以决定是否希望此变量为最终变量。

2. 接下来我们将为字符串值引入一个变量。这样做有两个原因：首先，记录 String 值代表什么，其次因为它将帮助我们删除幻数。

   将插入符号放在某处screen_name并按。CtrlAlt0V

   

   我们将给它一个更有意义的名字，fieldName。

   

3. 现在，我们将substring()使用相同的过程为用作 的参数的另一个表达式创建一个变量，我们将其称为indexOfEndOfFieldValue。

   

4. 最后，我们可以删除幻数，因为这只是字段名称的长度。最终代码如下所示：

   static String getUsernameFromMessage(String message) {
       final String fieldName = "\"screen_name\":\"";
       final int indexOfFieldValue = message.indexOf(fieldName) + fieldName.length();
       final int indexOfEndOfFieldValue = message.indexOf("\"", indexOfFieldValue);
       return message.substring(indexOfFieldValue, indexOfEndOfFieldValue);
   }

   它比原来的更长，但更具描述性，这在这样的代码中尤其重要，因为不清楚每个表达式代表什么。选择final是否申请由您决定，并且取决于您的编码标准。

提取参数

提取或添加参数允许开发人员更改方法，使其更易于使用。您可能希望更改参数，例如，通过传入对象中的一些值而不是对象本身，或者您可能希望引入方法体中的值作为参数，以允许该方法在更多地方使用。我们将看一个后者的例子。

对于此示例，我们将在重构后使用与上一个示例相同的代码，并稍微扩展它以显示同一类中的另一个方法：

static String getTextFromMessage(String message) {
    final String fieldName = "\"text\":\"";
    final int indexOfFieldValue = message.indexOf(fieldName) + fieldName.length();
    final int indexOfEndOfFieldValue = message.indexOf("\"", indexOfFieldValue);
    return message.substring(indexOfFieldValue, indexOfEndOfFieldValue);
}

static String getUsernameFromMessage(String message) {
    final String fieldName = "\"screen_name\":\"";
    final int indexOfFieldValue = message.indexOf(fieldName) + fieldName.length();
    final int indexOfEndOfFieldValue = message.indexOf("\"", indexOfFieldValue);
    return message.substring(indexOfFieldValue, indexOfEndOfFieldValue);
}

我们的目标是消除在这两种方法中看到的重复代码。为此，我们将：

• 改成fieldName一个参数，这样我们就可以让这个getUsernameFromMessage方法适用于任何领域。

• 重命名getUsernameFromMessage为代表其更一般性质的名称

• 删除 中的重复代码getTextFromMessage。

1. 将插入符置于fieldName并按CtrlAlt0P

   

   与其他重构一样，如果您愿意，可以为参数键入新名称。IntelliJ IDEA 还预览了更新的方法签名。按批准更改。Enter

   

   这个特定问题告诉我们该方法被用作方法引用，并且此更改将导致方法引用转换为 lambda 表达式。此消息可能表明这不是您希望执行的重构。如果是这种情况，下一个示例展示了我们可以使用提取方法采取的方法。但是，对于此示例，我们假设我们对引入新参数的结果感到满意，因此我们只需选择“继续”。

   接下来，IntelliJ IDEA 将检测现在可以通过调用新方法签名来替换的任何代码。

   

   如果您在这种情况下选择“替换”，所有重复的代码都将被替换，并且 IntelliJ IDEA 将为新参数选择适当的值。

2. 此时，原始方法getUsernameFromMessage比原来更通用，因此我们应该重命名它。我们将插入符号放在 name 和 use 处，如上一节所示。ShiftF6

   

3. 我们可以进一步简化代码。内联是提取的逆过程，在我们这里的代码中，内联我们的临时变量可能是合适的，因为变量名给我们带来的只是将值直接传递到方法中。或者，鉴于 getTextFromMessage 实际上是对 的简单委托getValueForField，我们可以使用 inline 完全删除此方法。

   要内联，请将插入符号放在getTextFromMessage变量处，然后按CtrlAlt0N

   

4. 现在我们的最终代码如下所示：

   static String getValueForField(String message, String fieldName) {
       final int indexOfFieldValue = message.indexOf(fieldName) + fieldName.length();
       final int indexOfEndOfFieldValue = message.indexOf("\"", indexOfFieldValue);
       return message.substring(indexOfFieldValue, indexOfEndOfFieldValue);
   }

   我们调用原始 getUsernameFromMessage 方法的代码是：

   Parser::getUsernameFromMessage

   现在是

   (message) -> Parser.getValueForField(message, "\"screen_name\":\"")

   我们调用原始 getTextFromMessage 方法的代码是：

   String[] wordsInMessage = Parser.getTextFromMessage(message).split("\\s");

   现在是

   String[] wordsInMessage = Parser.getValueForField(message, "\"text\":\"").split("\\s");

请注意，我们应用此重构的方式会强制所有调用者传入字段名称，并且 a) 在代码中广泛使用字符串值，b) 可能会引入一个或多个字符串值的重复。这可能适合您的代码，特别是在处理字符串重复或不经常使用该方法的情况下。但是，如果这不是您希望减少代码重复的权衡，请参阅下一章以了解替代方法。

提取参数非常强大，因此值得阅读更详细的帮助页面。

提取方法

提高代码可读性的一种方法是将其分成小的、易于理解的部分。Extract 方法允许开发人员做到这一点，在适当的时候将代码段移动到他们自己的、描述性命名的方法中。

一些开发人员可能会发现自己编写了很长的方法来执行他们想要的操作，当他们完成（并测试）功能时，查看代码以了解可以在哪里重构和简化并分解这些较长的方法。或者，当开发人员在实现新功能时遇到代码时，他们意识到将一些代码提取到自己的方法中可以让他们重用现有功能。

提示

当 IntelliJ IDEA 检测到重复代码时，这是创建一个可以由所有具有重复代码的位置调用的新方法的非常好的候选者。

我们将看与上一节中相同的示例，但采用与之前略有不同的方法。

static String getTextFromMessage(String message) {
    final String fieldName = "\"text\":\"";
    final int indexOfFieldValue = message.indexOf(fieldName) + fieldName.length();
    final int indexOfEndOfFieldValue = message.indexOf("\"", indexOfFieldValue);
    return message.substring(indexOfFieldValue, indexOfEndOfFieldValue);
}

static String getUsernameFromMessage(String message) {
    final String fieldName = "\"screen_name\":\"";
    final int indexOfFieldValue = message.indexOf(fieldName) + fieldName.length();
    final int indexOfEndOfFieldValue = message.indexOf("\"", indexOfFieldValue);
    return message.substring(indexOfFieldValue, indexOfEndOfFieldValue);
}

正如我们之前看到的，之前的重构需要进行一些权衡：方法引用需要转换为 lambda 表达式，并且所有调用代码都需要知道所需的字段名称。我们可以选择以不同的方式去除两种方法之间的代码重复：

• 将公共代码提取到自己的方法中。

• 内联变量以简化其余代码。

1. 首先，突出显示两种方法之间通用的代码：

   

   按下将弹出提取方法对话框。CtrlAlt0M

   

   输入新方法的名称 ，getValueForField并检查参数名称和顺序。在本例中，我们将交换参数的顺序，因为我们希望参数fieldName更接近方法的名称。这将取决于您的代码风格和团队偏好，您可能想大声朗读名称和参数，看看它作为自然语言的语句是否有意义。

   

   当您按下OK时，IntelliJ IDEA 将检测可以通过调用此新方法来替换的代码，并提供重构功能。我们将选择Yes。

   

2. 此时，我们的getTextFromMessage和方法是两行简单的代码，这里内联fieldName 变量getUsernameFromMessage是有意义的，因为方法名称具有足够的描述性，可以删除临时变量。按并选择重构。CtrlAlt0NfieldName

   

3. 作为最后一步，您可能希望将所有类似的方法组合在一起。根据您的设置，IntelliJ IDEA 可能已将新方法直接放置在您选择提取方法时所在的方法下，就像我们这里的例子一样。要将辅助方法放在一起，请将脱字符号放在getValueForField方法名称处，然后按。这会将您的新方法 放置在现有的 getUsernameFromMessage 方法下。CtrlShift0↓getValueForField

   我们的最终代码如下所示：

   static String getTextFromMessage(String message) {
       return getValueForField("\"text\":\"", message);
   }
   
   static String getUsernameFromMessage(String message) {
       return getValueForField("\"screen_name\":\"", message);
   }
   
   static String getValueForField(String fieldName, String message) {
       final int indexOfFieldValue = message.indexOf(fieldName) + fieldName.length();
       final int indexOfEndOfFieldValue = message.indexOf("\"", indexOfFieldValue);
       return message.substring(indexOfFieldValue, indexOfEndOfFieldValue);
   }

   现在我们有两个非常具体的帮助器方法，用于获取消息正文和用户名，以及一个更通用的方法，可用于从消息中获取任何字段的值。当存在经常需要的其他字段时，可以添加其他辅助方法。

请注意，提取参数和提取方法示例以相同的代码开始，但以看起来非常不同的代码结束。这不仅是因为我们使用了不同的重构，还因为我们做出了不同的决定 - 在第一个示例中，我们选择完全删除重复，并将一些决策移至方法的调用者中。在第二个示例中，我们选择提供一个 API，它将字段名称的详细信息隐藏在小帮助器方法后面，但仍然提供更通用的方法。我们还可以混合和匹配这些方法，我们选择开始的重构可能会引导我们走向特定的方向，但我们可以决定我们的最终目的地。我们应该记住重构的目标（在这种情况下，减少重复）并理解当我们选择一个方向而不是另一个方向时我们所做的权衡，例如决定是否要调用代码来知道他们要求哪个字段名称。

提取的影响

好消息是您可以相当轻松地撤消提取。当然，不仅通过选择，还通过内联创建的方法，以便代码回到原来的位置。Ctrl0Z

我们在这里提到的提取重构被经验丰富的开发人员定期使用，以随着代码的发展来塑造代码，并且每次接触代码时或多或少地使用它们并不少见。一些没有涉及到的，比如extract interface和extract superclass，可能会对整体设计产生更广泛的影响，应该更加小心。

安全删除

IntelliJ IDEA 允许您安全删除未使用的代码片段或整个文件，通知您是否可以安全删除代码，并让您可以选择在进行更改之前预览更改。识别和处理未使用代码的最快方法是确保启用相关检查，通常默认情况下：

让我们继续之前重构的例子。假设我们最终得到了这段代码：

static String getUsernameFromMessage(String message) {
    return getValueForField("\"screen_name\":\"", message);
}

static String getValueForField(String fieldName, String message) {
    final int indexOfFieldValue = message.indexOf(fieldName) + fieldName.length();
    final int indexOfEndOfFieldValue = message.indexOf("\"", indexOfFieldValue);
    return message.substring(indexOfFieldValue, indexOfEndOfFieldValue);
}

有可能一段时间后，当我们回到这段代码时，该getUsernameFromMessage方法不再使用——也许不再需要它，或者也许人们愿意使用getValueForField相关参数进行调用。因此，假设我们对这些原因感到满意，我们可以继续删除此方法。

1. 如果开启未使用声明检查，则方法名称将呈灰色，表示未使用。

   

2. 将插入符号放入getUsernameFromMessage并按。这将为您提供删除此方法的选项。AltEnter

   

3. 选择安全删除会弹出安全删除对话框，您可以搜索该方法的用法。

   

   按“确定”继续进行搜索。在我们的例子中，删除是完全安全的，因此该方法被删除。

4. 我们的“未使用”方法可能没有被标记为未使用，因为它可能被测试覆盖。但如果我们仍然知道它没有被使用，或者已经通过检查过它，我们仍然可以安全地删除它。AltF7

   将插入符号放在方法名称处，然后按。这将像以前一样弹出安全删除对话框，这次当你按OK IntelliJ IDEA 会警告你这个方法有用法AltDelete

   

   按查看用法来检查这些是什么

   

5. 使用结果面板通过双击每个用法来导航到用法。在我们的例子中，我们看到有一个测试调用我们想要删除的方法。

   

   由于此测试是为了确保我们不再需要的方法的正确性，因此我们也可以删除此测试。在编辑器窗口中，按测试方法名称，然后在“安全删除”对话框中说“确定” 。测试方法将被删除。AltDelete

6. 现在，我们将在“安全删除冲突”窗口中看到该代码不再有效。

   

   由于这是我们最初想要删除的方法的唯一用途，因此我们可以选择“重新运行安全删除”按钮。这次当您在“安全删除”对话框中按“确定”getUsernameFromMessage时，该方法将被删除。

删除的影响

提示

如果您发现某个公共方法看似未使用，但确实构成公共 API 的一部分，则应该对其进行测试。“未使用”警告可能并不意味着您应该删除该方法，而是告诉您应该测试该方法。

IntelliJ 的检查可以向您显示未使用的代码，但是如果您的代码要打包为库供其他人使用，或者以其他方式公开公共 API，则某些公共符号可能会在使用时被标记为未使用。事实上，它们由您无法控制的代码使用。如果公共符号似乎未使用，您应该检查这些符号是否被其他系统以某种方式使用。

未使用的参数、局部变量和私有字段都是删除的好选择，因为应该很容易看出删除它们不会影响任何功能。

使用安全删除来删除符号，无论它们是否未使用，都可以让您在执行重构之前检查受影响的区域是否是您期望的区域，并让您可以控制要应用的更改。但是，仍然要注意公共符号可能会被您无法控制的系统使用，因此在删除这些符号时请务必小心谨慎。