协议设计注意事项


。.编码使用
避免编码使用不当,不统一.

示例:供应商ID CoEid必填-1:全部 !-1:查询指定供应商 修改为0表示全部,其它表示指定的供应商ID


0的常见语义有初始,未指定.-1通常表示错误.

保持编码在项目内一致.


。需要指明是否分页,排序方式
示例:查询常购商品(7293)
---该协议从界面上看不出支持分页。本身也未清楚说明.


。.协议功能尽量单一
示例:原操作常购商品(7294)协议中通过OperType区分加入和删除.可分拆成2个协议,7294,7296分别提供加入,删除功能。
协议对应到用例,如加入,删除常购商品是2个用例。


通常关于一个业务对象的操作,可以对应到以下几个独立的协议:
---新增
---修改
---删除
---修改状态


协议设计的常见模式有:
.列表-明细:1个协议负责查询列表,另一个协议查询具体对象的详情
.新增,修改:通常每次一个对象,通过参数传递即可
.删除:通常支持批量删除,通过行集记录传递
.状态修改:即使是批处理,通常更新到同一种状态
.是否支持批量要根据界面原型决定,特殊场景下可以同时定义单个对象和批处理2个协议

。其它

.协议参数名或行集列名与数据库表字段保持一致:可简化通用实现

.对于实现者,仅仅定义协议是不够的,它仅表示了传输内容的格式,支持开发的完整设计包括类,活动等。


猜你喜欢

转载自blog.csdn.net/wherwh/article/details/48817749