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有比较全面的了解;
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,214评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,307评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,543评论 0 341
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,221评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,224评论 5 371
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,007评论 1 284
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,313评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,956评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,441评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,925评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,018评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,685评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,234评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,240评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,464评论 1 261
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,467评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,762评论 2 345

推荐阅读更多精彩内容