asp.net core上使用Redis探索(2)

在<<asp.net core上使用Redis探索(1)>>中，我介紹了一個微軟官方實現Microsoft.Extensions.Caching.Redis的類庫，這次，我們使用微軟官方的Redis客戶端。

使用Nuget引入Microsoft.Extensions.Caching.Redis庫, 依賴項:
Microsoft.Extensions.Caching.Abstract
Microsoft.Extensions.Options
StackExchange.Redis.StrongName

原來Microsoft.Extensions.Caching.Redis其實就是封裝了StackExchange.redis，作為.net core平台下的redis客戶端與redis通信的。

源碼地址:
https://github.com/aspnet/Caching/tree/dev/src/Microsoft.Extensions.Caching.Redis
源碼分析:
RedisCache繼承自IDistributeCache接口，該接口是Microsoft.Extensions.Caching.Distributed命名空間下的一個接口，主要就是封裝了Redis的一些最基本的操作，比如，Set, Get, Refresh, Remove.就是最基本的增刪改查。
RedisCache類中有一個用於同步的SemaphoreSlim類，該類是CLR中的同步遍歷的混合構造——內核模式和用戶模式的混合。該類除了顯式實現了IDistributedCache的所有方法外，還有一個重要的方法要說下，那就是Connect()方法:

private void Connect()
{
    if (_cache != null)
    {
        return;
    }

    _connectionLock.Wait();
    try
    {
        if (_cache == null)
        {
            _connection = ConnectionMultiplexer.Connect(_options.Configuration);
            _cache = _connection.GetDatabase();
        }
    }
    finally
    {
        _connectionLock.Release();
    }
}

該方法用於連接Redis服務器，通過RedisCacheOptions這個類的屬性，來連接redis數據庫，源碼:

/// <summary>
/// Configuration options for <see cref="RedisCache"/>.
/// </summary>
public class RedisCacheOptions : IOptions<RedisCacheOptions>
{
    /// <summary>
    /// The configuration used to connect to Redis.
    /// </summary>
    public string Configuration { get; set; }

    /// <summary>
    /// The Redis instance name.
    /// </summary>
    public string InstanceName { get; set; }

    RedisCacheOptions IOptions<RedisCacheOptions>.Value
    {
        get { return this; }
    }
}

其中的Configuration屬性就是我們的一般在.config文件中配置redis連接語句的地方，隨后我們會講到應用。而InstanceName是什么？繼續看源碼(RedisCache.cs文件):

private readonly RedisCacheOptions _options;
public RedisCache(IOptions<RedisCacheOptions> optionsAccessor)
{
    if (optionsAccessor == null)
    {
        throw new ArgumentNullException(nameof(optionsAccessor));
    }

    _options = optionsAccessor.Value;

    // This allows partitioning a single backend cache for use with multiple apps/services.
    _instance = _options.InstanceName ?? string.Empty;
}

可以看到，這個屬性是可以設置為空的，那么它到底是什么呢？這個就是我們在存儲redis的時候的前綴了，我們可以這么這是Demo, 或者Demo:test等。
也就是說RedisCache類主要就是實現了IDistributedCache接口的所有方法，同時另外實現了Connect()方法用來連接redis，而這個的連接又是基於StackExchange.Redis(關於StackExchange.Redis請看  StackExchange.Redis通用封裝類分享 )的ConnectionMultiplexer。但是我們在大型項目中使用的redis隊列在RedisCache類中並沒有實現，但是，要知道整個asp.net-core都是可拓展的，我們可以基於RedisCache類再實現一個pub/sub方法用來做消息隊列。
最后使用asp.net-core默認的DI容器將RedisCache類注冊到框架中。RedisCacheServiceCollectionExtensions類源碼:

/// <summary>
/// Extension methods for setting up Redis distributed cache related services in an <see cref="IServiceCollection" />.
/// </summary>
public static class RedisCacheServiceCollectionExtensions
{
    /// <summary>
    /// Adds Redis distributed caching services to the specified <see cref="IServiceCollection" />.
    /// </summary>
    /// <param name="services">The <see cref="IServiceCollection" /> to add services to.</param>
    /// <param name="setupAction">An <see cref="Action{RedisCacheOptions}"/> to configure the provided
    /// <see cref="RedisCacheOptions"/>.</param>
    /// <returns>The <see cref="IServiceCollection"/> so that additional calls can be chained.</returns>
    public static IServiceCollection AddDistributedRedisCache(this IServiceCollection services, Action<RedisCacheOptions> setupAction)
    {
        if (services == null)
        {
            throw new ArgumentNullException(nameof(services));
        }

        if (setupAction == null)
        {
            throw new ArgumentNullException(nameof(setupAction));
        }

        services.AddOptions();
        services.Configure(setupAction);
        // .net core DI容器的使用無非就是在容器中實例化接口，而接口的的實例化，是通過實例化接口的派生類(即以接口為父類的子類)...
        services.Add(ServiceDescriptor.Singleton<IDistributedCache, RedisCache>());

        return services;
    }
}

在這里我們基於IServiceCollection接口拓展出來了一個方法，該方法就是微軟官方為我們創建的基於Redis的實現了，在最后使用DI的三種方法的Singleton來實現IOC。那么我們怎么來使用呢？
引入完了Microsoft.Extensions.Caching.Redis之后，在Startup類中:

services.AddDistributedRedisCache(option =>
{
    option.Configuration = "123.207.96.138:6379, password=*****";
    option.InstanceName = "";
});

個人的建議是給Redis設置一個密碼，要不然容易被攻擊。
接下來就是給Redis設置值了, 我們新建一個WebApi的程序，然后新建一個HomeController Api控制器

[Produces("application/json")]
[Route("api/[controller]")]
public class HomeController : Controller
{
    // 通過構造函數注入，內置IOC容器實例化了之后，就可以通過接口對象來調用相應的函數了.
    private readonly IDistributedCache _distributedCache;

    public HomeController(IDistributedCache distributedCache)
    {
        _distributedCache = distributedCache;
    }

    [HttpGet]
    public async Task<string> Get()
    {
        
        var cacheKey = "TheTime";

        //await _distributedCache.RemoveAsync(cacheKey);
        
        var existingTime = _distributedCache.GetString(cacheKey);
        if (!string.IsNullOrEmpty(existingTime))
        {
            return "Fetched from cache : " + existingTime;
        }
        else
        {
            existingTime = DateTime.UtcNow.ToString();
            
            _distributedCache.SetString(cacheKey, existingTime);
            return "Added to cache : " + existingTime;
        }
    }
}

代碼我就不運行了，親測能用。

百度雲盤demo下載地址: 

鏈接：https://pan.baidu.com/s/1vzuS5pEk_Ouh9I-NkPWXfg 密碼：armw