在上一章节中,我们对SDK工程进行了一些配置,很多朋友已经开始着手进行开发了,同时也提出了一些问题并给出了纠正,非常感谢各位支持。本章中,我们将对资源文件以及三方库做一些配置,以便能更好的利用到我们的项目当中。开始之前,确保你已经打开了我们之前创建好的Workspace。
Bundle
在SDK开发中,有时候我们需要用到图片、xib等等一些资源文件,这时候需要通过bundle来进行管理。选中MySDK工程,然后File->New->Target,当然你也可以直接点击TARGETS底下的“+”来创建
找到macOS下的Bundle,新建并命名为MySDKResources。接下来切换到Bundle工程的Build Settings选项,这里我们需要修改几项配置。首先选择Base SDK,按下Delete键将其修改为iOS
然后配置编译后的输出路径Per-configuration Build Products Path,这里仍然设置在build目录
去掉Info.plist文件并删除配置,因为编译后plist文件同样会打包进bundle文件内
修改Product Name
将COMBINE_HIDPI_IMAGES设置为NO,默认配置下会被转为.tiff格式
将Versioning System设置为None,默认Xcode会通过agvtool生成对应的版本信息,并打包进bundle文件中,这会导致后续在SDK跟随使用的App提交到AppStore的时候报错。
好了,这时候我们选择MySDKResources来进行编译
编译成功后,去到你的build目录中查看
bundle文件顺利生成了,接下来我们还需要做一些配置以便能够在开发当中更好的使用bundle文件。在MySDK的Build Phases中将MySDKResources加入Target Dependencies
接下来我们加入图片进行测试
编译,到build目录中查看bundle文件(右键显示包内容),这时候我们的test.png已经顺利打包进了bundle文件中,是时候来使用它了。在SDK工程中创建View来加载图片,这里创建MySDKView类来测试
MySDKView.m
#import "MySDKView.h"
@interface MySDKView()
@property (strong, nonatomic) UIImageView *imageView;
@end
@implementation MySDKView
- (instancetype)initWithFrame:(CGRect)frame
{
self = [super initWithFrame:frame];
if (self) {
self.imageView = [[UIImageView alloc] initWithFrame:self.bounds];
self.imageView.autoresizingMask = UIViewAutoresizingFlexibleWidth | UIViewAutoresizingFlexibleHeight;
self.imageView.image = [UIImage imageNamed:@"MySDK.bundle/test.png"];
[self addSubview:self.imageView];
}
return self;
}
@end
别忘了把MySDKView加入Public Header和MySDK.h中
这时候在MySDKTests工程中创建View并显示
MySDKView *sdkView = [[MySDKView alloc] initWithFrame:CGRectMake(20, 20, 100, 100)];
[self.view addSubview:sdkView];
运行测试工程进行测试,这时候图片并没有显示出来,需要把build目录中的bundle文件导入到测试工程中,注意不要选择copy确保编译同步最新
OK,再次运行测试,图片正常展示了。到此Bundle已经完成了对bundle文件的配置。
使用第三方库
开发过程中,必然会想到去使用一些优秀的开源库,比如AFNetworking、SDWebImage等等,毕竟自己去开发一套代价会更大。那么问题来了,当你在把这些库加入到你的工程中后,打包发布给其它项目使用,而其它项目也使用了相同的库,那么就会编译出错,也就是"duplicate symbols”错误。要解决这个问题,方法有很多,但我选择给所有库加上前缀,这需要做一些配置。虽然这样会增加包的大小,也会延长编译时间,但给开发带来的便利以及稳定性来说不失为一个好的选择。
首先在我们的SDK目录中新建vendor文件夹
然后将我们需要用到的三方库加入进来,我们以AFNetworking为例
这里是通过手动下载源码的方式导入,当然如果你用Git可以用Submodule更新,或者新建一个空的工程用CocoaPods导入都会更加方便。回到我们的SDK工程,创建静态库Target并命名为MySDKVendor
接下来把Vendor中的AFNetworking加入进来,注意不要Copy,这里需要同时加入到MySDK和MySDKVendor中,这里我只是将Vender作为一个辅助Target,是为了生成后面需要用到的宏定义文件。
在scripts目录中创建脚本generate_namespace_header.sh
# This script is a modified version of this: https://github.com/jverkoey/nimbus/blob/master/scripts/generate_namespace_header
header=../vendor/MySDK+Namespace.h
prefix="MySDK"
echo "Generating $header from $CODESIGNING_FOLDER_PATH..."
echo "// Namespaced Header
#ifndef __NS_SYMBOL
// We need to have multiple levels of macros here so that __NAMESPACE_PREFIX_ is
// properly replaced by the time we concatenate the namespace prefix.
#define __NS_REWRITE(ns, symbol) ns ## _ ## symbol
#define __NS_BRIDGE(ns, symbol) __NS_REWRITE(ns, symbol)
#define __NS_SYMBOL(symbol) __NS_BRIDGE($prefix, symbol)
#endif
" > $header
# The following one-liner is a bit of a pain in the ass.
# Breakdown:
#
# nm $CODESIGNING_FOLDER_PATH -j
# Dump all of the symbols from the compiled library. This will include all UIKit
# and Foundation symbols as well.
#
# | grep "^_OBJC_CLASS_$_"
# Filter out the interfaces.
#
# | grep -v "\$_NS"
# Remove all Foundation classes.
#
# | grep -v "\$_UI"
# Remove all UIKit classes.
#
# | sed -e 's/_OBJC_CLASS_\$_\(.*\)/#ifndef \1\'$'\n''#define \1 __NS_SYMBOL(\1)\'$'\n''#endif/g'
# I use the syntax outlined here:
# http://stackoverflow.com/questions/6761796/bash-perl-or-sed-insert-on-new-line-after-found-phrase
# to create newlines so that we can write the following on separate lines:
#
# #ifndef ...
# #define ...
# #endif
#
echo "// Classes" >> $header
nm $CODESIGNING_FOLDER_PATH -j | sort | uniq | grep "^_OBJC_CLASS_\$_" | grep -v "\$_AGSGT" | grep -v "\$_MK" | grep -v "\$_CL" | grep -v "\$_NS" | grep -v "\$_UI" | sed -e 's/_OBJC_CLASS_\$_\(.*\)/#ifndef \1\'$'\n''#define \1 __NS_SYMBOL(\1)\'$'\n''#endif\'$'\n''/g' >> $header
echo "// Functions" >> $header
nm $CODESIGNING_FOLDER_PATH | sort | uniq | grep " T " | cut -d' ' -f3 | grep -v "\$_NS" | grep -v "\$_UI" | grep -v "llvm" | sed -e 's/_\(.*\)/#ifndef \1\'$'\n''#define \1 __NS_SYMBOL(\1)\'$'\n''#endif\'$'\n''/g' >> $header
echo "// Externs" >> $header
nm $CODESIGNING_FOLDER_PATH | sort | uniq | grep " D " | cut -d' ' -f3 | grep -v "\$_NS" | grep -v "\$_UI" | grep -v "llvm" | sed -e 's/_\(.*\)/#ifndef \1\'$'\n''#define \1 __NS_SYMBOL(\1)\'$'\n''#endif\'$'\n''/g' >> $header
nm $CODESIGNING_FOLDER_PATH | sort | uniq | grep " S " | cut -d' ' -f3 | grep -v "\$_NS" | grep -v ".eh" | grep -v "llvm" | grep -v "\$_UI" | grep -v "OBJC_" | sed -e 's/_\(.*\)/#ifndef \1\'$'\n''#define \1 __NS_SYMBOL(\1)\'$'\n''#endif\'$'\n''/g' >> $header
脚本来自nimbus,主要是生成一个头文件,通过宏定义替换的方式来实现对类名、方法、外部定义等等的修改,从而能够顺利的使用各种三方库。当然有可能你需要对改脚本做一些改变,有些库比较特殊,这取决于你的工程。是时候把脚本配置到Vendor中了
选择MySDKVendor进行编译,注意一定是选择模拟器编译,真机是不能正常生成的。可能真机并没有把符号表暴漏出来。
这时候可以在vendor文件夹中看到生成了MySDK+Namespace.h文件
把该文件加入进MySDK工程
在你所有需要使用三方库的地方都需要import该文件,为了方便,这里我们创建pch文件
然后在MySDK-Project.xcconfig中配置
GCC_PREFIX_HEADER = MySDK/MySDK-Prefix.pch
GCC_PRECOMPILE_PREFIX_HEADER = YES
最后写上测试代码
#import "MySDKTest.h"
#import "AFNetworking.h"
@implementation MySDKTest
+ (void)printTest {
NSLog(@"MySDK Test");
NSURLSessionConfiguration *configuration = [NSURLSessionConfiguration defaultSessionConfiguration];
AFURLSessionManager *manager = [[AFURLSessionManager alloc] initWithSessionConfiguration:configuration];
NSURL *URL = [NSURL URLWithString:@"https://www.baidu.com"];
NSURLRequest *request = [NSURLRequest requestWithURL:URL];
NSURLSessionDataTask *dataTask = [manager dataTaskWithRequest:request completionHandler:^(NSURLResponse *response, id responseObject, NSError *error) {
if (error) {
NSLog(@"Error: %@", error);
} else {
NSLog(@"%@ %@", response, responseObject);
}
}];
[dataTask resume];
}
@end
编译运行,这时候Namespace文件也许会报错
稍作修改
再次运行测试工程,将输出正确结果。到此完成了第三方库的导入。下一章继续讨论发布以及相关文档的输出。
有很多问题没有及时回复,欢迎加群讨论557165621