用BeanShell实现公式管理>
用BeanShell实现公式管理
内容：
前言
BeanShell简介
JDOM简介
公式管理系统的目标
公式管理系统的设计
何时应用BeanShell
更好的了解该系统
结束语
参考资料
关于作者
Java 专区中还有:
教学
工具与产品
代码与组件
所有文章
实用技巧
使用Java脚本构建强大、灵活的公式管理系统
杨铁军(yattie@163.com或helloyattie@hotmail.com)
Java技术爱好者，系统设计师
2003年7月
在很多中大型的应用中，如SCM（供应链管理）、CRM（客户关系管理）和ERP（企业资源计划）等，使用者往往要根据自身的需求，灵活的对某一些参数值进行变更，使得按照某固定公式计算的结果符合目前的情况。如不同时期商品价格的折扣率需要根据实际情况进行调整，或者职员的奖金百分比要根据公司的业绩而定。这就需要有一个强大的公式管理机制来对一些参数进行灵活调整。本文用BeanShell（一种Java 解释器）实现了一个这样的公式管理系统。从该系统的实现我们可以了解到BeanShell带给我们灵活的Java 脚本机制；并且，我们还可以在该系统的基础上，定制自己的公式管理系统。
前言
客户的需求是在不断变化的。虽然他们说现在他们公司的职员奖金应该就是按照那个公式计算，但是过了几个月他们会告诉你这个公式并不是很合理，还需要加一些参数。你可能会说，这个没问题，我们可以改程序。但是当这样的变更不是一次一个的发生，而是频繁的、大量的出现时，你也许就在想应该有一个公式管理系统来完成这些琐碎却很重要的变更了。是的，在很多系统中已经这样做了。这里将介绍一种简单的、易扩展的公式管理系统，它采用简单灵活的BeanShell脚本机制，并且结合JDOM技术来实现。在阅读本文以前，你需要对BeanShell和JDOM有所了解。
BeanShell简介
BeanShell是一种Java 解释器，它包含的脚本语言基本与Java 语言兼容，具有体积小、简单、符合Java 风格等特点。本文不是介绍BeanShell的语法和用法，而是基于BeanShell脚本实现一个公式管理器来说明BeanShell的强大脚本功能，从而简化Java程序员的编程工作，使他们更深入的了解什么时候使用BeanShell技术将使得构建的系统更灵活。你可以阅读参考资料了解更多BeanShell的知识。类似的Java脚本技术还有DynamicJ等，想要详细了解它们的更多信息，请查阅后面的参考资料。（请注意：这里的Java脚本不是Javascript。）
JDOM简介
JDOM使得用Java操作xml文件更轻松。这里使用xml文件格式对用户的自定义公式库进行存储，即简单又容易管理。利用JDOM技术，能够简单、快速的完成这个任务。如果你想详细了解有关JDOM的知识，请查阅文章后面的参考资料。
公式管理系统的目标
公式管理系统实现的主要目标是：用户可以根据自己的需要自定义公式，包括添加、修改和删除公式或者公式包含的参数；提供接口使得用户或其它系统能够利用公式库中的公式进行计算求值。从以上系统的主要功能，可以知道该系统主要包含两个用例：自定义公式和计算表达式。自定义公式是用户预先定义好某公式包含的参数（包括参数名、参数类型等），然后将这些参数用运算符按照一定的法则组合成所需要的公式。公式定义好后，将被保存到公式库中，供以后用户或其它系统计算时调用。这是管理者根据自身的需求，灵活更改公式或公式包含的参数的系统功能；计算表达式是用户给相应参数赋值，然后指定要遵照的公式进行计算求值。这是该系统提供给使用者的外部接口。一般的，使用者只需要提供要遵照的公式ID和相关的参数值，就可以调用该接口进行计算。该系统的用例图如下：
图1. 公式管理系统用例图
公式管理系统的设计
明确了系统的目标，我们第一步要做的就是找出系统的核心类。首先，我们需要一个公式管理器（FormulaParser），它负责将用户自定义的公式转换成系统格式并保存到公式库中，它提供外部接口，供外部需要根据公式计算时使用；我们还需要一个计算器（Calculator），它的工作就是进行计算。它包含了所有的运算类型，如加、减、乘或除，当然还可以包含大（小）于、等于等其它运算，可以根据需要进行扩展；最后，我们还需要一个公式类（Formula）。顾名思义，公式对象就代表一个公式。公式管理器就是一个管理者，它既要接受用户的自定义公式，又要提供接口给外部系统，调用相应的公式并用计算器进行计算。该系统的核心类如下图所示。
图2. 核心类图
很显然，这样的类设计有利于BeanShell的实施（笔者一直认为：设计人员中至少要包括一位语言专家，这样才能设计得更灵活、更简单，为编码阶段做铺垫）。那么，BeanShell应用于系统哪一部分将最为合适呢？
何时应用BeanShell
答案是要根据实际情况而定。你可能会说这是废话，但是这是事实的真相。一般的，当系统的某个部分变化很多，而且需要根据实际情况动态的调用一些方法和参数，那么你可以试着去实施BeanShell到你的系统中。如果你发现问题变得简单而且灵活性大大提高，那么BeanShell就值得你去试一试；相反的，如果你发现问题不仅没有简化，甚至变得更加复杂，那么你就要考虑一下你的方法是否合适，或者找一些BeanShell应用专家交流一下。注意，我们不是追求新技术，而是追求一种能够提高我们生产效率的新方法。
那么，在这个公式管理系统中我们如何应用BeanShell技术呢？从以上的分析我们知道，该系统中用户需要将自定义的公式保存起来，以供外部系统计算时调用。设想一下，当外部系统调用该接口时，它至少应该传入两个参数：一个是计算需要遵照的公式ID；另外一个是一个Hashtable对象，存放"参数名－参数值"列表。FormulaParser类接收到这些参数后，根据公式ID从公式库中装载指定的公式，然后将参数值赋值给公式包含的对应参数，最后根据定义好的公式表达式进行计算求值。在没有BeanShell以前，我们一般通过分析字符窜的方式完成自定义公式到系统格式公式的转换、参数赋值、表达式求值等，这样做虽然比较直接，但是很复杂，尤其当运算符、运算优先级很多的时候。笔者就曾经见过一个1000多行代码的公式解析器，而且功能很简单。原因就在于它的大部分代码是在做字符窜的解析。那么，你应该抓住了问题的所在。我们试试让BeanShell来完成这些解析工作。
首先你必须对BeanShell脚本的语法有所了解，并且应该熟悉一下它的文档中的几个例子。然后我们将重点放在BeanShell应用的地方――外部接口caculateByFormula(Formula formula, Hashtable parameters)。其中的两个参数，formula是计算要遵照的公式，parameters是"参数名－参数值"列表，它的返回值是计算的结果。假设公式库中我们已经定义好了两个公式，分别是商品折扣后价格公式和职员奖金计算公式。公式库xml文件如下所示：
清单1.
<formulas>
<formula id="1001" name="F_DISCOUNT">
<parameters>
<parameter type="double" name="price"/>
<parameter type="double" name="discount"/>
</parameters>
<script>result= Calculator.mutiply(price, discount)</script>
</formula>
<formula id="1002" name="F_BONUS">
<parameters>
<parameter type="double" name="sale"/>
<parameter type="double" name="score"/>
</parameters>
<script>result= Calculator.add(Calculator.mutiply(sale, 0.1),Calculator.mutiply(score, 10000))</script>
</formula>
</formulas>
公式库中每个公式有一个唯一的ID来标识，并且有一个易记忆的名字。每个公式包含一个parameters元素和一个script元素，它们分别对应公式包含的参数列表和公式计算脚本。公式计算脚本就是BeanShell脚本。这样做的好处是：无需对表达式字符窜的解析，用BeanShell解释器来完成对脚本的求值。下面的代码简洁的完成了对表达式的求值：
清单2.
public double caculateByFormula(Formula formula, Hashtable parameters) {
double result=0.0;
try
{
Interpreter i = new Interpreter();
// 实例化一个BeanShell解释器
i.eval("import parse.*;");
//引用公式管理系统
Vector para= formula.getParameters();
//获取公式中包含的参数列表
Iterator it= para.iterator();
//设置参数值
while (it.hasNext()){
String[] dec= (String[])it.next();
String declare= dec[1]+ " "+ dec[0];
i.eval(declare);
String value= ((Double)parameters.get(dec[0])).toString();
if (value != null){
String assign_value= dec[0]+ "="+ value;
i.eval(assign_value);
}else{
System.out.println("caculateByFormula():"+ dec[0]+ "参数名不符或改参数不存在"); System.exit(1);
}
}
//参数设置成功，根据公式计算脚本进行计算，仅用了一行代码就完成了求值过程，BeanShell值得你去了解 i.eval(formula.getScript());
Double rst= (Double)i.get("result");
result= rst.doubleValue();
}catch(Exception e){
System.out.println("caculateByFormula():"+ e.getMessage());
}
return result;
}
也许你曾经用解析字符窜的方法做过类似的编程工作，当你看到这里仅用一行代码就完成了对表达式的求值，是不是很惊讶？首先，实例化一个BeanShell解释器，然后将要使用的系统包import 进来，Interpreter.eval()方法就是对括号内的脚本求值或者说是解释执行脚本。然后，将formula的参数取出来，用BeanShell脚本方式声明这些参数，再将parameters中参数对应的值再次用BeanShell脚本的方式赋值给对应的变量。请注意，如果这时候传入的参数名不正确或者是参数名对应的参数类型不符，就会抛出系统异常。如果参数设置成功，则调用formula的公式计算脚本。仅用一行代码，BeanShell完成了大部分的工作：i.eval(formula.getScript())。最后，从解释器中取得计算结果，该结果存放在result变量中（可以查看清单1.中公式计算脚本）。现在是不是觉得BeanShell是一个好帮手？只要使用恰当，BeanShell将帮助你大大简化你的编程工作，这是一件非常快乐的事情。
另外，装载formula使用了JDOM技术，它从公式库中找到对应的公式，然后将该公式的参数列表以及计算脚本读出来组装成一个公式对象。见如下代码：
清单3.
public Formula loadFormula(String formulaID) {
Vector paras= new Vector();
try{
SAXBuilder builder= new SAXBuilder();
Document doc= builder.build(prefix+ "Formulas.xml");
//prefix是一个字符窜，用来指定公式库实际所在的位置
Element root= doc.getRootElement();
List formulas= root.getChildren("formula");
Iterator it= formulas.iterator();
Element formula= null;
while( it.hasNext()){
formula= (Element)it.next();
if(formula.getAttributeValue("id").equals(formulaID)){
break;
}
}
//获取参数列表
List parameters= formula.getChild("parameters").getChildren();
Iterator itp= parameters.iterator();
while(itp.hasNext()){
String[] s_para= new String[2];
Element e_para= (Element)itp.next();
s_para[0]= e_para.getAttributeValue("name");
s_para[1]= e_para.getAttributeValue("type");
paras.add(s_para);
}
Element script= formula.getChild("script");
String s_script= script.getTextTrim();
return new Formula(s_script, paras);
//将读出的信息组装成一个公式对象
}catch(Exception e){
System.out.println("loadFormula():"+ e.getMessage());
}
return null;
}
更好的了解该系统
上面介绍了系统应用BeanShell的部分，也就是系统的外部接口实现部分。你可能觉得有些迷惑，不是要自定义公式吗？怎么公式库早就有公式了呢？其实细心的读者早就发现，要自定义公式完成系统的另外一个重要功能并不是什么难事，你甚至可以想到直接编辑公式库来添加、修改、删除公式。当然你可以开发一个友好易用的自定义公式界面，你完全可以这样做。你需要完成的只是将用户输入的自定义公式信息（包括公式的参数及参数类型，运算表达式）转换成公式库中的参数列表和公式计算脚本。如果你要这样做，你不可避免的陷入到字符窜的解析当中去了。不过建议不要这样做，因为用户来写公式计算脚本将是可行的。再看看公式库的两个公式计算脚本，相信你会同意这一点。因为本文的讨论重点是BeanShell应用，所以这部分工作不做详细讨论，读者可以选择一个合适的方式来完成自定义公式的用户接口。下面是该系统的循序图和FormulaParser的状态图，能够帮助你更好的理解该系统。
图3. 调用公式计算外部接口
图4. FormulaParser状态图
最后，我们给出一个测试用例来说明如何使用该系统。公式库中有两个公式，一个用来计算商品折扣价格，一个用来计算职员奖金。我们将公式包含的参数值传给系统外部接口。见下面代码：
清单4.
FormulaParser fp= new FormulaParser();
Hashtable paras= new Hashtable();
paras.put("price", new Double(100.0));
//价格paras.put("discount", new Double(0.9));
//折扣率为0.9
System.out.println("计算结果："+ fp.caculateByFormula(fp.loadFormula("1001"), paras));
//遵照公式1001计算，计算预期结果为90.0
FormulaParser fp1= new FormulaParser();
Hashtable paras1= new Hashtable();
paras1.put("sale", new Double(11000.0));
//销售额
paras1.put("score", new Double(0.8));
//表现得分
System.out.println("计算结果："+ fp1.caculateByFormula(fp1.loadFormula("1002"), paras1));
// 遵照公式1002计算，计算预期结果为9100.0
程序输出为：
计算结果：90.0
计算结果：9100.0
与预期结果完全一致。开发环境为JDK1.3.1。
结束语
这就是BeanShell给我们带来的奇妙体验。并且，基于BeanShell的公式管理系统是一个很有用的工具。你可以试着将更多的运算法则加入到系统的计算器中，试着扩展该公式系统以集成到你目前的工作当中，你也可以提供一个非常友好的界面给用户，让他们轻松的定制自己的公式。一个增强功能的公式管理系统已经成功应用到笔者参与的一个电信系统中。当然，本文的方法可能不是最好的，欢迎你与我讨论。系统相关的源代码你可以在参考资料中找到。衷心希望“开源世界里充满了思想者。”
参考资料
你可以到BeanShell的发源地http://www.beanshell.org/了解更多关于BeanShell的知识
BeanShell的最新下载地址是http://www.beanshell.org/download.html
你还可以参考一篇developerWorks上介绍BeanShell的文章http://www-900.ibm.com/developerWorks/cn/java/l-beanshell/index.shtml
要想了解更多关于JDOM的知识，请访问http://www.jdom.org和参考developerWorks上的相关文章
系统相关的所有源代码点击这里下载
