一直未间断SDK的工作,总是在做到现在从未总结,现在总结一下,备录一下,供大家参考和借鉴。
一、什么是库?
共享代码便是库,实现代码的复用,一般分为静态库和动态库。
二、静态库和动态库的区别?
静态库:链接时完整的拷贝到可执行文件,多次使用多次拷贝,造成冗余,使包变的更大。
动态库:链接时不复制,程序运行时由系统加在到内存中,供系统调用,系统加在一次,多次使用,共用节省内存。
三、iOS的静态库?
.a和.framework 样式
四、iOS的动态库?
.dylib和.framework
五、为什么framework既是静态又是动态?
系统的framework是动态的,我们自己创建的是静态的。
六、.a 和 .framework 的区别是什么?
.a 是单纯的二进制文件,.framework是二进制问价+资源文件。
其中.a 不能直接使用,需要 .h文件配合,而.framework则可以直接使用。
.framework = .a + .h + sorrceFile(资源文件)
七、为什么使用静态库?
共享代码,方便使用。
实现代码的模块化,固定的业务模块话,减少开发的重复劳动。
和别人分享代码,但又不想让别人知道代码的具体实现。
八、实现静态库的注意事项:
1 、注意理解:无论是.a静态库还.framework静态库,我们需要的都是二进制文件+.h+资源文件,不同的是,.a本身只是二进制文件,需要配上.h和资源文件才能使用,而.framework本身已经包含了二进制文件、.h和资源文件,可以直接使用。
2 、图片资源的处理:两种静态库,一般都是把图片文件单独的放在一个.bundle文件中,一般.bundle的名字和.a或.framework的名字相同。新建一个文件夹,把它改名为.bundle,右键->显示包内容,之后就可以向其中添加资源文件。
3 、把category打成静态库,但是在使用静态库的工程中,调用category中的方法时会有找不到该方法的运行时错误(selector not recognized),解决办法是:在使用静态库的工程中配置other linker flags的值为-ObjC。
4 如果一个静态库很复杂,需要暴露的.h比较多的话,就可以在静态库的内部创建一个.h文件(一般这个.h文件的名字和静态库的名字相同),然后把所有需要暴露出来的.h文件都集中放在这个.h文件中,而那些原本需要暴露的.h都不需要再暴露了,只需要把.h暴露出来就可以了。
封装framework
1、打开xcode,新建工程
2、创建功能类
3、实现功能类
.h文件
.m文件
4、Xcode项目配置
将framework设置成静态库
5、设置header,将需要暴露的头文件放在public下面,隐藏在project或者private下面无法被引用。
然后需要在mySDk.h(必须是公开的,否则无法引用)中将你所有要公开的.h引入。
修改下面:如果是YES,说明当前活跃的版本是8,如果只编译此机型,就设置成YES,适配所有的架构Architecture 设置为No。
打包
手动打包
1、选中模拟器,command+B
2、选中真机,command+B
3、在finder中找到framework文件
会发现,真机和模拟器的包
4、通过终端命令将两个framework合为一个模拟器和真机都可使用的framework。
打开终端,输入lipo -create命令,将
Debug-iphoneos下mySdk.framework目录下的mySDk.framework文件
拖拽到终端中,会自动有空格。然后将Debug-iphonesimulator下mySDk.framework目录下的mySDk.framework文件
拖拽进来,也会自动有空格,然后输入 -output,敲空格,在引入一个新的路径。最后敲回车,这样就合并了。
将生成的文件拖回上面的一个mySDk.framework的文件夹中,就生成我们最终的framework。
5、使用
将framework拖入新的项目
将framework添加到
假如还是不可以,设置framework和.h的搜索路径
第二种方法
1、创建.a 静态库
2、.h文件
.m文件
3.添加脚本生成
set -e
if [ ${DEPLOYMENT_LOCATION} == "YES" ]; then
echo "Deploying, exit"
exit 0
fi
export FRAMEWORK_LOCN="${BUILT_PRODUCTS_DIR}/${PRODUCT_NAME}.framework"
rm -rf ${FRAMEWORK_LOCN}
# Create the path to the real Headers die
mkdir -p "${FRAMEWORK_LOCN}/Versions/A/Headers"
# Create the required symlinks
/bin/ln -sfh A "${FRAMEWORK_LOCN}/Versions/Current"
/bin/ln -sfh Versions/Current/Headers "${FRAMEWORK_LOCN}/Headers"
/bin/ln -sfh "Versions/Current/${PRODUCT_NAME}" \
"${FRAMEWORK_LOCN}/${PRODUCT_NAME}"
echo "taget built dir=${TARGET_BUILD_DIR},public headers path=${PUBLIC_HEADERS_FOLDER_PATH}"
# Copy the public headers into the framework
/bin/cp -a "${TARGET_BUILD_DIR}/${PUBLIC_HEADERS_FOLDER_PATH}/" \
"${FRAMEWORK_LOCN}/Versions/A/Headers"
echo "Framework built successfully"
4、xcode 配置
1、选中TARGETS下的工程,点击上方的Editor,选择Add Target创建一个Aggregate.
2、嵌入脚本。选中刚刚创建的Aggregate,然后选中右侧的Build Phases,点击左下方加号,选择New Run Script Phase
3、脚本是:
set -e
# If we're already inside this script then die
if [ -n "$RW_MULTIPLATFORM_BUILD_IN_PROGRESS" ]; then
exit 0
fi
export RW_MULTIPLATFORM_BUILD_IN_PROGRESS=1
RW_FRAMEWORK_NAME=${PROJECT_NAME}
RW_INPUT_STATIC_LIB="lib${PROJECT_NAME}.a"
RW_FRAMEWORK_LOCATION="${BUILT_PRODUCTS_DIR}/${RW_FRAMEWORK_NAME}.framework"
#RW_BUNDLE_NAME="VKSdkResources"
function build_static_library {
# Will rebuild the static library as specified
# build_static_library sdk
xcrun xcodebuild -project "${PROJECT_FILE_PATH}" \
-target "${TARGET_NAME}" \
-configuration "${CONFIGURATION}" \
-sdk "${1}" \
ONLY_ACTIVE_ARCH=NO \
BUILD_DIR="${BUILD_DIR}" \
OBJROOT="${OBJROOT}" \
BUILD_ROOT="${BUILD_ROOT}" \
SYMROOT="${SYMROOT}" $ACTION
}
function make_fat_library {
# Will smash 2 static libs together
# make_fat_library in1 in2 out
#xcrun
lipo -create "${1}" "${2}" -output "${3}"
}
# 1 - Extract the platform (iphoneos/iphonesimulator) from the SDK name
if [[ "$SDK_NAME" =~ ([A-Za-z]+) ]]; then
RW_SDK_PLATFORM=${BASH_REMATCH[1]}
else
echo "Could not find platform name from SDK_NAME: $SDK_NAME"
exit 1
fi
# 2 - Extract the version from the SDK
if [[ "$SDK_NAME" =~ ([0-9]+.*$) ]]; then
RW_SDK_VERSION=${BASH_REMATCH[1]}
else
echo "Could not find sdk version from SDK_NAME: $SDK_NAME"
exit 1
fi
# 3 - Determine the other platform
if [ "$RW_SDK_PLATFORM" == "iphoneos" ]; then
RW_OTHER_PLATFORM=iphonesimulator
else
RW_OTHER_PLATFORM=iphoneos
fi
# 4 - Find the build directory
if [[ "$BUILT_PRODUCTS_DIR" =~ (.*)$RW_SDK_PLATFORM$ ]]; then
RW_OTHER_BUILT_PRODUCTS_DIR="${BASH_REMATCH[1]}${RW_OTHER_PLATFORM}"
else
echo "Could not find other platform build directory."
exit 1
fi
# Build the other platform.
build_static_library "${RW_OTHER_PLATFORM}${RW_SDK_VERSION}"
# If we're currently building for iphonesimulator, then need to rebuild
# to ensure that we get both i386 and x86_64
if [ "$RW_SDK_PLATFORM" == "iphonesimulator" ]; then
build_static_library "${SDK_NAME}"
fi
# Join the 2 static libs into 1 and push into the .framework
make_fat_library "${BUILT_PRODUCTS_DIR}/${RW_INPUT_STATIC_LIB}" \
"${RW_OTHER_BUILT_PRODUCTS_DIR}/${RW_INPUT_STATIC_LIB}" \
"${RW_FRAMEWORK_LOCATION}/Versions/A/${RW_FRAMEWORK_NAME}"
# Ensure that the framework is present in both platform's build directories
cp -a "${RW_FRAMEWORK_LOCATION}/Versions/A/${RW_FRAMEWORK_NAME}" \
"${RW_OTHER_BUILT_PRODUCTS_DIR}/${RW_FRAMEWORK_NAME}.framework/Versions/A/${RW_FRAMEWORK_NAME}"
# Copy the framework to the user's desktop
ditto "${RW_FRAMEWORK_LOCATION}" "${SRCROOT}/${RW_FRAMEWORK_NAME}.framework"
open ${SRCROOT}
4、运行
将会生成framework在本文件中,并会自动打开文件夹
5、测试
运行之前需要查看framework是否已经拖入
总结:
1、.h文件的一定要包含自己想要暴露的。
2、开始打包的时候,一定要在选中模拟器和选中真机上边分别编译一次,选用的我第二的方法,可以直接运行framework。
3、调用的时候分清楚是类方法还是实例方法。
4、在制作framework或者lib的时候,如果使用了category,则使用改FMWK的程序运行时会crash,此时需要在该工程中 other linker flags添加两个参数 -ObjC -all_load。(这点没有亲测)
5、带有资源文件的需要把图片打包成Bundle文件,和framework一起拷贝到相应的项目中。
6、公开的类中如果引用的private的类,打包以后对外会报错,找不到那个private的类,可以把那个private的.h放到(也没亲测)
7、namespace 冲突。静态库用了某第三方库,项目也用了同样的第三方库,在编译的时候就会有 duplicate symbol 错误,因为有两份同样的第三方库。解决办法就是把用到的第三方库加上自定义前缀,包括类名、delegate 协议、常量名,尤其需要注意 Category 的方法名要修改。
8、封装静态库的时候应尽量避免引入重量级第三方库。
9、一个静态库要有自己独有的前缀,所有类名、常量等都要加同样的前缀。
10、真机+模拟器支持。Xcode 默认只会用当前环境(真机或模拟器)生成静态库,这样的 SDK 不方便其他项目开发时调试。解决办法就是通过脚本生成一份通用库,build_universal_library.sh,via SO.
11、图片等资源文件用 bundle 方式打包。一个简单制作 bundle 的方法:新建文件夹,重命名为 YourSDK.bundle,然后 Show Package Contents 打开,加入图片。使用图片的时候需要指明 bundle: [UIImage imageNamed:@"YourSDK.bundle/img.png"]。也可以用 Target 方式制作 bundle,比如 iOS Library With Resourceshttp://www.galloway.me.uk/tutorials/ios-library-with-resources/.
12、如果 SDK 有用到 Category**,注意项目设置 Other Linker Flags 添加 -ObjC。(后边介绍了-ObjC的作用)
注意:
编译过程:
从C代码到可执行文件经历的步骤是:源代码 > 预处理器 > 编译器 > 汇编器 > 机器码 > 链接器 > 可执行文件
在最后一步需要把.o文件和C语言运行库链接起来,这时候需要用到ld命令。源文件经过一系列处理以后,会生成对应的.obj文件,然后一个项目必然会有许多.obj文件,并且这些文件之间会有各种各样的联系,例如函数调用。链接器做的事就是把这些目标文件和所用的一些库链接在一起形成一个完整的可执行文件。Other linker flags设置的值实际上就是ld命令执行时后面所加的参数
下面逐个介绍3个常用参数:
-ObjC:加了这个参数后,链接器就会把静态库中所有的Objective-C类和分类都加载到最后的可执行文件中
-all_load:会让链接器把所有找到的目标文件都加载到可执行文件中,但是千万不要随便使用这个参数!假如你使用了不止一个静态库文件,然后又使用了这个参数,那么你很有可能会遇到ld: duplicate symbol错误,因为不同的库文件里面可能会有相同的目标文件,所以建议在遇到-ObjC失效的情况下使用-force_load参数。
-force_load:所做的事情跟-all_load其实是一样的,但是-force_load需要指定要进行全部加载的库文件的路径,这样的话,你就只是完全加载了一个库文件,不影响其余库文件的按需加载。
demo :mySDK
demo :myTool
希望大家批评指正。
持续更新:
1、关于使用static library的这部分,我们创建的不管是动态库还是静态库在工程中的呈现都是静态的,因为系统不允许我们使用动态的库,我们为了减少不必要的麻烦直接选择静态的,假如我记得没有错,你选择动态的在提交之后应该会被拒。
2、关于上面的使用公共的第三方库,例如AFNetWorking、SDWebImage等这个第三方库的问题,我在上面写到过,我们可以将所有的名字、协议修改,但是工作量有点巨大,而且容易出错,那我们就可以将这些公用的库放在外面,打成SDK之后让别人引用sdk的时候去引入这些第三方框架,这是可以的,我已经做过实践了。