需求：在SDK中使用資源文件,例如xib, image, 字符串國(guó)際化等等.
閱讀前提:
- 了解如何創(chuàng)建SDK
- 了解如何在一個(gè)項(xiàng)目中導(dǎo)入并使用SDK
GitHub地址(附代碼) : 如何在SDK中使用資源文件
簡(jiǎn)書(shū)地址 : 如何在SDK中使用資源文件
博客地址 : 如何在SDK中使用資源文件
掘金地址 : 如何在SDK中使用資源文件
原理
SDK中使用xib垛叨，圖片或者其他資源文件時(shí)不同于直接在一個(gè)項(xiàng)目中使用的方法肝箱，因?yàn)槲覀儽仨毭鞔_一點(diǎn)渴频，SDK中只有.h,.m,.mm,.swift等文件可以直接導(dǎo)入使用，像圖片荚坞，xib文件，做國(guó)際化的.string文件等資源文件無(wú)法直接通過(guò)加載Framework的路徑找到，我們必須要在項(xiàng)目Build Phases的Copy Bundle Resources添加我們需要使用的資源文件(nib, image, .string...)酬诀，因此，我們最好在SDK中新建一個(gè)Bundle文件存放所有的資源文件骆撇，然后在主工程中Copy Bundle Resources添加該bundle文件即可加載所有SDK中的資源文件.
創(chuàng)建Bundle
為了統(tǒng)一存放SDK中所有資源文件
注意：我們需要在每次編譯完成后手動(dòng)或?qū)懩_本自動(dòng)將資源文件拷貝到Bundle中以至于才能在主工程中生效瞒御。
此后我們?cè)赟DK項(xiàng)目所用到的所有資源文件都應(yīng)該放到Bundle之中。
情景分類
一.使用Xib文件
1. Build SDK工程
如果項(xiàng)目中包含xib文件神郊，則項(xiàng)目每次編譯后會(huì)在Framework中將自動(dòng)生成nib文件肴裙，如下圖所示
2.將新編譯好的Framework放入工程中
- 首先拷貝編譯好的framework到我們工程目錄中(即工程中進(jìn)入Framework,不會(huì)自行百度)
- 使用Nib文件分為兩種方式
- 直接將Nib文件導(dǎo)入主項(xiàng)目資源文件中
- (推薦)將Framework中編譯好的Nib文件放入Bundle中,再將Bundle導(dǎo)入項(xiàng)目的資源文件中，好處是可以統(tǒng)一管理一個(gè)Framework中所有的資源文件
如果只使用nib則如下圖涌乳，否則可按相同方式將bundle導(dǎo)入項(xiàng)目
3. 使用SDK中的xib文件
- 直接使用framework中的nib文件
NSString *path = [[NSBundle mainBundle] pathForResource:@"XDXTestFramework" ofType:@"framework"];
TestJumpVC *vc = [[TestJumpVC alloc] initWithNibName:@"TestJumpVC" bundle:[NSBundle bundleWithPath:path]];
[self presentViewController:vc animated:YES completion:nil];
- (推薦)使用framework中bundle中的nib文件蜻懦。
因?yàn)槲覀冊(cè)诘诙街幸呀?jīng)將bundle放入項(xiàng)目的copy bundle resources中，所以下面代碼中使用
[NSBundle mainBundle]
NSString *path = [[NSBundle mainBundle] pathForResource:@"XDXAllResources" ofType:@"bundle"];
TestJumpVC *vc = [[TestJumpVC alloc] initWithNibName:@"TestJumpVC" bundle:[NSBundle bundleWithPath:[path stringByAppendingString:@"/xibs"]]];
[self presentViewController:vc animated:YES completion:nil];
如果未進(jìn)行第2步中將nib文件導(dǎo)入項(xiàng)目則程序會(huì)crash,并提示“Terminating app due to uncaught exception 'NSInternalInconsistencyException', reason: 'Could not load NIB in bundle: 'NSBundle </var/containers/Bundle/Application/D46C1A83-E6F4-4DB2-8F02-EC0ED05C6C99/XDXSDKResourceFileDemo.app> (loaded)' with name 'TestJumpVC''”
二.使用圖片
1. 將圖片拷貝到Framework中創(chuàng)建好的bundle中
2. 使用圖片夕晓，加載bundle中圖片的路徑(Note:必須與真實(shí)路徑相同阻肩，可參考Demo)
// Test image
NSString *path = [[[NSBundle mainBundle] pathForResource:@"XDXAllResources" ofType:@"bundle"] stringByAppendingString:@"/images/1.png"];
self.testImage.image = [UIImage imageWithContentsOfFile:path];
三.使用國(guó)際化語(yǔ)言適配(中英文適配)
1.創(chuàng)建.string類型文件以支持中英文
2. 設(shè)置strings文件的Localize使其支持多種語(yǔ)言
3. 設(shè)置項(xiàng)目支持多種語(yǔ)音
4. 在多語(yǔ)言文件中添加對(duì)應(yīng)的字符
5. 創(chuàng)建NSBundle分類提供類方法以支持在SDK中使用多語(yǔ)言
原理同上，即在budle中找到對(duì)應(yīng)的中英文sting文件运授，然后利用- (NSString *)localizedStringForKey:(NSString *)key value:(nullable NSString *)value table:(nullable NSString *)tableName NS_FORMAT_ARGUMENT(1);方法來(lái)檢索bundle中對(duì)應(yīng)語(yǔ)言的字符串烤惊。
代碼中涉及APP手動(dòng)選擇中英文模式，而我們這里主要實(shí)現(xiàn)根據(jù)系統(tǒng)當(dāng)前設(shè)置的語(yǔ)言環(huán)境吁朦，所以忽略人為設(shè)置語(yǔ)言的情況
// Note : Be consistent with you create bundle‘s name.
#define XDXRouterResBundle @"XDXAllResources"
@implementation NSBundle (XDXLocalizable)
+ (instancetype)XDX_localizableBundleWithBundleName:(NSString *)bundleName {
static NSBundle *localizableBundle = nil;
if (localizableBundle == nil) {
if (!bundleName) {
bundleName = XDXRouterResBundle;
}
NSString *bundleType = nil;
if (bundleName && ![bundleName hasSuffix:@"bundle"]) {
bundleType = @"bundle";
}
NSString *bundlePath = [[NSBundle mainBundle] pathForResource:bundleName ofType:bundleType];
localizableBundle = [NSBundle bundleWithPath:bundlePath];
}
return localizableBundle;
}
+ (NSString *)XDX_localizedStringForKey:(NSString *)key {
return [self XDX_localizedStringForKey:key value:nil];
}
+ (NSString *)XDX_localizedStringForKey:(NSString *)key value:(NSString *)value{
NSBundle *bundle = nil;
//NSString *language = [self getLanguageFromSystem];
//NSString *language = [self getLanguageFromPlist];
NSString * language = [self getLanguageFromDevelopersSetup];
if (!language) {
language = [self getLanguageFromSystem];
NSLog(@"Current language is %@",language);
}
//從FrameworkTestBundle.bundle中查找資源
NSString *bundlePath = [[NSBundle XDX_localizableBundleWithBundleName:nil] pathForResource:language ofType:@"lproj"];
bundle = [NSBundle bundleWithPath:bundlePath];
value = [bundle localizedStringForKey:key value:value table:nil];
return [[NSBundle mainBundle] localizedStringForKey:key value:value table:nil];
}
//這個(gè)設(shè)置語(yǔ)言是通過(guò)讀取當(dāng)前系統(tǒng)使用語(yǔ)言
+ (NSString *)getLanguageFromSystem{
NSString *language = [NSLocale preferredLanguages].firstObject;
if ([language hasPrefix:@"en"]) {
language = @"en";
} else if ([language hasPrefix:@"zh"]) {
if ([language rangeOfString:@"Hans"].location != NSNotFound) {
language = @"zh-Hans"; // 簡(jiǎn)體中文
} else {
language = @"zh-Hant"; // 繁體中文
}
} else {
language = @"en";
}
return language;
}
//這個(gè)是設(shè)置語(yǔ)言通過(guò)Plist文件來(lái)讀取
+ (NSString *)getLanguageFromPlist{
NSString *bundlePath = [[NSBundle mainBundle] pathForResource:@"SDKInternationalizationDemoPlist.plist" ofType:nil];
if (!bundlePath) {
return nil;
}
NSDictionary *dict = [NSDictionary dictionaryWithContentsOfFile:bundlePath];
if (dict) {
NSInteger languageNum = [[dict valueForKey:@"language"] integerValue];
switch (languageNum) {
case 1:
return @"en"; //語(yǔ)言為英語(yǔ)：en
break;
case 2:
return @"zh-Hans";//語(yǔ)言為簡(jiǎn)中：zh-Hans
break;
case 3:
return @"zh-Hant";//語(yǔ)言為繁中：zh-Hanz
break;
default:
return @"en";
break;
}
}
return @"en";
}
//這個(gè)是設(shè)置語(yǔ)言通過(guò)開(kāi)發(fā)者手動(dòng)調(diào)用柒室，從NSUserDefaults里面去讀kDSADLanguageStyle這個(gè)字段是哪一種語(yǔ)言
+ (NSString *)getLanguageFromDevelopersSetup{
NSUserDefaults *userDefaults = [NSUserDefaults standardUserDefaults];
NSInteger languageStyle = [[userDefaults valueForKey:@"TODO"] integerValue];
if (!languageStyle) {
return nil;
}
switch (languageStyle) {
case 1:
return @"en";
break;
case 2:
return @"zh-Hans";
break;
case 3:
return @"zh-Hant";
break;
default:
return @"en";
break;
}
}
@end
6.在代碼中使用多語(yǔ)言字符串
self.testLabel.text = [NSBundle XDX_localizedStringForKey:@"Test"];
附：在Framework每次編譯后添加腳本來(lái)拷貝資源文件到Bundle中
原因
每當(dāng)資源文件有所改動(dòng)，例如圖片的增加減少逗宜，strings文件中添加新字段等等雄右，我們都需要手動(dòng)將新的文件放入Bundle對(duì)應(yīng)的文件夾下，如果我們想利用腳本自動(dòng)放所有資源文件纺讲，可利用Xcode特性擂仍。
操作
-
首先，在項(xiàng)目中新建一個(gè)腳本
10-createScript -
其次熬甚，在腳本中將我們項(xiàng)目的所有資源文件拷貝到bundle中對(duì)應(yīng)的目錄下(注意：文件路徑必須正確逢渔，如遇到Framework中的nib文件，項(xiàng)目的位置在個(gè)人電腦中是不用的乡括，需要查詢并修改)
11-writeScript -
最后肃廓，我們?cè)贐uild完項(xiàng)目后智厌，所有資源文件會(huì)更新到最新
12-getFile
