iOS SDK开发二三事

引子

• 无心间，看到5年前，Android大佬子勰写的，关于SDK开发方面的文章(SDK那些事（总纲）), 不禁得唤起本身开发iOS SDK的回忆；本文简单总结下本身开发SDK方面的经验；

• SDK（Software Development Kit）能够最大程度实现代码和功能的复用，为业务开发提供一个很是好的支持；这里的业务能够是内部业务，也能够是外部业务；

• 简单来讲，所谓SDK开发，本质是服务提供；不只须要写好代码，还要完善代码以外的事情，任重道远

1、准备

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

​ 通常而言，新起一个SDK必然有其深入的业务背景；研发同窗对SDK要解决的问题和SDK的特殊要求，了解地越详细越好；常见的要求有：

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

二、选择合适的开发语言

• 大多数状况下，选择Objective-C开发就对了，不只能接入Swift开发的项目，还能接入Objective-C开发的项目；
• 固然并不是绝对，具体根据业务状况决定；

三、选择合适的技术方案

• 网络请求使用第三方框架，仍是直接利用iOS的API；
• JSON转Model、Model序列化和反序列选择哪一个第三方框架(性能，框架大小方面考虑)
• 持久化存储选择SQLite、NSUserDefaults 或是 Keychain；
• UI布局使用 frame、autolayout(Masonry框架) or flexbox(YogaKit框架)
• MVVM or MVC 架构模式选择；
• ...

四、确立基本代码规范

​ SDK可能长期维护 或 多人开发，确立好基本代码规范，能保障SDK的代码质量；这些规范本质上是一些共识和约束，如：

• 命名规范：属性、变量、方法等均采用小写字母开头的驼峰命名；类名使用大写字母开头的驼峰命名；
• 注释要求：对外暴露的类、方便和变量要有注释，解释其功能；关键代码要有注释；
• 简洁要求：无用的代码选择直接删除，不要注释；无用的资源及时清除；
• ....

2、SDK的主体设计

一、多模块设计

• SDK中可能包含不一样的模块功能，而不一样的业务方须要的模块可能不一样；对SDK中模块进行拆分，保证业务方尽量引入的是他们须要的代码；

• 通常使用Cocoapods建立Pod库的，在podspec中定义好模块，为每一个模块清晰定义好包含的代码和资源，以及外部依赖(静态库 or 静态库)；这样能够将模块之间实现代码和资源的物理隔离；

• 关于Cocoapods建立Pod库更多细节能够参考Cocoapods使用小记，至因而公有Pod仍是私有Pod根据实际状况定；

  建立公有Pod库或者私有Pod库原理是同样的；不同的是：二者的版本索引查询方式不同，公有库的podspec由CocoaPods/Specs管理，而内部私有使用的pod库须要公司内部创建一个仓库来管理podspec

二、SDK目录层级

• Pod库中，代码放在Classes目录下，图片资源放在Assets目录下；

• Classes目录按模块划分第一级目录，如AModule、BModule、CModule等，其中每一个模块Code再划分二级目录，如ModuleService、View、Controller、Model、API等；具体的代码文件存放在这些二级目录中；其中ModuleService中代码是要对外暴露的，其余预期外部不可见；

• 资源方面，也按模块细节；主要的资源是图片资源，在Assets目录下新加AModule.xcassets、BModule.xcassets、CModule.xcassets等；

三、公开接口设计

• SDK使用者们关注接口是够好用，设计好接口，让你的SDK使用体验加分；

• 接口功能尽可能职责单一，接口须要的参数不要太多；若是参数多，可使用Model将业务参数封装下；提供Model的default实现；接口名，参数名使用驼峰命名，最好见名知义；

• 接口中每一个参数类型要明确，不要出现id、NSDictionary这样的类型；避免业务随意传参，增长SDK内部对参数校验难度；也减小业务方对参数的困惑；

• 接口内第一件事情是要作参数校验，不符合预期状况，Debug模式直接Assert，及早把问题抛出；Release模式要记录到日志并上报，提早返回，避免后续出现迷惑问题，增长排查问题成本；

四、代理和状态码

• 除了暴露接口，SDK还可能暴露代理（Delegate）方法 和 状态码；
• 代理（Delegate）是须要业务方根据须要实现的，代理（Delegate）中可选实现方法加上@optional关键字，没有的话默认要实现；协议和协议中具体方法的做用要增长上注释；
• 状态码设计上，须要注意两点：
  • SDK中定义的状态码使用枚举(NS_ENUM)定义，对应的每一个值增长注释；
  • 若是SDK依赖了其余SDK，这些SDK的状态码最好不要透传给业务方，中间增长转化；好比微信SDK中WXErrCode不要透传给业务方，封装一下，对外暴露的是咱们的状态码；

五、SDK的版本号

• SDK都要有明确的版本号，通常版本号分三段：主版本、特性版本、修正版本，如5.6.1；其中主版本号用于大版本的发布，特性版本主要用于更新迭代，修正版本号主要用于bug修复。
• SDK内部的埋点、监控，网络请求等都要携带SDK的版本号，这些版本号对定位SDK问题很是重要；
• SDK对外通常是二进制的形式提供，发布的SDK须要带上版本号信息；至少要保证三个地方的SDK版本信息是一致的；git仓库的tag版本号、podspec中的version、代码中的版本号；能够实现个脚本，在编译时候，统一修改这三处的版本号信息；

六、SDK安全需求

• 目前遇到的，有关SDK安全方面要求有：
  • 核心代码的混淆；包括字符串常量、类名和方法名方面的混淆；
  • 敏感数据须要加密存储，禁止明文传输等
  • 对SDK使用者鉴权的要求，"非法"App不得使用，非法调用者必Crash；
• 此外，有不常见的”安全诉求“：App内不得有任何调试信息，埋点、采集用户数据等行为；不得使用带来安全隐患的API，好比打开WKWebview跨域开关这个就不被容许；
• 代码混淆后，混淆先后的符号间映射必定要保留，不然线上问题堆栈信息中，出现的SDK混淆后的符号会让定位问题很是迷惑；能够作成转化工具，导入堆栈符号信息，输出混淆前正常的符号信息；

3、对业务的支持

一、提供SDK文档

• SDK开发好后，对外还要提供相关文档，包括但不限于：SDK功能介绍、SDK接入办法 和 SDK具体使用、SDK 更新日志记录 以及 SDK问题记录；
• 基于专业角度，建议提供SDK概况文档，包括但不限于：接入的业务状况，优化记录，SDK的依赖库信息，二进制 和 资源大小信息等；有些业务对SDK大小敏感，有些关注SDK的稳定性...；
• 业务方在接入SDK前，是从接触SDK文档开始，好的文档能帮助SDK更好地被接受，后续更好开展工做；

二、提供Demo

• 只有文档还不够的，必定要提供Demo；Demo有两个好处：
  • 帮助业务方结合文档更好了解SDK的接入和使用；
  • 帮助测试及时验证SDK升级后带来的影响；
• Demo中不只有SDK引入办法、使用办法；还能够写一些简单UI，帮助展现SDK功能；每次SDK升级，都经过Demo自动出包，提供给测试人员和产品去验证（功能验证和设备兼容性验证）；
• SDK的自动化测试这块，暂何尝试；但在是Demo中，定义对SDK接口的单元测试是必要的；单元测试要关注：非法传参case，非主线程调用case。

三、规范SDK开发流程

• 开发SDK和开发完整项目同样，要有需求评审、技术评审、排期，开发，自测，提测、测试验收等环节 ；不一样功能在不一样feature分支上开发，每一个feature功能验证经过后能够合入主干分支；合入主干后，由主干分支发布版本；

• 发布的SDK使用二进制的形式；SDK使用二进制形式，不只能提示项目项目编译速度，也能保护好源码；若是业务方须要SDK源码，须要向SDK负责人申请权限；

四、帮助业务排查问题

• SDK开发者常常会收到业务方帮助排查问题的诉求；毕竟，SDK对业务方是一个黑盒，不少业务上涉及到SDK问题，须要SDK开发者帮助排查，耗时耗力；
• 为了更好帮助业务排查问题，推出三件套：SDK核心链路监控埋点 + 重要日志信息持久化并上报 + 调试日志信息可视化；前二者是固化在于SDK中的；而调试日志信息是交给业务方，由他们灵活处理；
• 业务方拿到调试日志信息，能够将其输出到控制台，也能够输出到App的日志可视化工具中；鉴于业务方可能没有，能够提供一个轻量级的日志可视化工具。
• 必须注意的是，SDK中的调试日志信息禁止带到线上，SDK的Release版本不能够带这些信息。

五、沟通Plus

• 重要内容要有记录：SDK会被多个宿主App接入，不一样的App环境不一样，SDK可能遇到不少问题，积极帮助解决后，记录下来，做为后续宿主App使用SDK的重要参考；
• 创建SDK和业务沟通机制；及时同步SDK最新信息；SDK的bugfix版本，要及时同步，并帮助业务升级，尽可能减小损失；
• 为SDK增长代码Reviewer：SDK重大升级，最好involve主要业务方的研发进行技术评审和Code Review；其实这对业务方是个很高的要求，须要业务方至少有一我的对SDK有比较全面的了解；

4、SDK实现中的注意事项

一、注意多线程使用

• 不要在主线程执行耗时操做，能够将他们交给子线程；
• 控制好并发数量，GCD并发队列并不会去管理最大并发数，无限制提交任务给并发队列，会给性能带来问题。能够适当控制并发数量，防止线程爆炸；具体可见 iOS实录16：GCD小结之控制最大并发数
• 遇到必需要在主线程执行的任务；先判断当前是否在主线程，不在的话，能够经过GCD将任务放到主线程队列执行；此外，还能够加断言，Debug下，非主线程执行执行抛异常，Crash，帮助及时发现问题；
• 尽量使用轻量级的锁，可使用信号量；自旋锁性能很是好，可是有优先级反转的问题，谨慎使用；

二、使用缓存要克制

• 不管是内存缓存和磁盘缓存都要有清除策略（能够LRU）和使用大小限制；
• 若是内存缓存没有清除策略和使用大小限制，会致使内存使用无限制增加，最后可能会致使OOM问题；此外，当收到内存警告时候，内存缓存要及时清除，不然可能引发OOM问题，直接破坏用户体验；
• 若是磁盘缓存没有清除策略和使用大小限制，会致使磁盘空间滥用，对App总体体验都很差，并且后续清理成本比较高；
• 持久化在磁盘文件中数据，不要在App启动时去读取，能够懒加载；不要对数据量和文件读取性能报侥幸，随着SDK的迭代，那些数据可能不断变大，也可能在低端机器上文件读取性能比较差，偶现几十ms甚至几百ms的耗时，直接拖累启动速度；

三、内存使用要注意

• 尽可能优化内存使用，四个原则：减小大块内存使用、下降内存峰值、避免内存泄露和处理内存警告;
• 具体到内存使用中技巧：
  • 合理使用autorealsepool，下降内存峰值，避免 OOM
  • 复用大内存对象，如UITableViewCell对象；懒加载大的内存对象
  • 用 NSCache 代替 NSMutableDictionary，使用NSPurgableData 代替NSData；
  • weak strong dance 来解决 Block 中的循环引用，代理(delegate)使用weak修饰；
  • CoreFoundation对象、CoreGraphics对象、还有C/C++的内存分配须要管理好，有malloc()和calloc()就要有free；
  • ....
• 了解内存方面知识能够看：iOS内存二三事

四、使用单例要注意

• 有些SDK经过单例对象提供服务；由于，单例对象只有一个对象，不只能够节约开销，还能够保证App中多业务操做SDK中同一个服务对象；
• 可是定义单例要注意；日常App开发中，写单例不怎么严谨，提供个让外部访问的类方法，如+ (instancetype)sharedInstance，内部使用dispatch_once保证alloc和init只执行一次，这种是粗发式单例，并不能保证绝对单例；
• 在SDK中，必定要保证外部访问到的是单例对象；除了提供让外部访问的类方法，还要重写+(instancetype)allocWithZone、-(instancetype)copyWithZone和-(instancetype)mutableCopyWithZone方法，保证永远都只会分配一次内存空间，实现真正的单例；
• iOS中，一个对象有且只能有一个代理；若是你的单例对象有须要业务方实现的代理方法，根据实际状况判断，是否须要实现多代理；

五、注意宏定义和条件编译

• 编译器前端(如Clang)在编译源码时，首先要作预处理(preprocessor)，如头文件引入，宏替换，注释处理，条件编译(#ifdef) 等；
• 通常地，SDK中会使用到条件编译；在源码状况下，能够根据不一样的条件，编译不一样的源码；可是SDK使用二进制的形式对外提供的话，在二进制化时就已经根据XX条件编译好了；所以，二进制的SDK不会能跟随宿主App编译条件变化了；
• 使用宏能够提升程序的通用性和易读性，减小不一致性，减小输入错误和便于修改。可是若是宏对应实现，须要根据条件编译来区分不一样的行为；在二进制编译时候，宏定位的行为会被肯定下来；
• 宏定义有个小细节，用do{...}while(0)构造的宏定义不会受到大括号、分号等的影响，很是建议使用。

5、SDK实现中的小技巧

一、weak symbol

• 简介：symbol默认都是strong的，可是能够增长 __attribute__ ((weak))属性将其变成weak symbol；weak symbol在连接时候比较特殊：
  • strong symbol必须有实现，不然会报错;
  • 不能够存在两个同名的strong symbol
  • strong symbol能够覆盖weak symbol的实现
• SDK能够用weak symbol提供默认实现，而后业务中利用strong symbol把业务实现注入进来，以此来实现依赖注入；

weak symbol 不作标准方案推荐; 遇到要临时适配某些业务的特殊case，时间紧急状况下，能够"剑走偏锋";

二、预约义符号

• 简介：有些公开功能使用宏定义的函数形式，能够在函数中带上__FILE__、__LINE__和__FUNCTION__这些C语言中预约义符；这样能够在发生问题时，更好找到使用宏函数的位置，demo以下：

  #define AddFunc(a,b) 
  do { \
      addFuncImp(a,b, __FILE__,__LINE__,__FUNCTION__); \
  } while(0)

• 有人问过：为何不使用[NSThread callStackSymbols]获取当前线程堆栈信息，岂不是更好；不使用有3方面考虑:

  • 只是为了获取调用代码位置；了解到SDK调用位置，排查问题能高效地多；
  • [NSThread callStackSymbols]捕获堆栈信息在符号裁剪状况下，主模块中的是内存地址信息，而不是符号信息；
  • __FILE__、__LINE__和__FUNCTION__的成本更低，性能更好;

三、section()函数

• 简介：section()函数是Clang提供的，能够读写二进制段；实际应用中，在编译阶段将一些肯定的常量写入数据段(__DATA段)，并在运行期根据须要读取出来；能够利用此能力实现延迟加载；

• 在阿里的iOS的BeeHive有相似的使用，以下:

  #define BeeHiveMod(name) \
  char * k##name##_mod BeeHiveDATA(BeehiveMods) = ""#name"";
  
  #define BeeHiveDATA(sectname) __attribute((used, section("__DATA,"#sectname" ")))

  used关键词是告诉编译器，Release下不优化，必须保留这个符号；不然Release下。连接器会优化掉没有引用的符号；

四、pre-main和after_main

• 简介：App启动耗时通常统计pre-main阶段(T1)，和main()函数以后到didFinishLaunchingWithOptions方法执行完这段(T2)阶段；SDK中能够利用__attribute__ ((constructor))、__attribute__((destructor))这两个函数属性在pre-main和after_main时机作一些事情；

• 使用这两个属性定义函数示范以下：

  __attribute__((constructor)) void before_main_xxxx() { //can do something } __attribute__((destructor)) void after_main_xxxx() { //can do something }

• 须要说明的是：在pre-main和after_main时机，千万不要作耗时操做；在SDK（二进制形式）中使用比较隐蔽，通常状况下，业务方很难想到或注意到；若是在pre-main时机作了耗时的事情，宿主App启动体验就不太好了；

  dyld加载过程分四步：Load dylibs image、Rebase/Bind image、Objc setup和initializers；其中+load()在__attribute__((constructor))以前，他们都在initializers阶段内完成；initializers以后就是main函数执行了；

五、Method Swizzling

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

推荐👇：

• 020 持续更新，精品小圈子每日都有新内容，干货浓度极高。

• 结实人脉、讨论技术 你想要的这里都有！

• 抢先入群，跑赢同龄人！（入群无需任何费用）

• （直接搜索群号：789143298，快速入群）

• 点击此处，与iOS开发大牛一块儿交流学习

申请即送：

• BAT大厂面试题、独家面试工具包,

• 资料免费领取，包括 数据结构、底层进阶、图形视觉、音视频、架构设计、逆向安防、RxSwift、flutter，

   

  

参考文章

如何编写一个（不）受欢迎的 iOS SDK

听阿里云工程师谈谈如何开发一个优秀的SDK

做者：南华Coder
连接：https://juejin.im/post/5e9adea16fb9a03c364f216e