去年为公司开发了自己的SDK供外部客户使用,一直没来得及写个总结,最近时间稍微宽松点,写两篇文章总结一下iOS中Framework制作的流程。本文不会介绍iOS中静态库、动态库的基础知识,只是图文详解iOS中Framework的制作。(开发工具为Xcode14.0)
Framework牛刀小试
1、新建一个iOS Project(Static Library制作大同小异,不在本文讨论范围内),随意取个中意的名字LMBaseKit。
如果上面不是选择iOS系统,而是macOS或者其它的系统,可在Xcode中【Targets】->【Build Settings】->【Base SDK】中切换为iOS系统,如下图所示。
修改Mach-O Type为Static Library(静态库)
2、导入或者新建几个类文件,公开需要给外部调用的头文件。
如上图所示在Xcode中【Targets】->【Build Phases】->【Headers】下Project中选择需要公开的头文件拖入到Public下面。比如此处简单写了三个类LMBaseKitManager、LMNetworkManager、LMLogManager,把前两个公开了。修改头文件权限类型还有一个方法,如下图所示。
3、把Public中的头文件导入到项目头文件里(项目同名的头文件,系统自动生成)
4、创建Aggregate Target,如下图所示。Aggregate,翻译过来就是聚合的意思,在这里我们可以理解为模拟器和真机的聚合,即生成的Framework可供模拟器跟真机都可使用,而不用分别打模拟器和真机的独立包。
选中上图生成的LMBaseKitAggregate,为其添加依赖。
点击Target Dependencies下方的“+”,选中最开始创建的Framework对应的Target,点击“add”即可。
5、修改Target的Scheme
分别把两个Target的Run模式的Build Configuration改为Release。
6、创建打包脚本。选中聚合Target,点击左上角的“+”,选中New Run Script Phase。
在Run Script中添加如下脚本。脚本的作用是将模拟器包和真机包合并成一个聚合包,并将聚合包放在项目根目录下的Products文件夹中。
if [ "${ACTION}" = "build" ]
then
INSTALL_DIR=${SRCROOT}/Products/${PROJECT_NAME}.framework
DEVICE_DIR=${BUILD_ROOT}/${CONFIGURATION}-iphoneos/${PROJECT_NAME}.framework
SIMULATOR_DIR=${BUILD_ROOT}/${CONFIGURATION}-iphonesimulator/${PROJECT_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}/${PROJECT_NAME}" "${SIMULATOR_DIR}/${PROJECT_NAME}" -output "${INSTALL_DIR}/${PROJECT_NAME}"
#open "${DEVICE_DIR}"
open "${SRCROOT}/Products"
fi
7、生成Framework。先选择Framework对应的Target分别在模拟器跟真机上都run一遍。这里分别选择了iPhone 14跟Any iOS Device(也可选择自己的真机)。
然后选中聚合Target也运行一遍,就生成了Framework啦,并在Finder中打开了。
8、检查Framework有效性。打开电脑终端,进入到所在目录。利用lipo命令输出.framework下的LMBaseKit文件信息。如下所示:lipo -info LMBaseKit,显示为fat file,则表明是模拟器和真机的聚合包。fat file,顾名思义,胖文件。相应的,非聚合包就是瘦文件,则输出Non-fat file: LMBaseKit is architecture: arm64之类的
9、使用Framework。创建一个测试项目LMBaseKitDemo,把上面生成的LMBaseKit.framework导入项目中,在AppDelegate导入framework的头文件。在模拟器跟真机上分别运行,都可达到预期效果。至此,一个完整的Framework算是制作完成。
简单开启一下SDK的日志功能。
Framework外部依赖第三方库
自定义Framework有时可能需要借助其它优秀的第三方库。自己的Framework使用第三方库分两种情况:外部依赖、内部依赖。通常我们建议那些最常用的第三库使用外部依赖,比如AFNetworking、高德地图SDK等。接下来,以外部依赖高德SDK为例,说明一下自定义Framework时如何引入第三库。
1、在上面的LMBaseKit项目中导入高德地图SDK,注意要取消勾选Add to targets,这是最关键的一步
2、添加上面未加入Target的两个库的路径。如下图所示,注意如果是.a文件形式的第三方库则要加在Library Search Paths里。
3、Framework内部导入第三方库需要用到的相应头文件。然后按照普通Framework的制作流程弄完导出就可以用了。
4、外部使用Framework。除了导入我们自定义的Framework(这里为LMBaseKit.framework)外;还要导入要依赖的第三方库以及第三库所需要的系统库,比如这里的高德SDK,像平时使用高德SDK一样正常接入。
按需设置一些操作,比如此处第三库高德SDK,需在【Targets】->【Build Settings】->【Other Link Flags】中添加-ObjC。
最后在测试项目中调用自定义Framework中高德定位相关的接口,得到预期结果。
Framework内部依赖第三方库
自定义Framework时内部依赖第三方库比较简单,不是本文的重点,实际开发中很少这样操作。此处以自定义Framework内嵌AFNetworking为例说明一下如何处理。在自定义Framework工程中导入需要的第三方库的同时勾选上对应的Target就行。
然后在Framework工程中正常使用导入的第三库即可,此处用AFNetworking写了个get请求供外部使用。
正常导出自定义Framework后就可以直接使用了,而不需要额外再接入要依赖的第三库。如下所示,直接导入LMBaseKit.framework就可,而不用导入AFNetworking了。
下载好了神仙姐姐酷照~
最后附上代码地址,仅供参考。