iOS静态库和动态库读取图片资源

前言

在将私有组件打成二进制包的时候，我们可以选择打包成静态库或者动态库，静态库和动态库读取图片的方式也略有不同，同时在私有组件里面指定资源的方式也分两种，即resources和resource_bundles，下面做具体分析

resources和resource_bundles区别

1.resources
使用 resources 来指定资源，被指定的资源只会简单的被 copy 到目标工程中，如：

s.resources="#{root}/Assets/*.xcassets"

官方认为用 resources 是无法避免每个库和主工程之间的同名资源冲突，同时，Xcode 也不会对这些资源做优化。

2.resource_bundles
resource_bundles 允许定义当前 Pod 库的资源包的名称和文件。用 hash 的形式来声明，key 是 bundle 的名称，value 是需要包括的文件的通配 patterns。比如：

s.resource_bundles = {
   'OTSDebugPluginsModule' => ["#{root}/Assets/*.{xcassets,xib,storyboard}"]
}

CocoaPods 官方强烈推荐使用 resource_bundles，因为用 key-value 可以避免每个库和主工程之间的同名资源冲突

静态库

1.如果使用resourses指定资源：

s.resources="#{root}/Assets/*.xcassets"

读取图片可以直接从MainBundle读取：

self.staticIV.image = [UIImage imageNamed:@"appback.png"];

2.如果使用resource_bundles方式指定资源：

s.resource_bundles = {
   'OTSDebugPluginsModule' => ["#{root}/Assets/*.{xcassets,xib,storyboard}"]
}

读取图片就要从自己的bundle读取，也就是OTSDebugPluginsModule.bundle:

NSBundle *customBundle = [NSBundle bundleWithURL:[[[NSBundle bundleForClass:self.class] resourceURL] URLByAppendingPathComponent:@"OTSDebugPluginsModule.bundle"]];
self.staticIV.image = [UIImage imageNamed:@"appback.png" inBundle:customBundle compatibleWithTraitCollection:nil];

动态库

1.如果使用resourses指定资源：

s.resources="#{root}/Assets/*.xcassets"

图片需要到自己的frameWork里的bundle读取：

NSBundle *dynamicBundle = [NSBundle bundleForClass:[self class]];
self.dynamicIV.image = [UIImage imageNamed:@"appback.png" inBundle:dynamicBundle compatibleWithTraitCollection:nil];

2.如果使用resource_bundles方式指定资源：

s.resource_bundles = {
   'OTSDebugPluginsModule' => ["#{root}/Assets/*.{xcassets,xib,storyboard}"]
}

读取图片同样也需要到frameWork里的bundle读取，但是bundle名称是OTSDebugPluginsModule.bundle:

NSBundle *dynamicBundle = [NSBundle bundleWithURL:[[[NSBundle bundleForClass:self.class] resourceURL] URLByAppendingPathComponent:@"OTSDebugPluginsModule.bundle"]];
self.dynamicIV.image = [UIImage imageNamed:@"appback.png" inBundle:customBundle compatibleWithTraitCollection:nil];

后来试了一下不指定OTSDebugPluginsModule.bundle也行（注意：Xib和Storyboard不行，必须要指定OTSDebugPluginsModule.bundle）：

NSBundle *dynamicBundle = [NSBundle bundleForClass:[self class]];
self.dynamicIV.image = [UIImage imageNamed:@"appback.png" inBundle:customBundle compatibleWithTraitCollection:nil];

总结

静态库使用resources加载图片：

[UIImage imageNamed:@"appback.png"]

静态库使用resource_bundles加载图片：

NSBundle *customBundle = [NSBundle bundleWithURL:[[[NSBundle bundleForClass:self.class] resourceURL] URLByAppendingPathComponent:@"OTSDebugPluginsModule.bundle"]];
[UIImage imageNamed:@"appback.png" inBundle:customBundle compatibleWithTraitCollection:nil];

动态库加载图片：

[UIImage imageNamed:@"appback.png" inBundle: [NSBundle bundleForClass:[self class]] compatibleWithTraitCollection:nil];

更新

针对动态库和静态库通过resource_bundles获取资源，封装了一个分类UIImage+OTSAssets.h：

1.动态库获取资源

///动态库可根据 context class 获取当前资源所在的 bundle
+ (UIImage *)ots_imageNamed:(NSString *)name context:(id)context {
    NSBundle *currentBundle = [NSBundle bundleForClass:[context class]];
    UIImage *image = [UIImage imageNamed:name inBundle:currentBundle compatibleWithTraitCollection:nil];


    if (image.size.width > 0) {
        return image;
    } else {
        return [UIImage imageNamed:name];
    }
}

2.静态库获取资源
方案一：通过bundle获取

+ (UIImage *)ots_imageName:(NSString *)name bundle:(NSBundle *)bundle {
    if (bundle) {
        //静态库查资源文件 bundle
        UIImage *image = [UIImage imageNamed:name inBundle:bundle compatibleWithTraitCollection:nil];
        if (image.size.width > 0) {
            return image;
        }
    }
    return [UIImage imageNamed:name];
}

方案二：通过bundleName获取

///静态库根据 context class，找不到当前资源所在的 bundle，需传 bundleName
+ (UIImage *)ots_imageName:(NSString *)name context:(id)context bundleName:(NSString *)bundleName {
    NSBundle *bundle = [NSBundle bundleForClass:[context class]];
    NSURL *bundleURL = [[bundle resourceURL] URLByAppendingPathComponent:bundleName];
    NSBundle *resourceBundle = [NSBundle bundleWithURL:bundleURL];
    return [UIImage ots_imageName:name context:context bundle:resourceBundle];
}


+ (UIImage *)ots_imageName:(NSString *)name context:(id)context bundle:(NSBundle *)bundle {
    if (bundle) {
        //静态库查资源文件 bundle
        UIImage *staticImage = [UIImage imageNamed:name inBundle:bundle compatibleWithTraitCollection:nil];
        if (staticImage.size.width > 0) {
            return staticImage;
        }
    }
    
    //都没取到的情况，非常早期的部分图片在主工程里，去 main bundle 取一次试试看，没有就没有了
    return [UIImage imageNamed:name];
}

有了这个分类的话，在业务组件里面获取图片资源就很方便了，比如在登录模块OTSAccountModule:
声明：

.h声明:
#define OTS_ACCOUNT_MODULE_BUNDLE    @"OTSAccountModule"//bundle名
FOUNDATION_EXTERN NSBundle* _Nullable OTSAccountModuleBundle(void);

.m实现:
NSBundle *OTSAccountModuleBundle() {
    return [NSBundle bundleWithPath:[[NSBundle bundleForClass:OTSAccountModule.class] pathForResource:OTS_ACCOUNT_MODULE_BUNDLE ofType:@"bundle"]];
}

这样就可以全局使用了：

[self.jdSignButton setImage:[UIImage ots_imageName:@"LOGO_JD" bundle:OTSAccountModuleBundle()] forState:UIControlStateNormal];