关于接口返回码描述增加自定义功能
一)建议自定义成功描述,如下: returnCode: 1000
description: 操作成功: 处理成功条数:2; 处理失败条数:0 二)自定义描述分析 1:优点 自定义可以补充接口描述,便于用户理解,同时也方便后期与用户的接口调测 2:缺点 不便于管理,重用低,不合理的描述容易误导接口使用者。 三)管理建议 1:应对特殊模块的返回码,如要自定义可以合设计人员确认,认可后方可使用。 2:接口描述:应该包含两个部分 description:目前的des:接口调用结果明细(可以省略) 四)设计建议 1:建议返回码明细定义在一个ResultDescInfo class中
2:配置文件中增加一个描述明细获取的开关 ead.desc.info.switch = on 如果为on ,可以获得描述明细 如果为off,返回空字符; 热插拔,耦合低,仅是在不使用描述明细的时候会产生少量垃圾代码,如下: getReturnCodeDescInfo(ResultCode.NMS_EAD_SUCCESS,4,"自定义描述信息") ;