前言
移动端项目复杂到一定程度都会走上组件化的道路,组件一多就会出现联编缓慢的问题。对于Objectiv-C语言的项目,想要加速编译打包的速度,就需要将大量依赖的组件在打包的时候使用静态库依赖,以加快编译链接速度。
iOS项目进行组件化,一般会使用cocoapods包管理工具,二进制库在iOS项目中,指的是静态库与动态库,当组件提供静态库或动态库的时候,可以加速项目编译与构建,因为静态库与动态库本身就是已经编译好的库文件,从而能达到加速的目的。
同时在开发时,经常会需要多人协作开发,对于组件和一些不常改动的文件,使用静态库可以有效避免因为误改而产生bug的问题。
一、总体目标及方案选择
1 目标
通过对本文接下来的内容的学习,我们希望最终的目标主要有:
1. 将组件制作为静态库。
2. 通过cocoapods进行管理,实现源码和静态库的切换。
2 相关方案的对比和选择
2.1 静态库类型选择
静态库.framework
与.a
的区别:
.a
:只把代码文件打包编译成二进制。
.framework
:把代码文件及其他资源,如图片、音频等文件,一起打包成二进制。
选用何种二进制类型,可以根据实际的项目情况进行打包,在本文中,我们针对制作
.framework
进行介绍。
2.2 打包方式选择
静态库打包方式:
1.通过Xcode的打包方式,编译打包。
2.使用Aggregate打包。
3.使用脚本直接打包。
4.使用第三方打包工具打包,如cocoapods-packager
考虑到简单和易用,本文选用的是第二种Aggregate方式打包。
2.3 切换方案选择
源码和静态库切换方案:
1.在podspec
中使用if-else
条件去区分源码和静态库,但是在进行切换时,每次都需要pod cache clean
,切换麻烦,也比较耗时。
2.使用Carthage
和cocoapods
结合的方式,由cocoapods
管理源码,Carthage
管理静态库,学习成本较高。
3.使用subspec
实现源码和静态库的切换,subspec
主要是在cocoapods
中给私有库或第三方做目录分层使用,在podfile
中写入制定subspec
,可以只导入指定目录下的文件。
综合考虑下,本文选用第三种
subspec
的方式来实现切换,将源码和静态库一起做成私有库,分别放在两个subspec
下。
二、制作静态库
1 创建framework
1.1 将要制作为静态库的组件克隆到本地
本文内容是在已有私有库的基础上,针对私有库中的组件来制作静态库,所以下面将直接从制作静态库开始介绍。
在项目的根目录新建一个project或者在项目中新建一个target。
1.1 新建project
如果希望制作.a
文件,则选择Static Library
。
1.2 新建target
新建target和project选择其中一种方式即可。
2 设置framework
2.1 设置组件源码
将组件的代码文件引用到framework的target。
注意,这里不需要copy文件过去
2.2 其他设置
2.2.1 设置Build Settings
Architectures - 设置支持架构,这里
armv7、arm64(64位ARM处理器)
是真机架构,i386(32位模拟器)、x86_64(64位模拟器)
是模拟器架构。
iOS Deployment Target - 设置可支持的最低版本。
Dead Code Stripping - 是否从framework中删除未使用的代码
Link With Standard Libraries - 是否链接苹果标准库
Mach-O Type - 这里的类型我们要选择Static Library(静态)
Other Linker Flags(本文未使用) - 链接参数,如果使用了category
,最好加上Objc、all_load
Other C Flags(本文未使用) - 额外的C语言链接参数,如果需要支持bitcode
,需要加上-fembed -bitcode
Build Active Architecture Only - 是否只为当前架构编译,NO则编译所有架构
2.2.2 设置Build Phases
将要暴露的头文件移到public中
3 设置Aggregate
3.1 新建Aggregate
3.2 设置打包脚本
3.3 编写脚本内容
将以下内容复制进Run Script中,修改第三行中的
TARGET_NAME
改为自己创建的framework名字,这段脚本会自动合并真机和模拟器的二进制文件。
#!/bin/sh
#要build的target名
TARGET_NAME='TenUIKitFramework'
#${PROJECT_NAME}
if [[ $1 ]]
then
TARGET_NAME=$1
fi
UNIVERSAL_OUTPUT_FOLDER="${SRCROOT}/${PROJECT_NAME}_Products/"
#创建输出目录,并删除之前的framework文件
mkdir -p "${UNIVERSAL_OUTPUT_FOLDER}"
rm -rf "${UNIVERSAL_OUTPUT_FOLDER}/${TARGET_NAME}.framework"
#分别编译模拟器和真机的Framework
xcodebuild -target "${TARGET_NAME}" ONLY_ACTIVE_ARCH=NO -configuration ${CONFIGURATION} -sdk iphoneos BUILD_DIR="${BUILD_DIR}" BUILD_ROOT="${BUILD_ROOT}" clean build
xcodebuild -target "${TARGET_NAME}" ONLY_ACTIVE_ARCH=NO -configuration ${CONFIGURATION} -sdk iphonesimulator BUILD_DIR="${BUILD_DIR}" BUILD_ROOT="${BUILD_ROOT}" clean build
#拷贝framework到univer目录
cp -R "${BUILD_DIR}/${CONFIGURATION}-iphonesimulator/${TARGET_NAME}.framework" "${UNIVERSAL_OUTPUT_FOLDER}"
#合并framework,输出最终的framework到build目录
lipo -create -output "${UNIVERSAL_OUTPUT_FOLDER}/${TARGET_NAME}.framework/${TARGET_NAME}" "${BUILD_DIR}/${CONFIGURATION}-iphonesimulator/${TARGET_NAME}.framework/${TARGET_NAME}" "${BUILD_DIR}/${CONFIGURATION}-iphoneos/${TARGET_NAME}.framework/${TARGET_NAME}"
#删除编译之后生成的无关的配置文件
dir_path="${UNIVERSAL_OUTPUT_FOLDER}/${TARGET_NAME}.framework/"
for file in ls $dir_path
do
if [[ ${file} =~ ".xcconfig" ]]
then
rm -f "${dir_path}/${file}"
fi
done
#判断build文件夹是否存在,存在则删除
if [ -d "${SRCROOT}/build" ]
then
rm -rf "${SRCROOT}/build"
fi
rm -rf "${BUILD_DIR}/${CONFIGURATION}-iphonesimulator" "${BUILD_DIR}/${CONFIGURATION}-iphoneos"
#打开合并后的文件夹
open "${UNIVERSAL_OUTPUT_FOLDER}"
4 打包
以上内容设置完之后,就可以打包了,选择Aggregate进行编译,编译完成后会自动打开编译好的framework存储的文件夹。
5 静态库中使用cocoapods管理依赖的第三方
在之前建立的project中使用cocoapods导入第三方(pod init、修改Podfile、pod install),然后在要使用的地方导入头文件,在framework中编译一下,成功后则可以继续第4步的打包流程。
三、使用cocoapods管理
1 移动静态库到合适的位置
首先我们将刚才获得的静态库文件夹移动到根目录,或者也可以不移动,我是为了等会设置路径方便。
2 设置静态库与源码的切换
下面我们通过编写
podspec
文件来进行设置,其中source
代表源码,framework
代表静态库,pod导入时用于进行区分,默认使用framework。
Pod::Spec.new do |s|
s.name = 'TenUIKit'
s.version = '0.1.1'
s.summary = 'A short description of TenUIKit.'
s.description = <<-DESC
TODO: Add long description of the pod here.
DESC
s.homepage = '你的项目地址'
# s.screenshots = 'www.example.com/screenshots_1', 'www.example.com/screenshots_2'
s.license = { :type => 'MIT', :file => 'LICENSE' }
s.author = { 'Ten' => '账号' }
s.source = { :git => 'git地址', :tag => s.version.to_s }
# s.social_media_url = 'https://twitter.com/'
s.ios.deployment_target = '8.0'
s.default_subspec = 'framework'
s.subspec 'source' do |ss|
ss.source_files = 'TenUIKit/Classes/**/*'
end
s.subspec 'framework' do |ss|
ss.ios.vendored_framework = 'TenUIKit_Products/*.framework'
end
end
3 收尾
这之后就可以push代码到你的私有库,在项目中使用时,
podfile
中按如下写法
#使用默认framework
pod 'TenUIKit'
#使用源码
pod 'TenUIKit', :subspec => ['source']
四、资源文件bundle的制作
framework只能包含头文件和代码,而不能包含图片和
storyboard
等资源文件,这是就需要创建bundle来保存这些资源,以在其他工程中使用。
创建bundle文件有两种方式,通过xcode创建或者自己手动创建,下面我们将分别针对这两种方式来进行介绍。
1 通过xcode方式创建
1.1 创建target
首先在上文的工程中再添加一个target,选择
macOS
中的bundle
。
1.2 设置Build Settings
Base SDK - 默认是macOS用的,这里修改为iOS
Skip Install - 资源包是否需要安装,这里我们选择No不安装
Installation Directory - 安装路径,不需要安装所以这我们删除
1.3 设置Build Phases
将资源文件放进bundle中
1.4 使用bundle
将bundle文件添加到
framework
所在的工程后,在framework
中的Build Phases中添加bundle
1.5 项目中使用
使用时framework找到自己的bundle可以参考如下代码:
[NSBundle bundleWithPath:[[NSBundle bundleForClass:self.class] pathForResource:@"TenPremissionsBundle" ofType:@"bundle" inDirectory:@"TenPremissionsFramework.framework"]];
2 自己手动创建
这个方法也很简单,只需要创建一个新文件夹,重命名为"xxx.bundle",即可创建出一个bundle文件,右键显示包内容,即可向里面添加资源文件,使用的步骤与使用xcode创建出的bundle文件的使用方法一样。
3 framework与bundle的组合使用
3.1 项目中直接使用
上面讲述的使用方式中,我们将framework和bundle打包在一起,这样的好处主要是bundle随时和framework绑定,避免了遗漏的情况。但相应的也因为需要将framework拷贝到APP包中,增大了空间占用,完整的framework包也都暴露在APP包中。
所以更建议使用
framework
和bundle
分离的方式,bundle
文件不加入到framework
工程下,framework
中的Copy Bundle Resources
下也不要添加bundle
,分别将framework
和bundle
导入APP中,这样APP中的Copy Bundle Resources
只需要添加bundle
文件,而不需要添加framework
。
最后记得将在framework
中查找bundle
的代码改成如下示例:
[NSBundle bundleWithPath:[[NSBundle mainBundle] pathForResource:@"TenPermissionsBundle" ofType:@"bundle"]];
3.2 使用cocoapods管理
整体思路与上面相同,只需要将bundle
文件与framework
分开路径存储,一起push到组件库中。