xmlform 错误码设计说明

原创
2021/01/19 23:07
阅读数 192

XmlForm的错误码定义,参考了SOAP规范 SOAP Fault Codes

没有采用数字形式,一是数字没有意义,不能见名知意;二是数字需要有顺序,需要全局管理,如果一个功能废弃,就会出现断号的情况。

SOAP错误码是类似java包名的形式,错误码之间用"."点号分割,越靠右错误越具体。

XmlForm错误码分为三大类:

    ok 表示成功,没有错误; 

    c. 开头的错误码标明错误是由客户端原因造成的;

    s.开头的错误码标明错误是由服务端原因造成的。

 

在XMLFormException中定义了一些常用的错误码:

    ok: 操作成功
    s.type.unknown: 未知类型
    s.type.definition: 类型定义错误
    s.type.attribute.invalid: 类型属性错误
    s.form.unknown: 未知表单
    s.form.definition: 表单定义错误
    s.app: 通用服务端错误

    c.session: 未登录
    c.action.unknown: 无效的Action
    c.action.permission: 无操作权限
    c.form.data: 提交的数据错误
    c.form.version: 数据格式版本错误

 

对于自定义错误码,使用能描述错误的英文字母格式如下:
[c|s].[模块或微服务编码].[功能编码].[原因编码]

例如,定义订单系统库存原因造成的下单失败:  

s.order.place.outofstock

XmlForm中没有强制使用字母限定名的形式,可以根据实际的业务需求任意定义错误码。

 

展开阅读全文
打赏
0
0 收藏
分享
加载中
更多评论
打赏
0 评论
0 收藏
0
分享
返回顶部
顶部