怎样设计接口

Posted 2020-09-30 yutingliuyl

依据资料和经验总结。

要求：

1. 命名：
   1. 命名规则和风格统一、规范；
   2. 命名清晰明白，不冗余，不模糊；
   3. 有意义：清晰和有意义的命名比简略而模糊的命名更应受到青睐；

2. 功能
   1. 职责明白：功能尽量单一；
   2. 充分理由：不要随便有新功能就添加新接口；无意义的接口仅仅会添加维护的难度；
   3. 将功能层和策略层分开：
      1. 功能是基础数据。不易变。
      2. 策略是表层数据，易变——策略能够使用參数改动；
   4. 低耦合：降低不同接口间的依赖。
      1. 一个接口不应随着还有一个接口的变化而变化；
      2. 一个接口不应以某几个接口为前提而存在。
   5. 完备性：
      1. 考虑各种參数变化的情况。
      2. 考虑各种參数为default或为0的情况。
   6. 可扩展性：为以后可能会添加的參数预留余地，尽量不要写死；

3. 參数
   1. 不超过5个；
   2. 从做到右，依照參数easy变化的程度排列；
   3. 尽量提供默认值；
   4. 若超过5个，把相似的数据放入到一个json或list等数据结构中；
   5. 禁止任意扩展：理由见“功能”部分。
   6. 參数尽量是原生数据结构。少用对平台依赖的数据结构。

4. 分析角度：明白角度，不要一会以角色设计，一会以功能设计。
5. 必要信息：
   1. 初始信息
      1. 初始化是否完成
      2. 初始化完成后的基本信息（如：list或dict的长度——能够看出是否为0）
   2. 中间信息
      1. 数据源是否变动
      2. 数据长度是否改变（须要视重要程度决定是否需打印该信息）
   3. 返回信息
      1. 是否成功？
      2. 失败原因？

 

 

 

參考文献：

1. http://www.yixieshi.com/zhichang/14567.html