關於 Pod 庫的資源引用 resource_bundles or resources

1. 資源文件引用的方式

在第一節，先來介紹一下 CocoaPods 兩種資源文件引用的方式——resource_bundles & resources

1.1 resource_bundles

resource_bundles 容許定義當前 Pod 庫的資源包的名稱和文件。用 hash 的形式來聲明，key 是 bundle 的名稱，value 是須要包括的文件的通配 patterns。

We strongly recommend library developers to adopt resource bundles as there can be name collisions using the resources attribute.

CocoaPods 官方強烈推薦使用 resource_bundles，由於用 key-value 能夠避免相同名稱資源的名稱衝突。

同時建議 bundle 的名稱至少應該包括 Pod 庫的名稱，能夠儘可能減小同名衝突

Examples:

spec.ios.resource_bundle = { 'MapBox' => 'MapView/Map/Resources/*.png' }
複製代碼

spec.resource_bundles = {
    'MapBox' => ['MapView/Map/Resources/*.png'],
    'OtherResources' => ['MapView/Map/OtherResources/*.png']
  }
複製代碼

1.2 resources

使用 resources 來指定資源，被指定的資源只會簡單的被 copy 到目標工程中（主工程）。

We strongly recommend library developers to adopt resource bundles as there can be name collisions using the resources attribute. Moreover, resources specified with this attribute are copied directly to the client target and therefore they are not optimised by Xcode.

官方認爲用 resources 是沒法避免同名資源文件的衝突的，同時，Xcode 也不會對這些資源作優化。

Examples:

spec.resource = 'Resources/HockeySDK.bundle'
複製代碼

spec.resources = ['Images/*.png', 'Sounds/*']
複製代碼

FYI： Podspec Syntax Reference v1.4.0

2. 圖片資源的管理

咱們熟知日常用的 @2x @3x 圖片是爲了縮小用戶最終下載時包的大小，一般咱們會將圖片放在 .xcassets 文件中管理，新建的項目也默認建立：

使用 .xcassets 不只能夠方便在 Xcode 查看和拖入圖片，同時 .xcassets 最終會打包生成爲 Assets.car 文件。對於 Assets.car 文件，App Slicing 會爲切割留下符合目標設備分辨率的圖片，能夠縮小用戶最終下載的包的大小。

FYI： Xcode Ref Asset Catalog Format App thinning overview (iOS, tvOS, watchOS)

實際上，對於 Pods 庫的資源，一樣可使用 .xcassets 管理。

3. 實際驗證

不關注的能夠直接跳到下面『結論』

官文中推薦了 resource_bundles 其理由主要是『能夠解決同名衝突』和『Xcode爲 bundle 提供的一些優化』。

我知道不少人看過 這篇 文章，裏面提到 resource_bundles 不能使用 .xcassets。

那麼究竟是不是這樣，咱們須要親自動手驗證，看看兩種引用方式，CocoaPods 到底爲咱們作了什麼。

咱們將在『實際驗證』一節驗證：

1. resource_bundles 是否能使用 *.xcassets 指定資源並正確打包
2. 同名衝突是怎樣的

3.1 resource_bundles 是否能使用 *.xcassets 指定資源並正確打包

寫兩個 Demo Pod，同時建立好對應的 Example 測試工程。

對兩個 Pod 分別使用不一樣的方式指定資源。

第一個 Demo Pod：

第二個 Demo Pod：

分別用了 resource_bundles 和 resources 兩種方式引用。

pod install 後，觀察結果。

3.1.1 使用 resources

pod install 並編譯 Example 工程後，咱們能夠打開最後生成的 Product 文件下的內容：

能夠看到只有 一些 .a 文件，.a 文件是二進制文件。初次以外只有 SubModule-Example.app，打開包內容，能夠看到只有一個 Assets.car。

這說明，使用 resources 以後只會簡單的將資源文件 copy 到目標工程（Example 工程），最後和目標工程的圖片文件以及其餘一樣使用 resources 的 Pod 的圖片文件，統一一塊兒打包爲了一個 Assets.car。

再爲 Pod 寫一個 VC 來實驗讀取圖片：

讀取圖片的方式和日常使用的方式不一樣，要先獲取 Bundle：

UIImage *image = [UIImage imageNamed:@"some-image"
                                inBundle:[NSBundle bundleForClass:[self class]]
           compatibleWithTraitCollection:nil];
複製代碼

在 Example 的 ViewController 寫一下跳轉 SubModule/SMViewController：

運行以後，看一下，能正常訪問圖片：

3.1.2 使用 resource_bundles

pod install 並編譯 Example 工程後，一樣找到 Product 文件下的內容：

能夠看到最終生成了一個 SubModule_Use_Bundle.bundle，打開看內部：

發現包含了一個 Assets.car

再爲 Pod 寫一個 VC 來實驗讀取圖片：

因爲還須要帶上 .bundle 文件的路徑，獲取的方式又不一樣：

NSString *bundlePath = [[NSBundle bundleForClass:[self class]].resourcePath
                            stringByAppendingPathComponent:@"/SubModule_Use_Bundle.bundle"];
NSBundle *resource_bundle = [NSBundle bundleWithPath:bundlePath];
UIImage *image = [UIImage imageNamed:@"some-image"
                                inBundle:resource_bundle
           compatibleWithTraitCollection:nil];
複製代碼

在 Example 的 ViewController 寫一下跳轉 SubModule/SMViewController：

運行以後，看一下，也能正常訪問圖片：

3.1.3 resources 和 resource_bundles 對於 .xcassets 的支持

從 3.1 和 3.2 能夠看出 resources 和 resource_bundles 均可以很好的支持 .xcassets 的引用。

因此，這篇 文章，裏面提到 resource_bundles 不能使用 .xcassets 並不存在。應該說這篇文章已經比較老了，CocoaPods 隨着不斷的更新，resource_bundles 已經能夠很好的支持 .xcassets 了。

3.2 同名資源的衝突問題

從上面的分析能夠看出：

使用 resources 以後只會簡單的將資源文件 copy 到目標工程（Example 工程），最後和目標工程的圖片文件以及其餘一樣使用 resources 的 Pod 的圖片文件，統一一塊兒打包爲了一個 Assets.car。

使用 resource_bundles 以後會爲爲指定的資源打一個 .bundle，.bundle包含一個 Assets.car，獲取圖片的時候要嚴格指定 .bundle 的位置，很好的隔離了各個庫或者一個庫下的資源包。

顯然，使用 resources，若是出現同名的圖片，顯然是會出現衝突的，一樣使用 some-image 名稱的兩個圖片資源，不必定能正確調用到。

3.2.1 簡單驗證 resources 重名問題

給 Example 文件添加一個一樣叫 some-image 的圖片：

OK，如今的狀況是 Example 工程本身有一個 some-image 圖片資源，SubModule 這個 Pod 庫也有一個 some-image 圖片資源。

仍是以前的顯示圖片的代碼，再運行一下：

能夠看到，圖片顯然是用錯了，顯示了 Example 工程本身的 some-image

這就是 resources 的重名資源問題。

而使用 resource_bundles 則能夠很好的避開這個問題。

4. 總結

resource_bundles 優勢：

1. 可使用 .xcassets 指定資源文件
2. 能夠避免每一個庫和主工程之間的同名資源衝突

resource_bundles 缺點：

1. 獲取圖片時可能須要使用硬編碼的形式來獲取：[[NSBundle bundleForClass:[self class]].resourcePath stringByAppendingPathComponent:@"/SubModule_Use_Bundle.bundle"]

resources 優勢：

1. 可使用 .xcassets 指定資源文件

resources 缺點：

1. 會致使每一個庫和主工程之間的同名資源衝突
2. 不須要用硬編碼方式獲取圖片：[NSBundle bundleForClass:[self class]] compatibleWithTraitCollection:nil];

So，通常來講使用 resource_bundles 會更好，不過關於硬編碼，還能夠再找找別的方式去避免。

5. Demo

本文全部的 Demo 代碼都在 這裏

---

有什麼問題均可以在博文後面留言，或者微博上私信我，或者郵件我 coderfish@163.com。

博主是 iOS 妹子一枚。

但願你們一塊兒進步。

個人微博：小魚周凌宇