工作流SDK接口使用说明

1.需求场景

在涉及到工作流相关的业务场景时，业务数据和流程数据最好是要做到相互隔离，互不影响。因此，数据和逻辑之间，耦合度越低越好。工作流引擎作为一个独立的模块，要方便业务数据调用。

2.接口说明

启动一个流程，需要插入业务数据，也需要插入流程数据（包括流程日志、流程任务）。为了方便整合流程，流程引擎提供SDK接口调用。

流程主要有2个接口：启动流程和提交流程，其他的为辅助接口。

所有的接口功能，都封装在FlowUtil类中，提供静态方法调用。

2.1.启动流程

启动流程，只需要调用FlowUtil.startFlowInstance(NoCodeFlowParam flowParam)方法即可，传入NoCodeFlowParam对象参数，返回NoCodeResult对象。方法自动处理流程数据，如果传入了业务数据SQL语句，也会处理业务数据。

NoCodeFlowParam定义如下：

public class NoCodeFlowParam {
	private int flowId;
	private int dataId;
	private int userId;
	private int actionType;                    //操作类型
	private int nodeId;		//当前操作节点
	private int backNodeId;	//回退、拒绝、驳回后的节点
	private String nextNodeIds;	//下一节点
	private String tableName;    //业务数据库表名称
	private boolean executeSQL;		//是否执行更新或插入业务数据SQL
	private String sqlBusiness;                    //业务数据SQL
	private Object[] sqlParam;            //业务数据SQL参数
	private NoCodeFlowNode flowNode;		//当前流程节点
	private NoCodeFlowProcess flowProcess;        //处理日志
	private List flowTaskList;    //要发布的任务列表
	private int remarkField;		//备注关联字段id
	private int attachmentField;	//附件关联字段id
	private String flowRemark;		//备注信息
	private String flowAttachment;	//相关附件
}

在调用启动流程时，并不需要传入所有参数。参数说明如下：

1. flowId。流程Id，必填。当前启动的是哪个流程。引擎会根据该Id值查找配置项。
2. dataId。业务数据Id，视情况而定。如果自己单独处理了业务数据（新增业务数据），则需要传递dataId，以便引擎更新该业务数据的流程状态。如果需要引擎处理业务数据，则不需要传值。
3. userId。当前操作的用户id，必填。一般从session中取值，获取当前用户Id。如果是APP等无状态接口，则通过接口用户验证取到用户Id值。
4. actionType。操作类型，不用填。启动流程时，不需要传值。内部会固定为NoCodeFlowNode.NODE_TYPE_START，其值为1。提交流程时，则根据实际是什么操作，就传递什么值。各种操作类型，在NoCodeFlowNode中有定义。
5. nodeId。当前操作的节点Id，不用填。启用流程会固定查找启动节点。
6. backNodeId。回退节点，不用填。启动流程时，不会回退。
7. nextNodeIds。下一个节点Id列表，不用填。内部会自动获取。
8. tableName。业务数据库表名称，必填。引擎需要去更新业务数据的流程启动人、流程节点、流程状态数据。
9. executeSQL。是否执行业务数据SQL，必填。设置为true后，引擎会执行业务数据的SQL语句（sqlBusiness和sqlParam）。会自动判断是insert还是update。
10. sqlBusiness。业务SQL语句，视情况而定。如果需要引擎执行业务数据，则传递SQL语句给引擎执行。支持insert和update。如果是insert，则会把新增的数据id值，返回到NoCodeResult的data属性中。
11. sqlParam。业务SQL语句配套的参数，根据sqlBusiness而定。
12. flowNode。当前流程节点，不用填。如果是启动流程，引擎会自动查找开启节点；如果是提交流程，引擎会根据nodeId
13. flowProcess。流程日志对象，不用填。引擎会自动构造。
14. flowTaskList。流程任务对象列表，不用填。引擎会自动构造。
15. remarkField。关联节点的备注字段，不用填。自动根据节点设置项来读取。
16. attachmentField。关联节点的附件字段，不用填。自动根据节点设置项来读取。
17. flowRemark。备注说明内容，视情况而定。需要存储到流程日志中。如果有，就赋值。
18. flowAttachment。相关附件内容，视情况而定。需要存储在流程日志中。如果有，就赋值。

 

2.2.提交流程

提交流程，调用接口FlowUtil.submitFlowInstance(NoCodeFlowParam flowParam)方法，参数与返回值，类似于启动流程。

要传递的参数，与启动流程的区别如下。

1. nodeId。节点Id，必填。当前提交的是哪个流程节点，必填。
2. dataId。业务数据Id，必填。提交流程时，必然是有关联的业务数据。
3. actionType。操作类型，必填。提交流程时，必然是选择某种操作。
4. backNodeId。如果是回退操作类型，还需要传递选择的回退节点Id。

3.调用样例

3.1.启动流程

如果由工作流引擎来处理业务数据，则需要将插入业务数据的SQL语句以及SQL参数，传递到接口方法中。如下代码所示。

	//提交发起流程表单。添加业务表单数据，发起流程。
	public NoCodeResult submitFlowStart(HttpSession httpSession, Map mapRequestParam, int flowId) {
		if (!baseValidate(httpSession, mapRequestParam, flowId)) {
			return mResult;
		}

		//获取发起流程节点字段列表
		mListField = FlowService.getFlowStartPageFieldList(flowId);

		//将request的数据，存入字段列表
		setFieldValueFromRequestForSave();

		//验证字段数据
		if (!validateFieldValueForSave()) {
			return mResult;
		}

		//从session中获取当前用户id
		int userId = StringUtil.convertToInt(httpSession.getAttribute(NoCodeUser.SESSION_USERID));

		//保存业务数据的SQL和参数
		List