FoxBPM ，Fixflow任务命令扩展介绍

Foxbpm任务命令扩展介绍

 

          Foxbpm对中国式流程（如：退回、转发、跳转等）封装成了各种任务命令按钮，这种方式得到了用户的一致认可，foxbpm的最新版本也对这一功能做了更好的封装和完善，使用户能更好的使用和扩展任务命令，这篇文章主要介绍foxbpm的任务命令体系，以及如何扩展属于自己的任务命令。

 

任务命令介绍

         从foxbpm.cfg.xml或5.2版本的fixflowconfig.xml文件可以看出，每一个任务命令都有3个类组成，分别为**Command、**Cmd、**Filter，其中：

 

• **Command定义了命令有哪些特殊参数，如“退回节点”命令中的rollbackNodeId等等
• **Cmd：命令的真正处理类，execute方法中对taskEntity,processInstanceEntity,tokenEntity等实体操作，最终完成命令的执行逻辑。
• **Filter：命令过滤器，api中获取任务命令是通过taskService.getTaskCommandByTaskId(taskId),其中会通过taskId获取当前taskEntity，根据taskEntity的状态来确定当前按钮是否应该显示。如：对于“还回”按钮，只有当taskEntity为转办状态时，该access(taskEntity)方法才会返回True,才会显示该按钮。

 

任务命令扩展

 

综上，如果想要扩展一个自己的任务命令，只需要实现上述三个类，然后在对应的配置文件中注册即可。

 

         当然，上面的做法是兼容fixflow5.2版本和最新的foxbpm版本的，既然说了foxbpm对于扩展有了优化，那就肯定要有些新的提升。

 

         对于foxbpm的最新6.0版本,是不推荐随意修改foxbpm.cfg.xml文件，也不建议随意修改engine的jar包，因为这样才能平缓升级内核的版本。为了保证升级方便和灵活扩展，6.0版本在多个功能点上使用了开源框架经常使用的技术，java spi，该机制可以让用户在不修改Engine代码和foxbpm.cfg.xml文件的基础上，注册自己的任务命令，下面总结下新版本任务命令扩展步骤：

 

1. 新建上面的**Command,**Cmd,**Filter类，并实现
2. 新建类如：MyTaskCommandDefintionImpl 实现TaskCommandDefintion接口
3. 在项目META-INF/services文件夹下新建文件：org.foxbpm.engine.task.TaskCommandDefinition,内容是2步骤中类的全名

      原理：foxbpm在引擎加载时，会通过java spi服务发现机制，注册用户自己的任务命令，这段可参考java spi机制 

 

       附：TaskCommandDefintion接口定义

package org.foxbpm.engine.task;

import java.util.List;

public interface TaskCommandDefinition {

	/**
	 * 按钮编号，如startandsubmit
	 * @return
	 */
	String getId();

	/**
	 * 按钮名称
	 * @return
	 */
	String getName();

	/**
	 * command类全名 org.foxbpm.task****
	 * @return
	 */
	String getCommandClass();

	/**
	 * cmd类全名
	 * @return
	 */
	String getCmdClass();

	/**
	 * filter类全名
	 * @return
	 */
	String getFilterClass();

	/**
	 * 按钮描述
	 * @return
	 */
	String getDescription();

	/**
	 * 按钮参数
	 * @return
	 */
	List<CommandParam> getCommandParam();
}

 

 

任务命令前端介绍

 

       想扩展一个完整的任务命令，只靠后台代码往往是实现不了的，需要前端处理一下参数，如：转发按钮，需要弹出选人界面，并将transferUserId作为参数回传给引擎，这里顺便介绍前端的扩展。

 

       6.0版本对于任务命令的前端也做了封装，集成表单时，只需要引用几个具体的js即可，关于 表单集成，这期我不多说，后面会有专门的文章来介绍表单集成部分，这里只介绍扩展任务命令时自定义参数问题，打开flowCommandHander.js，会发现这里定义了转发，退回等按钮的前端操作，如转发：

 

Foxbpm.commandHandler.transfer = function(){
	var userId = showDialog(_bpmFilePath+"/selectUser.html");
	if(userId == null || userId === undefined){
		return null;
	}
	return {transferUserId:userId};
};

       所以这里只需要定义自己的实现即可，举例：自己扩展命令 mytaskcommand,需要参数,orgid，则所需代码如下：

 

 

Foxbpm.commandHandler.mytaskcommand = function(){
	
	
	var tmpOrgId = "";
	
	/**
	 * 这里自己的逻辑，弹出选部门界面，或其他逻辑处理
	 */
	
	
	
	if(tmpOrgId == null || tmpOrgId === undefined){
		return null;
	}
	return {orgid:tmpOrgId};
};

 

 

       这样结合上面的后端Java部分扩展，就完整的实现了自己任务命令，另外，可以将这段js单独抽取出来，放到一个单独的js中，后端代码也可以单独打成jar包，如果在配合完整的文档介绍，就可以贡献给其他foxbpm的用户进行使用。而其他用户，只需要将你的jar包放到自己项目中，js引用到自己的页面上，就可以使用你的命令了，做到了对最终用户完全透明，而且最重要的一点是完全没有修改foxbpm的代码，如果引擎升级，还是可以直接覆盖原有jar包和对应的js文件。

 

 

 

FoxBPM目前尚未发布6.0的稳定版本，敬请期待.....

评论

2 楼 yang_ch 2015-01-12  

mupenghaha 写道

任务命令扩展 的步骤3：在项目META-INF/services文件夹下新建文件：org.foxbpm.engine.task.TaskCommandDefinition,内容是2步骤中类的全名。
是不是应该是MyTaskCommandDefintionImpl 而不是TaskCommandDefinition？

以demo为例，META-INF/services文件夹是不是应该建在foxbpm-webapps-common项目中？

1.是的，文件名是接口名称，里面内容是你的实现类名称
2.是的，详情参考java spi机制

1 楼 mupenghaha 2015-01-12  

任务命令扩展 的步骤3：在项目META-INF/services文件夹下新建文件：org.foxbpm.engine.task.TaskCommandDefinition,内容是2步骤中类的全名。
是不是应该是MyTaskCommandDefintionImpl 而不是TaskCommandDefinition？

以demo为例，META-INF/services文件夹是不是应该建在foxbpm-webapps-common项目中？