Swift Academy · 课时

测试与调试宏

Q: 「测试与调试宏」这节课中我会学到什么？

使用 assertMacroExpansion 为宏展开编写单元测试。 你通过在浏览器中直接运行的动手代码来练习 Swift Academy，全天候 AI 导师会在你学习这节课的过程中回答你的问题。

使用 assertMacroExpansion 为宏展开编写单元测试。

测试与调试宏 是 CoddyKit 上的免费 Swift Academy 课时。这是第 4 节课，共 4 节。你可以在下方免费阅读本课时的完整内容 — 然后在浏览器中使用内置代码编辑器和全天候 AI 导师进行实践。这是 Swift Academy 学习路径的一部分，你的进度在网页和 CoddyKit 应用中同步。 Swift Academy 课程共包含 4 节课。

为什么要测试宏

宏会在编译时生成代码。单元测试可以在生成的源代码进入生产环境之前对其进行验证。

// The swift-syntax package ships SwiftSyntaxMacrosTestSupport
// with assertMacroExpansion for testing macro output

assertMacroExpansion

assertMacroExpansion接收输入源代码和预期的展开源代码，并验证两者是否匹配。

import SwiftSyntaxMacrosTestSupport
import XCTest

final class StringifyMacroTests: XCTestCase {
  func testStringify() throws {
    assertMacroExpansion(
      "#stringify(1 + 2)",
      expandedSource: "(1 + 2, \"1 + 2\")",
      macros: ["stringify": StringifyMacro.self]
    )
  }
}

测试附加宏

将经过修饰的结构体或类作为输入，并将完全展开后的源代码作为预期输出。

assertMacroExpansion(
  "@AddID struct User { var name: String }",
  expandedSource: """
  struct User {
    var name: String
    var id = UUID()
  }
  """,
  macros: ["AddID": AddIDMacro.self]
)

测试诊断信息发出

验证宏在误用时是否会发出正确的诊断信息，包括警告或错误。

assertMacroExpansion(
  "@AddID class Foo {}",
  expandedSource: "class Foo {}",
  diagnostics: [
    DiagnosticSpec(message: "@AddID can only be applied to structs", line: 1, column: 1)
  ],
  macros: ["AddID": AddIDMacro.self]
)

在 Xcode 中展开宏

在 Xcode 中右键点击宏调用，然后选择展开宏，即可在代码中直接查看生成的代码。

// Before expansion:
let (v, s) = #stringify(1 + 2)
// After:
let (v, s) = (1 + 2, "1 + 2")

在宏中调试打印输出

在开发期间，可以使用context.diagnose或print将信息输出到标准错误流，以调试宏逻辑。

// In macro implementation:
print("[StringifyMacro] expanding: \(node.description)", to: &standardError)

宏测试中的断点

由于宏会在测试期间于同一进程中运行，因此您可以在测试运行时于宏实现内部设置 Xcode 断点。

// Set a breakpoint in StringifyMacro.expansion()
// Run the test target — breakpoints are hit

检查语法树

使用 SwiftSyntax 的.debugDescription打印输入节点的完整语法树，以便进行调试。

print(node.debugDescription)
// Prints the full SyntaxTree hierarchy

测试多种参数变体

针对每种不同的参数形状编写一个测试，确保宏中的所有代码路径都得到执行。

func testNoArgument() {
  assertMacroExpansion(
    "#stringify()",
    expandedSource: "#stringify()",
    diagnostics: [DiagnosticSpec(message: "Need an argument", line: 1, column: 1)],
    macros: ["stringify": StringifyMacro.self]
  )
}

集成测试

添加一个实际使用该宏的测试应用目标，并确认编译和运行时行为。

// In test app:
let (val, src) = #stringify(Date.now)
XCTAssertEqual(src, "Date.now")

宏测试的持续集成

像测试其他 Swift 包一样，在持续集成环境中运行宏测试：在包目录中执行swift test。

// CI command:
swift test --package-path MyMacros

快速检查

哪个函数可以在单元测试中验证宏是否展开为预期的源代码？

课程回顾

使用assertMacroExpansion验证宏输出是否正确，并使用DiagnosticSpec测试错误情况。在测试运行期间，可以通过 Xcode 展开预览和同一进程中的断点进行调试。在持续集成环境中通过swift test运行测试。

常见问题解答

「测试与调试宏」课时是免费的吗？

是的 — 「测试与调试宏」的完整文本可在网页上免费阅读。要进行交互式练习（内置代码编辑器和全天候 AI 导师）并解锁 Swift Academy 课程的其余内容，请升级到 CoddyKit PRO。 Swift Academy 课程共包含 4 节课。

「测试与调试宏」这节课中我会学到什么？

使用 assertMacroExpansion 为宏展开编写单元测试。你通过在浏览器中直接运行的动手代码来练习 Swift Academy，全天候 AI 导师会在你学习这节课的过程中回答你的问题。

学习 Swift Academy 需要有经验吗？

无需任何先前经验。CoddyKit 上的 Swift Academy 课程适合初学者到高级学习者，你可以从这里开始或从头开始，按照自己的节奏学习。这是第 4 节课，共 4 节。

「测试与调试宏」课时需要多长时间？

大多数 CoddyKit 课程大约需要 5–10 分钟。每节课都很精短且互动，所以你能稳步进步，并在网页和应用中从离开的地方继续。

我能在这节 Swift Academy 课中编写并运行代码吗？

能。每节 Swift Academy 课都包含内置代码编辑器，你可以在浏览器中直接编写并运行真实代码，并获得即时 AI 反馈 — 无需本地设置。

此课程中的所有课时

← 返回 Swift Academy