Xcode10制作 framework详细步骤及坑说明

在开发中,我们经常使用使用封装的库进行开发,比如微信、微博分享等sdk,很容易实现我们的登录分享功能。

一、什么是库?

库是源代码经过编译,形成的二进制代码,别人项目中使用我们的库的时候,库在参与编译的时候,直接链接,按照链接的方式,可以把库分为静态库和动态库。

二、静态库与动态库的区别

静态库:链接时完整地拷贝至可执行文件中,被多次使用就有多份冗余拷贝。
动态库:链接时不复制,程序运行时由系统动态加载到内存,供程序调用,系统只加载一次,多个程序共用,节省内存。(苹果不允许用户使用自己制作的动态库)

三、库的表现形式

静态库: .a. 与.framework
动态库: .dylib.framework,如UIKit.framework.

四、静态库和动态库的区别

.a是一个纯二进制文件,.framework是一个文件夹,除了可执行文件外,还有资源文件。

.framework内部文件

注意.a文件不能直接使用,至少需要.h文件配合,而.framework可以直接使用。

五、静态库的制作

NOTE:苹果只允许用户创建自己静态库

1.打开Xcode,创建framework。


2.指定项目发布系统信息。



3.创建你需要的文件。把你需要的头文件公开。



注意项目中使用的资源文件,需要单独创建一个文件夹如source.bundle中,访问的时候,
//因为后面会把资源放到source.bundle里
//[UIImage imageNamed:@"dog.png"],就算图片在Assets.xcassets里,图片名要带后缀例如".png",因为要把Assets.xcassets里的图片都移到bundle里。
[UIImage imageNamed:@"source.bundle/dog.png"] 
// [[NSBundle mainBundle] loadNibNamed:@"LYFShowView" owner:self options:nil].firstObject 错误的访问方式
 [[NSBundle mainBundle] loadNibNamed:@"source.bundle/myNibView" owner:self options:nil].firstObject

4.配置库。如输出方式。以及架构方式。

指定debug和release都创建对应的架构

支持的架构如上图vaild Architecture 配置。

配置输出类型为静态库

注意:Dead Code Stripping 以及 Link With Standard Libaries 默认yes,可以不配置为NO
5.生成库。
1>手动生成
2>脚本生成。

下面分别说明2种方式:

1>手动生成
1.配置对应的运行环境,默认Debug.


配置对应的运行环境

模拟器编译生成对应的framework,然后依次真机编译生成对应的framework。选中Products 目录下的framework,show in finder,如下图。



然后打开终端,使用命令 lipo -create 模拟器文件 真机二进制文件 -output /xxx/test
lipo -create /Users/iOS/Library/Developer/Xcode/DerivedData/18.11.13-testFramework-asdmjgqiyqnbpwcvmrfohdcnxzlm/Build/Products/Debug-iphoneos/D_18_11_13_testFramework.framework/D_18_11_13_testFramework 
/Users/iOS/Library/Developer/Xcode/DerivedData/18.11.13-testFramework-asdmjgqiyqnbpwcvmrfohdcnxzlm/Build/Products/Debug-iphonesimulator/D_18_11_13_testFramework.framework/D_18_11_13_testFramework 
-output /Users/iOS/Desktop/D_18_11_13_testFramework

合成对应的包含模拟器和真机的文件。然后将该文件拖拽到真机或者模拟器的framework中替换对应的二进制文件即可。
可以通过lipo -info xxx查看对应的文件架构。

//终端输入指令,可以看出我们成功合成了。
lipo -info /Users/iOS/Desktop/D_18_11_13_testFramework 
Architectures in the fat file: /Users/zhaobin/Desktop/D_18_11_13_testFramework are: armv7 i386 x86_64 arm64 

2>脚本生成。



创建新的Targets Aggregate,然后再添加新的脚本。


选择New Run Script phase

关于此次脚本问题,Xcode 9之前的脚本已经不能使用。那是因为生成脚本的时候是在项目文件目录进行操作, xcodebulid clean 指令删除了当前的编译文件。
FMK_NAME=${PROJECT_NAME}
INSTALL_DIR=${SRCROOT}/Products/${FMK_NAME}.framework
WRK_DIR=build

DEVICE_DIR=${WRK_DIR}/Release-iphoneos/${FMK_NAME}.framework
SIMULATOR_DIR=${WRK_DIR}/Release-iphonesimulator/${FMK_NAME}.framework

xcodebuild -configuration "Release" -target "${FMK_NAME}" -sdk iphoneos clean build
#Xcode10此次clean会把当前目录删除然后,重新编译生成新的(即上一步真机生成)。
xcodebuild -configuration "Release" -target "${FMK_NAME}" -sdk iphonesimulator clean build

if [ -d "${INSTALL_DIR}" ]
then
rm -rf "${INSTALL_DIR}"
fi
mkdir -p "${INSTALL_DIR}"
cp -R "${DEVICE_DIR}/" "${INSTALL_DIR}/"

lipo -create "${DEVICE_DIR}/${FMK_NAME}" "${SIMULATOR_DIR}/${FMK_NAME}" -output "${INSTALL_DIR}/${FMK_NAME}"
rm -r "${WRK_DIR}"
open "${SRCROOT}/Products/"

简单的方法,使用脚本就是将xcodebuild -configuration "Release" -target "${FMK_NAME}" -sdk iphonesimulator clean build中的clean去掉。
保证模拟器和真机生成的文件都存在。
NOTE:此种方式不保证一定可以合成,建议用最新的

还有一种新的脚本,本质就是直接到app的沙盒build目录去copy,然后生成新的文件,放到项目目录。

#!/bin/sh
#要build的target名(若一个工程有多个target,最好手动指定需要打包的目标,如TARGET_NAME="framework名")
TARGET_NAME=${PROJECT_NAME}
if [[ $1 ]]
then
TARGET_NAME=$1
fi
UNIVERSAL_OUTPUT_FOLDER="${SRCROOT}/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}"

感兴趣的朋友可以自己试试看~~~(简单注释掉rm指令即可,#开头)
shell参考文档

六、生成库中的注意点

1.制作framework,注意项目名称不能包含”.”。如test.dog 项目名,生成的库是test_dog.framework,导致脚本运行失败。(手动生成也是可以的,但遵循命名规则还是好的)
项目的名字也不要以数字开头,如”2018_11_13_testFramework”,生成018_11_13_testFramework.framework.导致生成失败。
2.路径缩写区分大小写,如(SRCROOT)表示当前根路径,不能表示(srcroot)
3.关于脚本的报错。如打开一个目录不存在,或者copy一个文件不存在,会报错.

cp: build/Release-iphoneos/D_18_11_13_testFramework.framework——/: No such file or directory
fatal error: lipo: can't open input file: build/Release-iphonesimulator/D_18_11_13_testFramework.framework/D_18_11_13_testFramework (No such file or directory)
The file /Products does not exist.
Command PhaseScriptExecution failed with a nonzero exit code

到了这万事ok(关于如何用就不多说了)。。

推荐阅读更多精彩内容