SDK开发的一些思考

发表于 2年以前  | 总阅读数:307 次

人应当像“人”字一样,永远向上而又双脚踏地。—— 但丁


自从毕业之后,好像我一直都在做SDK相关的开发工作,但做了这么长时间貌似也没正经复盘一次。

最近有一些思考:

  • 什么样的SDK才能称之为一个好的SDK?
  • 怎么才能做出一个好的SDK?
  • 怎么才能做好一个项目?

在这里和大家分享一下,也希望听听大家的看法。

下面是我的粗浅看法:

  • 接口简单易用:用户可以快速方便的接入,在确保提供相应能力的前提下,对外暴露的接口越少越简单越好。接口越多,用户接入的复杂性就越高,出bug的概率就越大。
  • 接入的第三方库要做成插件化:一个SDK想要获取某些能力不可避免的要接入一些三方库。这里一定要做好隔离,实现同样的功能,可以灵活替换其他同类型的三方库。功能侧做好mock,当发生某一问题时(比如CPU占用率高、难以排查的内存泄漏等),可以灵活去掉某个三方库,缩小复现路径,方便定位问题。
  • 完备的日志:关键函数调用一定要有log,可以在调试某个不容易复现的问题时打印完整的调用路径,方便定位问题,其实最好能有一个全链路追踪方案。这种方案也是我一直想要做的,但苦于到现在还没有找到合适的实现方法。
  • 参数可配置:很多参数不要写死,最好做成可配置的。
  • 要有监控手段:比如内存、CPU占用率、帧率等的监控。保证质量第一,质量问题要量化,确定好什么指标才算是高质量SDK。
  • 线上出问题后可定位:这一般取决于SDK的log覆盖程度,以及开发人员的调试能力和经验。

其实这和开发一个好的项目类似,下面是我一些粗浅的想法:

  • 整个项目代码风格统一:在项目启动前确定代码规范,C++的话一般都是参考的Google的编码规范。项目的编译环境、设计风格也要统一,比如消息传递方式、模块如何调用方通知错误、软件如何向用户通知错误、如何组织数据结构、模块间通信机制等。

  • 想清楚:不用着急动手,写代码之前一定要想清楚。开发一个SDK之前要设计好整个架构,这可能会设计出多种架构,最好都能给出架构图,然后说明每个架构的优缺点。从中选择最合适的架构,想清楚自己的取舍,为什么选择了这个,而非其他。

  • 文档先行:这里不要求文档格式,先制定方案,核心诉求是想清楚之后再开发。重要核心功能最好拉上组内核心成员review,尽可能对方案做进一步优化。

  • 方便扩展:这其实还是涉及到SDK的架构问题,我见到过很多扩展性非常差的SDK,迭代需求非常困难,牵一发而动全身。想要做好扩展性,我想更多的还是要知道SDK的发展方向,只有预测到将来会有什么需求才能更好的设计架构。当然,也没必要过度设计,架构都是一点点演进的,没有一步到位的架构。其实只要合理定义好模块,抽象好接口,SDK的扩展性还是大体可以保证的。

  • 接口设计:做好接口的抽象与设计,让用户没有错误调用的机会。比如你的参数类型是enum class,用户想传错参数都不可能,编译就会报错。

  • 模块划分清晰:模块边界要清晰,尽量减少模块之间的耦合度,确定好每个模块的输入和输出,做好团队协作与沟通,每个模块划分责任人,确定时间点。

  • 测试先行:这是基本的编程原则啦,但貌似真正做到的也没几个,我在这块做的也不好...但还是要说一说,写代码之前要提前想好测试方案,不要一口气写完一大块代码,要一边写代码一遍测试,真正出现问题时也更好定位。

  • 做好质量的监控与保障:

  • CPU占用

  • GPU占用

  • 内部状态

  • 内存

  • 帧率

  • 型号

  • 错误和崩溃信息

  • 画面评估:

  • 声音是否卡顿

  • 音画是否同步

  • 是否有回声

  • 要有监控的手段,比如音视频SDK中一些常见的指标:

  • 做好自动化测试,测试的代码覆盖率要超过90%

  • 跨平台:SDK最好做成跨平台的,拿我常做的移动端SDK来说,一般要求移动端SDK要支持双端,即Android和iOS。所以一般都会使用双端都支持的Native语言开发,即C/C++。

  • 因为把所有业务逻辑都沉到底层,用一套语言实现,这样在后期需求迭代和维护时可以只使用一份人力,如果使用双端上层Android和OC语言开发,同一套需求需要使用双倍人力,而且双端效果可能还不一致,排期也可能不一致,bug数也可能不一致。可能会影响整个SDK的交付进度。

  • 为什么不使用平台相关的语言,而使用Native开发?

  • 这里可能大家会有些问题,比如某些功能只能使用上层语言开发,比如Android的Camera和MediaCodec,iOS的AVCaptureSession和VideoToolBox等,这怎么办?

  • 这里要按功能做好抽象,拿录制来说,只需要提供开启录制、停止录制的接口即可,内部谁管你怎么实现呢。可以设计成同一个头文件,然后把平台差异化隐藏在实现中,使用条件编译的方式选择编译某个平台下的源文件。

  • 三方库接入:要确保做好封装,做到模块化、可复用、可插拔。比如setBeautify、setFilter、setSticker等。

03 如何才能做好一个项目?

我认为做好一个项目的前提是人,要有合适的人。

其次还是要规范好流程,关于开发流程方面的东西,我对此还知之甚少,贴一个群友分享的产品迭代流程图吧:

然后还有一位前辈给我发的开源项目邮件里说了一些他的看法,我感觉非常不错,这里也贴出来给大家看看:

1.希望有完备而用心的UT,追求100%逻辑覆盖率,UT维护良好,短小易读

2.子系统解耦良好,各模块相对独立,以标准化IO接口,通过项目基础库进行通讯,能独立更新迭代,独立进行测试

3.不需要过多的smoke test

4.子系统通讯和管理所经由的基础库希望由技术过硬的大佬写,希望跨平台,而且可读性高

5.数据链路有类似kernel的各种数据统计,数据统计不应耦合于业务,而是有数据统计子系统,高度解耦的方式

6.使用好的log,多线程库,数据解析库,通讯库,而不是自己写

7.迅捷的编译,提交任何代码都需要门禁,快速的跑全量UT与smoke

8.每日daily自动化跑全量UT与smoke,weekly性能测试;自动化测试跑出来的bug可以自动建立并根据模块自动分派给个人

9.希望使用比较新一点的技术栈

作为技术人,还有很多的问题等着我们揭开答案,什么样的流程才更合理?做些什么能够更好的保证工程质量?不知道大家对此有什么想法?希望能向大家学习。

本文由哈喽比特于2年以前收录,如有侵权请联系我们。
文章来源:https://mp.weixin.qq.com/s/DmWTD8ve0pfomy4pl4O43Q

 相关推荐

刘强东夫妇:“移民美国”传言被驳斥

京东创始人刘强东和其妻子章泽天最近成为了互联网舆论关注的焦点。有关他们“移民美国”和在美国购买豪宅的传言在互联网上广泛传播。然而,京东官方通过微博发言人发布的消息澄清了这些传言,称这些言论纯属虚假信息和蓄意捏造。

发布于:1年以前  |  808次阅读  |  详细内容 »

博主曝三大运营商,将集体采购百万台华为Mate60系列

日前,据博主“@超能数码君老周”爆料,国内三大运营商中国移动、中国电信和中国联通预计将集体采购百万台规模的华为Mate60系列手机。

发布于:1年以前  |  770次阅读  |  详细内容 »

ASML CEO警告:出口管制不是可行做法,不要“逼迫中国大陆创新”

据报道,荷兰半导体设备公司ASML正看到美国对华遏制政策的负面影响。阿斯麦(ASML)CEO彼得·温宁克在一档电视节目中分享了他对中国大陆问题以及该公司面临的出口管制和保护主义的看法。彼得曾在多个场合表达了他对出口管制以及中荷经济关系的担忧。

发布于:1年以前  |  756次阅读  |  详细内容 »

抖音中长视频App青桃更名抖音精选,字节再发力对抗B站

今年早些时候,抖音悄然上线了一款名为“青桃”的 App,Slogan 为“看见你的热爱”,根据应用介绍可知,“青桃”是一个属于年轻人的兴趣知识视频平台,由抖音官方出品的中长视频关联版本,整体风格有些类似B站。

发布于:1年以前  |  648次阅读  |  详细内容 »

威马CDO:中国每百户家庭仅17户有车

日前,威马汽车首席数据官梅松林转发了一份“世界各国地区拥车率排行榜”,同时,他发文表示:中国汽车普及率低于非洲国家尼日利亚,每百户家庭仅17户有车。意大利世界排名第一,每十户中九户有车。

发布于:1年以前  |  589次阅读  |  详细内容 »

研究发现维生素 C 等抗氧化剂会刺激癌症生长和转移

近日,一项新的研究发现,维生素 C 和 E 等抗氧化剂会激活一种机制,刺激癌症肿瘤中新血管的生长,帮助它们生长和扩散。

发布于:1年以前  |  449次阅读  |  详细内容 »

苹果据称正引入3D打印技术,用以生产智能手表的钢质底盘

据媒体援引消息人士报道,苹果公司正在测试使用3D打印技术来生产其智能手表的钢质底盘。消息传出后,3D系统一度大涨超10%,不过截至周三收盘,该股涨幅回落至2%以内。

发布于:1年以前  |  446次阅读  |  详细内容 »

千万级抖音网红秀才账号被封禁

9月2日,坐拥千万粉丝的网红主播“秀才”账号被封禁,在社交媒体平台上引发热议。平台相关负责人表示,“秀才”账号违反平台相关规定,已封禁。据知情人士透露,秀才近期被举报存在违法行为,这可能是他被封禁的部分原因。据悉,“秀才”年龄39岁,是安徽省亳州市蒙城县人,抖音网红,粉丝数量超1200万。他曾被称为“中老年...

发布于:1年以前  |  445次阅读  |  详细内容 »

亚马逊股东起诉公司和贝索斯,称其在购买卫星发射服务时忽视了 SpaceX

9月3日消息,亚马逊的一些股东,包括持有该公司股票的一家养老基金,日前对亚马逊、其创始人贝索斯和其董事会提起诉讼,指控他们在为 Project Kuiper 卫星星座项目购买发射服务时“违反了信义义务”。

发布于:1年以前  |  444次阅读  |  详细内容 »

苹果上线AppsbyApple网站,以推广自家应用程序

据消息,为推广自家应用,苹果现推出了一个名为“Apps by Apple”的网站,展示了苹果为旗下产品(如 iPhone、iPad、Apple Watch、Mac 和 Apple TV)开发的各种应用程序。

发布于:1年以前  |  442次阅读  |  详细内容 »

特斯拉美国降价引发投资者不满:“这是短期麻醉剂”

特斯拉本周在美国大幅下调Model S和X售价,引发了该公司一些最坚定支持者的不满。知名特斯拉多头、未来基金(Future Fund)管理合伙人加里·布莱克发帖称,降价是一种“短期麻醉剂”,会让潜在客户等待进一步降价。

发布于:1年以前  |  441次阅读  |  详细内容 »

光刻机巨头阿斯麦:拿到许可,继续对华出口

据外媒9月2日报道,荷兰半导体设备制造商阿斯麦称,尽管荷兰政府颁布的半导体设备出口管制新规9月正式生效,但该公司已获得在2023年底以前向中国运送受限制芯片制造机器的许可。

发布于:1年以前  |  437次阅读  |  详细内容 »

马斯克与库克首次隔空合作:为苹果提供卫星服务

近日,根据美国证券交易委员会的文件显示,苹果卫星服务提供商 Globalstar 近期向马斯克旗下的 SpaceX 支付 6400 万美元(约 4.65 亿元人民币)。用于在 2023-2025 年期间,发射卫星,进一步扩展苹果 iPhone 系列的 SOS 卫星服务。

发布于:1年以前  |  430次阅读  |  详细内容 »

𝕏(推特)调整隐私政策,可拿用户发布的信息训练 AI 模型

据报道,马斯克旗下社交平台𝕏(推特)日前调整了隐私政策,允许 𝕏 使用用户发布的信息来训练其人工智能(AI)模型。新的隐私政策将于 9 月 29 日生效。新政策规定,𝕏可能会使用所收集到的平台信息和公开可用的信息,来帮助训练 𝕏 的机器学习或人工智能模型。

发布于:1年以前  |  428次阅读  |  详细内容 »

荣耀CEO谈华为手机回归:替老同事们高兴,对行业也是好事

9月2日,荣耀CEO赵明在采访中谈及华为手机回归时表示,替老同事们高兴,觉得手机行业,由于华为的回归,让竞争充满了更多的可能性和更多的魅力,对行业来说也是件好事。

发布于:1年以前  |  423次阅读  |  详细内容 »

AI操控无人机能力超越人类冠军

《自然》30日发表的一篇论文报道了一个名为Swift的人工智能(AI)系统,该系统驾驶无人机的能力可在真实世界中一对一冠军赛里战胜人类对手。

发布于:1年以前  |  423次阅读  |  详细内容 »

AI生成的蘑菇科普书存在可致命错误

近日,非营利组织纽约真菌学会(NYMS)发出警告,表示亚马逊为代表的电商平台上,充斥着各种AI生成的蘑菇觅食科普书籍,其中存在诸多错误。

发布于:1年以前  |  420次阅读  |  详细内容 »

社交媒体平台𝕏计划收集用户生物识别数据与工作教育经历

社交媒体平台𝕏(原推特)新隐私政策提到:“在您同意的情况下,我们可能出于安全、安保和身份识别目的收集和使用您的生物识别信息。”

发布于:1年以前  |  411次阅读  |  详细内容 »

国产扫地机器人热销欧洲,国产割草机器人抢占欧洲草坪

2023年德国柏林消费电子展上,各大企业都带来了最新的理念和产品,而高端化、本土化的中国产品正在不断吸引欧洲等国际市场的目光。

发布于:1年以前  |  406次阅读  |  详细内容 »

罗永浩吐槽iPhone15和14不会有区别,除了序列号变了

罗永浩日前在直播中吐槽苹果即将推出的 iPhone 新品,具体内容为:“以我对我‘子公司’的了解,我认为 iPhone 15 跟 iPhone 14 不会有什么区别的,除了序(列)号变了,这个‘不要脸’的东西,这个‘臭厨子’。

发布于:1年以前  |  398次阅读  |  详细内容 »
 相关文章
Android插件化方案 5年以前  |  237273次阅读
vscode超好用的代码书签插件Bookmarks 2年以前  |  8108次阅读
 目录