SwiftFormat 中关于 `@storageRestrictions` 的 `self` 使用问题解析

在 Swift 5.9 中引入的 init-accessors 特性为 Swift 属性提供了更灵活的初始化控制能力。@storageRestrictions 属性作为这一特性的重要组成部分，允许开发者明确指定哪些存储属性会被初始化器访问或修改。然而，在实际使用中，我们发现了一个值得注意的语法细节问题。

问题背景

在 Swift 代码中，当使用 @storageRestrictions 属性时，其参数列表中引用的存储属性名称是否需要添加 self. 前缀存在一个微妙的语法差异。根据 Swift 编译器的当前实现：

// 这种写法会被编译器接受
@storageRestrictions(initializes: __myVar)

// 而这种带 self 前缀的写法会被拒绝
@storageRestrictions(initializes: self.__myVar)

这个行为与 Swift 中大多数其他场景下的属性引用方式不同，因为在常规情况下，self.__myVar 和 __myVar 通常是等价的。

技术细节分析

1. @storageRestrictions 的设计意图：这个属性主要用于声明式地指定哪些存储属性会被初始化器访问，其参数列表中的标识符应该被解析为纯粹的属性名称而非完整的成员访问表达式。

2. SwiftFormat 的影响：当开发者配置 SwiftFormat 使用 --self insert 选项时，格式化工具会自动为属性引用添加 self. 前缀，这会导致原本有效的 @storageRestrictions 声明变为无效代码。

3. 编译器的处理逻辑：Swift 编译器在解析 @storageRestrictions 参数时，将其视为一个特殊的上下文，只接受简单的标识符而非完整的表达式，这与常规的属性访问语法有所区别。

解决方案

SwiftFormat 在 0.54.0 版本中修复了这个问题，现在会智能地识别 @storageRestrictions 属性中的参数列表，避免在这些位置自动插入 self 前缀。开发者可以安全地使用以下两种配置：

• 继续使用 --self insert 全局配置
• 或者在 @storageRestrictions 处手动禁用 self 插入

最佳实践建议

1. 在使用 init-accessors 时，建议直接使用简单的属性名而不加 self. 前缀
2. 更新到 SwiftFormat 0.54.0 或更高版本以避免格式化导致的编译错误
3. 在团队协作项目中，统一关于 @storageRestrictions 的代码风格约定

这个案例提醒我们，在使用新兴语言特性时，需要特别注意其与工具链的交互行为，及时关注编译器和相关工具的更新，以确保开发流程的顺畅。