重构

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

例如，一种用于避免代码重复（一个维护难题）的常见重构是提取方法重构，您选择源代码并将其提取到自己的共享方法中，以便可以在其他地方重用该代码。

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

不同语言的重构 UI 元素和 VS Code 命令是相同的。本文演示了 VS Code 中使用 TypeScript 语言服务的重构支持。

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

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

如果您只希望看到重构而不看到快速修复，那么您可以使用重构命令 (⌃⇧R (Windows, Linux Ctrl+Shift+R))。

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

保存时的代码操作

通过 editor.codeActionsOnSave 设置，您可以配置一组在保存文件时自动应用的代码操作，例如组织导入。根据您的工作区文件和活动扩展，IntelliSense 会提供一个可用代码操作列表。

您可以为 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 进行调试。

常见问题

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

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