問題現狀
平時我們使用UIImage，UIFont，UIColor會遇到很多String-based的接口方法，比如常用的UIImage：
let testImage = UIImage(named: "test")
對于上面的代碼，如果我們把 test 拼寫錯了，Xcode 并不會給出提示，只有當我們運行的時候才會收到報錯，這樣維護起來是有一定成本的。
代碼解決
我們可以用類似如下的代碼來解決這個問題：
import UIKit.UIImage
struct ImageAssets {
fileprivate var name: String
var image: UIImage {
let image = UIImage(named: name)
guard let result = image else { fatalError("Unable to load image named \(name).") }
return result
}
}
enum Assets {
enum AppLogo {
static let appLogo = ImageAssets(name: "appLogo")
static let grayLogo = ImageAssets(name: "gray_logo")
}
enum Arrow {
static let arrowBlue = ImageAssets(name: "arrow_blue")
static let arrowBrown = ImageAssets(name: "arrow_brown")
}
// ....
}
extension UIImage {
convenience init!(asset: ImageAssets) {
self.init(named: asset.name)
}
}
利用上面的代碼，我們在新建 UIImage 的時候就不需要去想圖片的名字了，而且 Xcode 還會有代碼提示：
let logo = Asset.AppLogo.appLogo.image
let grayLogo = UIImage(asset: Asset.AppLogo.grayLogo)
存在問題
雖然這種方法在調用的時候簡單又安全了，但是項目中的圖片往往比較多，如果手動編寫維護那段代碼也是需要不少精力，而且不能保證后續不會添加新的圖片，這樣每次都要去維護那段代碼不免有些反人類。
那么現在就要介紹這個開源項目--- SwiftGen了！
SwiftGen is a tool to auto-generate Swift code for resources of your projects, to make them type-safe to use.
利用 SwiftGen 可以幫我們生成這類的代碼，但是 SwiftGen 默認生成的代碼樣式有時候并不是我們想要的，而且默認生成還會有針對 macOS 上的代碼，比較好的是 SwiftGen 提供了模板的功能，我們可以按自己的需要來修改模板。
集成 SwiftGen 在項目中
SwiftGen 提供了好幾種的集成方式，我這里只介紹我自己比較喜歡的方式：就是通過下載它的 Zip 文件解壓到項目的目錄中，然后通過添加 Run Script 來進行管理。這樣可以基本做到不用操心代碼。
1.修改模板
- 到 SwiftGen倉庫的Release頁面下載最新的 swiftgen-5.2.1.zip
- 將解壓后的
swiftgen-5.2.1文件夾放到項目所在的目錄下(存放xxx.xcodeproj的位置)，可以將文件夾的名字改為SwiftGen5簡潔一點。 - 進入到
SwiftGen5里的templates/xcassets目錄下，這里面可以看到有不少模板，我們選擇swift4.stencil復制一份，命名為my-swift4.stencil然后我們就可以在里面修改我們自己想要的模板，我主要是把真的macOS等其它平臺的一些判斷代碼給刪掉:// Generated using SwiftGen, using my-templete created by Hanson {% if catalogs %} {% set imageAlias %}{{param.imageAliasName|default:"Image"}}{% endset %} import UIKit.UIImage typealias {{imageAlias}} = UIImage {% set enumName %}{{param.enumName|default:"Asset"}}{% endset %} {% set imageType %}{{param.imageTypeName|default:"ImageAsset"}}{% endset %} @available(*, deprecated, renamed: "{{imageType}}") typealias {{enumName}}Type = {{imageType}} struct {{imageType}} { fileprivate var name: String var image: {{imageAlias}} { let bundle = Bundle(for: BundleToken.self) let image = {{imageAlias}}(named: name, in: bundle, compatibleWith: nil) guard let result = image else { fatalError("Unable to load image named \(name).") } return result } } {% macro enumBlock assets sp %} {{sp}} {% call casesBlock assets sp %} {{sp}} {% if not param.noAllValues %} {{sp}} {% endif %} {% endmacro %} {% macro casesBlock assets sp %} {{sp}} {% for asset in assets %} {{sp}} {% if asset.type == "color" %} {{sp}} static let {{asset.name|swiftIdentifier:"pretty"|lowerFirstWord|escapeReservedKeywords}} = {{colorType}}(name: "{{asset.value}}") {{sp}} {% elif asset.type == "image" %} {{sp}} static let {{asset.name|swiftIdentifier:"pretty"|lowerFirstWord|escapeReservedKeywords}} = {{imageType}}(name: "{{asset.value}}") {{sp}} {% elif asset.items %} {{sp}} enum {{asset.name|swiftIdentifier:"pretty"|escapeReservedKeywords}} { {{sp}} {% set sp2 %}{{sp}} {% endset %} {{sp}} {% call casesBlock asset.items sp2 %} {{sp}} } {{sp}} {% endif %} {{sp}} {% endfor %} {% endmacro %} {% macro allValuesBlock assets filter prefix sp %} {{sp}} {% for asset in assets %} {{sp}} {% if asset.type == filter %} {{sp}} {{prefix}}{{asset.name|swiftIdentifier:"pretty"|lowerFirstWord|escapeReservedKeywords}}, {{sp}} {% elif asset.items %} {{sp}} {% set prefix2 %}{{prefix}}{{asset.name|swiftIdentifier:"pretty"|escapeReservedKeywords}}.{% endset %} {{sp}} {% call allValuesBlock asset.items filter prefix2 sp %} {{sp}} {% endif %} {{sp}} {% endfor %} {% endmacro %} enum {{enumName}} { {% if catalogs.count > 1 %} {% for catalog in catalogs %} enum {{catalog.name|swiftIdentifier:"pretty"|escapeReservedKeywords}} { {% call enumBlock catalog.assets " " %} } {% endfor %} {% else %} {% call enumBlock catalogs.first.assets "" %} {% endif %} } extension {{imageAlias}} { convenience init!(asset: {{imageType}}) { let bundle = Bundle(for: BundleToken.self) self.init(named: asset.name, in: bundle, compatibleWith: nil) } } private final class BundleToken {} {% else %} // No assets found {% endif %}
2.建立RunScript
-
在
Xcode中，進入到項目的Target，選擇Build Phases,然后點擊左上角的+號后點擊New Run Script Phase
在新建的RunScript里添加如下內容：if which "$PROJECT_DIR"/SwiftGen5/bin/swiftgen >/dev/null; then set -e "$PROJECT_DIR"/SwiftGen5/bin/swiftgen xcassets -t my-swift4 "$PROJECT_DIR/swiftGenExample/Assets.xcassets" --output "$PROJECT_DIR/swiftGenExample/ImageCode/ImageAsset.swift" else echo "##run echo warning: SwiftGen not installed, download it from https://github.com/SwiftGen/SwiftGen" fi這段
Run Script作用就是利用 SwiftGen 生成代碼后寫入到ImageAsset.swift文件中。 Build 一下project，我們就可以在
/swiftGenExample/ImageCode/目錄下看到ImageAsset.swift，此時該文件還沒有被項目索引，所以把它拖進項目Xcode對應的目錄下就行了，之后即使我們添加了新的圖片或者刪掉舊的圖片，只要每次Build一下項目，代碼就會自動更新了。
下面是生成的 ImageAsset.swift 的代碼：
// ImageAsset.swift
// Generated using SwiftGen, using my-templete created by Hanson
import UIKit.UIImage
typealias Image = UIImage
@available(*, deprecated, renamed: "ImageAsset")
typealias AssetType = ImageAsset
struct ImageAsset {
fileprivate var name: String
var image: Image {
let bundle = Bundle(for: BundleToken.self)
let image = Image(named: name, in: bundle, compatibleWith: nil)
guard let result = image else { fatalError("Unable to load image named \(name).") }
return result
}
}
enum Asset {
static let arrowBlue = ImageAsset(name: "arrow_blue")
static let arrowBrown = ImageAsset(name: "arrow_brown")
static let iconLeftBack = ImageAsset(name: "icon_left_back")
static let startLogo = ImageAsset(name: "start_logo")
}
extension Image {
convenience init!(asset: ImageAsset) {
let bundle = Bundle(for: BundleToken.self)
self.init(named: asset.name, in: bundle, compatibleWith: nil)
}
}
private final class BundleToken {}
結語
這里只是利用了 SwiftGen 對于 Image 的部分。它還有其它的關于 String ，StroyBoard，Font等等的代碼生成。原理基本相同，靠大家按需研究啦。
到我的博客閱讀：myhanson.com
本文Demo：SwiftGenExample
Contact
我的微博：漢森hs
我的Github: zyphs21
我的博客： myhanson.com
我的公眾號：HansonTalk
