美文网首页
一般api设计使用基本原则

一般api设计使用基本原则

作者: freebell | 来源:发表于2017-03-20 22:05 被阅读0次

    1.在相同的模块中,严禁在回调中使用该模块除了get语意的接口,尤其是close,stop之类的action接口除非底层做了相应处理。不能使用该属性通知而又通过get该属性,原则上面,该接口可能是无效的。

    2.要区分reset,flush和Finish的语意场景,原则上调用了reset之后,所有的接口get类的接口都不可以再调用,直到重新初始化或者set接口之后,往往用于实时环境,需要快速返回的情况。而flush的接口往往在使用在确保之前的接口都应该将数据或者状态传递到最后一个知情者。Finish而使用者在确保所有的接口行为都已经执行完成。因此熟悉这类的接口将有助于理解以及设计相应的接口。偏于沟通理解,防止误用。

    3.接口应该成双成对出现,比如open与close,play和stop,一个完备的软件体系必须从起点出发,也有相应的途径返回到相应的起点。

    4.接口的设计语意功能应该适度,最好可以用一句言简意赅的陈述该接口的意义,另外需要考虑上层该接口的使用场景。

    5.接口设计应该可以多层次化。一个好的接口设计体系即可以非常方便实现通用的功能,也能满足特定的场合使用。在这个情况下,接口多层次化也可以清晰展现给上层开发人员。

    6.所有的接口都应该有返回值,除了对相应对象最后的销毁方法可以用void类型,也应该提倡用void类型,另外,上层需要判断每个接口是否操作正确。

    7.所有的接口设计功能要保持单一明确,接口名要规范,接口直接需要保持适度的冗余与一致。

    大概的经验之谈。

    相关文章

      网友评论

          本文标题:一般api设计使用基本原则

          本文链接:https://www.haomeiwen.com/subject/lcppnttx.html