lovellx

工程中使用图片主要有两种方式：

UIImage.init(named: “imageKey”)
Image Literal 在Xcode中直接选择要使用的图片。

问题

第一种方式直接输入图片全名，很容易拼错，并且拼错之后没有任何提示。

第二种方式使用Image Literal可以通过Xcode提示直接选择需要的图片，看上去可以完美替代第一种方式，但是当图片名字改变或者被删除时，同样无法获得编译器提示。

改进

使用swiftgen，通过读取图片资源，生成UIImage的枚举代码。这样我们在使用图片资源的时候还能通过编译器提示获取需要的图片，并且可以通过执行脚本使图片资源与模版代码生成的Image case保持一致，使用指南

替换现有的代码

引入swiftgen之后，面临的一大问题就是怎么把已有的代码全部替换为Image case，例如：

1	UIImage.init(named: "reviewIcon")

需要替换为:

1	Asset.reviewIcon.image

工程中使用图片的地方有千百个，一个一个手动的替换就显得太僵硬了。

正则匹配替换

庆幸的是Xcode提供了正则替换的功能，可以使用如下正则替换：

正则1

但是，由于长期的图片累积有些图片名字并不是驼峰的命名方式，比如:

1	UIImage.init(named:"a_logo")

类似这样名字的图片，经过上述正则替换后对应的代码为：

1	Asset.a_logo.image

而a_logo对应生成的Image case为：

1	static let aLogo = ImageAsset(name: "a_logo")

所以这时编译器会提示编译错误。

如何将下划线命名转化为驼峰命名？

Xcode的正则替换只允许做如上简单的匹配替换，没有提供进一步转换匹配到的字符串的功能，所以只能换个支持转化正则匹配结果的编辑器，我使用的是Sublime。

使用Sublime打开工程，在上述正则替换的基础上键入如下匹配替换：

正则2

“\u” 的意思是把匹配到的字符串首字母大写输出，这样就完成了驼峰命名的转换，匹配转换规则在这里可以找到。

为什么要类型化通知？

在重构工程的时候，发现工程中使用Notification API的地方非常多，notification的使用充满了各种硬编码，例：

extension Notification.Name {
    static let test = Notification.Name.init("com.typedNotification.test")
}
NotificationCenter.default.post(name: .test, object: nil, userInfo: ["passedNum": 1, "passedString": "it is boring"])

在一个通知中，可能会携带object或userInfo，在接收端的代码：

notiToken = NotificationCenter.default.addObserver(forName: .test, object: nil, queue: nil) { (noti) in
    guard let num = noti.userInfo?["passed"] as? Int, let str = noti.userInfo?["passedString"] as? String else {
        return
    }
    print("\(num) \(str)")
}

同时还需要在通知不用的时候remove

1	NotificationCenter.default.removeObserver(notiToken)

这样会导致每当我们需要post和接收test通知的时候，都需要写上面那样的代码。假如需要修改“passed”的类型或者增加一个传递的参数，那就需要找到每一处发送和接收test通知的地方进行修改，这样维护起来就非常艰难了，所以需要改写这些通知的使用方式。

如何类型化通知？

首先定义一个通知发送描述协议

protocol NotificationDescriptor {
    var name: Notification.Name { get }
    var userInfo:[AnyHashable: Any]? { get }
    var object: Any? { get }
}

extension NotificationDescriptor {
    var userInfo:[AnyHashable: Any]? {
        return nil
    }
    var object: Any? {
        return nil
    }
}

extension NotificationDescriptor {
    func post(on center: NotificationCenter = NotificationCenter.default) {
        center.post(name: name, object: object, userInfo: userInfo)
    }
}

定义一个接收解析通知的类型

protocol NotificationDecodable {
    init(_ notification: Notification)
}

extension NotificationDecodable {
    static func observer(on center: NotificationCenter = NotificationCenter.default ,
                  for aName: Notification.Name,
                  using block: @escaping (Self) -> Swift.Void) -> NotificationToken {
        let token = center.addObserver(forName: aName, object: nil, queue: nil, using: {
            block(Self.init($0))
        })
        return NotificationToken.init(token, center: center)
    }
}

我们还希望能把通知的发送和解析逻辑写在一起

1	typealias TypedNotification = NotificationDescriptor & NotificationDecodable

这样test通知可以写成这样：

struct TestNotificaiton: TypedNotification {
    var name: Notification.Name { return .test }
    var userInfo: [AnyHashable : Any]? {
        return ["passedNum": num, "passedStr": str]
    }
    var num: Int
    var str: String
    init(_ notification: Notification) {
        num = notification.userInfo!["passedNum"] as! Int
        str = notification.userInfo!["passedStr"] as! String
    }
    init(_ num: Int, str: String) {
        self.num = num
        self.str = str
    }
}

发送通知：

1 2	let testDescriptor = TestNotificaiton.init(1, str: "it is fine") testDescriptor.post()

接受通知：

1
2
3

notiToken = TestNotificaiton.observer(for: .test) { (testObj) in
    print("\(testObj.num) \(testObj.str)")
}

notiToken类似于NSKeyValueObservation, 并不需要手动去移除通知，管理notiToken的生命周期就可以了。

通过类型化通知，把通知的发送的描述和接收的解析处理写在一起，有利于后期的持续维护，具体实现我单独拿出来放到了这个repo中, 有兴趣的可以去看看。

注意

通知在MVC中是一个非常重要的机制。但是使用通知需要谨慎，如果过度使用通知，对象之间会产生各种错综复杂的依赖，非常不利于工程的拆分。

使用swiftgen管理图片资源

问题

改进

替换现有的代码

正则匹配替换

如何将下划线命名转化为驼峰命名？

swift类型化通知

为什么要类型化通知？

如何类型化通知？

注意