服务与联调
报错规范
禁止吞掉底层原因,返回模糊的报错,类似”系统异常“、”未知错误“
报错信息应让调用方、测试、业务们能一眼就看出原因,尽量用中文
经常遇到业务同学反馈系统报错,一看 Password is Wrong,后来改成中文就没再找了。
查问题时顺手优化日志与报错中不合理之处
最理想的状态是调用方看到调用结果就能知道为什么,其次是自己看到就能知道为什么, 如果需要花些时间去查日志、数据库、缓存等环境或配置的话说明接口的体验还做得不够。
联调测试环境应返回流水号、数据库分库编号、缓存实例、容器名、机器名、IP等,以便快速排查问题
用profile
或数据库配置等方式区分好环境,避免在生产上返回
联调测试环境的错误提示可以说明解决方法
输出排查的 SQL、缓存键、依赖系统也是可以的
报错码中增加应用前缀,但禁止在调用时写其他应用的前缀
实践下来对问题排查非常有帮助