开始写一个 Swift 宏吧-六虎

什么是宏

Apple 在 Swift 5.9 里边加入了 Swift macros（宏），宏能够在编译的进程中帮咱们生成一些需求重复编写的代码。WWDC 23 中有两个关于宏的 Session，Expand on Swift macros 介绍了什么是宏和宏的几种类型，Write Swift macros 介绍了怎样去写一个宏。这两个 Session 介绍了每种宏能够做什么，可是缺少了详细的代码，我不知道详细要怎样去完成我想要的效果，在查阅了一些材料和 Swift 官方库的内部完成之后才知道每个宏的界说和用法。

宏类型介绍

宏主要分为两种类型：

@freestanding 是一个独立的宏（与 # 语法一起运用），而且能够用作表达式。

@attached 是一个附加宏（与 @ 语法一起运用），需求调配 struct/class/enum/property/function 等类型运用，能够为其增加代码。

每个类型的宏详细能干什么？

@freestanding(expression)

编写一段代码使其回来一个值。

let url = #URL("https://www.baidu.com")
// 宏内部会判别该字符串能否生成 URL，假如无法生成会报错，将运转报错提前到了编译阶段。
let url = #URL("https:// www.baidu.com") // 报错：UnableToCreateURL

宏生成代码：

let url = URL(string: "https://www.baidu.com")!

宏的完成代码（点击检查）

/// 声明
@freestanding(expression)
public macro URL(_ value: String) -> URL = #externalMacro(module: "MyMacroMacros", type: "URLMacro")
/// 完成
public struct URLMacro: ExpressionMacro {
    enum MacroError: Error {
        case unableToCreateURL
    }
    public static func expansion<Node: FreestandingMacroExpansionSyntax, Context: MacroExpansionContext>(
        of node: Node,
        in context: Context
    ) throws -> ExprSyntax {
        let content = node.argumentList.first?.expression.as(StringLiteralExprSyntax.self)?.segments.first?.description ?? ""
        guard let _ = URL(string: content) else {
            throw MacroError.unableToCreateURL // 无法生成 URL，报错
        }
        return "URL(string: \"\(raw: content)\")!"
    }
}

@freestanding(declaration)

宏能够写在恣意当地，能够创立一段或多段代码。

#guardValue(self)

宏生成代码：

guard let self = self else { return }

宏的完成代码（点击检查）

/// 声明
@freestanding(declaration)
public macro guardValue(_ values: Any...) = #externalMacro(module: "MyMacroMacros", type: "GuardMacro")
/// 完成
public struct GuardMacro: DeclarationMacro {
    public static func expansion<Node: FreestandingMacroExpansionSyntax, Context: MacroExpansionContext>(
        of node: Node,
        in context: Context
    ) throws -> [DeclSyntax] {
        let code = node.argumentList.map {
            $0.expression.description
        }.map {
            "let \($0) = \($0)"
        }.joined(separator: ", ")
        return [
            "guard \(raw: code) else { return }"
        ]
    }
}

@attached(peer)

宏会在同个代码层级生成一段代码。

@AddCompletionHandler()
func fetchDetail(_ id: Int) async -> String? { }

宏生成代码：

// 宏会在同个代码层级生成代码
func fetchDetail(_ id: Int, completionHandler: @escaping (String?) -> Void) {
  Task {
    completionHandler(await fetchDetail(id))
  }
}

宏的完成代码（点击检查）

该宏来自 Swift 官方库声明完成

现在在 beta 1 中生成出来的代码无法直接被调用，不清楚是否是宏写的有问题，仍是有 Bug。我更倾向这是 Bug，上面说到的 #guardValue 宏也无法调用到解包后的变量。假如是我用法的问题，费事在评论区告诉我。

@attached(accessor)

能够给变量生成 get、set、willSet、didSet 等办法。

class Foo {
    @PrintWhenAssigned
    var name: String = ""
}
let f = Foo()
f.name = "Tom" // Logs: Tom
f.name = "Bob" // Logs: Bob

宏生成代码：

class Foo {
    @PrintWhenAssigned
    var name: String = ""
    {
        didSet {
            print(name)
        }
    }
}

宏的完成代码（点击检查）

/// 声明
@attached(accessor)
public macro PrintWhenAssigned() = #externalMacro(module: "NetworkMacros", type: "PrintWhenAssignedMacro")
/// 完成
public struct PrintWhenAssignedMacro: AccessorMacro {
    public static func expansion<Context: MacroExpansionContext, Declaration: DeclSyntaxProtocol>(
        of node: AttributeSyntax,
        providingAccessorsOf declaration: Declaration,
        in context: Context
    ) throws -> [AccessorDeclSyntax] {
        guard let propertyName = declaration.as(VariableDeclSyntax.self)?.bindings.first?.pattern.description else { return [] }
        return [
        """
        didSet {
            print(\(raw: propertyName))
        }
        """
        ]
    }
}

@attached(memberAttribute)

能够给 struct/class/enum 等里边的属性、办法加上 attribute，比方 @property、宏等。

@TestMemberAttribute
public class Foo {
    var name: String = ""
    func foo() { }
}

宏生成代码：

@TestMemberAttribute
public class Foo {
  	@SomeMacro
    var name: String = ""
  	@SomeMacro
    func foo() { }
}

宏的完成代码（点击检查）

/// 声明
@attached(memberAttribute)
public macro TestMemberAttribute() = #externalMacro(module: "MyMacroMacros", type: "TestMemberAttributeMacro")
/// 完成
public struct TestMemberAttributeMacro: MemberAttributeMacro {
    public static func expansion<Declaration: DeclGroupSyntax, MemberDeclaration: DeclSyntaxProtocol, Context: MacroExpansionContext>(
        of node: AttributeSyntax,
        attachedTo declaration: Declaration,
        providingAttributesFor member: MemberDeclaration,
        in context: Context
    ) throws -> [AttributeSyntax]  {
        return ["@SomeMacro"]
    }
}

@attached(member)

能够给 struct/class/enum 增加属性、办法。

@CaseDetection
enum Animal {
    case cat(String)
}

宏生成代码：

@CaseDetection
enum Animal {
    case cat(String)
    var isCat: Bool {
        if case .cat = self { true }
        else { false }
    }
}

宏的完成代码在后面的事例中。

@attached(conformance)

能够给 struct/class 增加协议和约束。

@TestConformance
struct Foo { }

宏生成代码：

extension Foo : SomeProtocol where AAA: BBB {}

宏的完成代码（点击检查）

/// 声明
@attached(conformance)
public macro TestConformance() = #externalMacro(module: "MyMacroMacros", type: "TestConformanceMacro")
/// 完成
public struct TestConformanceMacro: ConformanceMacro {
    public static func expansion<Declaration: DeclGroupSyntax, Context: MacroExpansionContext>(
        of node: AttributeSyntax,
        providingConformancesOf declaration: Declaration,
        in context: Context
    ) throws -> [(TypeSyntax, GenericWhereClauseSyntax?)] {
        let conformance = try GenericWhereClauseSyntax(
            leadingTrivia: .newline,
            requirementList: [
                .init(body: .conformanceRequirement(.init(
                    leftTypeIdentifier: TypeSyntax(stringLiteral: " AAA"),
                    rightTypeIdentifier: TypeSyntax(stringLiteral: " BBB"))))
            ])
        return [("SomeProtocol", conformance)]
    }
}

怎样自己创立宏

写宏的准备工作

1.创立工程

新建一个 Swift Macro Package ，Xcode -> File -> New -> Package，选择 Swift Macro。

Swift Macro 需求依赖 apple/swift-syntax 第三方库，这是 Apple 的词法分析库，用于解析、检查、生成和转化 Swift 源代码。

创立完成后，咱们能够看到项意图结构是这样的：

├── Package.resolved
├── Package.swift
├── Sources
│ ├── MyMacro
│ │ └── MyMacro.swift // 宏声明文件
│ ├── MyMacroClient
│ │ └── main.swift // 可运转文件，能够在这儿测验宏的实际效果
│ └── MyMacroMacros
│     └── MyMacroMacro.swift // 宏完成文件
└── Tests
    └── MyMacroTests
        └── MyMacroTests.swift // 宏测验文件，用于编写、调试宏

2.宏完成文件

咱们先翻开 MyMacroMacro.swift 写一下上面说到的 @CaseDetection 宏。先让宏恪守 MemberMacro 协议，然后点击报错让 Xcode 生成协议办法，生成之后先回来一个空数据，并将断点打到 return [] 上面，不着急写宏。

public struct CaseDetectionMacro { }
extension CaseDetectionMacro: MemberMacro {
    public static func expansion<Declaration: DeclGroupSyntax, Context: MacroExpansionContext>(
        of node: AttributeSyntax,
        providingMembersOf declaration: Declaration,
        in context: Context
    ) throws -> [DeclSyntax] {
        return []
    }
}

然后咱们需求在底部将宏加到 MyMacroPlugin 里边。

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

3.宏声明文件

翻开 MyMacro.swift 文件声明一下宏：

// 假如宏恪守了多个协议，需求在这儿写上多个 @attched()
@attached(member)
public macro CaseDetection() = #externalMacro(module: "MyMacroMacros", type: "CaseDetectionMacro")

4.宏测验文件

翻开 MyMacroTests.swift 文件写一个测验用例，意图是为了能断点打到宏里边。

先在 testMacros 里边加上咱们的宏：

let testMacros: [String: Macro.Type] = [
    "stringify": StringifyMacro.self,
  	"CaseDetection": CaseDetectionMacro.self,
]

再写一个测验用例，这儿 expandedSource 是宏预期生成出来的代码，咱们能够先不写。

func testCaseDetectionMacro() {
    assertMacroExpansion(
        """
        @CaseDetection
        enum Animal {
            case cat
        }
        """,
        expandedSource: """
        """,
        macros: testMacros
    )
}

运转测验用例，咱们就会进入宏完成的断点里边了，这时候咱们能够开端写宏了。

开端写宏

public static func expansion<Declaration: DeclGroupSyntax, Context: MacroExpansionContext>(
    of node: AttributeSyntax,
    providingMembersOf declaration: Declaration,
    in context: Context
) throws -> [DeclSyntax] {
    return []
}

node

node 参数能够获取宏的声明部分，假如宏接纳参数能够从 node 中取到，履行 po node。

AttributeSyntax
├─atSignToken: atSign
╰─attributeName: SimpleTypeIdentifierSyntax
  ╰─name: identifier("CaseDetection")

假如咱们想要获取宏的称号能够这样写：

let macroName = node.attributeName.description // "CaseDetection"

declaration

declaration 参数能够获取类型里边的界说，履行 po declaration：

EnumDeclSyntax
├─attributes: AttributeListSyntax
│ ╰─[0]: AttributeSyntax
│   ├─atSignToken: atSign
│   ╰─attributeName: SimpleTypeIdentifierSyntax
│     ╰─name: identifier("CaseDetection")
├─enumKeyword: keyword(SwiftSyntax.Keyword.enum)
├─identifier: identifier("Animal")
╰─memberBlock: MemberDeclBlockSyntax
  ├─leftBrace: leftBrace
  ├─members: MemberDeclListSyntax
  │ ╰─[0]: MemberDeclListItemSyntax
  │   ╰─decl: EnumCaseDeclSyntax
  │     ├─caseKeyword: keyword(SwiftSyntax.Keyword.case)
  │     ╰─elements: EnumCaseElementListSyntax
  │       ╰─[0]: EnumCaseElementSyntax
  │         ╰─identifier: identifier("cat")
  ╰─rightBrace: rightBrace

调试

宏需求获取枚举的称号，咱们现在断点里边获取到想要的数据，再去写代码。

咱们一步步去点开，会发现到 decl 就下不去了。

po declaration.memberBlock.members.first!.decl

因为 decl 是顶层的协议 DeclSyntax，咱们需求运用 as() 将其转化为 EnumCaseDeclSyntax：

po declaration.memberBlock.members.first!.decl.as(EnumCaseDeclSyntax.self)

在写宏的进程中，咱们会经常遇到这个问题，发现类型对不上能够用 as() 进行类型转化，最终的调试代码：

po declaration.memberBlock.members.first!.decl.as(EnumCaseDeclSyntax.self)?.elements.first!.identifier.description // "cat"

宏完成代码

根据这个调试代码，咱们能够去写宏完成代码了。

public struct CaseDetectionMacro { }
extension CaseDetectionMacro: MemberMacro {
    public static func expansion<Declaration: DeclGroupSyntax, Context: MacroExpansionContext>(
        of node: AttributeSyntax,
        providingMembersOf declaration: Declaration,
        in context: Context
    ) throws -> [DeclSyntax] {
        var names: [String] = []
        for member in declaration.memberBlock.members { // 循环获取所有属性、办法
            let elements = member.decl.as(EnumCaseDeclSyntax.self)?.elements
            if let propertyName = elements?.first?.identifier.description {
                names.append(propertyName) // 取出枚举名
            }
        }
        return names.map { // 拼接完成代码
            """
            var \("is" + capitalized($0)): Bool {
                if case .\($0) = self { true }
                else { false }
            }
            """
        }.map {
            DeclSyntax(stringLiteral: $0)
        }
    }
    /// 首字母大写
    private static func capitalized(_ str: String) -> String {
        var str = str
        let firstChar = String(str.prefix(1)).uppercased()
        str.replaceSubrange(...str.startIndex, with: firstChar)
        return str
    }
}

检查宏效果

最终咱们到 main.swift 里边写一个枚举测验一下宏。

@CaseDetection
enum Animal {
    case cat
}

写完咱们能够右击 @CaseDetection 宏，点击 Expand Macro 检查宏生成的代码。

报错处理

Declaration name 'isCat' is not covered by macro 'CaseDetection'

宏生成的代码十分完美，可是修正报错了，这是因为宏生成出来的变量/办法需求在宏声明部分界说好，回到 MyMacro.swift 宏声明文件修正一下声明代码：

@attached(member, names: arbitrary)
public macro CaseDetection() = #externalMacro(module: "MyMacroMacros", type: "CaseDetectionMacro")

⚠️注意：arbitrary 表明宏能够生成恣意变量/办法，在这个例子中，因为咱们要生成的变量是动态变化的，所以只能写 arbitrary，假如你的宏生成的变量/办法是固定的，建议在这儿也固定写死，比方：

@attached(member, names: named(isCat))
public macro CaseDetection() = #externalMacro(module: "MyMacroMacros", type: "CaseDetectionMacro")

咱们再运转就发现编译通过了，最终的最终，记得去完善测验用例～

总结

宏十分强大，能够帮咱们省去很多重复的代码，虽然写宏的进程会比较费事，可是写完之后就能够为你节约十分多的时刻。另外每一个类型的宏都是 protocol，所以咱们能够将多个宏组合在一起运用，比方 Swift Data 里边的 @Model。现在宏还在 beta 测验阶段，后续 Apple 也或许会对宏进行改善，我也会继续重视并更新哒。

本文由mdnice多渠道发布

开始写一个 Swift 宏吧

什么是宏

宏类型介绍

每个类型的宏详细能干什么？

@freestanding(expression)

@freestanding(declaration)

@attached(peer)

@attached(accessor)

@attached(memberAttribute)

@attached(member)

@attached(conformance)

怎样自己创立宏

写宏的准备工作

1.创立工程

2.宏完成文件

3.宏声明文件

4.宏测验文件

开端写宏

node

declaration

调试

宏完成代码

检查宏效果

报错处理

总结

相关文章

MySQL查询数据库表记录数

打工：本身就毫无意义

WWDC2022-iOS篇完全解析

掘金公开课｜2022 金三银四下程序员的自我修养

作者信息