Skip to content

错误码使用

错误码规则

错误码建议长度为 6 位,其中前两位为模块英文前两位,后 4 位为数字;例如:RB1001

错误码分类

  • 系统内部错误码
  • 系统外部错误码

当系统与外部系统对接时,如果需要将内部错误码转化为外部系统错误码,此时需要配置系统外部错误码。

错误码定义

系统错误码统一定义在系统配置文件夹 resources/config 目录下,默认有两个配置文件分别用于配置内部错误码和外部错误码。其中:

  • XX_errorCode_zh_CN.config 用于配置内部错误码;
  • XX_errorCode_zh_CN.xml 用于配置外部错误码;

当同一错误码在两个文件都配置时,系统将采用 XX_errorCode_zh_CN.xml 文件的配置信息。

示例

XX_errorCode_zh_CN.config文件

properties
CI3001:证件号不能为空
CI3002:证件类型不能为空
CI3003:证件签发国家不能为空

如果错误信息中有变量,则使用以下方式:

properties
CI4012:[{}]和关联客户[{}]的关联信息已存在!

XX_errorCode_zh_CN.xml文件

xml
<errorCode code="CI3027" message="批次开户序号不能为空!" outCode="HX1001"/>
<errorCode code="CI3028" message="客户号英文名称不一致!" outCode="HX1002"/>
<errorCode code="CI4001" message="[{}] 客户状态不存在!" outCode="HX1003"/>
<errorCode code="CI4002" message="[{}] 客户信息不存在!" outCode="HX1004"/>

code 表示内部错误码,message 表示错误提示信息,outCode 表示对应的外部错误码。

错误码具体使用请参考异常处理章节!