设计原则

更新时间:2017-06-07 13:26:11

针对CDP Java SDK,总体上遵循了以下几个原则:

  • Java API是CDP REST API(对下称RESTAPI)的客户端代理,通过RESTAPI访问CDP。
  • Java API不是REST API接口的一一映射,要有更高的抽象层次,符合对CDP概念的一般理解。用户容易推断各个类的用法,具有较低的学习曲线。例如对于查询接口,若查询没有找到对象而报错,RESTAPI返回错误为404(NotFound),但是考虑到JavaAPI的设计风格,在Java层面不再抛出异常,取代的是返回null。
  • Java API的设计是面向对象的,符合面向对象的设计原则。目前JavaAPI接口设计暂时不提供“语法糖衣”,所有操作是最小功能的。将来根据需求再逐步完善。
  • Java API对所有用户的入参不允许做任何修改,对于需要修改入参情况,CDP做法是拷贝一份入参,并修改后作为方法返回值返回结果。
  • Java API体现Session、Pipeline、Job等概念模型的层次结构,例如Pipeline.start(Job),用户必须持有Pipeline才能启动Job。