表单或者列表上通常绑定了对应的很多操作，但是点击后操作是如何一步步执行的？干预中间的校验逻辑该用哪个方法？在某项操作之前希望先执行其他操作该怎么办？又或者说，如何设置在删除报销单之前，先校验该单据是否生成下游单据，如果生成了，就不允许删除？

所有的疑问，小编都将在这篇文章里给你一一解惑。

1 单据操作插件及事件

想要干预操作流程，首先需要了解操作插件。系统预置了一个操作插件基类 AbstractOperationServicePlugIn，实现了操作插件接口。对于，自定义的操作插件，通过扩展预置的操作插件基类 AbstractOperationServicePlugIn即可干预操作流程。

那么，哪些操作可以绑定操作插件呢？

系统预置了一批操作，可以绑定在界面菜单、按钮上。用户点击菜单、按钮时，即自动执行这些操作，完成特定的操作功能。

这些预置的操作，可以根据是否写数据入库，分为两大类：

表单操作：仅对表单界面及界面上的数据进行处理，不会写数据入库，如“新建”、“关闭”操作，但可以通过开发表单插件，对表单操作进行适度的干预；

与表单操作相关的表单插件事件，包括：菜单、按钮点击事件(beforeitemClick, itemClick, beforeClick, click)，可以取消操作的执行；操作执行前后事件(beforeDoOperation, afterDoOperation)，用于准备操作参数、接收操作执行结果刷新界面；
实体操作：会写数据入库，只能配置在单据、基础资料上，如“保存”、“提交”、“审核”操作。

实体操作清单说明

有这么多操作，那我们具体的执行流程是怎样的呢？以实体操作为例，可以通过下图有个宏观的了解：

实体操作流程图

至此，如何干预整个操作的流程就已经很清晰了。我们可以在对应的时机，获取到相关的数据后即可添加自己想要的逻辑了。

2 操作插件事件的详细介绍

插件基类 AbstractOperationServicePlugIn 内置了如下属性方法和本地变量，供插件访问，用以获取操作执行上下文。

拿到具体的数据后，我们就可以在事件中展开自己想要的逻辑了。接下来，小编将给大家介绍每个事件各自代表什么意义~

2.1 onPreparePropertys事件

事件介绍：需要在此事件添加插件，并添加需要用到的字段；否则，操作引擎加载出的单据数据包，可能没有插件需要的字段值，从而引发中断。

事件触发时机：在操作执行、加载单据数据包之前，触发此事件；

在单据列表上执行单据操作，传入的是单据内码，操作引擎需要先根据传入的单据内码，加载单据数据包，其中只包含操作要用到的字段，然后再执行操作；

在加载单据数据包之前，触发此事件；在单据维护界面，执行单据操作时，传入的是单据数据包，不需要操作引擎自行加载单据，不会触发此事件。代码模板如下：

 1package kd.bos.plugin.sample.bill.bizoperation.template;
 2
 3import kd.bos.entity.plugin.AbstractOperationServicePlugIn;
 4import kd.bos.entity.plugin.PreparePropertysEventArgs;
 5
 6public class OnPreparePropertys extends AbstractOperationServicePlugIn {
 7
 8    @Override
 9    public void onPreparePropertys(PreparePropertysEventArgs e) {
10         // TODO 在此添加业务逻辑
11    }
12}

2.2 onAddValidators事件

事件介绍：插件可以在此事件增加自定义操作校验器，或者去掉内置的校验器。

事件触发时机：构建好操作校验器之后，执行操作校验之前，触发此事件。代码模板如下：

 1import kd.bos.entity.plugin.AbstractOperationServicePlugIn;
 2import kd.bos.entity.plugin.AddValidatorsEventArgs;
 3
 4public class OnAddValidators extends AbstractOperationServicePlugIn {
 5
 6    @Override
 7    public void onAddValidators(AddValidatorsEventArgs e) {
 8         // TODO 在此添加业务逻辑
 9    }
10}

2.3 beforeExecuteOperationTransaction事件

事件介绍：插件可以在此事件对已经通过校验的数据进行整理或者取消操作的执行。这个事件触发时，还没有启动事务保护。因此，不能在此修改数据库数据。

事件触发时机：操作校验通过之后，开启事务存储数据之前，触发此事件。代码模板如下：

 1import kd.bos.entity.plugin.AbstractOperationServicePlugIn;
 2import kd.bos.entity.plugin.args.BeforeOperationArgs;
 3
 4public class BeforeExecuteOperationTransaction extends AbstractOperationServicePlugIn {
 5
 6    @Override
 7    public void beforeExecuteOperationTransaction(BeforeOperationArgs e) {
 8         // TODO 在此添加业务逻辑
 9    }
10}

2.4 beginOperationTransaction事件

事件介绍：可以在此事件进行数据同步处理。这个事件触发时，系统还未调用ORM引擎存储单据，此时访问数据库，拿到的单据数据是旧的，单据数据包中的脏标志也没有被复位。因此，可能会执行失败的同步处理。但和第三方系统的对接，放在此事件比较合适。

事件触发时机：在操作校验通过、开启了事务之后，仍未将数据提交到数据库之前触发此事件。代码模板如下：

  1import kd.bos.entity.plugin.AbstractOperationServicePlugIn;
 2import kd.bos.entity.plugin.args.BeginOperationTransactionArgs;
 3
 4public class BeginOperationTransaction extends AbstractOperationServicePlugIn {
 5
 6    @Override
 7    public void beginOperationTransaction(BeginOperationTransactionArgs e) {
 8         // TODO 在此添加业务逻辑
 9    }
10}

2.5 endOperationTransaction事件

事件介绍：可以在此事件进行数据同步处理；这个事件触发时，系统已经调用ORM引擎存储了单据，数据已经入库，单据数据包中的脏标志已经复位。因此，可能执行失败的同步处理，不适合放在这个事件执行，事务回滚会有难度。

事件触发时机：在单据数据提交到数据库之后，事务未提交之前，触发此事件。代码模板如下：

 1import kd.bos.entity.plugin.AbstractOperationServicePlugIn;
 2import kd.bos.entity.plugin.args.EndOperationTransactionArgs;
 3
 4public class EndOperationTransaction extends AbstractOperationServicePlugIn {
 5
 6    @Override
 7    public void endOperationTransaction(EndOperationTransactionArgs e) {
 8         // TODO 在此添加业务逻辑
 9    }
10}

2.6 rollbackOperation事件

事件介绍：该方法在事务异常后执行，插件可以在此事件，对没有事务保护的数据更新进行补偿。

事件触发时机：在操作事务提交失败，事务回滚之后触发此事件。代码模板如下：

 1import kd.bos.entity.plugin.AbstractOperationServicePlugIn;
 2import kd.bos.entity.plugin.args.RollbackOperationArgs;
 3
 4public class RollbackOperation extends AbstractOperationServicePlugIn {
 5
 6    @Override
 7    public void rollbackOperation(RollbackOperationArgs e) {
 8         // TODO 在此添加业务逻辑
 9    }
10}

2.7 afterExecuteOperationTransaction事件

事件介绍：插件可以在此事件对操作结果进行整理或执行其他无需事务保护的逻辑。这个事件触发时，事务已经完成并提交。因为缺少事务保护，不能在此事件更新数据库。

事件触发时机：在操作执行完毕，事务提交之后，触发此事件。代码模板如下：

 1import kd.bos.entity.plugin.AbstractOperationServicePlugIn;
 2import kd.bos.entity.plugin.args.AfterOperationArgs;
 3
 4public class AfterExecuteOperationTransaction extends AbstractOperationServicePlugIn {
 5
 6    @Override
 7    public void afterExecuteOperationTransaction(AfterOperationArgs e) {
 8         // TODO 在此添加业务逻辑
 9    }
10}

2.8 setContext事件

事件介绍：插件基类会在此事件，把传入的上下文变量放在本地变量中，供插件快速访问。插件通常不需要捕获此事件，避免影响插件基类接收传入的上下文变量值。

事件触发时机：在插件初始化时触发，传入操作执行上下文变量值。代码模板如下：

 1import kd.bos.dataentity.OperateOption;
 2import kd.bos.entity.MainEntityType;
 3import kd.bos.entity.plugin.AbstractOperationServicePlugIn;
 4
 5public class OperationDemoPlugin extends AbstractOperationServicePlugIn {
 6
 7    @Override
 8    public void setContext(MainEntityType billEntityType, Map<String, Object> operateMeta, OperateOption option) {
 9         // TODO Auto-generated method stub
10         super.setContext(billEntityType, operateMeta, option);
11    }
12}

2.9 initializeOperationResult事件

事件介绍：操作执行时，会先创建好操作结果对象，后续在操作执行过程中，把操作结果记录在操作结果对象上。操作插件可以重写本事件，接收传入的操作结果对象，放在本地变量中，以便在后续其它事件中使用。

事件触发时机：在操作创建好操作结果对象后，触发本事件。代码模板如下：

 1import kd.bos.entity.operate.result.OperationResult;
 2import kd.bos.entity.plugin.AbstractOperationServicePlugIn;
 3
 4public class OperationDemoPlugin extends AbstractOperationServicePlugIn {
 5
 6    @Override
 7    public void initializeOperationResult(OperationResult result) {
 8         // TODO Auto-generated method stub
 9         super.initializeOperationResult(result);
10    }
11}