【iOS】静态库(.framework)制作

最近公司有个业务需求是封装一个即时通讯SDK，需要用到环信静态SDK和一些图片资源。研究很久终于封装成功了，下面分享一下我的经验，如果我的理解有错误欢迎指出。

一、库介绍

• 什么是库？
  库是共享程序代码的方式，本质上来说是一种可执行代码的二进制格式，可以被载入内存中执行。一般分为静态库和动态库。

• 静态库：
  1、平时我们用的第三方SDK基本上都是静态库。
  2、静态库在项目编译时完整地拷贝至可执行文件中，被多次使用就有多份冗余拷贝。
  3、静态库很大的一个优点是减少耦合性，因为静态库中是不可以包含其他静态库的，使用的时候要另外导入它的依赖库，最大限度的保证了每一个静态库都是独立的，不会重复引用。
  4、静态库有.a 和 .framework两种形式。

• 动态库：
  1、iOS平时使用的系统库基本是动态库，比如使用频率最高的UIKit.framework和Fundation.framework。
  2、动态库在程序运行时由系统动态加载到内存，供程序调用，系统只加载一次，多个程序共用，节省内存。
  3、动态库在制作的时候可以直接包含静态库，也能自动link所需要的依赖库。
  4、动态库有.dylib/.tbd 、.framework两种形式。
  5、苹果禁止iOS开发中使用动态库

• .a与.framework有什么区别？
  1、.a是一个纯二进制文件，.a文件不能直接使用，至少要有.h文件配合，.framework文件可以直接使用。
  2、.a + .h + sourceFile = .framework。
  3、自己封装静态SDK建议用.framework

二、 Framework（静态库）的制作

动态库与静态库的制作流程基本一样唯一不同的是Mach-O文件的编译形式。

1、创建工程

选择 “Cocoa Touch Framework”

新建Framework工程

2、选择Mach-O的编译方式

这步很重要，这一步决定我们制作出来的是静态库还是动态库，默认选择的是Dynamic Library，要手动选择Static Library

Mach-O Type

3、导入需要的第三方静态库和待封装的代码

正常导入要打包的文件就可以了
⚠️注意：导入第三方静态库的时候不要选择添加到target中

导入需要的第三方静态库

如果你用到的第三方库需要依赖其他系统库的话，需要在导入第三方静态库之后再link依赖的系统库

link依赖系统库

所有文件导入完成后：

所有文件导入结果g

4、选择暴露的头文件

将需要暴露出来的头文件拖到public里

暴露头文件

然后需要在MyIMSDK.h（MyIMSDK.h必须放在Public里）中将你所有要公开的.h引入。

5、编译生成静态库

• 设置 Build Active Architecture Only

  
  设置 Build Active Architecture Only
  

  设置为NO的时候，会编译支持的所有的版本
  设置为YES的时候，是为Debug的时候速度更快，它只编译当前的architecture 版本

• 选中模拟器，编译程序
  编译出来的framework只能在模拟器上运行。

• 选中测试机，编译程序
  编译出来的framework只能在真机上运行。

• 在finder中找到framework文件

  
  

⚠️注意：编译时可能会出现三方静态库文件找不到的情况：报"XXXX/XXXX.h file not found "错误，那是因为没有设置Framework Search Paths。
我项目中的三方在MyIMSDK目录下（点击+，将MyIMSDK目录拖进来就可以了）

设置Framework Search Paths

6、合并模拟器、真机模式下的framework

方法一：

1>分别找到模拟器和真机编译下的Framework里面的MyIMSDK

2> 通过终端命令将两个framework合为一个模拟器和真机都可使用的framework。
打开terminal ，输入：
lipo -create 模拟器下的MyIMSDK的路径 真机下的MyIMSDK的路径 -output 合并的新的MyIMSDK的路径
合并指令

合并完成后，将合并生成的MyIMSDK替换原来framework里面的MyIMSDK，现在的framework就可以同时给模拟器和真机使用了。

方法二：

1>点击导航栏上的Editor,选择Add Target创建一个Aggregate。

创建Aggregate

本项目中的Aggregate命名为MyIM。

2>选中刚刚创建的Aggregate,然后选中右侧的Build Phases,点击左下方加号，选择New Run Script Phase。

3> 嵌入脚本

#这个是声明生成的framework的名字，有些和工程名字一样，看你创建时候怎么写
#FMK_NAME是个变量
FMK_NAME=${PROJECT_NAME}
if [ "${ACTION}" = "build" ]
then
INSTALL_DIR=${SRCROOT}/Products/${FMK_NAME}.framework
DEVICE_DIR=${BUILD_ROOT}/${CONFIGURATION}-iphoneos/${FMK_NAME}.framework
SIMULATOR_DIR=${BUILD_ROOT}/${CONFIGURATION}-iphonesimulator/${FMK_NAME}.framework
if [ -d "${INSTALL_DIR}" ]
then
rm -rf "${INSTALL_DIR}"
fi
mkdir -p "${INSTALL_DIR}"
cp -R "${DEVICE_DIR}/" "${INSTALL_DIR}/"
#ditto "${DEVICE_DIR}/Headers" "${INSTALL_DIR}/Headers"
lipo -create "${DEVICE_DIR}/${FMK_NAME}" "${SIMULATOR_DIR}/${FMK_NAME}" -output "${INSTALL_DIR}/${FMK_NAME}"
#这个是合并完成后打开对应的文件夹，你就可以直接看到文件了
open "${SRCROOT}/Products"
fi

嵌入脚本

4>编译合并framework

合并

选中MyIM ，设备选 Generic iOS Device，点击运行，如果有跳到Finder说明编译成功。

合并成功，跳转到Finder

⚠️注意：需要模拟器和真机都编译生成framework后，再做此步操作

7、资源文件 .bundle

静态库中有使用到图片、音视频等资源文件，可以将这些文件打包成.bundle文件供静态库使用。

最简单的方法是，新建一个文件夹，将图片、音视频等资源拖到文件夹中，将文件夹后缀名改为.bundle.
静态库想要使用里面的资源的话需要先获取到该.bundle文件。

NSBundle *bundle = [NSBundle bundleWithPath: [[NSBundle mainBundle] pathForResource:@"BundleName" ofType: @"bundle"]];

静态库中使用.bundle文件里面的图片的方法是：

NSString *imageName = [[bundle resourcePath] stringByAppendingPathComponent:assetName];
[_imageView setImage:[UIImage imageWithContentsOfFile:imageName]];

⚠️注意：.bundle文件无法封装到framework里，需要将.framework，.bundle同时导入项目中才能正常使用

8、静态库的使用

1>将封装好的静态库、资源文件、用到的第三方静态库一同导入项目中.

导入静态库

2>将用到到三方静态库加入Embedded Binaries 中

Embedded Binaries

三方静态库加入Embedded Binaries的同时，会自动加入到下方的Linked Frameworks and Libraries，如果Linked Frameworks and Libraries有重复的库保留一个就可。

三、一些需要注意的点

• 在制作framework的时候，如果使用了category，则使用该framework的项目运行时会crash，此时需要在该工程中 other linker flags添加一个参数 -ObjC

  
  other linker flags

• 开始打包的时候，一定要在选中模拟器和选中真机上分别编译一次

• bundle文件无法封装到framework里，需要将.framework，.bundle同时导入项目中才能正常使用

• 在本次封装SDK过程中，Framework里用到的一些三方库，比如AFNetworking在项目中同样导入使用，并没有引起命名冲突，具体原因还不清楚。但是最好把用到的第三方库加上自定义前缀，包括类名、delegate 协议、常量名，Category分类。

顺便介绍下other linker flags里的三个参数：

－ObjC：加了这个参数后，链接器就会把静态库中所有的Objective-C类和分类都加载到最后的可执行文件中

－all_load：会让链接器把所有找到的目标文件都加载到可执行文件中，但是千万不要随便使用这个参数！假如你使用了不止一个静态库文件，然后又使用了这个参数，那么你很有可能会遇到ld: duplicate symbol错误，因为不同的库文件里面可能会有相同的目标文件，所以建议在遇到-ObjC失效的情况下使用-force_load参数。

-force_load：所做的事情跟-all_load其实是一样的，但是-force_load需要指定要进行全部加载的库文件的路径，这样的话，你就只是完全加载了一个库文件，不影响其余库文件的按需加载

后期有什么更深入的了解会进行修改
最后的最后，有不对的地方欢迎指出，我会及时改进。