JAVA api设计的一些原则

1,将api与其实现置于不同的包中
2,将api放入高层包中,实现可以放在底层包中
3,考虑将大型api拆分成若干个小包
4,考虑将api与其实现包归置到不同的java文档中
5,避免api与实现类内部依赖
6,避免不必要的api碎片
7,不要将公共实现类放在api包中
8,不要在调用和实现类之间创建依赖
9,不要将不相关的api放在同一个包中
10,不要将api与spi(服务提供接口)放在同一个包中
11,不要移动及重命名已发布的公共api包

12建立强有力的条款,随着api的不断增长,这些条款被重复使用,他们看起来很相似,需要通过命名来区分
   execute(String)
   executeBatch()
   executeQuery(String)
   executeUpdate(String)
13,组合上用运用对称。一旦你创建强有力的条款,你会开始将他们结合起来。当你看到JDK收集APIS,你会注意到它们以对称的方式创建条款add()、remove()、contains()等等
14,使用重载人们之所以使用方法重载,主要是因为它给程序带来了许多方便。你经常希望在不同的地方做相同的事情,但每次去构造方法又很繁琐,那怎么办?你只需为API用户在相同的方法里提供额外的变量,并且把参数类型设置成友好型(friend)。
15,参数顺序一致,为了确保参数顺序的一致性,把数组类型放在第一位会给你带来很多好处

违反例子:
    regionMatches(int, String, int, int)
    regionMatches(boolean, int, String, int, int)

   a1.很难理解明白这两个方法之间的差异,而且可选的布尔参数排在参数列表的最前面。
   a2.很难理解每个int参数的作用,在一个方法里有过多参数
16,建立返回值类型,当涉及到返回值类型时,你应该创建一致的、正规的API,下面提供一套设置规则
   b1.当方法返回一个单独的对象,但并没有对象被发现时,应该返回null。
   b2.当方法返回多个对象,但并没有对象被发现时,应该返回空List、Set、Map、array等,而不是null。
   b3.方法应该抛异常以防万一
17,通用原则
  c1.亲密性
  c2.对比
  c3.对齐
  c4.重复 

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值