2. 程式人生 > >ASP.NET Core 中的配置

ASP.NET Core 中的配置

阿新 • • 發佈：2018-09-26
ted .com 托管 lee obj 根據 webapi ocs 根目錄

前言

配置在我們開發過程中必不可少，ASP.NET中的配置在 Web.config 中。也可配置在如：JSON、XML、數據庫等(但ASP.NET並沒提供相應的模塊和方法)。

在ASP.NET Core中Web.config已經不存在了(但如果托管到 IIS 的時候可以使用 web.config 配置 IIS)，

而是用appsettings.json和appsettings.(Development、Staging、Production).json配置文件

(可以理解為ASP.NET中的Web.config和Web.Release.config的關系)。

下面我們一起看下ASP.NET Core 中的配置

基礎用法

HomeController.cs：

[ApiController]
public class HomeController : ControllerBase
{
    private readonly IConfiguration _configuration;
    public HomeController(IConfiguration configuration)
    {
        _configuration = configuration;
    }

    [HttpGet("/")]
    public dynamic Index()
    {
        return JsonConvert.SerializeObject(new
        {
            ConnectionString = _configuration["ConnectionString"],
            Child1 = _configuration["Parent:Child1"],
            Grandchildren = _configuration["Parent:Child2:Grandchildren"]
        });
    }
}

返回結果：

{
    "ConnectionString": "data source=.;initial catalog=TEST;user id=sa",
    "Child1": "child",
    "Grandchildren": "grandchildren"
}

對應appsettings.json的值：

{
    "ConnectionString": "data source=.;initial catalog=TEST;user id=sa;password=123",
    "Parent": {
        "Child1": "child1",
        "Child2": "child2"
    }
}

需要註意的：

  • 鍵不區分大小寫。 例如，ConnectionString 和 connectionstring 被視為等效鍵。

  • 如果鍵名相同(包含所有加載的配置文件),以最後一個值為準。

    所以appsettings.(Development、Staging、Production).json會覆蓋appsettings.json的配置信息。

    • 多層級用:來分割,但如果是環境變量則存在跨平臺問題 查看具體細節
    • 上面這種寫法是沒緩存的即：appsettings.json修改後,獲取的值會立即改變

綁定到對象 IOptions<TestOptions>

對於_configuration["Parent:Child2:Grandchildren"]的寫法對程序員來說肯定很反感,下面我們看下把配置文件綁定到對象中。

  1. 首先把 JSON 對象轉換成對象

    public class TestOptions
{
    public string ConnectionString { get; set; }
    public Parent Parent { get; set; }
}
public class Parent
{
    public string Child1 { get; set; }
    public Child2 Child2 { get; set; }
}
public class Child2
{
    public string GrandChildren { get; set; }
}

  2. 在Startup.cs的ConfigureServices方法添加代碼：

    services.Configure<TestOptions>(Configuration);

  3. HomeController.cs：

    [ApiController]
public class HomeController : ControllerBase
{
    private readonly IOptions<TestOptions> _options;

    public HomeController(IOptions<TestOptions> options)
    {
        _options = options;
    }

    [HttpGet("options")]
    public string Options()
    {
        return JsonConvert.SerializeObject(_options);
    }
}

    返回的結果如下：

    {
"Value": {
    "ConnectionString": "data source=.;initial catalog=TEST;user id=sa",
        "Parent": {
        "Child1": "child",
            "Child2": {
            "GrandChildren": "grandchildren"
            }
        }
    }
}

發現

  • 如果我們修改appsettings.json，然後刷新頁面，會發現值並沒用變

  • 我們發現根節點是Value

    根據上面 2 個問題我們去看源代碼：

    首先找到這句：

    services.TryAdd(ServiceDescriptor.Singleton(typeof(IOptions<>), typeof(OptionsManager<>)));

    我們去看OptionsManager方法：

    public class OptionsManager<TOptions> : IOptions<TOptions>, IOptionsSnapshot<TOptions> where TOptions : class, new()
{
    private readonly IOptionsFactory<TOptions> _factory;
    // 註解: _cache 為 ConcurrentDictionary<string, Lazy<TOptions>>()
    // 不知道註意到上面註入方法沒，用的是 Singleton 單例,所以更新配置文件後沒及時更新
    private readonly OptionsCache<TOptions> _cache = new OptionsCache<TOptions>();

    public OptionsManager(IOptionsFactory<TOptions> factory)
    {
        _factory = factory;
    }

    /// <summary>
    /// TOptions的默認配置實例
    /// 這裏就是為什麽根節點為Value
    /// </summary>
    public TOptions Value
    {
        get
        {
            return Get(Options.DefaultName);
        }
    }

    /// <summary>
    /// 該方法在 IOptionsSnapshot 接口中
    /// </summary>
    public virtual TOptions Get(string name)
    {
        name = name ?? Options.DefaultName;

        // Store the options in our instance cache
        return _cache.GetOrAdd(name, () => _factory.Create(name));
    }
}

綁定到對象 IOptionsSnapshot<TestOptions>

  1. 與 IOptions<TestOptions> 的用法一樣，區別就是依賴註入的生命周期為Scoped,所以沒緩存，直接看代碼：

    services.TryAdd(ServiceDescriptor.Scoped(typeof(IOptionsSnapshot<>), typeof(OptionsManager<>)));

  2. IOptionsSnapshot<TOptions> 比 IOptions<TOptions> 多了個方法TOptions Get(string name);

    Value屬性其實就是調用了該方法，只是name為Options.DefaultName

  3. IOptionsSnapshot<TOptions> 繼承了 IOptions<TOptions> (這裏有個疑問，上面的OptionsManager<TOptions>繼承了IOptions<TOptions>, IOptionsSnapshot<TOptions>2 個接口,也許是為了清晰吧)。

自定義配置文件(JSON)

有的時候配置信息很多，想在單獨的文件中配置，ASP.NET Core 提供了INI、XML、JSON文件系統加載配置的方法。

  1. 首先在 Program.cs的CreateWebHostBuilder方法中添加如下代碼：

    public static IWebHostBuilder CreateWebHostBuilder(string[] args)
 {
     return WebHost.CreateDefaultBuilder(args)
                 .ConfigureAppConfiguration((hostingContext, config) =>
                 {
                     //設置根目錄,我們放在 /Config 文件夾下
                     // 此種寫法不會加載  `appsettings.json`
                     // config.SetBasePath(Path.Combine(Directory.GetCurrentDirectory(), "Config"));
                     config.SetBasePath(Directory.GetCurrentDirectory());
                     //添加 setting.json 配置文件
                     //optional： 文件是否可選，當為false時 如果文件不存在 程序啟動不起來
                     //reloadOnChange：文件改變後是否重新加載
                     config.AddJsonFile("Config/setting.json", optional: false, reloadOnChange: false);
                 })
                 .UseStartup<Startup>();
 }

    我們看下 reloadOnChange 參數處理了哪些事情：

    if (Source.ReloadOnChange && Source.FileProvider != null)
{
    ChangeToken.OnChange(
        //監視文件 如果改變就執行 Load(true) 方法
        () => Source.FileProvider.Watch(Source.Path),
        () => {
            Thread.Sleep(Source.ReloadDelay);
            Load(reload: true);
        });
}

  2. 創建setting.json：

    {
        "Rookie": {
            "Name": "DDD",
            "Age": 12,
            "Sex": "男"
        }
}

  3. 在 Controller 中：

     [Route("api/[controller]")]
 [ApiController]
 public class OptionsController : ControllerBase
 {
     private readonly IConfiguration _configuration;
     public OptionsController(IConfiguration configuration)
     {
         _configuration = configuration;
     }
     [HttpGet]
     public string Index()
     {
         return JsonConvert.SerializeObject(new
         {
             Name = _configuration["Rookie:Name"],
             Age = _configuration["Rookie:Age"],
             Sex = _configuration["Rookie:Sex"]
         });
     }
 }

自定義配置文件(JSON)綁定到對象

通過上面配置發現獲取配置用的是 _configuration["Name"] 方式，下面我們綁定到對象上

  1. 定義配置對象 Setting 類

  2. 在Startup.cs的ConfigureServices方法添加代碼：

    services.Configure<Setting>(Configuration.GetSection("Rookie"));

    GetSection方法:獲得指定鍵的配置子部分

  3. 用法和上面一樣

不知道發現個情況沒，我們setting.json的配置文件的信息也是存到_configuration中的，如果文件多了很可能會覆蓋節點，下面我們換一種寫法。

  1. 首先刪除 Program.cs中CreateWebHostBuilder方法的代碼：

    config.AddJsonFile("Config/setting.json", optional: false, reloadOnChange: true);

  2. 修改配置文件setting.json：

    {
   "Name": "DDD",
   "Age": 12,
   "Sex": "男"
}

  3. 在中Startup.cs的ConfigureServices方法中添加：

    var config = new ConfigurationBuilder()
             .SetBasePath(Directory.GetCurrentDirectory())
             .AddJsonFile("Config/setting.json", optional: false, reloadOnChange: true)
             .Build();
 services.Configure<Setting>(config);

這樣就不會影響 全局 的配置信息了

其他方式

  1. 我們看下下面 2 個方式：

    [Route("[controller]")]
[ApiController]
public class HomeController : ControllerBase
{
    private readonly IConfiguration _configuration;
    private readonly TestOptions _bindOptions = new TestOptions();
    private readonly Parent _parent = new Parent();

    public HomeController(IConfiguration configuration)
    {
        //全部綁定
        _configuration.Bind(_bindOptions);
        //部分綁定
        _configuration.GetSection("Parent").Bind(_parent);
    }

    [HttpGet("options")]
    public string Options()
    {
        return JsonConvert.SerializeObject(new
        {
            BindOptions = _bindOptions,
            Parent = _parent
        });
    }
}

    個人感覺這種方式有點多余 ( ╯□╰ )

  2. IOptionsMonitor、IOptionsFactory、IOptionsMonitorCache 方式：

    我們看如下代碼

    services.TryAdd(ServiceDescriptor.Singleton(typeof(IOptions<>), typeof(OptionsManager<>)));
services.TryAdd(ServiceDescriptor.Scoped(typeof(IOptionsSnapshot<>), typeof(OptionsManager<>)));
services.TryAdd(ServiceDescriptor.Singleton(typeof(IOptionsMonitor<>), typeof(OptionsMonitor<>)));
services.TryAdd(ServiceDescriptor.Transient(typeof(IOptionsFactory<>), typeof(OptionsFactory<>)));
services.TryAdd(ServiceDescriptor.Singleton(typeof(IOptionsMonitorCache<>), typeof(OptionsCache<>)));

    這裏只說下 IOptionsMonitor<>:

     [Route("[controller]")]
 [ApiController]
 public class HomeController : ControllerBase
 {
     private readonly IOptionsMonitor<TestOptions> _optionsMonitor;

     public HomeController(IOptionsMonitor<TestOptions> optionsMonitor
     , ILogger<HomeController> logger)
     {
         _optionsMonitor = optionsMonitor;
         _logger = logger;
     }

     [HttpGet("options")]
     public string Options()
     {
         //這裏有個變更委托
         _optionsMonitor.OnChange((options, name) =>
         {
             var info = JsonConvert.SerializeObject(new
             {
                 Options = options,
                 Name = name
             });
             _logger.LogInformation($"配置信息已更改：{info}");
         });
         return JsonConvert.SerializeObject(new
         {
             OptionsMoitor = _optionsMonitor
         });
     }

    當我們修改配置文件後會看到日誌信息：

    info: WebApiSample.Controllers.HomeController[0]
    配置信息已更改：{"Options":{"ConnectionString":"data source=.;initial catalog=TEST;user id=sa","Parent":{"Child1":"child","Child2":{"GrandChildren":"grandchildren"}}},"Name":"TestOptions"}
    info: WebApiSample.Controllers.HomeController[0]
    配置信息已更改：{"Options":{"ConnectionString":"data source=.;initial catalog=TEST;user id=sa","Parent":{"Child1":"child","Child2":{"GrandChildren":"grandchildren"}}},"Name":"TestOptions"}
    info: WebApiSample.Controllers.HomeController[0]
    配置信息已更改：{"Options":{"ConnectionString":"data source=.;initial catalog=TEST;user id=sa","Parent":{"Child1":"child","Child2":{"GrandChildren":"grandchildren"}}},"Name":"TestOptions"}
    info: WebApiSample.Controllers.HomeController[0]
    配置信息已更改：{"Options":{"ConnectionString":"data source=.;initial catalog=TEST;user id=sa","Parent":{"Child1":"child","Child2":{"GrandChildren":"grandchildren"}}},"Name":"TestOptions"}

    不知道為什麽會有這麽多日誌...

    還有一點不管我們修改哪個日誌文件，只要是執行了AddJsonFile的文件，都會觸發該事件

寫在最後

寫的有點亂希望不要見怪，本以為一個配置模塊應該不會復雜，但看了源代碼後發現裏面的東西好多...

本來還想寫下是如何實現的，但感覺太長了就算了。

最後還是希望大家以批判的角度來看，有任何問題可在留言區留言！

ASP.NET Core 中的配置

相關推薦

ASP.NET Core中配置監聽URLs的五種方式

原文： 5 ways to set the URLs for an ASP.NET Core app 作者： Andrew Lock 譯者： Lamond Lu 預設情況下，ASP. NET Core應用會監聽一下2個Url: http://localhost:5000 https://localh

ASP.NET Core 中的配置

ted .com 托管 lee obj 根據 webapi ocs 根目錄 前言 配置在我們開發過程中必不可少，ASP.NET中的配置在 Web.config 中。也可配置在如：JSON、XML、數據庫等(但ASP.NET並沒提供相應的模塊和方法)。 在ASP.NET

ASP.NET Core 中的Ajax全域性Antiforgery Token配置

前言 本文基於官方文件 《在 ASP.NET Core 防止跨站點請求偽造 (XSRF/CSRF) 攻擊》擴充套件另一種全域性配置Antiforgery方法，適用於使用ASP.NET Core Razor + JQuery Ajax的專案，喜歡玩前後端分離的同學可以酌情參考，但希望不要對XSRF/CSRF掉以

（10）ASP.NET Core 中的環境配置

1.環境變數配置 ASP.NET Core在應用程式啟動時讀取環境變數（Properties\launchSettings.json）ASPNETCORE_ENVIRONMENT，並將該值儲存在IHostingEnvironment.EnvironmentName中。ASPNETCORE_ENVIRONME

（11）ASP.NET Core 中的配置一（Configuration）

1.前言 ASP.NET Core在應用程式上引入Microsoft.Extensions.Configuration配置，可以支援多種方式配置，包括命令列配置、環境變數配置、檔案配置、記憶體配置，自定義配置等等。下面我們就其中幾個配置來聊聊。 2.命令列配置 CommandLineConfigurat

（12）ASP.NET Core 中的配置二（Configuration）

1.記憶體配置 MemoryConfigurationProvider使用記憶體中集合作為配置鍵值對。若要啟用記憶體中集合配置，請在ConfigurationBuilder的例項上呼叫AddInMemoryCollection擴充套件方法。可以使用IEnumerable<KeyValuePair<

Asp.Net Core中Json序列化處理整理

忽略 化工 res ref 工具 使用 asp.net ctr ide 一、Asp.Net Core中的Json序列化處理使用的是Newtonsoft.Json,更多參考：C# Newtonsoft.Json JsonSerializerSettings配置序列化操作，C#

在Asp.net core使用配置Json創建動態目錄樹

ref 一個 left 設置 構造 path pat aspnet 演示 一、前言 　　使用動態目錄樹可以使左邊欄中的目錄更加靈活，本文介紹如何將目錄保存在json配置文件中，再讀取出來經過處理後生成目錄樹。 二、數據結構 　　1. TreeMenuNode類名 　　將Tr

asp.net core中負載均衡場景下http重定向https的問題

進行 urn 循環 == 是否 美的 err add ddr 上周欣喜地發現，微軟官方終於針對 asp.net core 在使用負載均衡的情況下從 http 強制重定向至 https 的問題提供了解決方法。 app.UseForwardedHeaders(new Fo

體驗 ASP.NET Core 中的多語言支持（Localization）

lan expander -c blank 根據 body esp doc input 首先在 Startup 的 ConfigureServices 中添加 AddLocalization 與 AddViewLocalization 以及配置 RequestLocaliz

在ASP.NET Core 中使用Cookie中間件

新用戶 private 應該 validate ive mes esp tom 全選 http://ASP.NET Core 提供了Cookie中間件來序列化用戶主題到一個加密的Cookie中並且在後來的請求中校驗這個Cookie，再現用戶並且分配到HttpContext對

ASP.NET.Core中使用AutoMapper

nvi 創建 reat fin intern stat 中間件 isa addm 首先需要在NuGet中引用AutoMapper的類庫 install-package AutoMapper install-package AutoMapper.Extens

.Net Core中配置文件的解析

sof div gets path 構建 sta 讀取 創建 http 資源來自汝鵬網 使用ConfigurationBuilder讀取json配置文件 首先需要先使用Nuget安裝程序集 Install-Package Microsoft.Extensions.Conf

ASP .NET CORE 讀取配置文件的方法

pat clu ros man tab nta director basepath 定義 老式的config文件在ASP。net core2.0中變成了appsettings.json，如果想要讀取自定義配置，可以寫如下代碼 { "Logging": { "I

IdentityServer4在Asp.Net Core中的應用(一)

types eid 應用 temp ant 所有 com 好用 nts IdentityServer4是一套身份授權以及訪問控制的解決方案，專註於幫助使用.Net 技術的公司為現代應用程序建立標識和訪問控制解決方案，包括單點登錄、身份管理、授權和API安全。

IdentityServer4在Asp.Net Core中的應用(二)

str discover content 用戶信息 完成 服務 resp csharp line 繼續上次授權的內容，客戶端模式後我們再說以下密碼模式，先回顧下密碼模式的流程： 我們還是使用上次的代碼，在那基礎上修改，在IdentityServer4裏面有一個Id

asp.net core中遇到需要自定義數據包解密方法的時候

聲明 AD AR 但是 sof AC asp 參數聲明 request 最近將公司的項目用.netcore重寫, 服務的http外部接口部分收發消息是DES加解密的, 那麽在asp.net core mvc的action處理之前需要加入解密這個步驟. 我第一想到的是用f

ASP.NET Core中使用Razor視圖引擎渲染視圖為字符串(轉)

http onf ces mod ado efault his .html 返回 一、視圖渲染說明 在有些項目需求上或許需要根據模板生產靜態頁面，那麽你一樣可以用Razor語法去直接解析你的頁面從而把解析的頁面生成靜態頁，這樣的使用場景很多，不限於生成靜態頁面，視圖引擎為我

asp.net core中IHttpContextAccessor和HttpContextAccessor的妙用

class sys image 只需要 iap href build .com bubuko 分享一篇文章，關於asp.net core中httpcontext的拓展。 現在，試圖圍繞HttpContext.Current構建你的代碼真的不是一個好主意，但是我想如果你

Asp.Net Core中利用Seq組件展示結構化日誌功能

eve 發布 哪裏 HA 快速 inf ron void 級別 在一次.Net Core小項目的開發中，掌握的不夠深入，對日誌記錄並沒有好好利用，以至於一出現異常問題，都得跑動服務器上查看，那時一度懷疑自己肯定沒學好，不然這一塊日誌不可能需要自己扒服務器日誌來查看，果然，很