iOS SDK 封装和开发实战SDK制作SDK开发

iOS-SDK开发经验分享

2017-07-12  本文已影响574人  Yochi
本文目标：掌握封装SDK的全部技巧及跳坑指南

本文目标：掌握封装及开发SDK的全部技巧

文章比较长，建议分模块阅读

内容提要：不同场景下如何封装及开发SDK

  • .a静态库创建

知识准备

真机和模拟器上的库文件合并 
Framework库合并的是Framework内包含的二进制文件，合并后替换库中的文件，没有.a后缀
lipo -create xxx.a(真机) xxx.a(模拟器) -output 新名字.a
查看SDK支持的架构
lipo -info XXX.a  输出： i386 armv7 x86_64 arm64

arm7: 在最老的支持iOS7的设备上使用
arm7s: 在iPhone5和5C上使用
arm64: 运行于iPhone5S的64位 ARM 处理器 上
i386: 32位模拟器上使用
x86_64: 64为模拟器上使用
注意: 高位兼容地位(32位兼容16位)，arm7版本可以在arm7s上运行
需要在对应架构设备上运行，才能生成对应架构的包

category是项目开发中经常用到的，把category打包成静态库是没有问题的，但是在使用这个静态库时，
调用category中的方法时会发生找不到该方法的运行时错误（selector not recognized），
解决的办法是在使用静态库的工程中配置other linker flags的值为 -ObjC -all_load

.a和.framework两种静态库，通常都是把需要用的到图片或者xib文件存放在一个bundle文件中，而该bundle文件的名字和.a或.framework的名字相同。
.a文件中无法存放图片或xib文件，很容易理解，但是.framework从本质上说也是一个bundle文件，为什么不把图片或者xib文件直接放在.framework中而单独再创建个bundle文件呢？
那是因为iOS系统不会去扫描.framework下的图片等资源文件，也不会在项目中显示，也就是说即使放在 .framework目录下，系统根本就不会去扫描，因此也无法发现使用

Debug和Release，在我看来主要是针对其面向的目标不同的而进行区分的。
Debug通常称为调试版本，通过一系列编译选项的配合，编译的结果通常包含调试信息，而且不做任何优化，以为开发人员提供强大的应用程序调试能力。
Release通常称为发布版本，是为用户使用的，一般客户不允许在发布版本上进行调试。所以不保存调试信息，同时，它往往进行了各种优化，以期达到代码最小和速度最优。为用户的使用提供便利

开发指南

网上找了一个动画工程，作为我们开刀的对象
下载原始工程
如果你有耐性，可以和我一起走完整个流程。当然每个模块都是独立的，你可以进行针对性的阅读

一、.a静态库创建

创建静态库工程 libLoader(名字你高兴就好) 删除自动创建的.m文件，清空头文件里的信息 导入你要封装的系统库文件 添加头文件选项 设置私有和暴露头文件 设置私有和暴露头文件 选择sdk支持的系统版本 Dead Code Stripping设置为NO Strip Debug Symbol During Copy 全部设置为NO Strip Style设置为Non-Global Symbols Base SDK >> Latest iOS（iOS 选择最新的) 切换编译模式 分别查看.a库文件 
使用终端进行合并
cd 文件保存目录
lipo -create 模拟器.a(路径) 真机.a(路径) -output 重命名.a
查看架构模式
lipo -info XXX.a  查看是否满足运行要求
静态库完成

二、直接创建Framework库

<p id="jump"></p>

Framework是资源的集合，将静态库和其头文件包含到一个结构中，让Xcode可以方便地把它纳入到你的项目中。本质也是一个bundle文件

      点击目标工程 >> 选择你创建的Framework >> 点击工程设置 >> 做出如下修改

      Build Settings >> Dead Code Stripping >> 设置为NO

      Build Settings >> Strip Debug Symbol During Copy >> 全部设置为NO

      Build Settings >> Strip Style >> 设置为Non-Global Symbols

      Build Settings >> Base SDK >> Latest iOS（iOS 选择最新的)

      Build Settings >>  Link With Standard Libraries >> 设置为 NO

      Build Settings >>  Mach-O Type >> Static Library

      对于Mach-O Type有两种情况:（1）选择 Static Library 打出来的是静态库;（2）选择 Relocatable Object File 打出来是动态库。
其他参数修改类似 
cd 到保存文件目录下
lipo -create xxx/Debug-iphoneos/LibLoaderFramework.framework/LibLoaderFramework xxx/Debug-iphonesimulator/LibLoaderFramework.framework/LibLoaderFramework -output LibLoaderFramework
lipo -info LibLoaderFramework
输出
Architectures in the fat file: LibLoaderFramework are: i386 arm64 
然后替换二进制文件
image.png 
 参数配置基本都一样
点击目标工程 >> 选择你创建的Framework >> 点击工程设置 >> 做出如下修改
  Build Settings >> Dead Code Stripping >> 设置为NO
  Build Settings >> Strip Debug Symbol During Copy >> 全部设置为NO
  Build Settings >> Strip Style >> 设置为Non-Global Symbols
  Build Settings >> Base SDK >> Latest iOS（iOS 选择最新的)
  Build Settings >>  Link With Standard Libraries >> 设置为 NO
  Build Settings >>  Mach-O Type >> Static Library
  对于Mach-O Type有两种情况:（1）选择 Static Library 打出来的是静态库;（2）选择 Relocatable Object File 打出来是动态库。

-  选择Debug(或Release)模式分别在模拟器和真机上 command + B 编译

- 合并真机和模拟器下编译的二进制文件

cd到你想要保存合并后文件的目录下
lipo -create xxx.framework/xxx ooo.framework/ooo -output ooo。
查看文件支持的架构
lipo -info LibLoaderFramework
将合并成功的二进制文件替换为framework中的二进制文件，如果没有用到info.plist文件，可以删除，避免在工程中发生冲突

如果工程无法联想出Framework头文件，导入路径形式如下：
#import <LibLoaderFramework/PublicHeader.h>

三、创建Bundle资源库文件

因为你正在创建一个在iOS上使用的bundle，这与默认的OS X不同。
 Build Settings >> Base SDK >> Latest iOS (iOS 10.2选择最新)
 Build Settings >> Product Name >> ${TARGET_NAME}替换为你的工程名XXXX(直接写工程名就好)
################注意事项######################
默认情况下，有两种resolutions(分辨率)的图片可以产生一些有趣的现象。
例如，当你导入一个retina@2x版本的图片时，普通版的和Retina版的将会合并成一个多resolution的TIFF（标签图像文件格式，Tagged Image File Format）。
Build Settings > COMBINE_HIDPI_IMAGES设置为NO

    NSBundle *bundle = [NSBundle bundleWithURL:[[NSBundle mainBundle] URLForResource:@"LoaderBundle" withExtension:@"bundle"]];
    NSString *resourceStr = [bundle pathForResource:@"IMG_0017" ofType:@"JPG"];
    我们可以创建NSBundle分类避免重复书写

四、含界面SDK如何进行依赖开发

在无法看到真实效果的情况下为iOS开发一个UI控件库是极其困难的,所以我们需要掌握依赖开发的知识

如果工程无法联想出Framework头文件，导入路径形式如下：
#import <LibLoaderFramework/PublicHeader.h>

像这样使用嵌套工程的好处是你可以对库本身做出修改，而不用离开示例工程，即使你同时改变两个地方的代码也一样。每次你编译工程，你都要检查是否将头文件的public/project关系设置正确。如果实例工程中缺失了任何需要的头文件，它都不能被编译。

五、使用脚本创建Framework库

#set –e确保脚本的任何地方执行失败，则整个脚本都执行失败。
set -e

#导出framework路径
export FRAMEWORK_LOCN="${BUILT_PRODUCTS_DIR}/${PRODUCT_NAME}.framework"

# 创建当前版本真实头文件夹
mkdir -p "${FRAMEWORK_LOCN}/Versions/A/Headers"

# 创建引用路径
/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}"

# 拷贝公共头文件到framework中
/bin/cp -a "${TARGET_BUILD_DIR}/${PUBLIC_HEADERS_FOLDER_PATH}/" \ 
"${FRAMEWORK_LOCN}/Versions/A/Headers"

#######################简化目录也可用使用如下脚本#######################

#set –e确保脚本的任何地方执行失败，则整个脚本都执行失败。
set -e

#导出的文件路径
export FRAMEWORK_LOCN="${BUILT_PRODUCTS_DIR}/${PRODUCT_NAME}.framework"

# 创建真是文件路径
mkdir -p "${FRAMEWORK_LOCN}/Headers"

# 拷贝公共头文件到framework中
/bin/cp -a "${TARGET_BUILD_DIR}/${PUBLIC_HEADERS_FOLDER_PATH}/" \
"${FRAMEWORK_LOCN}/Headers"

这个脚本做了如下三个操作：
1.创建了libLoader.framework/Versions/A/Headers目录
2.创建了一个framework所需要的三个连接符号（[symbolic links](http://en.wikipedia.org/wiki/Symbolic_link)）

当前版本文件夹
Versions/Current => A
头文件夹
Headers => Versions/Current/Headers
二进制文件
libLoader => Versions/Current/libLoader

3.将公共头文件从你之前定义的公共头文件路径拷贝到Versions/A/Headers目录下，-a参数确保修饰次数作为拷贝的一部分不会改变，防止不必要的重新编译。
构建成功后的Framework目录 
 arm7: 在最老的支持iOS7的设备上使用
 arm7s: 在iPhone5和5C上使用 
 arm64: 运行于iPhone5S的64位 ARM 处理器 上
 i386: 32位模拟器上使用
 x86_64: 64为模拟器上使用

每个CPU架构都需要不同的二进制数据，当你编译一个应用时，无论你目前正在使用那种架构，Xcode都会正确地依照对应的架构编译。例如，如果你想跑在虚拟机上，Xcode只会编译i386版本（或者是64位机的x86_64版本）。
这意味着编译会尽可能快地进行，当你归档一款app或者构建app的发布版本（release mode）时，Xcode会构建上述三个用于真机的ARM架构。因此这样app就可以跑在所有设备上了。不过，其他的编译架构又如何呢？让我们一起往下走

为什么使用集合（Aggregate）目标来创建一个framework呢？为什么这么不直接？因为OS X对库的支持更好一些，事实上，Xcode直接为每一个OS X工程提供一个Cocoa Framework编译目标。基于此，你将使用集合编译目标，作为Bash脚本的连接串来创建神奇的framework目录结构。
你是不是开始觉得这个方法有些懵逼了？

    #set –e确保脚本的任何地方执行失败，则整个脚本都执行失败。
    set -e

    #标示 如果已经插入脚本 退出
    if [ -n "$IYQ_MULTIPLATFORM_BUILD_IN_PROGRESS" ]; then
    exit 0
    fi
    export IYQ_MULTIPLATFORM_BUILD_IN_PROGRESS=1

    # 自定义变量
    IYQ_FRAMEWORK_NAME=${PROJECT_NAME}
    IYQ_INPUT_STATIC_LIB="lib${PROJECT_NAME}.a"
    IYQ_FRAMEWORK_LOCATION="${BUILT_PRODUCTS_DIR}/${IYQ_FRAMEWORK_NAME}.framework"

    #构建静态库 传参 "${1}"
    function build_static_library {
    # 重新构建库
        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 {

        xcrun lipo -create "${1}" "${2}" -output "${3}"
    }

    # 1 正则判断 真机还是模拟器 (iphoneos/iphonesimulator)
    if [[ "$SDK_NAME" =~ ([A-Za-z]+) ]]; then
    IYQ_SDK_PLATFORM=${BASH_REMATCH[1]}
    else
    echo "Could not find platform name from SDK_NAME: $SDK_NAME"
    exit 1
    fi

    # 2 SDK版本
    if [[ "$SDK_NAME" =~ ([0-9]+.*$) ]]; then
    IYQ_SDK_VERSION=${BASH_REMATCH[1]}
    else
    echo "Could not find sdk version from SDK_NAME: $SDK_NAME"
    exit 1
    fi

    # 3 其他平台判断 如果 则 否则
    if [ "$IYQ_SDK_PLATFORM" == "iphoneos" ]; then
    IYQ_OTHER_PLATFORM=iphonesimulator
    else
    IYQ_OTHER_PLATFORM=iphoneos
    fi

    # 4 其他平台路径
    if [[ "$BUILT_PRODUCTS_DIR" =~ (.*)$IYQ_SDK_PLATFORM$ ]]; then
    IYQ_OTHER_BUILT_PRODUCTS_DIR="${BASH_REMATCH[1]}${IYQ_OTHER_PLATFORM}"
    else
    echo "Could not find other platform build directory."
    exit 1
    fi

    #调用上面构建函数 如果当前运行的是真机则构建模拟器
    build_static_library "${IYQ_OTHER_PLATFORM}${IYQ_SDK_VERSION}"

    # 如果你现在正在为模拟器编译，那么Xcode会默认只在该系统对应的结构下编译，例如i386 或 x86_64。为了在这两个结构下都进行编译，这里调用了build_static_library，基于iphonesimulator SDK重新编译，确保这两个结构都进行了编译。
    if [ "$RW_SDK_PLATFORM" == "iphonesimulator" ]; then
    build_static_library "${SDK_NAME}"
    fi

    # 合并库
    make_fat_library "${BUILT_PRODUCTS_DIR}/${IYQ_INPUT_STATIC_LIB}" \
    "${IYQ_OTHER_BUILT_PRODUCTS_DIR}/${IYQ_INPUT_STATIC_LIB}" \
    "${IYQ_FRAMEWORK_LOCATION}/${IYQ_FRAMEWORK_NAME}"

    # 确保文件存在 相当于-dpR,保持文件的连接(d),保持原文件的属性(p)并作递归处理(R)
    cp -a "${IYQ_FRAMEWORK_LOCATION}/${IYQ_FRAMEWORK_NAME}" \
    "${IYQ_OTHER_BUILT_PRODUCTS_DIR}/${IYQ_FRAMEWORK_NAME}.framework/${IYQ_FRAMEWORK_NAME}"

    # 拷贝到指定目录下
    ditto "${IYQ_FRAMEWORK_LOCATION}" "${SRCROOT}/BuildFramework/${IYQ_FRAMEWORK_NAME}.framework"

  # 拷贝bundle到指定目录下
  ditto "${BUILT_PRODUCTS_DIR}/${IYQ_FRAMEWORK_NAME}.bundle" \
  "${SRCROOT}/BuildFramework/${IYQ_FRAMEWORK_NAME}.bundle"

六、swift 工程如何创建Framework库

终端命令
cd 到Products目录
真机和模拟器上的库文件合并 
lipo -create xx/aa.framework/aa oo/aa.framework/aa -output aa
查看SDK支持的架构
lipo -info LibLoaderFramework
上一篇下一篇

猜你喜欢

热点阅读