iOS- SDK开发注意事项记录

因公司业务要求，需要开发一款广告SDK，自己之前未涉及到SDK开发，所以一路踩坑记录如下：

【 前言 】

1、清晰解决的问题和要求

一般而言，一个SDK必然有其深刻的业务背景；对SDK要解决的问题和SDK的特殊要求，了解地越详细越好；

常见的要求有：

• 禁止采集用户敏感信息【安全方面】
• 核心代码必须混淆【安全方面】
• 不可以有调试日志，不可以监控上报【安全方面】
• 持久化的敏感数据要加密；【安全方面】
• SDK大小不可以超过XXKB：【其他】
  …..

2.选择合适的开发语言
大多数情况下，选择Objective-C开发就ok了，不仅能接入Swift开发的项目，还能接入Objective-C开发的项目；
当然并非绝对，具体根据业务情况决定；

【 SDK开发注意事项】

1.确定SDK库的类型

A、静态库，链接时完整地拷贝至可执行文件中，被多次使用就有多份冗余拷贝。
(我司选型采用静态库)

B、动态库，链接时不拷贝，程序运行时由系统动态加载到内存，供程序调用，系统只加载一次，多个程序共用，节省内存。
(据说早在WWDC2014苹果在iOS上便开放了动态库，具体可以谷歌了解)

这里简单说一下Mach-O类型，为什么说简单说一下。因为深入我也不了解了，深入可以谷歌或度娘资料。

• Executable：应用的主要二进制
• Dylib Library：动态链接库（又称DSO或DLL）
• Static Library：静态链接库
• Bundle：不能被链接的Dylib，只能在运行时使用dlopen( )加载，可当做macOS的插件
• Relocatable Object File：可重定向文件类型

2.Method Swizzling

简介：Method Swizzling是Objective-C中运行时特性之一，本质是在运行时交换方法实现（IMP）；SDK有时候需要Method Swizzling利用hook一些系统(Objective-C)方法； 需要Method Swizzling的话，推荐使用 RSSwizzle，它是线程安全的Method Swizzling方案，优势是：不需要在+load()中实现方法交换 而且是 线程安全的；

3.category的处理

category是项目开发中经常用到的，把category打包成静态库是没有问题的，但是在使用这个静态库时，调用category中的方法时会发生找不到该方法的运行时错误（selector not recognized）.

• 解决的办法是在使用静态库的工程中配置other linker flags的值为 -ObjC -all_load，建议SDK中少用类别，因为有时候会对项目造成影响；

4.对图片资源和UI界面xib或nib文件的处理

.a和.framework两种静态库，通常都是把需要用的到图片或者xib文件存放在一个bundle文件中，而该bundle文件的名字和.a或.framework的名字相同。

.a文件中无法存放图片或xib文件，但是.framework中，也许需要单独创建bundle文件的，因为iOS系统不会去扫描.framework下的图片等资源文件，也不会在项目中显示，也就是说即使放在 .framework目录下，系统根本就不会去扫描，因此也无法发现使用.
(我司选用的是framework的静态库)

5.plist文件

如果SDK中没有用到info.plist文件可以删除，避免在工程中发生冲突，如果有用的记得在info.plist文件的名字加前缀，修改下plist文件的名字；

6.不要将第三方库打包进 SDK

尽量不要将第三方库打包进 SDK，如果要打包，最好也要将该第三方库重命名，以避免冲突，pod引入的方式也会涉及到和APP宿主工程版本号不兼容问题；

7.所有类名都应该加前缀

SDK是给别人用的，如果类名不加前缀很容易重名。重名可能导致有冲突的风险。

8.文档完整并且正确

需要有完成的开发接入文档以及Demo示例工程工开发人员接入参考，每次升级还需要完善对应的升级日志；

9.SDK需要常规架构支持

比如：i386 x86_64 armv7 arm64

• 模拟器32位处理器测试需要i386架构
• 模拟器64位处理器测试需要x86_64架构
• 真机32位处理器需要armv7,或者armv7s架构
• 真机64位处理器需要arm64架构

i386是针对intel通用微处理器32位处理器
x86_64是针对x86架构的64位处理器
armv7｜armv7s｜arm64都是ARM处理器的指令集
i386｜x86_64 是Mac处理器的指令集

10.SDK打包framework脚本

正常打包framework需要通过终端的两个命令行来完成
lipo -create "真机包路径" "模拟器包路径" -output "合并包路径"
添加脚本后可以通过sh脚本实现 真机模拟器脚本合并framework 打包。

.......

【 结尾 】

最后，沟通Plus

• SDK会被多个宿主App接入，不同的App环境不同，SDK可能遇到很多问题，积极帮助解决后，记录下来，作为后续其它宿主App使用SDK的重要参考；
• 及时同步SDK最新信息；SDK的bugfix版本，要及时同步，并帮助业务升级，尽量减少损失；
• SDK重大升级，需要业务方至少有一个人对SDK有比较全面的了解；