如何更好地在项目中管理 Swift 扩展

原文:Medium: Better way to manage swift extensions in your project

该如何管理项目中的扩展(extension)?下面是我项目的截图,它说明了一切。

例如,我有一个简单的扩展 UIColor+Image.swift,它用于通过颜色生成图像。

swift 复制代码
extension UIColor {
    func toImage() -> UIImage {
        // 通过颜色生成图片的方法
    }
}

用法:

swift 复制代码
let redImage = UIColor.red.toImage()

完美,不是吗?

问题

可读性。

  1. 没有人可以轻易地猜到这个函数是来自于原生的 UIColor 类还是来自于我定制的扩展(除非你去阅读源码)。
  2. 这些扩展在不同的项目中是可以重用的,所以我们很可能希望它们能延续到下一个项目中。要猜测它属于哪个命名空间很困难。

解决办法

一个简单而古老的方法是,在我们的扩展中,在所有函数名前添加 _ (下划线)作为前缀。 例如: my_abc_

swift 复制代码
extension UIColor {
    func my_toImage() -> UIImage {
        // 通过颜色生成图片的方法
    }
}

用法:

swift 复制代码
let redImage = UIColor.red.my_toImage()

但是这个解决方案难以管理,因为我们必须确保所有的函数都以 my_ 为前缀。

Swift 协议为我们提供了解决方案

要是我们用 my.toImage() 来代替 my_toImage() 会怎么样?

所以我们的想法是做一个单独的类/结构模块,叫做 MyHelper,它将包含所有的扩展方法。如果你愿意,你也可以将函数分组为扩展方法。

MyHelper.swift

swift 复制代码
import UIKit

public protocol MyHelperCompatible {
    associatedtype someType
    var my: someType { get }
}

public extension MyHelperCompatible {
    var my: MyHelper<Self> {
        get { return MyHelper(self) }
    }
}

public struct MyHelper<Base> {
    let base: Base
    init(_ base: Base) {
        self.base = base
    }
}

// All conformance here
extension UIColor: MyHelperCompatible {}

MyHelperCompatible 协议有一个 "my "变量,它保存了整个 MyHelper 类/结构体对象。

现在,可以根据我们的需求来扩展 MyHelper

例如,UIImage+myHelper.swift

swift 复制代码
import Foundation
import UIKit

extension MyHelper where Base: UIColor {
    func toImage() -> UIImage {
        // 通过颜色生成图片的方法
    }
}

在上面的文件中,我们可以添加与 UIColor 相关的其他辅助函数。同样,我们也可以将所有的函数归入 MyHelper 扩展。

最后,可以像下面这样使用 toImage() 方法:

swift 复制代码
let redImage = UIColor.red.my.toImage()

从现在开始,我们只需要创建像上面一样的扩展和方法。

在任何情况下,如果你想禁用该扩展,可以直接注释/删除一致性部分的代码。

swift 复制代码
// extension UIColor: MyHelperCompatible {}

提示:最好把所有的一致性代码都放在一个地方,而不是分散在项目的各个地方,这样你就可以有更多的控制权。

最后的结论

我知道这似乎有点棘手,需要额外的精力来设置,但相信我,当你的项目增长时,它有很大的帮助。

相关推荐
计算机魔术师7 小时前
NVIDIA 季度营收指引达 1080 亿美元,首次突破单季千亿大关
前端
数据狐(Datafox)7 小时前
京东商品列表API技术解析与落地应用(含标准 JSON 示例)
java·大数据·前端·人工智能·python·数据分析·json
风萧何7 小时前
架构艺术,是权衡的艺术。
前端·javascript·架构
YIAN7 小时前
ESLint 新版 Flat Config 实战:团队代码风格统一,从这一份配置开始
前端·团队管理
计算机魔术师7 小时前
英伟达单季营收逼近千亿美元,黄仁勋放话:真实需求远超想象
前端
明月_清风7 小时前
看完这段关于"全插件化架构"的技术分析后,我整理了一份笔记
前端·后端
YIAN7 小时前
Next.js App Router 全栈实战:从 0 到 1 写一个 Todo 应用,前端后端一个项目搞定
前端·全栈·next.js
计算机魔术师7 小时前
英伟达预计 2028 财年营收同比增 70%,黄仁勋称实际需求远高于此
前端
掘金酱8 小时前
🔥 AI 时代,Token 就是你的数字燃料!晒账单,赢好礼!
前端·人工智能·ai编程
计算机魔术师8 小时前
Warp用Claude搭自我改进智能体
前端