jBPM开发入门指南
工作流虽然还在不成熟的发展阶段，甚至还没有一个公认的规范标准。但其应用却已经在快速展开，这说明市场对工作流框架的需求是急迫而巨大的。
我们公司的后台短信管理系统涉及短信编发、领导层层审核等操作，这是一个比较典型的工作流系统。过去我们用的工作流引擎是 shark ，然后在使用后发现其过于庞大，后台数据库操作频繁而未进行优化，直接导致的后果就是前台操作缓慢。于是经研究决定，将工作流引擎由 shark 换成 jBPM 。
jBPM 之前是一个开源软件，后加入 JBoss 组织。正好我们公司也是用 JBoss 的。不过 jBPM 并没有绑定在 JBOSS 上， Tomcat 等也可以使用它。
jBPM 的正处在不断发展中，做为开源软件的特点，其设计变化往往很大。所以一些过去的资料可能已经不适用了。于是作者根据自己的使用经验，重新整理出这份文档，以备学习参考。
注：本文使用的 jBPM 版本为 3.1.1
环境准备
1、安装JDK
所有 JAVA 开发第一个需要安装的，没什么好说的。记得把系统变量 JAVA_HOME 设上。
2、安装Ant
Ant 是使用 jBPM 必须的一个工具。 jBPM 中的很多操作都要用到 Ant 。
安装方法：
（ 1 ）先下载： http://archive.apache.org/dist/ant/binaries/ ，选一个如： apache-ant-1.6.5-bin.zip 。
（ 2 ）解压到 D:"ant （当然其他目录也可以）。
（ 3 ）设置如下系统变量： ANT_HOME=d:"ant 。
（ 4 ）把 %ANT_HOME%"bin 加入到系统变量 PATH 中。
3、安装Eclipse
Eclipse 不是开发 jBPM 必须的工具，但它是对 jBPM 开发很有帮助的工具，特别是 jBPM 提供了一个 Eclipse 插件用来辅助开发 jBPM 。关于 Eclipse 的安装不赘述了，本文用的版本是： Eclipse3.2
安装 jBPM
jBPM 的下载地址： http://www.jboss.com/products/jbpm/downloads
l JBoss jBPM 是 jBPM 的软件包
l JBoss jBPM Starters Kit 是一个综合包，它包括了 jBPM 软件包、开发插件、一个配置好了的基于 JBoss 的 jBPM 示例、一些数据库配置文件示例。
l JBoss jBPM Process Designer Plugin 是辅助开发 jBPM 的 Eclipse 插件。
l JBoss jBPM BPEL Extension jBPM 关于 BPEL 的扩展包
本指南选择下载： JBoss jBPM Starters Kit 。下载后解压到 D:"jbpm-starters-kit-3.1 ，目录下含有五个子目录：
l jbpm jBPM 的软件包
l jbpm-bpel 只含有一个网页
l jbpm-db 各种数据库 hibernate 配置文件示例，有些还包含了相应的 jdbc 驱动程序。
l jbpm-designer 辅助开发 jBPM 的 Eclipse 插件，具体在 jbpm-gpd-feature 子目录中
l jbpm-server 一个已经配置好了的基于 JBoss 的 jBPM 示例 .
感觉下工作流
前面我们说了，在 JBoss jBPM Starters Kit 的 jbpm-server 目录是一个已经配置好的了 jBPM 示例，那么让我们来感觉一下 jBPM 做出的东西吧。
双击 jbpm-server 目录下的 start.bat 文件，启动 JBoss 服务。这时会打开一个 DOS 窗口，启动完成后，日志会不断输出，其中最后一句是“ 13:55:39,937 DEBUG [StaticNotifier] going to wait for (CMD_EXECUTOR, java.lang.Object@1df59bd) ”，这表示 jBPM 在开始工作了，它不断进行轮询。
打开网页： http://localhost:8080/jbpm/ 得到如下画面
这是一个已经用 jBPM 开发好的用户定单流程，具有下单、审核、估价等流程。它所用的数据库是一个内置的数据库。
以 cookie monster 用户登录，选择“ create new web sale order ”可以创建一个定单。如下图所示，在图左边是填写的定单情况，右边一整个定货流程的示意图，红色框表示流程进行到哪一步了。填写好定单好，选择“ Save and Close Task ”，完成定单提交。
选择右上角的“ Login as another user ”以另外一个用户名 ernie 登录。这时可以看到 ernie 用户的任务列表中多了一项。
点进去后，显示如下画面。这个示例对中文的支持不好，全都显示成了 unicode 码了。不管这什么多，反正知道是这么回事就行了。在 comment 项填写意见，选 OK 按钮，进入到下一步。如果选择 more info needed 按钮，则打回给 cookie monster 用户修改定单。
下面的流程，这里就不再赘述了。在这个很标准的工作流示例中，我们基本可以看到 jBPM 的应用范围还是比较广的。而且从这个示例，我们是看不出有 jBPM 的，也就是说 jBPM 在后台起着作用。
从这个例子，还看不出 jBPM 的优势。不过，如果在一个流程不确定，经常需要变动的项目中， jBPM 的好处将会显然出来。应用 jBPM 后，改变流程只需改变流程描述文件，这将在后面的内容提到。
这是一个已做好的示例，接下来我们将仿造这个实例来开发一个请假流程。
4 数据库初始化
jBPM 需要数据库支持， jBPM 会把自己的一个初始化数据存储到数据库，同时工作流的数据也是存储到数据库中的。 jBPM 使用 Hibernate 来做为自己的存储层，因此只要是 Hibernate 支持的数据库， jBPM 也就支持。
本文先以 MySQL 为例，然后再以 Oracle 为例，来谈谈 jBPM 的数据库初始化操作。
注：在上面的 JBoss 自带的示例中，并没有设置数据库，那是因为 jBPM 默认使用的是内存数据库 hsqldb 。
4.1 MySQL
1 、首先安装 MySQL 。
MySQL 的安装比较简单，网上也有很多文章，本文不再赘述。本指南所用 MySQL 版本为 MySQL 4.1 （ for windows ）。再找一个 MySQL 客户端，目的是方便查看数据库中的数据，本文推荐使用 MySQL 网站上免费提供的“ MySQL Query Brower ”，当然你用其他的客户端也行，比如 MySQL-Front 。
2 、建库
MySQL 中创建一个库，库名： jbpm
3 、生成建表的 SQL 语句并建表
将 jbpm-starters-kit-
D:\jbpm-starters-kit-
D:\jbpm-starters-kit-
在 DOS 窗下，进入 D:\jbpm-starters-kit-
ant mysql.scripts
执行成功后，在 D:\jbpm-starters-kit-
4.2 Oracle
先安装好 Oracle 服务器。我们公司有现存的 Oracle 服务器，也提供给了我一个属于我自己的用户名，一登录就可以任意在我的库之下创建表了。所以这一步就省了，没有的自个先装好吧。
访问 Oracle 推荐用“ PLSQL Developer ”。不过要连接 Oracle 还要在本机上装上 Oracle 自己的客户端程序，里面提供了 JDBC 包和一些配置。要连接服务器还得配置一下，我一般都是不用 GUI 而直接改 tnsnames.ora 文件，在我的电脑里此文件的目录地址是： D:\oracle\ora92\network\ADMIN\tnsnames.ora ，内容如下 ( 两面有两个配置了 ) ：
# TNSNAMES.ORA Network Configuration File: E:\oracle\ora92\network\admin\tnsnames.ora
# Generated by Oracle configuration tools.
WXXRDB_192.168.3.2 =
(DESCRIPTION =
(ADDRESS_LIST =
(ADDRESS = (PROTOCOL = TCP)(HOST = 192.168.3.2)(PORT = 1521))
)
(CONNECT_DATA =
(SID = wxxrDB)
(SERVER = DEDICATED)
)
)
WXXRDB_192.168.4.2 =
(DESCRIPTION =
(ADDRESS_LIST =
(ADDRESS = (PROTOCOL = TCP)(HOST = 192.168.4.2)(PORT = 1521))
)
(CONNECT_DATA =
(SID = wxxrDB)
(SERVER = DEDICATED)
)
)
前面都是 Oracle 的一些知识，不会的 Google 一下吧。最后配置好后，用 PLSQL Developer 输入你的用户名和密码联接到 Oracle ，就算 OK 了。
参考上面 MySQL 的步骤，基本一样：
（1） 将 jbpm 改名为 jbpm.3
（2） 再执行 ant oracle.scripts
（3） 用 jbpm-db\build\oracle\scripts 目录的 oracle.create.sql 脚本，在 Oracle 中生成 jBPM 的所有表。在“ PLSQL Developer ”中可以新建一个 Command Windows 窗口然后输入命令： @D:\jbpm-starters-kit-
5 安装 jBPM 的 Eclipse 开发插件
有个辅助工具开发起来方便一点，只不过现在 jBPM 的开发工具插件功能还不算太强，也就一个“项目创建向导”的功能，让你：
（1）不用再去配置 classpath 库的引用了
（2）直接得到了一个 jBPM 的项目初始结构
其实吧，开发 jBPM 也不需要什么插件工具，在熟练了以后，库引用了项目初始结构都可以手工创建。
插件不用再去下载了， jbpm-starters-kit-
如果安装成功，则 Eclipse 首选项里多了一个 JBoss jBPM ，另外我们也需要到这个 jBPM 的首选项里做一些配置工作――指定 jBPM 的安装路径（如下图所示）。这个配置主要是为了找到 jbpm 下的各种 jar 包，好让 Eclipse 设置项目的库引用。本文指向路径是 d:\jbpm-starters-kit-
6 jBPM 的 Hello World
6.1 新建jBPM项目
主菜单“文件－＞新建－＞项目”，在弹出的对话框里，有“ Process Project ”项，如下图所示：
选上好，单击“下一步”，起个名“ myjbpm ”，然后就可以单击“完成”了。然后就生成了如下图所示的一个项目结构：
这个项目和通常 Eclipse 的项目结构有点不同，不过这是一个现在非常流行的项目结构， src/java 存放源文件， test/java 存放相应的 JUnit 单元测试代码。如果你用 Maven 来编译构建项目，对这种目录结构一定不陌生。
项目创建起了，介绍一下里面的文件吧：
l MessageActionHandler ，自动生成的一个 ActionHandler 。不想要可以删掉。
l ehcache.xml cache 的配置文件，里面有很详解的英文说明。没有必要可以不用改它。
l hibernate.cfg.xml jBPM 是用 Hibernate 进行工作流的数据存储的，这个就是 Hibernate 的配置文件。后面我们将讲到如何配置这个文件。
l jbpm.cfg.xml jbpm 本身的配置文件。现在是空的，它用的是缺省配置，你想知道有哪些配置就去看这个文件 D:\jbpm-starters-kit-
l log4j.properties 这个是日志 API 包 log4j 的配置文件，用过 log4j 的都知道。
l SimpleProcessTest.java 这个是对最重要的流程配置文件的 processdefinition.xml 单元测试代码。这里表扬一点， jBPM 的优良设计使得它的可测试性非常之高，喜欢写 t 单元测试的人有福了。
l gpd.xml 用于生成流程图的定义文件。都是一些方框的坐标和长宽
l processdefinition.xml 这个是对最重要的流程配置文件，以后写流程要经常和它打交道。
l processimage.jpg 一个流程图
从项目结构来看，我们没有看到 JSP 网页程序，也没有看到 GUI 客户端程序，这些代码都是要我们以后开发中来写的。但本文不准备用 JSP 、 GUI （ Swing 、 SWT ）来做示例，而是用 JUnit 代码来做使用 jBPM 客户端来演示。因为 jBPM 实际上是一个后台框架，至于前台是 JSP 还是 Swing 还是无界面的 java.class 都是无关紧要的。在教程里用无界面的 java.class 来做客户端则更方便一些，如果进一步采用 JUnit ，则这样的 java.class 同时还具备了单元测试的功能。以后就是用 JSP 写了 WEB 页面，我们还是可以用这些 JUnit 程序来做单元测试，避免了频繁的鼠标点按 WEB 页面这样的力气活。所以在 jBPM 自带的英文教程里都是一个 JUnit 程序，不仔佃看还真摸不着头脑。
6.2 修改hibernate.cfg.xml
hibernate.cfg.xml 的默认设置是用 HSQL ，这是一个内存数据库，这种内存数据库用来代替项目实际所用的数据库来做单元测试挺不错的。不过我们这里是要试试用 MySQL 、 Oracle ，那就改一下设置吧。
注：配置值可参考 D:\jbpm-starters-kit-
1 、 MySQL 的更改如下：
<property name="hibernate.dialect">org.hibernate.dialect.MySQLDialect</property>
<property name="hibernate.connection.driver_class">com.mysql.jdbc.Driver</property>
<property name="hibernate.connection.url">jdbc:mysql://localhost:3306/jbpm</property>
<property name="hibernate.connection.username">root</property>
<property name="hibernate.connection.password">123456</property>
2 、 Oracle 的更改如下：
<property name="hibernate.dialect">org.hibernate.dialect.OracleDialect</property>
<property name="hibernate.connection.driver_class">oracle.jdbc.driver.OracleDriver</property>
<property name="hibernate.connection.url">jdbc:oracle:thin:@192.168.123.10:1521:wxxrDB</property>
<property name="hibernate.connection.username">chengang</property>
<property name="hibernate.connection.password">chengang</property>
如果你装了 Oracle 的客户端，并且 D:\oracle\ora92\network\ADMIN\tnsnames.ora 里做了如下的设置
WXXRDB_192.168.123.10 =
(DESCRIPTION =
(ADDRESS_LIST =
(ADDRESS = (PROTOCOL = TCP)(HOST = 192.168.123.10)(PORT = 1521))
)
(CONNECT_DATA =
(SID = wxxrDB)
(SERVER = DEDICATED)
)
)
则 Oracle 的 hibernate.connection.url 项也可以设为： jdbc:oracle:oci:@WXXRDB_192.168.123.10
6.3 完善库引用
虽然 jBPM 在创建项目之初给我们设置好了库引用，如下图
但后面运行时还是报一些 NoClassDefFoundError 异常，如没有对 hibernate3.jar 的引用导致下面的错误
java.lang.NoClassDefFoundError: org/hibernate/Session
at org.jbpm.persistence.db.DbPersistenceServiceFactory.openService(DbPersistenceServiceFactory.java:55)
at org.jbpm.svc.Services.getService(Services.java:136)
.......
所以我们要为本文的实例完善库引用。主要是把 MySQL 和 Oracle 的 JDBC 库、以及 Hibernate 的 hibernate3.jar 加入到项目的库引用中。
（1） 找到缺少的 jar 包
l mysql 的 jdbc 包，在 D:\jbpm-starters-kit-
l oracle 的 jdbc 包， jbmp 中没有包含（可能是没拿到 oracle 授权），我们可以自已去 oracle 网站上下载，或者去 oracle 安装目录 D:\oracle\ora92\jdbc\lib 找 ojdbc14.jar （我们公司用的是 Oracle9i ）
l Hibernate3.jar 在目录 D:\jbpm-starters-kit-
（2） 在项目里创建一个 lib 目录，将这三个 jar 复制到 lib 目录。
（3） 如下图设置三 jar 包的库引用
6.4 开始HellorWorld
这里是一个很简单的请假流程，请假人提交假单给经理审批，经理审批后结束。要说明的是，这个流程并不严谨，比如经理不通过流程应该到哪？不过这并不防碍拿它来做示例，螃蟹还得一个一个的吃。我们先拿这一杆子捅到底的流程做一个最简单的示例，从整体上对 jBPM 工作流开发有概念先。然后我们再慢慢丰富。
1 、定义流程
流程的定义文件是 processdefinition.xml ，这个是一个关键文件， jBPM 的很大一部份内容都是关于它的。在这里我们把原来自动生成的内容，稍做改动：
<?xml version="1.0" encoding="GBK"?>
<process-definition xmlns="urn:jbpm.org:jpdl-3.1" name="helloworld">
<!-- 申请 -->
<start-state name="request">
<task>
<controller>
<variable name="name" />
<variable name="day" />
<variable name="note" />
</controller>
</task>
<!-- 流程转向 -->
<transition name="to_confirm" to="confirm">
<action name="requestAction"
class ="cn.com.chengang.jbpm.RequestAction">
<reason> 我要请假 </reason>
</action>
</transition>
</start-state>
<!-- 审批 -->
<state name="confirm">
<transition name="to_end" to="end">
<action name="finishAction"
class ="cn.com.chengang.jbpm.ConfirmAction" />
</transition>
</state>
<!-- 结束 -->
<end-state name="end" />
</process-definition>
说明：
流程的名称改成了 helloworld 。（呵呵，也就是这里和 helloworld 有关了）
<controller> 标签定义了三个数据：姓名、请假天数、说明。
<transition> 标签定了 request 节点的一个流程转向，这里是转到 confirm 节点。
<action> 标签定义了流程由一个节点转到另一个节点时，所要执行的动作，动作封装在一个 ActionHandler 类中。比如这里当 request 到 confirm 结点时将执行 RequestAction 类的 execute 方法。
FinishAction 下面还有一个 <reason> （请假理由），它对应于 FinshAction 的属性 String reason 。
2 、 编写 ActionHandler
在上面 processdefinition.xml 里我们定义了两个 ActionHandler ： RequestAction 、 ConfirmAction 。其代码如下：
package cn.com.chengang.jbpm;
import org.jbpm.graph.def.ActionHandler;
import org.jbpm.graph.exe.ExecutionContext;
public class RequestAction implements ActionHandler {
private static final long serialVersionUID =
private String reason;
public String getReason() {
return reason;
}
public void setReason(String reason) {
this .reason = reason;
}
public void execute(ExecutionContext context) throws Exception {
context.getContextInstance().setVariable("note", reason);
}
}
说明： ExecutionContext 是一个贯通流程的容器。它是个大宝箱，里面啥玩意都有，后面将更深入的提到。这里的 reasion 就是 processdefinition.xml 中的 ” 我要请假 ”
package cn.com.chengang.jbpm;
import org.jbpm.graph.def.ActionHandler;
import org.jbpm.graph.exe.ExecutionContext;
public class ConfirmAction implements ActionHandler {
private static final long serialVersionUID =
public void execute(ExecutionContext context) throws Exception {
context.getContextInstance().setVariable("note", " 准假 " );
}
}
OK ，后台的程序就算写完了（前台客户端的程序还没写），下面开始部署。
6.5 部署processdefinition.xml
我们要把 processdefinition.xml 的流程定义的数据部署到数据库中，因为 jBPM 在正式运行的时候不是去读 processdefinition.xml 文件，而是去读数据库中的流程定义。 这里写了一个个 JUnit 程序来部署 processdefinition.xml ，当然你用普通的 Java Main 也可以。
package com.sample;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.InputStream;
import junit.framework.TestCase;
import org.jbpm.JbpmConfiguration;
import org.jbpm.JbpmContext;
import org.jbpm.graph.def.ProcessDefinition;
/**
* 部署 processdefinition.xml
*
* @author chengang
*
*/
public class DeployProcessTest extends TestCase {
/**
* 在本方法执行完毕后，检查 jbpm_processdefinition 表会多了一条记录
*
* @throws FileNotFoundException
*/
public void testDeployProcessDefinition() throws FileNotFoundException {
// 从 jbpm.cfg.xml 取得 jbpm 的配置
JbpmConfiguration config = JbpmConfiguration.getInstance();
// 创建一个 jbpm 容器
JbpmContext jbpmContext = config.createJbpmContext();
// 由 processdefinition.xml 生成相对应的流程定义类 ProcessDefinition
InputStream is = new FileInputStream("processes/simple/processdefinition.xml");
ProcessDefinition processDefinition = ProcessDefinition.parseXmlInputStream(is);
// 利用容器的方法将流程定义数据部署到数据库上
jbpmContext.deployProcessDefinition(processDefinition);
// 关闭 jbpmContext
jbpmContext.close();
}
}
运行此程序，在控制台打印了一些日志，通过。如果出错，仔佃阅读出错信息以判断错误原因，并确定你按照前面两节：“修改 hibernate.cfg.xml ”和“完善库引用”的内容做好了设置。
6.6 从数据库中的查看部署效果
无论是 MySQL 还是 Oracle ，查询 jbpm_processdefinition 表，你会发现多了一条记录，如下图 ( 以 PLSQL Developer 的显示为例 )
依次检查各表我们可以发现有如下变化：
并由此简单判断出各表的作用，表中各字段的作用由字段名也能知晓一二。
|
jbpm_processdefinition |
一个流程定义文件对应一条记录，可记录多个流程定义文件，可记录一个流程定义文件的对个版本。 |
|
jbpm_action |
记录 ActionHandler 的对象实例（以名称为标识） |
|
jbpm_delegation |
记录了 ActionHandler 全类名，以便于用反射方式来加载 |
|
jbpm_envent |
它的 transition 引用了 Jbpm_transition 表的 id ，再看其它字段，估计此表是表示流程转向事件的一个实例，或者是一个各表之间的联接表。 |
|
jbpm_node |
流程结点 |
|
jbpm_transition |
流程的转向定义 |
|
jbpm_variableaccess |
流程中携带的变量。 ACCESS 字段是这些变量的读写权限 |
7 jBPM 的客户端开发
有了前面的 HelloWorld 后台流程，我们就要开始客户端程序了。正如前面提到的，本文不写 JSP ，而改采用 JUnit 的形式，输出则用 System.out.println 。举一反三，知道在方法中输入及用 println 输出，在 JSP 和 SWING 等 GUI 界面还不是一样嘛。
这个 JUnit 客户端，我们就借用创建项目时自动生成的 SimpleProcessTest.java 了，改写后如下：
package com.sample;
import junit.framework.TestCase;
import org.jbpm.JbpmConfiguration;
import org.jbpm.JbpmContext;
import org.jbpm.context.exe.ContextInstance;
import org.jbpm.graph.def.ProcessDefinition;
import org.jbpm.graph.exe.ProcessInstance;
public class SimpleProcessTest extends TestCase {
private JbpmConfiguration config = JbpmConfiguration.getInstance();
private JbpmContext ctx = config.createJbpmContext();
// helloworld 对应于 jbpm_processdefinition 表的 name 字段值，也即 processdefinition.xml 的 name
// 这个值得取比较耗时，实际项目里最好和“数据库的 JDBC 连接”一样，让它共享，不要频繁打开关闭。
private ProcessDefinition processDefinition = ctx.getGraphSession().findLatestProcessDefinition("helloworld");
public void testNewRequest() {
long id = newRequest();
System.out.println("id=" + id);
checkNewRequest(id);
confirmRequest(id);
checkconfirmRequest(id);
ctx.close();// 关闭 jbpm 容器
}
/**
* 创建一个请假单
*
* @return
*/
private long newRequest() {
// 创建一个新流程
ProcessInstance pi = processDefinition.createProcessInstance();
// 取得流程的数据环境
ContextInstance ci = pi.getContextInstance();
// 创建一张请假单
ci.setVariable("name", "
ci.setVariable("day", 2);
assertEquals(null, ci.getVariable("note"));
// 请假申请结束，转到下一个流程结点
pi.signal();
return pi.getId();
}
/**
* 检查请假单的数据
*
* @param id
*/
private void checkNewRequest(long id) {
// 从数据库提取原流程
ProcessInstance pi = ctx.loadProcessInstance(id);
// 取得流程的数据环境
ContextInstance ci = pi.getContextInstance();
// 创建一张请假单
assertEquals("
assertEquals(Integer.valueOf(2), ci.getVariable("day"));
assertEquals(" 我要请假 " , ci.getVariable("note"));
// 当前是结点为 confirm
assertEquals(pi.getRootToken().getNode().getName(), "confirm");
// 流程还没结束
assertFalse(pi.hasEnded());
}
/**
* 审批
*
* @param id
*/
private void confirmRequest(long id) {
ProcessInstance pi = ctx.loadProcessInstance(id);
ContextInstance ci = pi.getContextInstance();
// 不通过
ci.setVariable("note", " 不准请假，继续加班 " );
// 审批结束，到下一个流程结点
pi.signal();
}
private void checkConfirmRequest(long id) {
ProcessInstance pi = ctx.loadProcessInstance(id);
ContextInstance ci = pi.getContextInstance();
// ConfirmAction 类在 signal 后执行，所以覆盖了经理的审批意见
assertEquals(" 准假 " , ci.getVariable("note"));
// 当前是结点为 end
assertEquals(pi.getRootToken().getNode().getName(), "end");
// 流程结束了
assertTrue(pi.hasEnded());
}
}
转自：http://www.blogjava.net/chengang/archive/2006/07/13/57986.html
