MLH 统一返回码使用教程

1. MLH返回码规范

ajax 请求返回的json数据都需要包含:
{
   code : "0",
   msg : "信息"
}
code 非0代表异常

2.  引入响应的jar包

<dependency>
<groupId>com.palm.mlh</groupId>
<artifactId>mlh-common</artifactId>
</dependency>

3. 注入RetCodeService类

@Autowired
private RetCodeService retCodeService;

4. 替换返回结果

  根据我们的规定,json数据返回结果中,都包含有code、msg信息,如:

retCodeService.replaceRetCode(ctx, resultJson)会根据resultJsonmsg值去缓存中查找并替换成定义好的code/msg

替换后的结果:



5. 主要根据msg中的信息替换,所以代码中resultJson中code = -1标识为异常就可以了,返回时会替换回正确的code



6. 添加返回码

两种方法添加:

在mongodb上直接添加:


单元测试RetCodeServiceImplTest上运行addRetCode添加:

msg_+地区,主要是为了横向扩展,国际化提示消息,详细实现可以查看 RetCodeServiceImpl.replaceRetCode

备注:由上面可以知道,resultJson中msg信息就是d_ret_code集合中的key,不要纠结这点






posted @ 2016-05-25 18:13  kaishui  阅读(402)  评论(0编辑  收藏  举报