接口设计

blogs / 编码心路历程--接口设计

返回目录

好的接口应该让调用者能从名字大致猜到它的语义和常见副作用;复杂行为应通过更高层、带业务含义的动作函数来封装,而不是把所有细节暴露在低层接口上。

  1. 函数名称设计

    名称应表达其意图

  2. 函数副作用

    底层简单函数接口应简化或仅包含其函数名直接展示的意图相关的副作用;

    复杂的副作用应包装为更高抽象的函数,用业务或动作来抽象其名称,并且包含类似副作用的函数使用类似的签名如enter_table,enter_room,leave_room,leave_table,这样可以通过了解一个函数的副作用猜测其他函数的副作用。