二开案例.单据插件.缓存清理

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

二开案例.单据插件.缓存清理

【应用场景】

直接后台修改了数据,前端缓存不会自动刷新,此时,需要在后台手动调用一下缓存清理服务。

【注意】

本案例仅适用于22年9月,以及之后的补丁版本。


【案例演示】

采购订单,修改订单明细引用的某个物料的规格型号数据,然后通过手动刷新物料的缓存,使得修改后的物料数据在单据界面上立即生效。

【实现步骤】

<1>编写单据插件,代码如下。

using Kingdee.BOS;

using Kingdee.BOS.App.Core;

using Kingdee.BOS.App.Data;

using Kingdee.BOS.Core.Bill.PlugIn;

using Kingdee.BOS.Core.Const;

using Kingdee.BOS.Core.DynamicForm.PlugIn.Args;

using Kingdee.BOS.ServiceHelper;

using Kingdee.BOS.Util;

using System;

using System.Collections.Generic;

using System.ComponentModel;


namespace Jac.XkDemo.BOS.Business.PlugIn

{

    /// <summary>

    /// 【单据插件】缓存清理

    /// </summary>

    [Description("【单据插件】缓存清理"), HotUpdate]

    public class ClearCacheBillPlugIn : AbstractBillPlugIn

    {

        public override void BarItemClick(BarItemClickEventArgs e)

        {

            base.BarItemClick(e);

            if (e.BarItemKey.Equals("tbUpdateData", StringComparison.OrdinalIgnoreCase))

            {

                // 修改物料【普通物料A】的规格型号数据

                var sql = "UPDATE T_BD_MATERIAL_L SET FSPECIFICATION=N'国产' WHERE FMATERIALID IN (187780,187802,187812,187822,421843)";

                DBUtils.Execute(Context, sql);

                this.View.ShowMessage("物料【普通物料A】的规格型号已更新为国产!");

                return;

            }


            if (e.BarItemKey.Equals("tbClearCacheByFormIds", StringComparison.OrdinalIgnoreCase))

            {

                // 清除物料的所有缓存(传入参数为物料的业务对象标识)

                ClearCacheByFormIds(Context, new List<string>(new[] { "BD_MATERIAL" }));

                this.View.ShowMessage("物料的缓存已被清空!");

                return;

            }


            if (e.BarItemKey.Equals("tbClearCacheByPrimaryKeys", StringComparison.OrdinalIgnoreCase))

            {

                // 清除指定内码的物料的所有缓存(传入参数为物料的业务对象标识)

                ClearCacheByPrimaryKeys(Context, "BD_MATERIAL", new List<string>(new[] { "187780", "187802", "187812", "187822", "421843" }));

                this.View.ShowMessage("物料【普通物料A】的缓存已被清空!");

                return;

            }

        }


        /// <summary>

        /// 清理缓存(整个基础资料的缓存全清)

        /// </summary>

        /// <param name="ctx">上下文</param>

        /// <param name="formIds">业务对象标识</param>

        /// <returns></returns>

        public static bool ClearCacheByFormIds(Context ctx, List<string> formIds)

        {

            if (formIds == null || formIds.Count == 0)

            {

                return false;

            }


            var area = ctx.GetDBCacheKey();

            foreach (var formId in formIds)

            {

                var metadata = FormMetaDataCache.GetCachedFormMetaData(ctx, formId);

                if (metadata != null)

                {

                    CacheUtil.ClearCache(area, metadata.BusinessInfo.GetEntity(0).TableName);

                    CacheUtil.ClearCache(ctx.DBId + formId, CacheRegionConst.BOS_QuickBaseDataCache);

                }

            }


            return true;

        }


        /// <summary>

        /// 清理缓存(只清理指定内码的数据缓存)

        /// </summary>

        /// <param name="ctx">上下文</param>

        /// <param name="formId">业务对象标识</param>

        /// <param name="keys">数据内码</param>

        public static bool ClearCacheByPrimaryKeys(Context ctx, string formId, List<string> keys)

        {

            if (keys == null || keys.Count == 0)

            {

                return false;

            }


            var metadata = FormMetaDataCache.GetCachedFormMetaData(ctx, formId);

            if (metadata == null)

            {

                return false;

            }


            using (DataEntityCacheManager cacheManager = new DataEntityCacheManager(ctx, metadata.BusinessInfo.GetDynamicObjectType()))

            {

                cacheManager.RemoveCacheByPrimaryKeys(keys);

            }


            CacheUtil.ClearCache(ctx.DBId + formId, CacheRegionConst.BOS_QuickBaseDataCache);

            return true;

        }

    }

}


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


<3>BOSIDE扩展采购订单,菜单集合新增3个菜单项,注册表单插件,保存元数据,开发完毕。



【功能验证】

<1>登录业务站点,打开采购订单编辑界面,点击菜单【后台修改物料数据】,修改物料的规则型号。

退出采购订单当前界面并重新进入,因为物料缓存数据的存在,此时显示的物料的规格型号还是旧数据,点击菜单【清除指定内码的物料的所有缓存】,再次退出采购订单当前界面并重新进入,此时显示的物料的规格型号数据已刷新。

---------------------------------------------------------------------------------------------------------













【金蝶云星空BOS二次开发案例演示】https://vip.kingdee.com/article/94751030918525696

二开案例.单据插件.缓存清理

【应用场景】直接后台修改了数据,前端缓存不会自动刷新,此时,需要在后台手动调用一下缓存清理服务。【注意】本案例仅适用于22年9月,以...
点击下载文档
确认删除?
回到顶部
客服QQ
  • 客服QQ点击这里给我发消息