使用Visual Studio Code開發Asp.Net Core WebApi學習筆記（七）-- 結構化配置

本篇將記錄.Net Core里頗有特色的結構化配置的使用方法。

相比較之前通過Web.Config或者App.Config配置文件里使用xml節點定義配置內容的方式，.Net Core在配置系統上發生了很大的變化，具有了配置源多樣化、更加輕量、擴展性更好的特點。

第一部分、基於鍵值對的配置

如果要使用結構化配置，需要先引用 "Microsoft.Extensions.Configuration": "1.0.0" nuget包。下面通過一個.Net Core控制台程序演示

一、單層結構的配置

using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.Configuration.Memory;
using System;
using System.Collections.Generic;

namespace DiApplicationTest
{
    public class Program
    {
        public static void Main(string[] args)
        {
            IDictionary<string, string> source = new Dictionary<string, string>()
            {
                ["Ele1"] = "value1",
                ["Ele2"] = "value2"
            };

            IConfiguration config = new ConfigurationBuilder().Add(new MemoryConfigurationSource() { InitialData = source }).Build();
            Console.WriteLine($"Ele1: {config["Ele1"]}");
            Console.WriteLine($"Ele2: {config["Ele2"]}");

            Console.ReadLine();
        }
    }
}

啟動調試，查看cmd窗口輸出內容

上面的例子里，將一個字典作為配置源讀入到config配置對象里，通過鍵可以讀取到對應的值。

二、多層結構的配置

在大多數情況下，項目里的配置都是多層結構的，也可以稱為是結構化的。在上面的例子的基礎上稍加修改，實現結構化的配置讀取。

using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.Configuration.Memory;
using System;
using System.Collections.Generic;

namespace DiApplicationTest
{
    public class Program
    {
        public static void Main(string[] args)
        {
            IDictionary<string, string> source = new Dictionary<string, string>()
            {
                ["Ele1"] = "value1",
                ["Ele2:Sub1"] = "value2.1",
                ["Ele2:Sub2"] = "value2.2"
            };

            IConfiguration config = new ConfigurationBuilder().Add(new MemoryConfigurationSource() { InitialData = source }).Build();
            Console.WriteLine($"Ele1: {config["Ele1"]}");
            Console.WriteLine($"Ele2.Sub1: {config.GetSection("Ele2")["Sub1"]}");
            Console.WriteLine($"Ele2.Sub2: {config.GetSection("Ele2")["Sub2"]}");

            Console.ReadLine();
        }
    }
}

啟動調試，查看cmd窗口輸出內容

在這個例子里，字典內容描述了一個具有兩層結構的配置，第一層有Ele1和Ele2兩個節點，分別對應一個字符內容和一個復合內容，第二層有Sub1和Sub2兩個節點，同時掛在Ele2節點下，組成了一個復合結構。

注意看字典項里的Key，因為字典里的數據是扁平化的，為了能清晰描述節點之間的上下層關系，需要通過“:”符號來標識。

config對象通過GetSection方法來獲取當前節點的某個下級節點內容。

 

第二部分、其他配置來源

除了上面例子里展示的配置源來自內存內容，也可以來自Xml文件、JSON文件或者數據庫等。因為在.Net Core里使用JSON文件描述配置內容很常見，下面就展示如何讀取JSON配置文件。

先添加如下兩個nuget包，支持從json文件讀取內容

"Microsoft.Extensions.Configuration.FileExtensions": "1.0.0",
"Microsoft.Extensions.Configuration.Json": "1.0.0",

添加 appsettings.json 文件

{
  "Ele1": "value1",
  "Ele2": {
    "Sub1": "value2.1",
    "Sub2": "value2.2"
  }
}

修改Main函數內容

using Microsoft.Extensions.Configuration;
using System;
using System.IO;

namespace DiApplicationTest
{
    public class Program
    {
        public static void Main(string[] args)
        {
            IConfigurationBuilder builder = new ConfigurationBuilder();
            builder.SetBasePath(Directory.GetCurrentDirectory());
            builder.AddJsonFile("appsettings.json");

            IConfiguration config = builder.Build();
            Console.WriteLine($"Ele1: {config["Ele1"]}");
            Console.WriteLine($"Ele2.Sub1: {config.GetSection("Ele2")["Sub1"]}");
            Console.WriteLine($"Ele2.Sub2: {config.GetSection("Ele2")["Sub2"]}");

            Console.ReadLine();
        }
    }
}

啟動調試，查看cmd窗口輸入內容，與上面的例子內容一致。

這個例子將原來在字典里的內容轉換成Json格式化的內容存儲在持久化文件里。通過指定配置源，同樣可以讀取內容。

 

第三部分、Options對象映射

當配置文件內容較多時，通過config的Key獲取對應的配置項的值變得比較繁瑣。.Net Core的配置系統采用了一種叫“Options Pattern”的模式使配置內容與有着對應結構的對象進行映射，這種對象就叫做Options對象。

下面將簡單演示一下這種映射方式。

首先添加如下nuget包引用，使用此模式的相關接口和類都在這個包里。同時還需要引入DI容器。

"Microsoft.Extensions.DependencyInjection": "1.0.0",
"Microsoft.Extensions.Options.ConfigurationExtensions": "1.0.0",

添加兩個具有層級結構的Options類

    public class ConfigOptions
    {
        public string Ele1 { get; set; }
        public SubConfigOptions Ele2 { get; set; }
    }

    public class SubConfigOptions
    {
        public string Sub1 { get; set; }
        public string Sub2 { get; set; }
    }

修改Main函數內容

        public static void Main(string[] args)
        {
            // 創建DI容器，注冊Options Pattern服務
            IServiceCollection services = new ServiceCollection();
            services.AddOptions();

            // 讀取配置文件
            IConfigurationBuilder builder = new ConfigurationBuilder();
            builder.SetBasePath(Directory.GetCurrentDirectory());
            builder.AddJsonFile("appsettings.json");
            IConfiguration config = builder.Build();

            // 通過注冊的服務獲取最終映射的配置對象
            IServiceProvider serviceProvider = services.Configure<ConfigOptions>(config).BuildServiceProvider();
            ConfigOptions options = serviceProvider.GetService<IOptions<ConfigOptions>>().Value;

            Console.WriteLine($"Ele1: {options.Ele1}");
            Console.WriteLine($"Ele2.Sub1: {options.Ele2.Sub1}");
            Console.WriteLine($"Ele2.Sub2: {options.Ele2.Sub2}");

            Console.ReadLine();
        }

啟動調試，查看cmd窗口輸入內容，與上面的例子內容一致。

在定義Options對象結構時，對象內的屬性名稱要與對應層級的配置Key的值保持一致，層級關系也要與配置內容的層級結構保持一致。

通過調用 services.AddOptions() 方法注冊Options Pattern服務。將配置內容注冊到容器里，來獲取對應的服務Provider對象。通過調用GetService方法獲得對應的真實服務對象，即帶有事先定義的Options類型的泛型接口IOptions，接口的Value值就是配置內容映射的Options對象。

 

第四部分、Asp.Net Core里的配置管理

在這個系列之前使用的例子里添加配置管理相關的功能，來修改初始化日志級別的代碼，同時添加一些自定義配置。

先添加配置相關的nuget包

    "Microsoft.Extensions.Configuration": "1.0.0",
    "Microsoft.Extensions.Configuration.FileExtensions": "1.0.0",
    "Microsoft.Extensions.Configuration.Json": "1.0.0",
    "Microsoft.Extensions.Options.ConfigurationExtensions": "1.0.0"

添加appsettings.json文件

{
    // 日志配置
    "Logging": {
        "LogLevel": {
            "Microsoft": "Warning"
        }
    },
    // 自定義配置
    "CfgContent": {
        "Ele1": "value1",
        "Ele2": {
            "Sub1": "value2.1",
            "Sub2": "value2.2"
        }
    }
}

添加上個例子里的 ConfigOptions.cs、SubConfigOptions.cs 類，修改 Startup.cs 的內容，添加配置相關代碼

using System.IO;
using Microsoft.AspNetCore.Builder;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Logging;

namespace WebApiFrame
{
    public class Startup
    {
        public IConfiguration Configuration { get; }

        public Startup()
        {
            var builder = new ConfigurationBuilder()
                .SetBasePath(Directory.GetCurrentDirectory())
                .AddJsonFile("appsettings.json");

            Configuration = builder.Build();
        }

        public void ConfigureServices(IServiceCollection services)
        {
            services.AddOptions();
            services.Configure<ConfigOptions>(Configuration.GetSection("CfgContent"));

            // 注入MVC框架
            services.AddMvc();
        }

        public void Configure(IApplicationBuilder app, ILoggerFactory loggerFactory)
        {
            // 添加日志支持
            loggerFactory.AddConsole(Configuration.GetSection("Logging"));
            loggerFactory.AddDebug();

            // 添加NLog日志支持
            //loggerFactory.AddNLog();

            // 添加MVC中間件
            app.UseMvc();
        }
    }
}

修改 DemoController.cs 內容

using System.Threading.Tasks;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Options;

namespace WebApiFrame
{
    [Route("[controller]")]
    public class DemoController : Controller
    {
        private ConfigOptions _cfgContent { get; }

        public DemoController(IOptions<ConfigOptions> options)
        {
            _cfgContent = options.Value;
        }

        [HttpGet("index")]
        public async Task Index()
        {
            HttpContext.Response.ContentType = "text/html";
            await HttpContext.Response.WriteAsync($"<span>Ele1: {_cfgContent.Ele1}</span><br />");
            await HttpContext.Response.WriteAsync($"<span>Ele2.Sub1: {_cfgContent.Ele2.Sub1}</span><br />");
            await HttpContext.Response.WriteAsync($"<span>Ele2.Sub2: {_cfgContent.Ele2.Sub2}</span><br />");
        }
    }
}

啟動調試，訪問地址 http://localhost:5000/demo/index ，頁面顯示配置內容

從這個例子里可以看到，讀取 appsettings.json 配置文件內容並分成兩部分，其中一部分配置Logging作為Logger的配置內容用於日志初始化，另外一部分CfgContent配置內容注冊到DI容器，在控制器的構造函數里通過IOptions泛型類型的參數注入，這樣控制器就可以讀取配置文件的內容。