这是我参与8月更文挑战的第11天,活动详情查看:8月更文挑战
在制作 iOS 的第三方库时,有时需要携带图片资源或者多语言文件。当把制作好的第三方库移交出去之后,用户可以通过 CocoaPods
、Swift Package Manager
,Carthage
等方式来引用库,也可能把源文件和资源文件直接放到主工程当中。
在多种情况下,我们应该如何管理这些资源文件,才能正确的读取到资源文件呢?
资源文件的 Bundle
首先,我们应该将资源文件放到一个专门的 Bundle 中,方便统一管理和读取。
当制作的库支持 CocoaPods
时,可以在 库名.podspec
文件中,通过 resource_bundles
来指定 Bundle 的名称和对应的资源路径:
s.resource_bundles = {
'库名' => [
'资源文件的路径1',
'资源文件的路径2',
'资源文件的路径3',
]
}
复制代码
资源文件的路径可有几种情况:
- 文件路径,指定特定的文件;
- 目录,指定包含在该目录下的所有文件;
- 包含通配符
*
,来指定某一类的文件,比如路径/*.json
表示指定路径下的所有 json 文件,路径/**/*.m
,表示该目录及其子目录下的所有.m
文件;
制作支持
Carthage
和Swift Package Manager
的库时,可以分别搜索一下设置资源文件的 Bundle 名称的方法。
资源文件 Bundle 的路径
在用户使用第三方库时,根据使用的方式不同,第三方库的资源文件的 Bundle 所处的位置也不同:
- 当被直接链接到应用程序时,第三方库资源文件的 Bundle 在
Bundle.main.resourceURL
目录下; - 当被通过 framework 使用时,第三方库资源文件的 Bundle 在第三方库的 Bundle 目录下;此时,需要通过第三方库中的某个类来获取该库对应的 Bundle,即
Bundle(for: BundleToken.self)
; - 当被用在命令行工具时,第三方库的资源文件的 Bundle 在
Bundle.main.bundleURL
下。
接下来,通过资源文件的 Bundle 所在的路径和名称,就可以得出完整的资源文件 Bundle 的路径 URL,然后通过 URL 初始化资源文件的 Bundle。
SwiftMessages 中的做法
在阅读 SwiftMessages 源码时,看到下面代码,处理了获取资源文件的所有情况。我们在制作第三方库时,也可以直接使用。
import Foundation
private class BundleToken {}
extension Bundle {
// This is copied method from SPM generated Bundle.module for CocoaPods support
static func sm_frameworkBundle() -> Bundle {
let candidates = [
// Bundle should be present here when the package is linked into an App.
Bundle.main.resourceURL,
// Bundle should be present here when the package is linked into a framework.
Bundle(for: BundleToken.self).resourceURL,
// For command-line tools.
Bundle.main.bundleURL,
]
let bundleNames = [
// For Swift Package Manager
"SwiftMessages_SwiftMessages",
// For Carthage
"SwiftMessages",
]
for bundleName in bundleNames {
for candidate in candidates {
let bundlePath = candidate?.appendingPathComponent(bundleName + ".bundle")
if let bundle = bundlePath.flatMap(Bundle.init(url:)) {
return bundle
}
}
}
// Return whatever bundle this code is in as a last resort.
return Bundle(for: BundleToken.self)
}
}
复制代码
加载图片时,就可以使用:
UIImage(named: rawValue, in: Bundle.sm_frameworkBundle(), compatibleWith: nil)
复制代码
© 版权声明
文章版权归作者所有,未经允许请勿转载。
THE END