接口设计原则
- 接口类型
- 简单数据查询接口:action、facade、dao
- 带业务逻辑的数据查询接口:action、facade、biz、dao
- 简单的数据写入接口:action、facade、dao
- 带业务逻辑的数据写入接口:action、facade、biz、dao
- 同步接口
- 异步接口
- 设计原则
- 接口粗粒度 一个接口代表一个完整的业务功能
- 减少系统间的网络交互
- 防止业务接口数量爆炸
- 解决Dubbo接口的事物问题。
- 接口粗粒度 一个接口代表一个完整的业务功能
- 接口版本
<dubbo:service interface="com.XxService" version="1.0" />
- 为后期不兼容升级提供可能
- 接口兼容性
- 可兼容 :
- 增加方法
- 服务模型增加字段
- 不兼容 需要变更版本号
- 删除方法
- 删除模型字段
- 枚举类型新增字段也不兼容
- 可兼容 :
- 异常处理
- 使用抛出异常来汇报错误,而不是返回错误码,异常信息能携带
更多信息,以及语义更友好。
- 如果担心性能问题,在必要时,可以通过override掉异常类的
fillInStackTrace()方法为空方法,使其不拷贝栈信息。 - 查询方法不建议抛出checked异常,否则调用方在查询时将过
多的try…catch,并且不能进行有效处理。
- 如果担心性能问题,在必要时,可以通过override掉异常类的
- 使用抛出异常来汇报错误,而不是返回错误码,异常信息能携带
- 必要的接口输入参数校验
在Provider上尽量多配置Consumer端属性
作服务的提供者,比服务使用方更清楚服务性能参数,如调用的超时时间,合理的重试次数,等等
在Provider配置后,Consumer不配置则会使用Provider的配置值,即Provider配置可以作为Consumer的缺省值。否则,Consumer会使用
Consumer端的全局设置,这对于Provider不可控的,并且往往是不合理的。
服务系统划分
- 按业务独立性垂直划分
- 本书无状态
- 注意事项