通用的业务编号规则设计实现(附源码)
通用的业务编码规则设计实现(附源码)
一、说明
本篇博客参考 http://www.cnblogs.com/xqin/p/3708367.html, 但源博客贴出了部分代码,对部分代码没有过多的解释。本篇针对想参考现成的完整代码的人。
二、背景
1、概要
每一个企业应用中不可避免的都会涉及到业务编码规则的问题,比如订单管理系统中的订单编号,比如商品管理系统中的商品编码,比如项目管理系统中的项目编码等等,这一系列的编码都需要管理起来,那么它们的应该如何编码的,具体的编码规则我们很多时候都是直接写在程序当中
2、分析
常用的的编码有:
1、数据库自增长ID或最大值加1
2、GUID
3、时间戳
4、常量+自增长
5、常量+时间戳+自增长
6、根据单据属性编码 比如商品编码:第X是代码商品颜色,第Y位是代码商品产地
7、自定义函数处理返回
8、其它
3、思考
第一个问题就是单据编码的时间顺序:
1、新增前先预取得新单据编码 优点是保存处理很简单,而且保存后不需要再刷新UI,缺点就是如果放弃表单那么编码计数已经跳号,做不到连续的单据号,而且没法实现上面编码的第6种情况。
2、保存时才生成单据编码 缺点是保存比较麻烦点,而且保存后需要再刷新UI中的单据编码字段,但是如果是需要根据单据属性编码,那就必做得使用这种方式了,而且能做到单据连续。
第二个问题是这个编码该怎么去取,怎么保证唯一性 。
这里要看是使用哪种编码方式,比如 max + 1 这种方式 就直接检索数据库 select max(id) + 1 from table 取得编码,如果是GUID则比较方便,但是GUID看着实在是有点恶心,使用时间戳的话如果精确到秒的话是没办法保证唯一性的,即使精确到毫秒理论上也是不行的。其它复杂的编码获取就更麻烦点了。总之不是很方便就能取得。 第三个问题如果这个编码规则需要更换怎么办 这个如果没有特别设计编码规则一般都要修改程序,没办法说不动程序直接修改配置就能实现
三、目的及设计
1、设计
鉴于以上几个问题,我们想设计一个比较通用的业务编码规则模块,以后的项目也可复用,它应该要实现以下功能及特点:
1、满足各种编码规则的需求
a.背景中提到的那7种都要实现,还要求各种规则可以自由组合
b.依赖重置,比如日期变化时序号自动重置为1
2、拓展性强,可添加自定义规则
3、通过配置文件或数据进行配置,修改业务编码规则只需要修改配置文件或数据
4、使用简单
2、数据库设置
我们先从配置来设计,我们把规则配置放在数据库中,可以考虑以后再做个界面来管理这些配置。设计2张表来保存这些规则
1、单据编码
2、单据编码规则 用来存储基础规则组合,一种单据编码对应多种规则
3、调用
public class PurchasingApiController : ApiController { private ISequenceFactory _sequenceFactory; public PurchasingApiController(ISequenceFactory sequenceFactory) { _sequenceFactory = sequenceFactory; } //取得主表的BillNo public string GetNextBillNo() { var sequence = _sequenceFactory.Create("sdx_purchasing"); return sequence.Next(); } //用BillNo过滤取得从表中的RowId public string GetNextRowId(string key) { var sequence = _sequenceFactory.Create("sdx_purchasingLine"); sequence.SetValue("BillNo", key) return sequence.Next(); } }
Sequence对象中主要就是一个Next()的实现
4、代码结构
稍微解释说明下:
1、DefaultSequenceFacotry 继承自接口ISequenceFactory负责构建Squence
2、Sequence 继承自ISeqence是採番的主要处理类,此类里可以设置上下文数据
3、SequenceContext Sequence上下文对象,保留着数据库的直接信息或者从数据库取出通过工厂模式创建的信息
4、Resets文件夹中类 继承自ISequenceReset,由SequenceResetFactory构建,处理重置的对象,比如今天的编号A20160130-001到A20160130-010,那么当明天到了编号需要重置成A20160131-001
5、Rules文件夹中类 继承自抽象类SequenceRuleBase,由SequenceRuleFactory构建,就是一系列规则信息
6、IClassSequenceHandler 自定义类规则接口,实现这个添口可添加自定义规则,SequenceHandler中是两个自定义类规则的实现 。(例如:商品编号需要受到商品颜色和其他属性影响的条件下)
5、实例
一个简单的例子:一般的编号形式是WT20160131001 其中包括3个规则,它在数据库的存储为:
a:主表T_Sequence存储重置信息及其他
程序根据表中SequenceReset反射调取相应的重置实现,根据CurrentCode判断什么时候去重置。
b:T_SequenceSetting表存储规则
程序根据RuleName去反射调用相应的规则类。
四、源码
针对源博客没有给出Sequence的完整代码。在理解作者的思想下已经补充完整:
源码下载:百度网盘链接:http://pan.baidu.com/s/1hrk3N2s 密码:man6