这是我参与「第五届青训营」伴学笔记创作活动的第14天!
『 背景 』
日常工作中，前端开发者一般会将通用的代码，合并到一个通用的 SDK 中，减少团队的工作效率。本文主要记录从编写 SDK 代码时的准入规范以及相关编码思维。 编写 SDK 代码的优势如以下两点：
- 防止反复造轮子；
- 将雷同的性能形象到一个通用 SDK 中，避免重复工作，提高团队的效率。
- 缩小线上 bug 概率。
- 通过大家独特的优化出 bug 的可能性较低，即便出 bug ，也只需要批改 SDK 即可。
一、需遵循的设计理念 ⌈ SOLID ⌋
在程序设计的领域内， SOLID 是由 Robert C.Martin 提出的面相对象编程以及面向对象设计的五个根本准则的缩写，这五个准则别离是:
- 繁多职责准则(Single Responsibility Principle)
- 类的设计，尽量做到只有一个能够引起它变动的起因。
- 一开闭准则(Open Close Principle)
- 一个软件实体，应该对扩大凋谢，对批改敞开。
- 里氏替换准则(Liskov Substitution Principle)
- 所有援用基类的中央必须能通明的应用其子类的对象。
- 接口隔离准则(InterfaceSegregation Principle)
- 客户端不应该依赖它不需要的接口;
- 类间的依赖关系应该建设在最小的接口上。
- 依赖反转准则(Dependence InversionPrinciple)
- 高层模块不能依赖底层模块，两者都应该依赖于其形象;
- 形象不应该依赖细节;
- 细节应该依赖形象。
在编写 SDK 中，我们需要深信 好的代码是设计进去的，而不是编写进去的 这一理念，所以在设计之初咱们就会依照这五大准则，逐个考量咱们是否的设计是否足够优良，咱们是否违反了某项准则。
二、需遵循的编码准则
2.1 稳固、高效
公共库是提供给泛滥业务方应用的第三方组件，如果公共库运行时程序解体，会危及业务方的我的项目，可能会造成线上事变，所以稳固是一个公共库的根本保障。
2.2 裸露异样
异样能够通过日志和接口返回裸露给用户。对于异常情况肯定要打日志，方便用户排查具体问题，并且约定错误码，通过错误码和 error message 将错误信息裸露给用户。在公共库外部，所有可能返回谬误的中央都不能疏忽。
2.3 测试
封装好一个函数或者功能模块后，需要测试其逻辑的正确性和函数的性能，可以采取单元测试和性能测试的方法。单元测试的重点在于验证程序设计或实现的逻辑是否正确，而压力测试的重点在于测试程序性能，确认程序在高并发的状况下还能保持稳定运行。
编码时还需要注重以下几点:
- 放弃向下兼容
- 缩小内部依赖
- 易用性
- 可了解性
结尾
编写一个好的 SDK 代码能够升高平台应用门槛、减少零碎健壮性等多个益处。为了更好呈现和优化 SDK 代码，需要开发者实时更新个人常识体系，继续优化、重构之前的代码。
综上，今天又是学习的一天呀！😎
