阅读视图

发现新文章,点击刷新页面。

Kingfisher图像处理库

Kingfisher 是一个功能强大的 Swift 图像处理库,专注于从网络加载、缓存和显示图像,广泛用于 iOS 开发。其 GitHub 仓库提供了丰富的文档和示例,方便开发者快速集成和使用。 方法

在平淡中等待 WWDC 2025 - 肘子的 Swift 周报 #84

不知不觉,距离 WWDC 2025 开始只有 20 天了。在过去的几年中,每当此时我都会写几篇文章畅想 WWDC 上会带来的新功能和我期待的一些变化。然而,或许是因为最近两年 WWDC 上展示的许多新功能并未完全落地,就我个人而言,今年似乎少了往日的热情和渴望。希望这只是我个人的情况。

iOS 截取和分割音视频

在 iOS 开发中,**截取或分割音视频**是常见需求,适用于短视频剪辑、语音消息裁剪、媒体内容编辑等场景。使用 **AVFoundation** 框架可以高效实现这一功能。下面将详细介绍如何在 iO

iOS 音视频格式

在 iOS 开发中,音频和视频的格式选择直接影响性能、兼容性和用户体验。以下是常见的音频和视频格式,以及实际开发中常用的场景: --- ### **一、音频格式** #### **1. 常见音频格

Swift Macros - 扩展绑定宏

在 Swift 宏系统中,ExtensionMacro 是一种用于自动生成扩展(extension)代码块的宏协议,适用于为类型生成协议实现、工具方法、便捷功能等 “类型之外”的附加内容。它是 Swi

6.4 Swift Macros - 对等绑定宏

在 Swift 宏体系中,PeerMacro 是一种非常灵活且强大的宏协议,专用于生成与绑定声明处于同一作用域的“对等”声明,常用于自动扩展同级的变量、函数或类型定义。

本节将深入介绍 PeerMacro 的用途、定义、参数结构以及实际示例,帮助你理解它在元编程场景中的独特价值。

建议结合《Swift Macros - 宏之全貌》和《Swift Macros - 宏之协议》一并阅读,便于全面理解宏系统的角色协作模型。

1. PeerMacro 的定义

标准库中 PeerMacro 的定义如下:

 public protocol PeerMacro: AttachedMacro {
  static func expansion(
    of node: AttributeSyntax,
    attachedTo declaration: some DeclSyntaxProtocol,
    in context: some MacroExpansionContext
  ) throws -> [DeclSyntax]
 }

这意味着:

  • 它是一个 附加宏(attached macro)
  • 不能生成成员,而是生成与附着声明同级的其他声明
  • 它的返回值为 [DeclSyntax],即可以注入多个顶层/局部声明;
  • 使用范围包括变量、函数、类型、扩展等几乎所有可声明位置。

2. PeerMacro 的典型用途

Peer 宏的应用场景非常广泛,常用于:

场景 示例 说明
自动生成伴生变量 @WithWrapper 为属性生成 _xxx 存储变量
自动生成伴生函数 @BindAction 为属性自动生成相关行为函数
生成衍生声明 @AutoObservable 为属性自动生成观察者包装及通知机制
声明反射信息 @Reflectable 自动生成结构体元信息注册代码

特别适合那些需要基于现有声明生成“相关声明”的情境,但不适合直接插入原声明体内的场合。


3. 参数详解

of node: AttributeSyntax

代表宏的语法标记本身,例如 @WithWrapper。可用于:

  • 宏参数提取;
  • 判断具体调用语法。

attachedTo declaration: some DeclSyntaxProtocol

  • 表示宏附着的原始声明节点;
  • 类型是 DeclSyntaxProtocol,表示可以是变量、函数、类型等;
  • 你可以从中提取关键元信息(如变量名、类型名、访问级别等)。

in context: some MacroExpansionContext

上下文对象,常用于:

  • 生成唯一名称(防止冲突);
  • 获取源文件路径、位置;
  • 报告诊断信息(如参数错误)。

4. 对等声明的展开位置

Peer 宏生成的声明会插入到与原声明相同的作用域中,而不是类型或函数内部

例如:

 @WithWrapper
 var name: String

展开后等同于:

 var name: String
 private var _name: String = ""

即:_namename 的“对等声明”,它们在同一语法级别上。


5. 示例解析

示例:为变量自动生成属性

用法
 struct User {
    @DebugEqual
    var userName: String = ""
 }
 
 // 展开后
 struct User {
    var userName: String = ""
     
    var debug_userName: String {
        "userName = (userName)"
    }
 }
实现
 @attached(peer, names: arbitrary)
 public macro DebugEqual() = #externalMacro(module: "McccMacros", type: "DebugEqualMacro")
 
 public struct DebugEqualMacro: PeerMacro {
    public static func expansion(
        of node: AttributeSyntax,
        providingPeersOf declaration: some DeclSyntaxProtocol,
        in context: some MacroExpansionContext
    ) throws -> [DeclSyntax] {
        // 把通用声明转成变量声明
        guard let varDecl = declaration.as(VariableDeclSyntax.self),
              // 变量可鞥有多个绑定(var a = 1, b = 2),这里获取第一个。
              let binding = varDecl.bindings.first,
              // 获取变量名,比如”userName“
              let identifier = binding.pattern.as(IdentifierPatternSyntax.self)?.identifier.text
        else {
            return []
        }
 
 
        // 生成新的变量名,如 debug_username
        // raw: 的作用?原样插入这个标识符文本,不会加引号,也不会逃逸。这是写 Swift 宏时推荐的写法之一。
        return [
            """
            var debug_(raw: identifier): String {
                "(raw: identifier) = \((raw: identifier))"
            }
            """
        ]
    }
 }

6. 注意事项

  • PeerMacro 会生成多个完整的顶层声明节点,开发者需手动控制命名与作用域;
  • 若生成的名称不一致,建议配合 names: 标注宏声明;
  • 生成类型或函数声明时,需手动处理访问修饰符和重名冲突。

7. 总结

PeerMacro 是 Swift 宏系统中“横向扩展”的核心工具,它允许开发者在不修改原始声明的前提下添加紧密关联的辅助声明。适用于:

  • 分离逻辑与存储
  • 为现有属性扩展行为能力
  • 构建声明式属性模型

当你需要构建“围绕声明的附属结构”,PeerMacro 就是你的利器。

Swift Macros - 成员绑定宏

在 Swift 中,结构体和类的声明体(即 {} 中的内容)常常会包含许多重复或模式化的成员声明。为了提升开发效率并避免重复劳动,Swift 宏系统提供了一种用于自动生成成员声明的宏协议:MemberMacro。在 Swift 宏体系中,MemberMacro 是一种具有极高实用价值的宏协议,它专门用于在类型声明内部生成新的成员(如属性、方法、构造器等)。这种宏是典型的附加宏(attached macro) ,能够大幅减少重复成员定义的样板代码,提高类型声明的表达能力。

本节建议结合《Swift Macros - 宏之全貌》和《Swift Macros - 宏之协议》一并阅读,以便更好地理解宏在声明结构中的角色。

1. MemberMacro 的定义

MemberMacro 是一种 附加宏协议,用于将成员注入至类型声明体中。它只作用于结构体、类、actor、枚举这些具备声明体的类型定义,不能用于函数、变量或其他非类型声明。

它在 Swift 中的声明为:

 public protocol MemberMacro: AttachedMacro {
  static func expansion(
    of node: AttributeSyntax,
    providingMembersOf declaration: some DeclGroupSyntax,
    in context: some MacroExpansionContext
  ) throws -> [DeclSyntax]
 }
参数名 类型 说明
node AttributeSyntax 当前宏调用的语法节点(包含宏名与参数)
declaration some DeclGroupSyntax 宏所附加的类型声明体,例如 structclass
context some MacroExpansionContext 提供诊断、源文件信息等上下文能力

你可以通过 MacroExpansionContext 提供的 diagnose() 方法抛出编译错误,也可以用 context.location(of:) 进行精确定位。

返回值为 [DeclSyntax],表示你希望宏注入的成员声明数组。例如你可以生成变量、函数、嵌套类型等内容:

 return [  "var id: String = UUID().uuidString",  "func reset() { self.id = UUID().uuidString }" ]
 .map { DeclSyntax(stringLiteral: $0) }

💡 注意:返回的成员会插入到原始类型声明体中,因此要避免命名冲突。

📌 使用限制

  • 只可用于具有声明体({})的类型定义:structclassenumactor
  • 不可用于 funcvarextension 等其他声明
  • 若注入的成员包含具名声明(如 var id),必须在宏声明中通过 names: 显式声明,以避免命名未覆盖错误(Declaration name 'id' is not covered by macro

2. 使用场景分析

MemberMacro 适用于所有需要自动生成类型成员的场景,特别是:

场景 示例 说明
自动生成协议实现 @AutoEquatable 自动实现 Equatable== 方法
自动添加辅助属性 @Observe 为属性生成 _xxx 存储与监控 getter
自动实现构造器 @AutoInit 基于属性自动生成初始化函数
自动生成默认值 @WithDefaults 为成员属性自动附加默认实现

3. 示例解析

示例1:AddID

用法:

 @AddID
 struct User {
  var name: String
 }
 
 // 等价于
 struct User {
  var name: String
  var id = UUID().uuidString
 }

实现:

 @attached(member, names: named(id))
 public macro AddID() = #externalMacro(
  module: "MyMacroImpl",
  type: "AddIDMacro"
 )
 
 public struct AddIDMacro: MemberMacro {
  public static func expansion(
    of node: AttributeSyntax,
    providingMembersOf declaration: some DeclGroupSyntax,
    in context: some MacroExpansionContext
  ) throws -> [DeclSyntax] {
    return [
      "var id = UUID().uuidString"
    ].map { DeclSyntax(stringLiteral: $0) }
  }
 }

如果不明确名称

 @attached(member)

运行会报错:

 ❗️Declaration name 'id' is not covered by macro 'AddID'

说明你使用的是 @attached(member) 宏,但没有在宏声明中说明要生成的成员名字,Swift 宏系统默认是不允许你偷偷“注入”成员名的,除非你通过 names: 明确标注。

示例2:CodableSubclass

对于继承自某个父类的子类,我们希望自动生成 CodingKeysinit(from:) 方法.

用法

 class BaseModel: Codable {
    var name: String = ""
 }
 
 @CodableSubclass
 class StudentModel: BaseModel {
    var age: Int = 0
 }
 
 
 // 宏展开后等效于
 class StudentModel: BaseModel {
    var age: Int = 0
     
    private enum CodingKeys: String, CodingKey {
        case age
    }
 
    required init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        self.age = try container.decode(Int.self, forKey: .age)
    }
 }

实现

 @attached(member, names: named(init(from:)), named(CodingKeys))
 public macro CodableSubclass() = #externalMacro(module: "McccMacros", type: "CodableSubclassMacro")
 
 
 public struct CodableSubclassMacro: MemberMacro {
    public static func expansion(
        of node: AttributeSyntax,
        providingMembersOf declaration: some DeclGroupSyntax,
        in context: some MacroExpansionContext
    ) throws -> [DeclSyntax] {
        // 1. 验证是否是类声明
        guard let classDecl = declaration.as(ClassDeclSyntax.self) else {
            throw MacroError.message("@CodableSubclass 只能用于类")
        }
         
        // 2. 验证是否有父类
        guard let inheritanceClause = classDecl.inheritanceClause,
              inheritanceClause.inheritedTypes.contains(where: { type in
                  type.type.trimmedDescription == "BaseModel" ||
                  type.type.trimmedDescription.contains("Codable")
              }) else {
            throw MacroError.message("@CodableSubclass 需要继承自 Codable 父类")
        }
         
        // 3. 收集所有存储属性
        let storedProperties = classDecl.memberBlock.members
            .compactMap { $0.decl.as(VariableDeclSyntax.self) }
            .filter { $0.bindingSpecifier.text == "var" }
            .flatMap { $0.bindings }
            .compactMap { binding -> String? in
                guard let pattern = binding.pattern.as(IdentifierPatternSyntax.self) else {
                    return nil
                }
                return pattern.identifier.text
            }
         
        // 4. 生成 CodingKeys 枚举
        let codingKeysEnum = try EnumDeclSyntax("private enum CodingKeys: String, CodingKey") {
            for property in storedProperties {
                "case (raw: property)"
            }
        }
         
        // 5. 生成 init(from:) 方法
        let initializer = try InitializerDeclSyntax("required init(from decoder: Decoder) throws") {
            // 调用父类解码器
            "try super.init(from: decoder)"
             
            // 创建容器
            "let container = try decoder.container(keyedBy: CodingKeys.self)"
             
            // 解码每个属性
            for property in storedProperties {
                "self.(raw: property) = try container.decode((raw: getTypeName(for: property, in: declaration)).self, forKey: .(raw: property))"
            }
        }
         
        return [DeclSyntax(codingKeysEnum), DeclSyntax(initializer)]
    }
     
    private static func getTypeName(for property: String, in declaration: some DeclGroupSyntax) -> String {
        for member in declaration.memberBlock.members {
            guard let varDecl = member.decl.as(VariableDeclSyntax.self) else { continue }
             
            for binding in varDecl.bindings {
                guard let identifierPattern = binding.pattern.as(IdentifierPatternSyntax.self),
                      identifierPattern.identifier.text == property else {
                    continue
                }
                 
                if let typeAnnotation = binding.typeAnnotation {
                    return typeAnnotation.type.trimmedDescription
                }
            }
        }
         
        // 默认返回 Any,如果找不到匹配
        return "Any"
    }
 }
 
 public enum MacroError: Error, CustomStringConvertible {
    case message(String)
     
    public var description: String {
        switch self {
        case .message(let text):
            return text
        }
    }
 }

4. 总结

MemberMacro 是 Swift 宏体系中连接语法结构与声明注入的关键机制。它让开发者能够根据类型结构自动生成成员,真正实现:

  • 结构自动扩展;
  • 代码样板消除;
  • 类型驱动式逻辑推导。

未来你可以将它与 AccessorMacroPeerMacro 等组合使用,构建更高层次的声明式元编程能力。

❌