在项目中或者工程中,难免需要设计API,因为一个系统不可能一个人来搞定,需要很多人协作,那么在你设计你的API的时候,需要注意几点。

谨慎地选择方法的名称

方法的名字应该始终遵循标准的命名规范,而且要很好理解,例如我们想使用英文来简单解释一个类方法的含义,那就用吧,但是您别没事在整几个全拼,好吧,不过瘾再来几个阿拉伯数字,例如 woyun()  woyun1()

不要过于追求提供便利的方法

每个方法都需要尽其所能,方法太多容易使类难以学习,只有一项操作被频繁的使用时候,考虑将其快捷方式化,不能确定的还是不用提供了。

避免过长的参数列表

很多人都很难记住很多的参数,好吧四个是我的底线,你要是弄个几十个参数我需要考虑还是不用你的API了:)如果参数太长,考虑使用数组,或者集合吧再不然Bean类。

如果对于参数类型,要优先使用接口而不是类,只要有适当的接口来定义参数,那就用接口,例如,没有理由在编写方法时使用HashMap类,可以使用Map接口,这样可以传入一个Hashtable,HashMap,TreeMap,这样相对灵活一些。