文章出處

自從接觸 IOptions 之后,一直糾結這樣的問題:自己定義的 Options 要不要實現 IOptions 接口。

微軟有的項目中實現了,比如 Caching 中的 MemoryCacheOptions :

public class MemoryCacheOptions : IOptions<MemoryCacheOptions>
{
    public ISystemClock Clock { get; set; }
    public TimeSpan ExpirationScanFrequency { get; set; } = TimeSpan.FromMinutes(1);
    MemoryCacheOptions IOptions<MemoryCacheOptions>.Value
    {
        get { return this; }
    }
}

有的項目中就沒有實現,比如 Session 中的 SessionOptions :

    public class SessionOptions
    {
        public string CookieName { get; set; } = SessionDefaults.CookieName;
        public string CookieDomain { get; set; }
        public string CookiePath { get; set; } = SessionDefaults.CookiePath;
        public bool CookieHttpOnly { get; set; } = true;
        public CookieSecurePolicy CookieSecure { get; set; } = CookieSecurePolicy.None;
        public TimeSpan IdleTimeout { get; set; } = TimeSpan.FromMinutes(20);
    }

但自己一直沒發現實現 IOptions 究竟有什么用處,于是之前的代碼就都沒實現,比如之前一篇博文中的 TopClientOptions

今天在使用 EnyimMemcachedCore ,需要手動 new MemcachedClientOptions 給 MemcachedClientConfiguration 的構造函數傳參時,終于明白了實現 IOptions 的真正用處。

public class MemcachedClientConfiguration : IMemcachedClientConfiguration
{
    public MemcachedClientConfiguration(
        ILogger<MemcachedClient> logger,
        IOptions<MemcachedClientOptions> optionsAccessor)
    {
    }
}

如果 MemcachedClientOptions 不實現 IOptions<MemcachedClientOptions> 接口,就根本無法將 MemcachedClientOptions 的實例傳遞給 MemcachedClientConfiguration 的構造函數。

所以,如果完全使用依賴注入,不會出現手動 new 的情況,可以不用實現 IOptions 。否則,必須要實現。保險起見,還是實現一下為好。

public class MemcachedClientOptions : IOptions<MemcachedClientOptions>
{
    //..
    public MemcachedClientOptions Value => this;
}

文章列表


不含病毒。www.avast.com
arrow
arrow
    全站熱搜
    創作者介紹
    創作者 大師兄 的頭像
    大師兄

    IT工程師數位筆記本

    大師兄 發表在 痞客邦 留言(0) 人氣()