重构

源代码重构可以通过重组代码来提高项目的质量和可维护性，同时不改变运行时行为。Visual Studio Code 支持重构操作（重构），例如提取方法和提取变量，以便在编辑器中改进你的代码库。

例如，一种常用于避免代码重复（这会给维护带来麻烦）的重构是提取方法重构，你可以选择源代码并将其提取到一个单独的共享方法中，以便在其他地方重用该代码。

重构由语言服务提供。VS Code 通过 TypeScript 语言服务内置支持 TypeScript 和 JavaScript 重构。对其他编程语言的重构支持则通过贡献语言服务的 VS Code 扩展来实现。

不同语言的重构操作的用户界面元素和 VS Code 命令是相同的。本文通过 TypeScript 语言服务演示了 VS Code 中的重构支持。

代码操作 = 快速修复和重构

在 VS Code 中，代码操作可以为检测到的问题（用红色波浪线突出显示）提供重构和快速修复。当光标位于波浪线上或选定的文本区域时，VS Code 会在编辑器中显示一个灯泡图标，表示有可用的代码操作。如果你选择代码操作灯泡或使用快速修复命令 ⌘. (Windows、Linux Ctrl+.)，将显示快速修复和重构控件。

如果你只想查看重构而不查看快速修复，可以使用重构命令（⌃⇧R (Windows、Linux Ctrl+Shift+R)）。

注意： 你可以使用 editor.lightbulb.enable 设置在编辑器中完全禁用代码操作灯泡。你仍然可以通过快速修复命令和 ⌘. (Windows、Linux Ctrl+.) 键盘快捷方式打开快速修复。

保存时代码操作

通过 editor.codeActionsOnSave 设置，你可以配置一组在保存文件时自动应用的代码操作，例如整理导入。根据你的工作区文件和活动扩展，智能感知提供了可用代码操作的列表。

你可以为 editor.codeActionsOnSave 配置一个或多个代码操作。然后按照列表中的顺序运行这些代码操作。

以下示例展示了如何配置保存时的多个代码操作

// On explicit save, run sortImports source action. On auto save (window or focus change), run organizeImports source action.
"editor.codeActionsOnSave": {
    "source.organizeImports": "always",
    "source.sortImports": "explicit",
},

每个代码操作支持以下值

• explicit (默认)：在明确保存时触发代码操作
• always：在明确保存以及由于窗口或焦点更改而进行自动保存时触发代码操作
• never：从不在保存时触发代码操作

重构操作

提取方法

选择要提取的源代码，然后选择行号旁边的灯泡或按下（⌘. (Windows、Linux Ctrl+.)）查看可用的重构。源代码片段可以提取为一个新方法，或在各种不同作用域提取为一个新函数。在提取重构期间，会提示你提供一个有意义的名称。

提取变量

TypeScript 语言服务提供提取到 const 重构，以便为当前选定的表达式创建一个新的局部变量

使用类时，你也可以将值提取为一个新属性。

重命名符号

重命名是与源代码重构相关的常见操作，VS Code 有一个单独的重命名符号命令（F2）。有些语言支持跨文件重命名符号。按下 F2，键入所需的新名称，然后按下 Enter。该符号在所有文件中的所有实例都将被重命名。

重构预览

应用重构时，更改会直接应用于你的代码。在重构预览面板中，你可以预览重构操作将应用的更改。

要打开重构预览面板，打开代码操作控件，将鼠标悬停在某个重构上，然后按下 ⌘Enter (Windows、Linux Ctrl+Enter)。

你可以选择重构预览面板中的任何更改，以获取重构操作导致的更改的差异视图。

使用接受或丢弃控件应用或取消建议的重构更改。

或者，你可以在重构预览面板中取消选中部分建议的更改，以部分应用重构更改。

代码操作的键盘快捷方式

editor.action.codeAction 命令允许你为特定的代码操作配置键盘快捷方式。例如，此键盘快捷方式会触发提取函数重构代码操作

{
  "key": "ctrl+shift+r ctrl+e",
  "command": "editor.action.codeAction",
  "args": {
    "kind": "refactor.extract.function"
  }
}

代码操作种类由扩展使用增强的 CodeActionProvider API 指定。种类是分层的，因此 "kind": "refactor" 显示所有重构代码操作，而 "kind": "refactor.extract.function" 仅显示提取函数重构。

使用上面的键盘快捷方式，如果只有一个 "refactor.extract.function" 代码操作可用，则会自动应用。如果提供了多个提取函数代码操作，VS Code 会弹出一个上下文菜单供你选择

你还可以通过使用 apply 参数控制代码操作的自动应用方式和时机

{
  "key": "ctrl+shift+r ctrl+e",
  "command": "editor.action.codeAction",
  "args": {
    "kind": "refactor.extract.function",
    "apply": "first"
  }
}

apply 的有效值

• first - 始终自动应用第一个可用的代码操作。
• ifSingle - (默认) 如果只有一个代码操作可用，则自动应用。否则，显示上下文菜单。
• never - 始终显示代码操作上下文菜单，即使只有一个代码操作可用。

当代码操作键盘快捷方式配置了 "preferred": true 时，仅显示首选的快速修复和重构。首选的快速修复解决根本错误，而首选的重构是最常见的重构选择。例如，虽然可能存在多个 refactor.extract.constant 重构，每个都提取到文件中的不同作用域，但首选的 refactor.extract.constant 重构是提取到局部变量的那个。

此键盘快捷方式使用 "preferred": true 创建一个重构，该重构总是尝试将选定的源代码提取为局部作用域中的一个常量

{
  "key": "shift+ctrl+e",
  "command": "editor.action.codeAction",
  "args": {
    "kind": "refactor.extract.constant",
    "preferred": true,
    "apply": "ifSingle"
  }
}

支持重构的扩展

你可以在 VS Code 市场中找到支持重构的扩展。你可以转到扩展视图（⇧⌘X (Windows、Linux Ctrl+Shift+X)），并在搜索框中键入“refactor”。然后可以按安装次数或评分排序，查看哪些扩展受欢迎。

提示：上面显示的扩展是动态查询的。选择上面的扩展磁贴以阅读说明和评论，从而决定哪个扩展最适合你。

下一步

• 入门视频 - 代码编辑 - 观看有关代码编辑功能的入门视频。
• 代码导航 - VS Code 让你快速浏览源代码。
• 调试 - 了解如何使用 VS Code 进行调试。

常见问题

我的代码有错误时，为什么我看不到灯泡？

灯泡（代码操作）仅在光标位于显示错误的文本上方时显示。将鼠标悬停在文本上会显示错误描述，但你需要移动光标或选择文本才能看到快速修复和重构的灯泡。