苍穹Java插件开发流程

苍穹Java插件开发流程原创

聚宝彭

21人赞赏了该文章 1万次浏览编辑于2021年10月23日 15:46:17

摘要由AI智能服务提供

本文介绍了金蝶云·苍穹平台中的插件开发，详细说明了插件基类选择、注册位置、开发步骤及注意事项。插件开发需确定应用场景和插件基类，根据业务需求选择合适的控件和事件方法。文章还提供了插件注册的具体路径和日志查看方式，并附上了相关参考资料和链接，旨在帮助开发者快速上手插件开发。

有用

反馈

目前，越来越多的伙伴加入到苍穹开发的大军中来，但很多同学对于插件开发还是相当难于快速上手，尤其是新入门的朋友，对于插件基类的选择 & 注册位置都不是很熟悉，下面仅以本文来给大家简单介绍一下，希望能给大家在苍穹开发的道路上提供一点帮助。

使用应用开发平台的设计器开发业务对象，全程配置，简单易学，但不够灵活。配置业务对象时使用的业务语意，需要预先定义，遇到未考虑的业务场景，则无法处理。业务对象设计器，目标是实现常见的大多数业务语意，利用开放的插件开发，可实现剩余的功能。

插件可以在适当的时机，根据接收到的上下文信息，对系统功能进行控制。适当的时机，是指插件只会在系统功能运行到了特定时刻，才能收到系统通知，进行功能处理，并不能对系统功能的全过程进行干预。插件拿到的上下文信息，能够调用的控制方法，也是经过系统封装，有所限制。简单的说，插件可以在系统约束的框架之内，对系统进行适度的干预，在灵活性与安全性之间有个平衡。

插件开发步骤

① 确定应用场景，选择插件基类

② 确定事件源&控件

③ 响应插件事件，进行业务逻辑开发

插件基类选择

不同的业务对象类型，提供特定的业务功能，有适用的应用场景。系统为各种业务对象类型、各种应用场景，封装了相应的插件接口、事件方法，定义了抽象插件基类，实现最基本的插件接口。进行业务功能设计时，首先需要根据业务需求特点，分析业务应用场景，选择业务对象类型。如果需要进行插件开发，则根据前面确定好的业务对象类型及应用场景，从下表中选择对应插件基类进行扩展。

金蝶云苍穹java插件基类选择.png

事件/方法选择

有交互界面的应用场景（如表单、单据列表等），在界面加载、关闭时，会触发相应的插件事件。此外，用户与界面，以及界面上的控件交互时，也会触发插件事件。各种控件有其自身功能特点，适用不同的业务需求，并提供了相应的插件事件。在进行功能设计时，需要根据业务需求，选用合适的控件，确定需要重写的插件接口方法，然后响应插件事件。

没有交互界面的应用场景（如单据操作、单据转换、关联反写等），不会与用户发生交互，其插件事件是由服务引擎按顺序触发的。

响应插件事件

系统会在适当的时机，调用插件事件接口的方法，传入上下文参数，触发插件事件。不同的插件事件，触发的时机、传入的上下文参数、可以控制的功能，差异非常大。因此，必须根据业务需求，选择合适的插件事件响应。

有界面交互的场景

有交互界面的应用场景，插件基类实现了表单界面支持的插件接口，但没有实现各种控件的插件接口。

如果只是要捕获表单界面事件，则扩展插件基类，重写表单事件方法即可。

如果要捕获各种控件事件，则需要：

> 在插件类定义，实现控件支持的插件事件接口。例如：以树形控件支持节点勾选为例，业务插件需实现接口TreeNodeCheckListener，代码如下：

public class TreeViewTreeNodeCheckDemoPlugin extends AbstractBillPlugIn implements TreeNodeCheckListener

> 实现控件的插件事件接口中的方法，完成事件的捕捉，接上例，示例代码如下：

        @Override
	public void treeNodeCheck(TreeNodeCheckEvent evt) {
		TreeView treeView = (TreeView) evt.getSource();
		if (StringUtils.equals(treeView.getKey(), KEY_TREEVIEW)){
			List<String> selectNodeIds = treeView.getTreeState().getCheckedNodeIds();
			// TODO 在此添加业务逻辑
		}
	}

> 在表单界面插件registerListener事件，向控件实例注册本插件实例，完成控件与插件实例的绑定：控件事件发生时，即触发其所绑定的插件事件。

        @Override
	public void registerListener(EventObject e) {
		super.registerListener(e);
		// 侦听树节点勾选事件
		TreeView treeView = getView().getControl(KEY_TREEVIEW);
		treeView.addTreeNodeCheckListener(this);
	}

示例树形控件支持的节点勾选的完整代码如下：

package kd.demo;

import java.util.EventObject;
import java.util.List;

import kd.bos.bill.AbstractBillPlugIn;
import kd.bos.dataentity.utils.StringUtils;
import kd.bos.form.control.TreeView;
import kd.bos.form.control.events.TreeNodeCheckEvent;
import kd.bos.form.control.events.TreeNodeCheckListener;

public class TreeViewTreeNodeCheckDemoPlugin extends AbstractBillPlugIn implements TreeNodeCheckListener {
	
	private final static String KEY_TREEVIEW = "treeviewap";

	@Override
	public void registerListener(EventObject e) {
		super.registerListener(e);
		// 侦听树节点勾选事件
		TreeView treeView = getView().getControl(KEY_TREEVIEW);
		treeView.addTreeNodeCheckListener(this);
	}

	@Override
	public void beforeBindData(EventObject e) {
		super.beforeBindData(e);
		TreeView treeView = getView().getControl(KEY_TREEVIEW);
		// 支持多选
		treeView.setMulti(true);
	}

	@Override
	public void treeNodeCheck(TreeNodeCheckEvent evt) {
		TreeView treeView = (TreeView) evt.getSource();
		if (StringUtils.equals(treeView.getKey(), KEY_TREEVIEW)){
			List<String> selectNodeIds = treeView.getTreeState().getCheckedNodeIds();
			// TODO 在此添加业务逻辑
		}
	}
}