错误码规范

错误码规范的好处

1.看到错误码就大概知道哪儿出了问题

2.方便制定错误码

3.减少服务内错误码重复的情况

规范如下:

错误码长度:六、五位数,示例:1-11-11,共分为三个模块,解释如下:

第一位

第二位

第三位

第四位

第五位

A

B

B

C

C

表示模块报错位置

代表函数位置

函数内错误位置

 

A模块,表示模块报错位置,1代表接口层(controller1-0000),2代表service层(2-0000),3表示model层(3-0000),4表示定时任务错误(4-0000),5表示初始化错误(5-0000

B模块,两位数字代表函数位置(接口函数,service函数,model函数),0199,例如1-01-01,表示第一个接口函数的错误

C模块,表示函数内错误位置/内容,普通报错01~98panic错误99,自己还可以定义一些常用的错误码,例如01表示网络超时等。示例2-01-02service层(文件比较多,可以将两个码再拆分一次,分别表示文件和函数)的第一个函数第二个报错。示例1-01-99,接口层的第一个接口发生了panic

 

举一个完整示例:

30203model层第二个函数的第三个报错(不一定严格是第三个,毕竟代码本身也时常改动,没必要为了严格的错误码浪费自己的时间)

你可能感兴趣的:(错误码规范)