脚印:关于错误编码的管理的一些思考

需求

错误编码定义的混乱带来了后期的管理和维护的问题:

1)应用内编码重复问题;

2)关联应用间编码重复问题;

3)干系人无法通过错误编码快速定位出现问题的应用;

4)各应用的错误描述没有统一的管理站点进行修改和查看;

这是由于目前应用各自定义了持久化实体,如XML资源文件数据库等。不同形式的数据源和格式定义,导致各应用需要自行开发管理站点;

运维/客服人员不能在统一的管理平台上查询错误描述,降低了工作效率。

解决方案

开发规范中应明确指出, 在跨越应用程序边界时传递错误,如果错误是以错误编码方式定义的,必须添加返回方的应用标识作为前缀。

定义实现层面的规范,方便自动化处理和错误定义的统一管理:

  1. 统一错误在项目中定义的实现手段 比如利用枚举类型;基类型指定为整型,标识错误编码;标准注释中添加对应的错误的文字描述;
  2. 在统一的实现手段的基础上,即可利用工具自动化相关任务,降低规范执行的成本。 例如,根据枚举定义:
    1)自动生成对应的持久化实体(如XML)或可创建持久化实体的脚本(如创建数据表); 2)自动生成根据错误编码,从持久化实体中获取错误描述的代码;

  3. 有了前述基础,可提供错误定义的管理站点,展现并管理所有的错误定义,数据源即为各应用创建的统一数据源和格式定义的持久化实体。``

 

posted @ 2012-03-13 16:04  sinlight23  阅读(424)  评论(0编辑  收藏  举报