EasyRule规则引擎设计及使用说明.docVIP

PAGE \* Arabic 3 / NUMPAGES \* Arabic 10 规则引擎使用文档 2012年10月 目录 TOC \o 1-3 \h \z \u 1. 设计背景 2 2. 什么是规则引擎 3 3. 体系结构 3 4. 如何调用规则引擎 5 5. 配置使用说明 6 6. 引擎现有的公式、函数 8 7. 扩展规则引擎 9 7.1.扩展函数 9 7.2扩展公式 9 8 结束语 10  设计背景 复杂企业级项目的 开发以及其中随外部条件不断变化的业务规则(business logic),迫切需要分离商业决策者的商业决策逻辑和应用开发者的技术决策，并把这些商业决策放在中心数据库或其他统一的地方，让它们能在运行时（即商务时间）可以动态地管理和修改从而提供软件系统的柔性和适应性。规则引擎正是应用于上述动态环境中的一种解决方法。 什么是规则引擎 为了进一步规范系统数据的有效性、完整性，加强对数据的校验在目前各个系统是必不可少的一部分，规则引擎实现对系统数据的纵向、横向校验以及表与表之间逻辑关系校验，它可以作为一个子模块添加到任意以JAVA为基础的系统当中去，同时制定相关接口规范，开发人员只需按照规范便可以对它进行二次扩展性的开发。 体系结构 规则引擎由以下六大部分组成： 函数：负责对数据的格式化处理，比如数据统计。 公式：负责对数据的逻辑处理，比如值之间比大小。 规则配置文件：配置校验数据的规则。 规则模型配置文件：配置校验数据规则的集合。 公式、函数配置文件：配置系统所有相关的函数以及公式。 引擎主程序：调用规则引擎的入口。 数据库配置文件：与数据库相关的配置文件。 以上几大部分均可由开发人员灵活配置以便后续再次扩展，程序类包机构如下如下： 类图如下： 如何调用规则引擎 将规则引擎作为子模块加入的主业务系统后，主业务系统只需在程序里调用规则引擎的com.git.easyrule.service.RuleService类的runRule()和runModel()方法即可，规则引擎启动之后便根据自身的规则配置项对数据进行校验处理，处理结果将存入规则文件配置的指定表当中。 在调用RuleService类的runRule()和runModel()方法时需传入几个参数，以下表格是参数说明： 参数名 类型 中文说明 备注 RuleID/ModelID String 规则ID/规则模型ID 数据校验规则文件 paramMap MapString,Object 参数对象 后台所有规则需要用到的变量集合 源方法代码： RuleService rs = new RuleService(); MapString,Object paramMap = new HashMapString, Object(); paramMap.put(num, 1); paramMap.put(cardNo,; ListMessageObj msgList = rs.runModel(M0002, paramMap); ListMessageObj msgList = rs.runRule(R0001, paramMap); 配置使用说明 规则引擎的配置由三大部分组成： 数据库配置:配置被检测的数据源。 公式函数配置:系统所有的公式函数类由该配置文件管理。 校验规则配置：系统所有的规则由该配置文件管理。 校验规则模型配置：系统所有的规则校验模型由该配置文件管理。 数据库配置文件env.properties 规则引擎的数据配置既可以共用主业务系统的配置文件，也可以独立采用该文件对其进行灵活配置，以下是具体的配置说明： 配置项 中文说明 备注 easyDriver JDBC访问数据库的驱动 easyUrl 数据库路径 easyUsername 用户名 easyPassword 密码 公式、函数配置文件ruleEngine_beans.xml 具体详细请参考本配置文件里的内容，本文件是标准的Spring配置文件。 数据校验规则文件ruleEngine_rules.xml rule节点：对表数据的纵向校验以及逻辑校验。 节点 属性 含义 备注 rule id 规则ID name 规则名称 checktype 检测的公式 1.该ID应与 ruleEngine_beans.xml 配置的ID保持一致。 2.公式可以有多个，以“-”符号分隔。 startValue 范围顶值 endValue 范围底值 checkedFieldName 被检测的值 errCode 错误码 errMsg 错误信息 targetD