二开案例.服务插件.校验器检查当前上下文是否已经存在校验错误

栏目：云星空知识作者：金蝶来源：金蝶云社区发布：2024-09-23浏览：1

【应用场景】

服务插件，自定义校验器，校验逻辑执行前，先检查当前上下文是否已经存在校验错误，如果前面的校验器已经产生了校验错误，出于性能考虑，当前校验器就不再校验了。

【案例演示】

采购订单，保存服务插件，注册两个自定义校验器，演示，如果第一个校验器校验不通过，第二个校验器就不要执行了。

控制前效果，两个校验器都执行了校验：

控制后效果，校验器1不通过，校验器2不执行：

【实现步骤】

<1>编写服务插件，代码如下。

using Kingdee.BOS;
using Kingdee.BOS.Core;
using Kingdee.BOS.Core.DynamicForm.PlugIn;
using Kingdee.BOS.Core.DynamicForm.PlugIn.Args;
using Kingdee.BOS.Core.Validation;
using Kingdee.BOS.Util;
using System;
using System.ComponentModel;
namespace Jac.XkDemo.BOS.App.PlugIn
{
    /// <summary>
    /// 【服务插件】校验器检查当前上下文是否已经存在校验错误
    /// </summary>
    [Description("【服务插件】校验器检查当前上下文是否已经存在校验错误"), HotUpdate]
    public class CheckValidatorHasErrorOperationServicePlugIn : AbstractOperationServicePlugIn
    {
        /// <summary>
        /// 添加插件需要用到的字段引用
        /// </summary>
        /// <param name="e"></param>
        public override void OnPreparePropertys(PreparePropertysEventArgs e)
        {
            base.OnPreparePropertys(e);
            //e.FieldKeys.Add("FQty");
            // TODO
        }
        /// <summary>
        /// 添加校验器
        /// </summary>
        /// <param name="e"></param>
        public override void OnAddValidators(AddValidatorsEventArgs e)
        {
            base.OnAddValidators(e);
            // 添加校验器
            e.Validators.Add(new Demo1Validator());
            e.Validators.Add(new Demo2Validator());
        }
    }
    /// <summary>
    /// 演示校验器2
    /// </summary>
    public class Demo1Validator : AbstractValidator
    {
        public override void InitializeConfiguration(ValidateContext validateContext, Context ctx)
        {
            base.InitializeConfiguration(validateContext, ctx);
            if (validateContext.BusinessInfo != null)
            {
                EntityKey = validateContext.BusinessInfo.GetEntity(0).Key;
            }
        }
        public override void Validate(ExtendedDataEntity[] dataEntities, ValidateContext validateContext, Context ctx)
        {
            if (validateContext.IgnoreWarning)
            {
                // 警告已经被用户忽略，就不需要再次执行了
                return;
            }
            if (dataEntities == null || dataEntities.Length <= 0)
            {
                return;
            }
            if (validateContext.HaveError())
            {
                // 前面的校验器已经产生了校验错误，出于性能考虑，这里就不再校验了
                return;
            }
            // 循环校验每一个数据包（一个数据包对应一张单据）
            foreach (var et in dataEntities)
            {
                var hasError = false;
                // TODO
                // 进行数据合法性校验
                hasError = et["FACCTYPE"].ToString() == "Q";
                // TODO
                // 如果校验不通过，抛出校验异常
                if (hasError)
                {
                    validateContext.AddError(et, new ValidationErrorInfo(
                        "", // 出错的字段Key，可以空
                        Convert.ToString(et.DataEntity[0]), // 数据包内码，必填，后续操作会据此内码避开此数据包
                        et.DataEntityIndex, // 出错的数据包在全部数据包中的顺序
                        et.RowIndex, // 出错的数据行在全部数据行中的顺序，如果校验基于单据头，此为0
                        "E1", // 错误编码，可以任意设定一个字符，主要用于追查错误来源
                        "Demo1校验器=>数据校验未通过，不能继续往下操作了哦。。", // 错误的详细提示信息
                        "Demo1校验器=>单据合法性检查", // 错误的简明提示信息
                        ErrorLevel.FatalError // 错误级别：警告、错误
                    ));
                }
            }
        }
    }
    /// <summary>
    /// 演示校验器2
    /// </summary>
    public class Demo2Validator : AbstractValidator
    {
        public override void InitializeConfiguration(ValidateContext validateContext, Context ctx)
        {
            base.InitializeConfiguration(validateContext, ctx);
            if (validateContext.BusinessInfo != null)
            {
                EntityKey = validateContext.BusinessInfo.GetEntity(0).Key;
            }
        }
        public override void Validate(ExtendedDataEntity[] dataEntities, ValidateContext validateContext, Context ctx)
        {
            if (validateContext.IgnoreWarning)
            {
                // 警告已经被用户忽略，就不需要再次执行了
                return;
            }
            if (dataEntities == null || dataEntities.Length <= 0)
            {
                return;
            }
            if (validateContext.HaveError())
            {
                // 前面的校验器已经产生了校验错误，出于性能考虑，这里就不再校验了
                return;
            }
            // 循环校验每一个数据包（一个数据包对应一张单据）
            foreach (var et in dataEntities)
            {
                var hasError = false;
                // TODO
                // 进行数据合法性校验
                hasError = true;
                // TODO
                // 如果校验不通过，抛出校验异常
                if (hasError)
                {
                    validateContext.AddError(et, new ValidationErrorInfo(
                        "", // 出错的字段Key，可以空
                        Convert.ToString(et.DataEntity[0]), // 数据包内码，必填，后续操作会据此内码避开此数据包
                        et.DataEntityIndex, // 出错的数据包在全部数据包中的顺序
                        et.RowIndex, // 出错的数据行在全部数据行中的顺序，如果校验基于单据头，此为0
                        "E1", // 错误编码，可以任意设定一个字符，主要用于追查错误来源
                        "Demo2校验器=>数据校验未通过，不能继续往下操作了哦。。", // 错误的详细提示信息
                        "Demo2校验器=>单据合法性检查", // 错误的简明提示信息
                        ErrorLevel.FatalError // 错误级别：警告、错误
                    ));
                }
            }
        }
    }
}

核心控制代码：

validateContext.HaveError()

<2>拷贝插件组件到应用站点的WebSite\Bin目录下，重启IIS。