iOS 开发SDK指南

文章前言

旅程是提升思想进阶的途径

🏷️作为一名合格的开发者,GitHub上开源项目相信大家都在开发中或多或少使用过,对于这些第三方SDK,知名的或者不知名的大家了解的也一定很多。

🏷️通过第三方SDK项目集成,用投入较少学习成本,就能快速实现需求功能的优势,所带来的高效开发,相信大家都尝到了甜头,甚至我们可以这样评价,我们的美好工作建立在了它们的无私奉献上。

🏷️那么问题来了,针对第三方SDK我们为何对它们如此信任?第三方SDK的代码内容遵循哪些规则?还有,如何来辨别第三方SDK是否是一个优秀的开源项目?

🏷️再随着深入的研究,从一个使用者到提供者的转变,针对一个开源SDK的开发,我们要如何去定义一套优秀的API?如何去实现一套高效的需求功能?最终,如何让自己的SDK能得到其他使用者们的认可?

🌟【SDK目标

针对上文的提问,总结了下面四点目标:

1: 有一套简洁,易懂的API;

2: 功能需求性能高效;

3: 代码逻辑安全,健壮。包括有一套异常收集和处理;

4: 功能点兼容处理;

🌟【API的合理性

API的合理性定义,是比较关键的。

我们开发中去使用第三方SDK,通常都是从暴露的API入手去分析和思考怎么实现功能,同时最关心API参数怎么传,关心API参数支持的数据类型,还关心API是否支持特殊的需求功能实现。特殊的功能需求实现简单讲就是,SDK功能扩展的智能强度。

OC开发的SDK API的合理性包括:

1). 属性的暴露合理性;               

2). 方法定义和方法入参定义的合理性;

一起看下知名SDK: Masonry API定义案例:

数据暴露
API暴露

1): Masonry中暴露属性的readonly修饰,保证了属性安全性。

2): API的清晰简洁。仅仅提供3条API就实现了强大的布局功能,作者在开发前的构思上是下了功夫的,值得学习。

🌟【性能高效】

性能高效是多方面的综合性评分,其中包括线程使用的正确性,数据结构使用的正确性,缓存机制使用的正确性,代码逻辑的优化,对内存管理的关心等。虽然“性能高效”注意点就前面几十个字,但都是精华,这里就不详细说了。

🌟【代码安全,SDK健壮】

一):  数据方面

iOS的OC是一门动态语言,编译时对数据类型的不确定性,是最致命的缺点,所以我们在开发中需要注意这个问题,写SDK关键需要判断数据类型;

注意对字典取数据和判断数据类型处理,写SDK必不可少的步骤;

注意对数据集合非空判断和取值判断处理,避免为空和数组越界,导致奔溃;

二):  权限方面

权限方面是指iOS在对用户隐私设置的保护,如果SDK有用到设置功能,需要判断状态,并给予提示。

三):  内存管理方面

内存管理注意点包括以下:

1): 属性修饰类型;

2): Block的强引用;

3): 对象生命周期的管理;

4): 数据存储优化;

注释:上面的注意点就不详细介绍了,都是平级的要点。

🌟【功能点兼容】

一):  UI方面的手机型号适配

包括iPhoneX以后的刘海,下巴UI和iPhone5,4小屏UI适配,能在SDK中处理,就不应该在外面让使用者手动设置值。

-----优化方案:

可以通过提供按照比例缩放和边距最小值适配方案,通过自定义枚举值类型参数和配置默认值,来实现使用者的调整需求。

-----温馨提示:

减少在SDK外部对SDK中UI功能值的设置,最好的效果是去除所有在外部值设置,如果没有达到这个目标,再好好优化一下API和功能代码实现逻辑。

二):  数据的异常收集

SDK数据处理可能出现的报错情况,需要我们对错误数据进行处理,防止程序崩溃,并将错误数据进行收集,Debug提示使用者,方便快速定位和解决问题。

—-看下案例:

备注:如果在数据类型不匹配的情况下,上面 setValue(  , forKey:  ) 的使用会导致崩溃,这里处理了数据类型判断,并Debug提示了使用者。SDK对异常数据的收集,是很能提升使用者好感的。

🌟【SDK目标总结】:

开发SDK,是通过多年的开发经验来预防和处理各种可能出现的问题,防止一个不合格的SDK成为APP中的一部分,导致拉低性能和用户体验。

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

推荐阅读更多精彩内容

  • 每天进步一点点点点点点点点点点点点点点点点点点点点点点点点点点点点点点~~从开始只能写几句话、模仿别人的观点,到现...
    一个帅气的名字呀阅读 18,047评论 4 31
  • 点击查看原文 Web SDK 开发手册 SDK 概述 网易云信 SDK 为 Web 应用提供一个完善的 IM 系统...
    layjoy阅读 13,675评论 0 15
  • 最近不知道怎么了,无论是母猪还是仔猪都腹泻而且传染性极强,一窝拉第二天变了四五窝拉,打针都没用。我怀疑是流行性腹...
    承思而行阅读 158评论 0 0
  • 巍巍关塞镇河津, 一炬红灯气象新。 漫道人山人海噪, 古城正定又逢春。
    荷锄叟阅读 709评论 0 7