Java 接口规范与最佳实践

• 可理解

• 文档完善

• 格式统一：这里涉及很多方面，包括：接口返回类型、命名规则以及参数顺序

  • 在我们所有的API方法中，要么是全是getXYZ()格式，要么全是xyz()，最好不要两种格式都有。
  • 假设我们有方法重载，原始方法接受参数Object...，重载方法接受参数为Collection<? extends Object>，那么，重载方法不能部分可见

• 恰到好处的适用：作为一名开发人员，很自然的一种本能就是尽可能的开发提供大而全的服务接口，但这样做可能会带来两个问题：1. 接口过于笨重，接口调用方可能需要额外消化一些不必要的业务逻辑来理解接口实际含义。2. 接口暴露越多，维护负担越重。因此，所谓恰到好处的适用就是这个含义：

  • 接口应功能单一，并且能正确响应
  • 了解接口潜在用户及目标

• 一定范围、时期的使用受限：我们都知道开发接口非常容易，但事情远非一蹴而就那么简单，接口背后带来的是服务承诺。接口的服务成本依赖于很多因素：项目的实际情况以及社区本身，比如，有些项目可能非常乐于变更，但有些项目（比如JDK）则期待尽量保持稳定，这是两种极端状态，但，对于绝大部分项目来说&#