首页
/ SwiftFormat 中扩展访问控制修饰符的注意事项

SwiftFormat 中扩展访问控制修饰符的注意事项

2025-05-28 16:20:51作者:羿妍玫Ivan

在 Swift 开发中,SwiftFormat 是一个广受欢迎的代码格式化工具,它可以帮助开发者保持代码风格的一致性。然而,在最新版本中,我们发现了一个关于扩展访问控制修饰符的有趣问题,值得开发者注意。

问题背景

当使用 SwiftFormat 的 extensionAccessControl 规则时,工具会尝试自动为扩展添加适当的访问控制修饰符。但在某些特定情况下,这种自动化处理可能会导致代码无法编译。

具体来说,当扩展用于遵循带有 @preconcurrency 属性的公共协议时,SwiftFormat 会错误地将扩展声明为 public,同时移除协议方法实现中的 public 修饰符。这种转换违反了 Swift 的编译规则。

技术细节解析

Swift 编译器对协议遵循有明确的要求:

  1. 如果扩展遵循的是公共协议,那么扩展中实现协议要求的方法必须保持 public 可见性
  2. 不能将遵循公共协议的扩展本身标记为 public,因为这会与协议要求的可见性产生冲突
  3. @preconcurrency 属性用于处理并发相关的向后兼容性问题,但它不应影响访问控制的基本规则

问题重现

原始代码:

extension MyViewController: @preconcurrency AVPictureInPictureControllerDelegate {
    public func pictureInPictureControllerDidStartPictureInPicture(_ pictureInPictureController: AVPictureInPictureController) {
    }
}

错误格式化后的代码:

public extension MyViewController: @preconcurrency AVPictureInPictureControllerDelegate {
    func pictureInPictureControllerDidStartPictureInPicture(_ pictureInPictureController: AVPictureInPictureController) {
    }
}

这种转换会导致两个编译错误:

  1. 不能将遵循协议的扩展标记为 public
  2. 协议要求的方法必须保持 public 可见性

解决方案

SwiftFormat 团队已经在新版本(0.56.1)中修复了这个问题。修复后的工具会正确识别这种情况,不再对这类扩展进行错误的访问控制修饰符调整。

对于开发者而言,当遇到类似情况时,可以:

  1. 确保使用最新版本的 SwiftFormat
  2. 如果暂时无法升级,可以在配置文件中禁用 extensionAccessControl 规则
  3. 手动检查涉及协议遵循的扩展,确保访问控制修饰符符合编译器要求

最佳实践建议

  1. 对于遵循公共协议的扩展,保持扩展本身不添加访问控制修饰符
  2. 确保协议要求的方法实现具有正确的可见性(通常为 public)
  3. 定期更新代码格式化工具,以获取最新的错误修复和功能改进
  4. 在团队中建立代码审查流程,特别是对于自动化工具修改后的代码

通过理解这些细节,开发者可以更好地利用代码格式化工具,同时避免因自动化处理而引入的编译错误。

登录后查看全文
热门项目推荐
相关项目推荐

项目优选

收起
kernelkernel
deepin linux kernel
C
22
6
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
202
2.17 K
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
208
285
pytorchpytorch
Ascend Extension for PyTorch
Python
61
94
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
977
575
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
9
1
ops-mathops-math
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
550
83
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
1.02 K
399
communitycommunity
本项目是CANN开源社区的核心管理仓库,包含社区的治理章程、治理组织、通用操作指引及流程规范等基础信息
393
27
MateChatMateChat
前端智能化场景解决方案UI库,轻松构建你的AI应用,我们将持续完善更新,欢迎你的使用与建议。 官网地址:https://matechat.gitcode.com
1.2 K
133