在 Visual Studio Code 中使用 Swift
Swift 是一门通用编程语言,对新手友好,对专家强大。它快速、现代、安全,编写起来充满乐趣。本主题详细介绍如何在 Visual Studio Code 中,通过 swiftlang.swift-vscode 扩展来设置和使用 Swift。
Swift 扩展包含:
- 语法高亮和代码补全
- 代码导航功能,如“转到定义”和“查找所有引用”
- 代码重构和快速修复
- 支持 Swift 包管理器的包管理和任务
- 丰富的调试支持
- 使用 XCTest 或 Swift Testing 框架进行测试
Swift 扩展旨在支持以下项目:
- Swift 包管理器项目(例如,使用
Package.swift
) - 可以生成
compile_commands.json
的项目(例如,使用 CMake)
安装扩展
- 首先,安装 Swift。如果你的系统上尚未安装 Swift,请参阅 Swift.org 上的入门指南。
- 下载并安装 Visual Studio Code。
- 从 VS Code Marketplace 或直接在 VS Code 扩展面板中安装 Swift 扩展。
创建一个新的 Swift 项目
要创建一个新的 Swift 项目,你可以使用 Swift 扩展中的 Swift: Create New Project...
(Swift: 创建新项目...) 命令来引导你完成整个过程。你可以通过打开命令面板并按照以下说明找到此命令。
- 对于 macOS: CMD+Shift+P
- 其他平台: Ctrl+Shift+P
- 从模板列表中选择你想要创建的项目类型。
- 选择项目将要存储的目录。
- 为你的项目命名。
- 打开新创建的项目。系统将提示你在当前窗口中打开项目、在新窗口中打开,或将其添加到当前工作区。默认行为可以通过使用
swift.openAfterCreateNewProject
设置进行配置。
语言特性
Swift 扩展使用 SourceKit LSP 来支持语言特性。SourceKit LSP 在编辑器中提供以下功能。使用这些链接查看每个主题的 VS Code 文档:
SourceKit LSP 还提供代码操作来自动化常见任务。在 VS Code 中,代码操作以编辑器边栏附近的一个灯泡图标出现(请参见下面的截图示例)。点击灯泡将显示可用的操作,其中可能包括:
- 向你的
Package.swift
添加目标 - 将 JSON 转换为协议
- 为你的函数添加文档
在 Swift 6.1 之前,你必须在项目上执行一次 swift build
命令(无论是在命令行还是使用 VS Code 中的任务),然后才能使用语言特性。这会填充 SourceKit-LSP 中的索引。
Swift 任务
Visual Studio Code 提供任务作为运行外部工具的方式。请参阅通过任务与外部工具集成文档以了解更多信息。
Swift 扩展提供了一些内置任务,你可以用它们通过 Swift 包管理器进行构建。你还可以通过在项目根文件夹中创建一个 tasks.json
文件来配置自定义任务。例如,这个 tasks.json
会以发布模式构建你的 Swift 目标:
{
"version": "2.0.0",
"tasks": [
{
"type": "swift",
"label": "Swift Build All - Release",
"detail": "swift build --build-tests",
"args": ["build", "--build-tests", "-c", "release"],
"env": {},
"cwd": "${workspaceFolder}",
"group": "build"
}
]
}
上述任务被配置在 build
组中。这意味着它将出现在 run build tasks
(运行构建任务) 菜单中,该菜单可以在 macOS 上使用 CMD+Shift+B 或在其他平台上使用 Ctrl+Shift+B 打开。
构建过程中出现的任何错误都会作为诊断信息显示在编辑器中,与 SourceKit-LSP 提供的诊断信息并列。运行另一个构建任务会清除上一个构建任务的诊断信息。
调试
Visual Studio Code 提供了丰富的调试体验。请参阅调试文档以获取更多信息。
Swift 扩展依赖 LLDB DAP 扩展来启用调试支持。
默认情况下,该扩展会为你的 Swift 包中的每个可执行目标创建一个启动配置。你可以通过在项目根文件夹中添加一个 launch.json
文件来自行配置这些。例如,这个 launch.json
会使用自定义参数启动一个 Swift 可执行文件:
{
"configurations": [
{
"type": "swift",
"name": "Debug swift-executable",
"request": "launch",
"args": ["--hello", "world"],
"cwd": "${workspaceFolder}",
"program": "${workspaceFolder}/.build/debug/swift-executable",
"preLaunchTask": "swift: Build Debug swift-executable"
}
]
}
你可以通过 VS Code 中的“调试”视图来启动调试会话。
- 选择你希望调试的启动配置。
- 点击绿色的播放按钮来启动调试会话。
可执行文件将被启动,你可以在你的 Swift 代码中设置断点,当代码执行到断点时会暂停。
下面的截图展示了一个调试“Hello World”程序的例子。它在一个断点处暂停,你可以看到“调试”视图显示了作用域内变量的值。你也可以将鼠标悬停在编辑器中的标识符上以查看它们的变量值。
测试资源管理器
Visual Studio Code 在左侧边栏中提供了一个“测试资源管理器”视图,可用于:
- 导航到测试
- 运行测试
- 调试测试
Swift 扩展支持 XCTest 以及 Swift Testing。当你编写测试时,它们会自动添加到“测试资源管理器”中。
要调试一个测试:
- 设置断点
- 使用
Debug Test
(调试测试) 配置文件运行测试、测试套件或整个测试目标。
Run Test with Coverage
(带覆盖率运行测试) 配置文件会检测被测试的代码,并在测试运行完成后打开一个代码覆盖率报告。当你浏览被覆盖的文件时,测试期间执行过的代码行号会显示为绿色,而未被执行的则显示为红色。将鼠标悬停在行号上会显示被覆盖行被执行的次数。可以使用 Test: Show Inline Coverage
(测试:显示行内覆盖率) 命令来显示或隐藏行执行计数。
使用 标签 注释的 Swift Testing 测试可以在“测试资源管理器”中使用 @TestTarget:tagName
进行筛选。然后你可以运行或调试筛选后的测试列表。
Swift VS Code 扩展不支持在 Swift 5.10 或更早版本中运行 Swift Testing 测试。
高级工具链选择
Swift 扩展会自动检测你安装的 Swift 工具链。但是,它也提供了一个名为 Swift: Select Toolchain...
(Swift: 选择工具链...) 的命令,如果你安装了多个工具链,可以用它在它们之间进行选择。
这是一个高级功能,用于将 VS Code 配置为使用非机器默认的工具链。建议在 macOS 上使用 xcode-select
或在 Linux 上使用 swiftly
来全局切换工具链。
系统可能会提示你选择在哪里配置这个新路径。你的选项是:
- 保存在用户设置中
- 保存在工作区设置中
请记住,工作区设置优先于用户设置。
然后 Swift 扩展会提示你重新加载扩展以应用新的工具链。你必须这样做,否则扩展将无法正常工作。