Swift 宏（Macro）入门趣谈（四）

概述

苹果在去年 WWDC 23 中就为 Swift 语言新增了"其利断金"的重要小伙伴 Swift 宏（Swift Macro）。为此，苹果特地用 2 段视频（入门和进阶）颇为隆重的介绍了它。

那么到底 Swift 宏是什么？有什么用？它和 C/C++ 语言中的宏又有什么异同呢？本系列博文将会尝试为小伙伴们揭开 Swift 宏的神秘面纱。

在本篇博文中，您将学到如下内容：

1. 书归正传：略显复杂的解决方案
- 5.1 定义宏接口
- 5.2 初步实现宏主体
- 5.3 补全客户端中宏的使用代码

相信学完本系列博文后，Swift Macro 会从大家心中的"阳春白雪"变为"阳阿薤露"，小伙伴们必可以将它们运用的"如臂使指"。

那还等什么呢？Let's go！！！;)

5. 书归正传：略显复杂的解决方案

首先对于我们的需求，必须先决定到底应该用使用哪种类型的宏。要在 7 种宏角色里选出一个合适的貌似有些头大呢。

回到博文开头 sortItemsBy 方法的实现中再回顾一下：

swift 复制代码

func sortItemsBy<Value: Comparable>(keyPath: KeyPath<Item, Value>, sortOrder: SortOrder = .forward) throws -> [Item] {
    items.sorted(using: SortDescriptor(keyPath, order: sortOrder))
}

可以看到我们的需求其实很简单：就是根据现有排序方法自动生成一个实参 KeyPath 中为可选 Value（KeyPath<Item, Value?>）类型的新方法。

注意，我们实际的意图是用宏在原有方法上自动生成一个新方法，并同时保留原有方法。

所以很显然，使用附属宏中的 peer 子类型最为切题和恰当：

在给自定义宏定下一个基调之后，我们现在可以着手来实现它啦！

注意，不是说只能用 @attached(peer) 宏才能实现我们这一功能，用其它种类的宏也是可以办到的，只不过可能方式和难易不同而已。

5.1 定义宏接口

首先，我们需要完成宏接口的定义：

swift 复制代码

@attached(peer, names: arbitrary)
public macro nilable() = #externalMacro(module: "MyMacroMacros", type: "NilableMacro")

在上面的代码中，我们将 @attached(peer) 宏生成的方法进一步声明为任意（arbitrary）类型。

从上面宏接口的定义还可以知道，我们的自定义宏的（调用）名称为 @nilable。

注意，在 Swift Macros 升级后的内部实现里我们已不能在全局方法上应用 arbitrary 类型了。

从上面接口代码还可以获悉一个非常重要的信息：我们实际是将 @nilable 宏的具体实现放在了 MyMacroMacros 模块中的 NilableMacro 类型里。

5.2 初步实现宏主体

回到 MyMacroMacro.swift 文件中，如约新增一个 NilableMacro 结构。现在它什么也不能做，只是直接抛出了一个错误：

swift 复制代码

public struct NilableMacro: PeerMacro {
    
    public static func expansion(of node: AttributeSyntax, providingPeersOf declaration: some DeclSyntaxProtocol, in context: some MacroExpansionContext) throws -> [DeclSyntax] {
        throw MacroExpansionErrorMessage("待实现！")
    }
}

这样做的用意是：不要纠结宏展开的具体细节，而是先从全局层面入手搭建整体框架。

5.3 补全客户端中宏的使用代码

接下来进入 main.swift 文件里，为我们的 @nilable 宏增加调用测试代码：

swift 复制代码

struct Model {
    let items: [Item]
    
    @nilable
    func sortItemsBy<Value: Comparable>(keyPath: KeyPath<Item, Value>, sortOrder: SortOrder = .forward) throws -> [Item] {
        items.sorted(using: SortDescriptor(keyPath, order: sortOrder))
    }
}

运行可以看到，编译器会直接抛出我们之前在 NilableMacro 展开方法里定义的错误：

这说明我们自定义宏的接口与宏实现已成功"珠联璧合"，Very Nice！

在最后一篇博文中，我们将完成 @nilable 宏的全部实现，收尾整个系列文章，不见不散哦。

总结

在本篇博文中，我们讨论了如何利用之前所学一步一步描绘出我们自定义宏的蓝图：包括定义宏接口、初步构造宏主体以及补全客户端中宏的测试用例。

感谢观赏，下一篇再见喽！8-)