IT博客汇
  • 首页
  • 精华
  • 技术
  • 设计
  • 资讯
  • 扯淡
  • 权利声明
  • 登录 注册

    java API 设计准则

    justjavac (justjavac@gmail.com)发表于 2012-05-24 00:00:00
    love 0

    原文: Java API Design Checklist

    作者: Ferenc Mihaly

    译文: java API 设计准则 (墙)

    译者: lukaseder


    在java API设计中有着许多的各种规则「只要一个返回语句」、「关于返回 Null 值的问题」 与折衷考量,和其他所有复杂任务一样,它考验着我们的记忆力及脑力. 这里我找到了一个对正在设计java API的软件开发人员而言非常不错的准则列表,其中介绍的一些准则可能是很明显的,又或者不那么显眼,但确实非常不错,希望你会喜欢.

    这里摘录了一些:

    • 优先将API与其实现置于不同的包中.
    • 优先将API放入高层包中,实现则可放在低层包.
    • 考虑将大型API拆分成若干包.
    • 考虑将API与其实现包归置到不同的java文档中.
    • 避免对API中实现类的内部依赖.
    • 避免出现不必要的API碎裂(fragmentation)情况.
    • 不要将公共实现类放在API包中.
    • 不要在调用及实现类间创建依赖.
    • 不要将不相关的API放在不同的包中.
    • 不要将API与SPI(Service Provider Interface,服务提供者接口)放在同一个包中.
    • 不要移动及重命名已发布的公共API包.

    完整的准则列表点击这里查看.



沪ICP备19023445号-2号
友情链接