abpvnext中使用后台工作者BackgroundWorker创建定时任务，实现定时从更新要缓存的数据到redis

abpvnext中使用后台工作者BackgroundWorker创建定时任务，实现定时从更新需要缓存的数据到redis

一、创建后台工作者

1、创建后台工作者

在application层 创建后台工作者类，内容如下 ，其中TAHM为我的自定义前缀名。 这个类的DoWorkAsync方法就是后台工作者默认定时执行的方法，重写这个方法可以填充自己的业务。

注意：为什么我在这个类里加了这么多service注入，那是因为我在第二步创建加载缓存的业务LoadEquipInfoService时，需要这些service，但是我在那边又没法初始化，只能在这个类里初始化，并借助doworkasync方法中的参数

workerContext.ServiceProvider.GetRequiredService<ILoadEquipInfoService>(); 来获取我的缓存业务接口对象，然后他需要的service初始化值就传递过去。

其实简单点理解，就是这个后台工作者类相当于一个控制器，DoWorkAsync相当于一个控制器暴露接口，后台工作者使用的service中需要注入和初始化的对象都要从这里通过workerContext来实现。

using JQ.TAHM.Application.Contracts;
using JQ.TAHM.Domain.Shared;
using JQ.TAHM.Domain;
using Microsoft.Extensions.DependencyInjection; 
using Volo.Abp.BackgroundWorkers;
using Volo.Abp.Caching;
using Volo.Abp.TenantManagement;
using Volo.Abp.Threading;

namespace JQ.TAHM.Application;

public class TAHMBackgroundWorker : AsyncPeriodicBackgroundWorkerBase
    {

        private readonly IDistributedCache<List<PageTahmCJ_descOutput>, string> _cj_descCache;
        private readonly IDistributedCache<List<TahmCJ_wd_tmpDto>, string> _cj_wd_tmpCache;
        private readonly ITenantRepository _tenantrepository;
        private readonly ITahmCJ_descAppService _cj_descappService;
        private readonly ITahmCJ_wd_tmpAppService _cj_wd_tmpappService;
        public TAHMBackgroundWorker(
             AbpAsyncTimer timer,
             IServiceScopeFactory serviceScopeFactory, IDistributedCache<List<PageTahmCJ_descOutput>, string> cj_descCache, IDistributedCache<List<TahmCJ_wd_tmpDto>, string> cj_wd_tmpCache, ITenantRepository tenantrepository, ITahmCJ_descAppService cj_descappService, ITahmCJ_wd_tmpAppService cj_wd_tmpappService
         ) : base(
             timer,
             serviceScopeFactory)
        { 
            Timer.Period = 20000; //此行为任务执行间隔时间，单位毫秒
            //下面5行变量初始化的代码可以不要，这是我的业务需要
            _cj_descCache = cj_descCache;
            _cj_wd_tmpCache = cj_wd_tmpCache;
            _tenantrepository = tenantrepository;
            _cj_descappService = cj_descappService;
            _cj_wd_tmpappService = cj_wd_tmpappService;

        } 
        protected async override Task DoWorkAsync(PeriodicBackgroundWorkerContext workerContext)
        { 
            //这个方法必须重写实现，因为abp默认就会定时执行这个方法.
            //初始可以写Console.WriteLine($"DoWorkAsync执行一次"); 
            //的日志行测试是后台工作者否设定成功。
            var loadEquipInfoService = workerContext
                .ServiceProvider 
                .GetRequiredService<ILoadEquipInfoService>(); 

            await loadEquipInfoService.LoadEquipInfoWithCache(); 
            
        } 
    }

2、注册后台工作者

在HttpApi.Host层 ， HttpApiHostModule类，OnApplicationInitialization方法下写入注册后台工作者的代码。我的代码行如下：

context.AddBackgroundWorkerAsync<TAHMBackgroundWorker>();

二、定时更新缓存数据到redis

1. 做好redis配置

我的HttpApi.Host层，appsettings.json配置代码如下：

"Redis": {

"Configuration": "IP:端口,password=密码,defaultDatabase=2(默认数据库号根据自己实际情况填写),ssl=false,sslHost=null,connectTimeout=4000,allowAdmin=true"

},

然后在HttpApi.Host层，ttpApiHostModule类中 创建一个缓存配置方法，由重写的ConfigureServices方法调用执行。

 private void ConfigureCache(ServiceConfigurationContext context)
        {
            //为应用程序设置缓存键前缀
            Configure<AbpDistributedCacheOptions>(
                options => { options.KeyPrefix = "TAHM:"; }); 
            //下面两行获取redis连接串配置
            var configuration = context.Services.GetConfiguration();
            var redis = ConnectionMultiplexer.Connect(configuration["Redis:Configuration"]);
            //下面这一段的目的我没猜透，加载redis连接串以提供数据防护？
            context.Services
                .AddDataProtection()
                .PersistKeysToStackExchangeRedis(redis, "TAHM-Protection-Keys");
        }

2. 在application层创建一个定时执行的业务接口(类)ILoadEquipInfoService，我的类在这个层下面， 接口在 Application.Contracts下面。

这个类就是定时任务的业务执行类了，注意除了继承自己类名本身的接口外，还需要继承ApplicationService, ITransientDependency。 而这个类所注入的所有对象，都需要调用他的主人去初始化传导过来。这也符合abp其他通用appService的使用逻辑。

IDistributedCache对象用来存储缓存键值对。

我是要实现定时从数据表按所属租户取出设备信息缓存到redis，以供其他业务使用，所以首先要取出所有租户。开始用ITenantAppService 来取出租户列表，报错提示没有权限，后来被迫无奈直接用ITenantRepository.GetListAsync取列表。

接口类代码如下：

using JQ.TAHM.Application.Contracts; 
using JQ.TAHM.Domain.Shared;
using Microsoft.Extensions.Caching.Distributed;
using Volo.Abp.Caching; 
using Volo.Abp.TenantManagement;
namespace JQ.TAHM.Application;

public class LoadEquipInfoService : ApplicationService, ITransientDependency, ILoadEquipInfoService
    {
        private readonly IDistributedCache<List<PageTahmCJ_descOutput>, string> _cj_descCache;
        private readonly IDistributedCache<List<TahmCJ_wd_tmpDto>, string> _cj_wd_tmpCache;
        
        private readonly ITahmCJ_descAppService _cj_descappService;
        private readonly ITahmCJ_wd_tmpAppService _cj_wd_tmpappService;
        private readonly ITenantAppService _tenantAppService;
        private readonly ITenantRepository _tenantrepository;
        public LoadEquipInfoService(IDistributedCache<List<PageTahmCJ_descOutput>, string> cj_descCache, IDistributedCache<List<TahmCJ_wd_tmpDto>, string> cj_wd_tmpCache, ITenantRepository tenantrepository, ITahmCJ_descAppService cj_descapp, ITahmCJ_wd_tmpAppService cj_wd_tmpapp )
        {
            _tenantrepository = tenantrepository;
            _cj_descappService =    cj_descapp;
            _cj_descCache = cj_descCache;
            _cj_wd_tmpCache = cj_wd_tmpCache;
            _cj_wd_tmpappService = cj_wd_tmpapp;
        }

        public async Task LoadEquipInfoWithCache()
        {
            NoPageTahmCJ_descInput mydescFilter = new NoPageTahmCJ_descInput(); 
            var allTenant= await _tenantrepository.GetListAsync(null,1000000,0,null);

            foreach (var tenant in allTenant)
            {
                mydescFilter.TenantId = tenant.Id.ToString();
                await GetListNoPageAsync(mydescFilter);
            }
            await Task.CompletedTask;
        }

        public async Task<List<PageTahmCJ_descOutput>> GetListNoPageAsync(NoPageTahmCJ_descInput mydescInput)
        {
            var mycachlist = new List<PageTahmCJ_descOutput>();
            var mydescList = _cj_descappService.GetListNoPageAsync(mydescInput);
            var tenantKey = mydescInput.TenantId + "_Desc";
             var cache_option = new DistributedCacheEntryOptions{ AbsoluteExpiration = DateTimeOffset.Now.AddSeconds(20)};  //缓存有效间隔设置

            //强行设置 ，每次更新缓存里的值
            await _cj_descCache.SetAsync(
                tenantKey, 
                await mydescList,
                cache_option
            );


            //查看缓存对象中是否有对应键值的内容存储在，不存在就加入list数据，这个方法有返回list，但是他不会每次都更新缓存里的值。 其实有了上面的SetAsync,这里就可以不需要了
            mycachlist = await _cj_descCache.GetOrAddAsync(
                tenantKey, //缓存键名
                //下面这一行还不能改为同步，只能用异步函数然后await变量值
                async () => await mydescList,
                () =>cache_option
            );

            return mycachlist;
        }
 
    }

接口代码如下：

namespace JQ.TAHM.Application.Contracts;

public interface ILoadEquipInfoService: IApplicationService
{ 
    Task LoadEquipInfoWithCache();
}

以上是我为了实现定时从数据库取出数据缓存到redis的基本思路代码，LoadEquipInfoService其实还有其他数据需要加载到redis，为避免内容太多看不懂，本文就写了一个数据表的redis缓存业务。