Swift Academy · 课时

编写独立表达式宏

使用 SwiftSyntax 和 MacroExpansion 实现简单的 #stringify 宏。

第 2 / 4 课13 个步骤

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

项目设置

宏位于单独的 Swift 包目标中,该目标的类型为.macro,并使用SwiftSyntax。

// Package.swift (excerpt)
.macro(
  name: "MyMacros",
  dependencies: [
    .product(name: "SwiftSyntaxMacros", package: "swift-syntax"),
    .product(name: "SwiftCompilerPlugin", package: "swift-syntax")
  ]
)

宏声明

在库目标中声明宏签名,以便客户端调用它。

@freestanding(expression)
public macro stringify<T>(_ value: T) -> (T, String)
  = #externalMacro(module: "MyMacros", type: "StringifyMacro")

实现宏类型

通过遵循ExpressionMacro并返回ExprSyntax来实现宏。

import SwiftSyntaxMacros
import SwiftSyntax

struct StringifyMacro: ExpressionMacro {
  static func expansion(
    of node: some FreestandingMacroExpansionSyntax,
    in context: some MacroExpansionContext
  ) throws -> ExprSyntax {
    guard let arg = node.arguments.first?.expression else {
      throw MacroError.message("Need an argument")
    }
    return "(\(arg), \(literal: arg.description))"
  }
}

注册插件

创建一个CompilerPlugin,列出包中的所有宏。

import SwiftCompilerPlugin

@main
struct MyPlugin: CompilerPlugin {
  let providingMacros: [Macro.Type] = [
    StringifyMacro.self
  ]
}

使用宏

导入宏库,并使用#stringify调用宏。

import MyMacros
let (value, source) = #stringify(2 + 3)
print(value)   // 5
print(source)  // "2 + 3"

构造 ExprSyntax

返回值通过在ExprSyntax上使用字符串插值来构建,同时利用 SwiftSyntax 的类型安全性。

// The expansion returns a tuple literal
return "((\(arg)), \(literal: arg.description))"

访问宏参数

通过node.arguments访问参数;它是一个带标签表达式列表。

let args = node.arguments
for arg in args {
  print(arg.label?.text ?? "_", arg.expression)
}

生成诊断信息

可以使用展开上下文从宏中发出编译器警告或错误。

context.diagnose(Diagnostic(
  node: node,
  message: MyDiagnostic.missingArgument
))

SwiftSyntax 语法节点

SwiftSyntax 会将每个语言结构表示为带类型的语法节点,您可以检查并构造这些节点。

import SwiftSyntax
let expr: ExprSyntax = "1 + 2"
print(type(of: expr)) // BinaryOperatorExprSyntax

宏卫生性

Swift 宏默认具有卫生性:生成的名称不会与调用方作用域中的名称冲突。

// Macro-generated variables get unique names internally
// preventing accidental shadowing in user code

在 Xcode 中展开

在 Xcode 中右键点击任意宏调用,然后选择展开宏,即可查看生成的源代码。

#stringify(40 + 2)
// Xcode expands to: (40 + 2, "40 + 2")

快速检查

表达式宏实现必须遵循哪个协议?

课程回顾

编写独立表达式宏的步骤包括:使用@freestanding(expression)声明宏,在.macro目标中实现ExpressionMacro,通过CompilerPlugin注册宏,然后使用#macroName()调用它。

免费开始

用 AI 导师学习 Swift — 免费

在浏览器中编写并运行真实代码,获得全天候 AI 导师的即时帮助,并在网页或应用中继续学习。

课程
122
课程
409

常见问题解答

「编写独立表达式宏」课时是免费的吗?

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

「编写独立表达式宏」这节课中我会学到什么?

使用 SwiftSyntax 和 MacroExpansion 实现简单的 #stringify 宏。 你通过在浏览器中直接运行的动手代码来练习 Swift Academy,全天候 AI 导师会在你学习这节课的过程中回答你的问题。

学习 Swift Academy 需要有经验吗?

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

「编写独立表达式宏」课时需要多长时间?

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

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

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

此课程中的所有课时

  1. 宏角色:独立宏与附加宏
  2. 编写独立表达式宏
  3. 用于减少样板代码的附加成员宏
  4. 测试与调试宏
← 返回 Swift Academy