山寨版的简易表达式解析器

山寨表达式解析器的背景：

    这里说说咖啡偶为啥突然“发神经”，要自己做一个表达式解析器。首先声明，偶不是一个喜欢自己造轮子的家伙。在Java这个每天都出新东西的社区中造轮子是一件很无聊，也很没有成就感的事，嘎嘎！

    开始的时候，我们的想法就是用jBPM来实现基于SOA的跨系统的工作流（ESB的残缺版）。完成技术预演后，就发现jBPM有点不够用，主要在于：1.Handler处理模式很不错，但还是不够灵活，需要编写java代码。2.没有web图形化的界面。 3.无法支持“中国特色”的流程配制（做过OA的都知道，国内的用户需求有多么的BT）。于是乎，我们开始了对jBPM的山寨过程。

    在这个过程中，比较关键的一块就是需要一个非常简单的表达式解析器。简单到可以让工程实施人员，甚至最终用户能够用的那种。（jBPM自带的BeanScript是基于Java语言的，对用户使用还是有一定要求的）。于是就有了现在的山寨版的表达式引擎。

    我们自己做完以后，用了一下，感觉虽然功能非常的简单，但确实能很大程度的增加jBPM的Handler的灵活性。再一看，这个引擎其实跟jBPM和工作流没有必然联系的，完全可以用在其他需要动态执行脚本的环境中。咖啡想了想，貌似开源社区木有类似的东东（也许偶孤陋寡闻哈，有的话，请大家告知一声，我也学习一下），就觉得可以拿出来分享一下，也许能给大家一定的帮助。最重要的是，大家可以根据自己需要修改扩充哦～～～～
（PS: IK Expression 2.0 已经发布，请访问http://linliangyi2007.iteye.com/blog/337069）


用途

• jBPM的判断节点DicisionHanlder，根据表达式判读选取路径
• jBPM的任务分配AssignHandler，根据表达式返回任务授权人
• jBPM的Action及Event，实现简单任务，如邮件通知
• 其他的java应用，需要简单的动态表达式的地方

表达式语法规范

1. 支持的参数类型：
a) 数字型 ：

• i. 整形 integer   ： -2321 ， 34234
• ii. 长整型 long    ：3245235235L
• iii. 单精度浮点 float ： 342.555F
• iv. 双精度浮点 double： 234234.3423

b) 字符型：“a-zA-Z012456789”
c) 布尔型：true、false
d) 日期时间型：[2008-08-08] 或 [2009-01-01 12:33:14]
e) 扩展类型：List对象集合 （PS: 该类型仅作为运算结果返回，不能做输入参数）

2. 分割符：
a) 括号 "("  ")" —— 标识优先级
b) 逗号   "," —— 分隔函数的参数
c) 方括号 "["  "]" —— 标识日期型常量
d) 双引号 """ —— 标识字符型常量
e) 美元号   "$"   —— 函数前缀
f) 转义符   "\" —— 字符串转义，支持\\ , \”, \r , \n , \t

3. 支持的运算符：




4. 支持的内部函数：
内置函数是目前解析器已经实现的一些非常简单、实用的函数



功能例子说明
1. 支持+、- 、* 、/ 、%（取模） 常规的算术运算，支持括号优先级
如：常见的OA中用于年休假工资计算公式

3000 / 21.5 *（12 - 转正月份）/ 2   

其中，“转正月份”可以是上下文变量

2. 支持字符串相加 , 如：

“ABC”+（123+10） => “ABC133”;
“ABC”+ 123 + 10 = > “ABC12310”

3. 支持 > >= < <= == !=逻辑比较运算，返回布尔值
    3-1.支持数值大小比较 :

1234 > 223  —— true 

    3-2.支持字符大小比较 :

 “1234” > “223”—— fasle

    3-3.支持日期大小比较 :

 [2008-12-23] >= [2008-08-08] —— true

3-4支持各类型常量和变量同null的 == 与 != 比较 ,如：

 申请人!=null  

(其中，“申请人”为执行上下文的变量)

4. 支持逻辑与、逻辑或、逻辑非运算, 如：

true && $DAYEQUALS([2008-01-01] , [2008-11-01]) ——false
true || $DAYEQUALS([2008-01-01] , [2008-11-01]) —— true
true && ！$DAYEQUALS([2008-01-01] , [2008-11-01]) —— true

5. 支持结果集合拼接 ， 如：

1000 / 10  #  [2008-12-23] > $SYSDATE() # “ABC” + 123 

结果为包含 100 ， false ， “ABC123”三种不同类型对象的List

6. 支持函数与操作符混合、嵌套调用，如：

!$DAYEQUALS($CALCDATE($SYSDATE(),0,0 , (8+11-5*(6/3)) * (2- 59 % 7),0 ,0,0 ) , [2008-10-01])  —— true

引擎API的QuickStart
实际上，如果只是使用IKExpression，那么只要掌握两Class和两个方法，是不是超级的简单！

类org.wltea.expression.ExpressionEvaluator
方法1：

public static Object evaluate(String expression, Collection<Variable> variables)

说明：传入表达式和表达式上下文的变量，执行表达式返回结果
参数1 ：String expression, 要传入执行的表达式
参数2 ：Collection<Variable> variables 表达式上下文的变量集合（详细请看类org.wltea.expression.datameta.Variable的说明）。
返回值：表达式执行结果，可能是以下类型的java对象中的一种。
Int、long、float、double、boolean、String、Date、List
方法用途：执行表达式

方法2：

public static String compileExpression(String expression) throws IllegalExpressionException

说明：传入表达式，编译并检查表达式，返回表达式内部的逆波兰型式字窜
参数1 ：String expression, 要传入执行的表达式
异常：IllegalExpressionException 表达式异常，如方法的参数类型不正确，或者将日期型与布尔型做相等比较等，都会抛出表达式异常。
返回值：表达式的逆波兰式表示，且所有运算符将使用内部形式代替，例如，表达式

“8+11-5*(6/3)”

将变成

“8 11 PLUS 5 6 3 DIV MUTI MINUS“

方法用途：预编译表达式，检查表达式是否有语法错误

类org.wltea.expression.datameta.Variable

该类是用来表示表达式的上下文变量的，咖啡在上面的例子中用到了大量的上下文变量，这是也是表达式最有用的地方，比如：报销审批流程中,判断流程走向的表达式，（申请金额 > 10000） : “总经理审批”，需要“申请金额“变量；计算年休假津贴的表达式，3000 / 21.5 *（12 - 转正月份）/ 2需要“转正月份” 变量。这些变量通过evaluate(String expression, Collection<Variable> variables)方法中的variables参数传入表达式中。而Variable类型变量的构造十分的简单，它是标准的POJO。

方法1 ： 使用构造函数new Variable()生成Variable

public Variable(String variableName , DataType variableDataType , Object variableValue) 

参数1——变量名，如设置为“转正月份”“申请金额”，变量名可以是中文，也可以是英文，使用中文的好处是使表达式容易阅读，使得最终用户也能编写。
参数2——变量类型， 它是DataType枚举类，可以用的有

		//字符窜	DATATYPE_STRING ,
		//布尔类	DATATYPE_BOOLEAN ,
		//整数		DATATYPE_INT ,
		//长整数	DATATYPE_LONG ,
		//浮点数	DATATYPE_FLOAT ,
		//双精度浮点	DATATYPE_DOUBLE ,
		//日期时间	DATATYPE_DATE

对于集合对象DATATYPE_COLLECTION型，目前只支持结果输出，暂不支持变量的输入（可能考虑后期加入）。另外DATATYPE_NULL类型是解析器内部类型，也不对外开放，如果设置变量类型为DATATYPE_NULL型，将抛出异常。
参数3——变量值。对于变量值，唯一要注意的是，如果你的类型是“日期时间DATATYPE_DATE”，那么变量值的字符串要遵循"yyyy-MM-dd HH:mm:ss"格式

方法2： 使用静态方法public static Variable createVariable(String variableName, DataType variableDataType , String variableValueStr) 生成Variable。以上静态方法的参数同构造函数一样，请参考方法1部分参数说明。

      关于这个山寨版的表达式解析器，咖啡先谈到这里，希望这个东东对大家有用。实际上，解析器还支持非常方便的函数扩展的，举例说，你可以自定义一个 $邮件（邮件地址 ， 标题， 内容）的函数，那么，你就可以用它在表达式中发送简单的邮件提醒了,特别适用于jBPM的节点任务和事件来调用，嘎嘎！
      如果大家感兴趣的话，咖啡将继续第二部分《简易表达式解析器 之 大家一起来山寨》，计划详细说明如何扩展改造解析器功能，同时谈谈相关的函数引擎算法实现。


附件为IKExpression的jar包，以及完整的Eclipse开发环境源码（有很详细的注释哦～）和Java API DOC

评论

10 楼 linliangyi2007 2009-02-11  

midea0978 写道

问题：变量名称不能包含数字，例如
4S店价 * 1.2

兄弟，变量是不能字母打头的啊，你可以用 _4S店价。
这个很多语言都不允许吧。

9 楼 midea0978 2009-02-11  

问题：变量名称不能包含数字，例如
4S店价 * 1.2

8 楼 linliangyi2007 2009-02-11  

兄弟们，预告一下，2.0版本准备出炉啦，采用了优化过的全新算法。届时会放到google code上开源。会有更详细的文档，更强的功能。

现在进入测试和文档阶段了，预估最快在3月初能发布

7 楼 whtinj2ee 2008-12-30  

简单的才是最好的，够用就好，非常感谢

6 楼 linliangyi2007 2008-12-27  

dearshor 写道

  linliangyi2007，建议把你这个东西也放到Google Code（或其他开放协同开发平台）上，并不断完善，做大做强。相信国人一样能做出优秀的开源项目来。也许若干年以后，我们完全能在project里用上国人开发的开源项目作为infrastructure &amp; utilities了。

感谢大牛们的支持，不过弱弱的说一句，俺还没用过google code的东东，对开源开发的运作方式也是不了解的，所以有点不得其门而入的无奈。

我先找人问问

5 楼 dearshor 2008-12-26  

  linliangyi2007，建议把你这个东西也放到Google Code（或其他开放协同开发平台）上，并不断完善，做大做强。
相信国人一样能做出优秀的开源项目来。也许若干年以后，我们完全能在project里用上国人开发的开源项目作为infrastructure & utilities了。

4 楼 linliangyi2007 2008-12-25  

jindw 写道

呵呵，赞，我的JSEL和这个有几分类似。

哈哈，还找到了通道中的高人 ！JSEL走得更远些，向你学习，多多指教啊:D 。

3 楼 jindw 2008-12-25  

呵呵，赞，我的JSEL和这个有几分类似。

2 楼 linliangyi2007 2008-12-25  

superscorpio 写道

不知道mvel能不能满足你的要求。赞啊赞！

3Q,去look一下mvel为何方圣神

1 楼 superscorpio 2008-12-24  

不知道mvel能不能满足你的要求。

赞啊赞！