基于 abp vNext 和 .NET Core 开发博客项目 - 使用Redis缓存数据
基于 abp vNext 和 .NET Core 開發博客項目 - 使用Redis緩存數據
轉載于：https://github.com/Meowv/Blog
在日志記錄中使用的靜態方法有人指出寫法不是很優雅，遂優化一下上一篇中日志記錄的方法，具體操作如下：
在.ToolKits層中新建擴展方法Log4NetExtensions.cs。
//Log4NetExtensions.cs
using log4net;
using log4net.Config;
using Microsoft.Extensions.Hosting;
using System.IO;
using System.Reflection;
namespace Meowv.Blog.ToolKits.Extensions
{
public static class Log4NetExtensions
{
public static IHostBuilder UseLog4Net(this IHostBuilder hostBuilder)
{
var log4netRepository = LogManager.GetRepository(Assembly.GetEntryAssembly());
XmlConfigurator.Configure(log4netRepository, new FileInfo(“log4net.config”));
}
配置log4net，然后我們直接返回IHostBuilder對象，便于在Main方法中鏈式調用。
//Program.cs
using Meowv.Blog.ToolKits.Extensions;
using Microsoft.AspNetCore.Hosting;
using Microsoft.Extensions.Hosting;
using System.Threading.Tasks;
namespace Meowv.Blog.HttpApi.Hosting
{
public class Program
{
public static async Task Main(string[] args)
{
await Host.CreateDefaultBuilder(args)
.UseLog4Net()
.ConfigureWebHostDefaults(builder =>
{
builder.UseIISIntegration()
.UseStartup();
}).UseAutofac().Build().RunAsync();
}
}
}
然后修改MeowvBlogExceptionFilter過濾器，代碼如下：
//MeowvBlogExceptionFilter.cs
using log4net;
using Microsoft.AspNetCore.Mvc.Filters;
namespace Meowv.Blog.HttpApi.Hosting.Filters
{
public class MeowvBlogExceptionFilter : IExceptionFilter
{
private readonly ILog _log;
}
可以刪掉之前添加的LoggerHelper.cs類，運行一下，同樣可以達到預期效果。
本篇將集成Redis，使用Redis來緩存數據，使用方法參考的微軟官方文檔：https://docs.microsoft.com/zh-cn/aspnet/core/performance/caching/distributed
關于Redis的介紹這里就不多說了，這里有一篇快速入門的文章：Redis快速入門及使用，對于不了解的同學可以看看。
直入主題，先在appsettings.json配置Redis的連接字符串。
//appsettings.json
…
“Caching”: {
“RedisConnectionString”: “127.0.0.1:6379,password=123456,ConnectTimeout=15000,SyncTimeout=5000”
}
…
對應的，在AppSettings.cs中讀取。
//AppSettings.cs
…
///
/// Caching
///
public static class Caching
{
///
/// RedisConnectionString
///
public static string RedisConnectionString => _config[“Caching:RedisConnectionString”];
}
…
在.Application.Caching層添加包Microsoft.Extensions.Caching.StackExchangeRedis，然后在模塊類MeowvBlogApplicationCachingModule中添加配置緩存實現。
//MeowvBlogApplicationCachingModule.cs
using Meowv.Blog.Domain;
using Meowv.Blog.Domain.Configurations;
using Microsoft.Extensions.DependencyInjection;
using Volo.Abp.Caching;
using Volo.Abp.Modularity;
namespace Meowv.Blog.Application.Caching
{
[DependsOn(
typeof(AbpCachingModule),
typeof(MeowvBlogDomainModule)
)]
public class MeowvBlogApplicationCachingModule : AbpModule
{
public override void ConfigureServices(ServiceConfigurationContext context)
{
context.Services.AddStackExchangeRedisCache(options =>
{
options.Configuration = AppSettings.Caching.RedisConnectionString;
//options.InstanceName
//options.ConfigurationOptions
});
}
}
}
options.Configuration是 Redis 的連接字符串。
options.InstanceNam是 Redis 實例名稱，這里沒填。
options.ConfigurationOptions是 Redis 的配置屬性，如果配置了這個字，將優先于 Configuration 中的配置，同時它支持更多的選項。我這里也沒填。
緊接著我們就可以直接使用了，直接將IDistributedCache接口依賴關系注入即可。
圖片
可以看到默認已經實現了這么多常用的接口，已經夠我這個小項目用的了，同時在Microsoft.Extensions.Caching.Distributed.DistributedCacheExtensions中微軟還給我們提供了很多擴展方法。
于是，我們我就想到寫一個新的擴展方法，可以同時處理獲取和添加緩存的操作，當緩存存在時，直接返回，不存在時，添加緩存。
新建MeowvBlogApplicationCachingExtensions.cs擴展方法，如下：
//MeowvBlogApplicationCachingExtensions.cs
using Meowv.Blog.ToolKits.Extensions;
using Microsoft.Extensions.Caching.Distributed;
using System;
using System.Threading.Tasks;
namespace Meowv.Blog.Application.Caching
{
public static class MeowvBlogApplicationCachingExtensions
{
///
/// 獲取或添加緩存
///
///
///
///
///
///
///
public static async Task GetOrAddAsync(this IDistributedCache cache, string key, Func<Task> factory, int minutes)
{
TCacheItem cacheItem;
}
我們可以在DistributedCacheEntryOptions中可以配置我們的緩存過期時間，其中有一個判斷條件，就是當minutes = -1的時候，不指定過期時間，那么我們的緩存就不會過期了。
GetStringAsync()、SetStringAsync()是DistributedCacheExtensions的擴展方法，最終會將緩存項cacheItem轉換成JSON格式進行存儲。
CacheStrategy是在.Domain.Shared層定義的緩存過期時間策略常量。
//MeowvBlogConsts.cs
…
///
/// 緩存過期時間策略
///
public static class CacheStrategy
{
///
/// 一天過期24小時
///
…
接下來去創建緩存接口類和實現類，然后再我們的引用服務層.Application中進行調用，拿上一篇中接入GitHub的幾個接口來做新增緩存操作。
和.Application層格式一樣，在.Application.Caching中新建Authorize文件夾，添加緩存接口IAuthorizeCacheService和實現類AuthorizeCacheService。
注意命名規范，實現類肯定要繼承一個公共的CachingServiceBase基類。在.Application.Caching層根目錄添加MeowvBlogApplicationCachingServiceBase.cs，繼承ITransientDependency。
//MeowvBlogApplicationCachingServiceBase.cs
using Microsoft.Extensions.Caching.Distributed;
using Volo.Abp.DependencyInjection;
namespace Meowv.Blog.Application.Caching
{
public class CachingServiceBase : ITransientDependency
{
public IDistributedCache Cache { get; set; }
}
}
然后使用屬性注入的方式，注入IDistributedCache。這樣我們只要繼承了基類：CachingServiceBase，就可以愉快的使用緩存了。
添加要緩存的接口到IAuthorizeCacheService，在這里我們使用Func()方法，我們的接口返回什么類型由Func()來決定，于是添加三個接口如下：
//IAuthorizeCacheService.cs
using Meowv.Blog.ToolKits.Base;
using System;
using System.Threading.Tasks;
namespace Meowv.Blog.Application.Caching.Authorize
{
public interface IAuthorizeCacheService
{
///
/// 獲取登錄地址(GitHub)
///
///
Task<ServiceResult> GetLoginAddressAsync(Func<Task<ServiceResult>> factory);
}
是不是和IAuthorizeService代碼很像，的確，我就是直接復制過來改的。
在AuthorizeCacheService中實現接口。
//AuthorizeCacheService.cs
using Meowv.Blog.ToolKits.Base;
using Meowv.Blog.ToolKits.Extensions;
using System;
using System.Threading.Tasks;
using static Meowv.Blog.Domain.Shared.MeowvBlogConsts;
namespace Meowv.Blog.Application.Caching.Authorize.Impl
{
public class AuthorizeCacheService : CachingServiceBase, IAuthorizeCacheService
{
private const string KEY_GetLoginAddress = “Authorize:GetLoginAddress”;
}
代碼很簡單，每個緩存都有固定KEY值，根據參數生成KEY，然后調用前面寫的擴展方法，再給一個過期時間即可，可以看到KEY里面包含了冒號 :，這個冒號 : 可以起到類似于文件夾的操作，在界面化管理工具中可以很友好的查看。
這樣我們的緩存就搞定了，然后在.Application層對應的Service中進行調用。代碼如下：
//AuthorizeService.cs
using Meowv.Blog.Application.Caching.Authorize;
using Meowv.Blog.Domain.Configurations;
using Meowv.Blog.ToolKits.Base;
using Meowv.Blog.ToolKits.Extensions;
using Meowv.Blog.ToolKits.GitHub;
using Microsoft.IdentityModel.Tokens;
using System;
using System.IdentityModel.Tokens.Jwt;
using System.Linq;
using System.Net;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Security.Claims;
using System.Threading.Tasks;
namespace Meowv.Blog.Application.Authorize.Impl
{
public class AuthorizeService : ServiceBase, IAuthorizeService
{
private readonly IAuthorizeCacheService _authorizeCacheService;
private readonly IHttpClientFactory _httpClient;
}
直接return我們的緩存接口，當查詢到Redis中存在KEY值的緩存就不會再走我們的具體的實現方法了。
注意注意，千萬不要忘了在.Application層的模塊類中添加依賴緩存模塊MeowvBlogApplicationCachingModule，不然就會報錯報錯報錯(我就是忘了添加…)
//MeowvBlogApplicationCachingModule.cs
using Meowv.Blog.Domain;
using Meowv.Blog.Domain.Configurations;
using Microsoft.Extensions.DependencyInjection;
using Volo.Abp.Caching;
using Volo.Abp.Modularity;
namespace Meowv.Blog.Application.Caching
{
[DependsOn(
typeof(AbpCachingModule),
typeof(MeowvBlogDomainModule)
)]
public class MeowvBlogApplicationCachingModule : AbpModule
{
public override void ConfigureServices(ServiceConfigurationContext context)
{
context.Services.AddStackExchangeRedisCache(options =>
{
options.Configuration = AppSettings.Caching.RedisConnectionString;
});
}
}
}
此時項目的層級目錄結構。
圖片
好的，編譯運行項目，現在去調用接口看看效果，為了真實，這里我先將我redis緩存數據全部干掉。
圖片
訪問接口，…/auth/url，成功返回數據，現在再去看看我們的redis。
圖片
成功將KEY為：Authorize:GetLoginAddress 添加進去了，這里直接使用RedisDesktopManager進行查看。
圖片
那么再次調用這個接口，只要沒有過期，就會直接返回數據了，調試圖如下：
圖片
可以看到，是可以直接取到緩存數據的，其他接口大家自己試試吧，一樣的效果。
是不是很簡單，用最少的代碼集成Redis進行數據緩存，你學會了嗎？😁😁😁
開源地址：https://github.com/Meowv/Blog/tree/blog_tutorial
總結
以上是生活随笔為你收集整理的基于 abp vNext 和 .NET Core 开发博客项目 - 使用Redis缓存数据的全部內容，希望文章能夠幫你解決所遇到的問題。
- 上一篇： 基于 abp vNext 和 .NET
- 下一篇： 基于 abp vNext 和 .NET