Swift中peer宏报错‘Circular reference expanding peer macros’原因探究

宏定义 #

@attached(peer, names: arbitrary)
public macro Lazify(name: String, lock: Protectable) = #externalMacro(module: "MacroModule", type: "LazifyMacro")

该宏用于附加到函数声明，生成对应的懒加载变量。

问题场景 #

在类中使用类属性classLock作为lock参数时，触发循环引用错误：

class SomeClass {
  
  var _internal_lock: NSLock = .init()
  static let classLock: NSLock = .init()
  
  // 错误：Circular reference expanding peer macros on 'createLazyVariable()'
  @Lazify(name: "internalClassName", lock: SomeClass.classLock) 
  func createLazyVariable() -> String {
    return "__" + NSStringFromClass(type(of: self))
  }
}

其他测试结果 #

• 若将宏的lock参数类型改为String，编译可正常通过，但会丢失类型检查能力；
• 若使用实例属性_internal_lock作为参数，会报错：Instance member '_internal_lock' cannot be used on type 'SomeClass'; did you mean to use a value of this type instead?；
• 使用全局锁时，编译完全正常：

let globalLock: NSLock = .init()

class SomeClass {
  @Lazify(name: "internalClassName", lock: globalLock)
  func createLazyVariable() -> String {
    return "__" + NSStringFromClass(type(of: self))
  }
}

1. 实例属性_internal_lock无法使用的核心原因 #

宏的参数在编译阶段的宏展开期就会被求值，此时类的实例还未创建。你在类的类型上下文（函数声明位置）直接引用实例属性，相当于试图在类型层面访问实例成员——这在Swift中本身就是语法错误，实例成员必须通过具体实例对象才能访问，编译阶段无法获取到实例，因此直接报错。

2. 类属性classLock触发循环引用的原因 #

当传递SomeClass.classLock作为宏参数时，宏展开过程陷入了循环依赖：

• 展开@Lazify宏需要先解析SomeClass.classLock这个类属性；
• 解析SomeClass类型又需要先完成它内部所有宏的展开（包括你标记的@Lazify）；
  这种相互依赖导致Swift宏展开器无法完成解析，最终抛出Circular reference expanding peer macros错误。

而全局锁不存在这个问题，因为全局变量定义在类外部，宏展开时可以直接解析全局变量，不需要依赖类本身的展开流程。

可行解决思路 #

• 类级别锁：可以将锁定义在类的外部（比如全局作用域），或者改为传递锁的类型给宏，在宏内部创建锁实例；
• 实例级别锁：修改宏的设计逻辑，让生成的懒加载变量在实例初始化时绑定锁，而非在宏参数中直接传递实例锁（比如结合属性包装器+宏的方式实现）。

内容的提问来源于stack exchange，提问作者Klein Mioke