ASP.NET Core實現強類型Configuration讀取配置數據

前言

實現讀取JSON文件幾種方式，在項目中采取老辦法簡單粗暴，結果老大過來一看，恩，這樣不太可取，行吧那我就用.NET Core中最新的方式諾，切記，適合的才是最好的，切勿懶。

.NET Core讀取JSON文件通過讀取文件方式

 當我將VS2015項目用VS2017打開后再添加控制器，此時會報錯如下：

此時我們應該在該項目中的.csproj中添加如下這一句才能解決此問題：

 <ItemGroup>
    <DotNetCliToolReference Include="Microsoft.VisualStudio.Web.CodeGeneration.Tools" Version="1.0.0" />
  </ItemGroup>

我們在讀取存放JSON目錄時利用 IHostingEnvironment 類來實現，通過該類中的如下兩個屬性來獲取項目目錄：

            //獲取當前項目所在目錄
            var contentPath = _hostingEnv.ContentRootPath;

            //獲取wwwroot所在目錄
            var rootPath = _hostingEnv.WebRootPath;

我們在當前項目下建立一個存放JSON的文件夾，如下：

在該json文件中，我們給出數據如下：

{
  "name": "jeffcky",
  "age": 25
}

接下來則是讀取JSON文件並獲取數據了：

        [HttpPost]
        public async Task<IActionResult> Json()
        {
            var result = string.Empty;

            var filePath = _hostingEnv.ContentRootPath + Path.DirectorySeparatorChar + "Json"
                + Path.DirectorySeparatorChar + "Read.json";

            using (var streamReader = System.IO.File.OpenText(filePath))
            {
                result = await streamReader.ReadToEndAsync();
            }

            var json = new { name = string.Empty, age = 0 };

            var data = JsonConvert.DeserializeAnonymousType(result, json);

            return View();
        }

此時將完全讀取數據：

到今天我才發現匿名類型是只讀的，而不能賦值。【可笑的我】

上述是一種通過讀取Json文件的方式來讀取數據，當每來一個請求則讀取一次文件，不太合適，所以老大說不可取，那就用第二種諾。

.NET Core內置讀取JSON文件

當我們需要在其他控制器獲取 appsettings.json 中的值時我們是怎樣做的呢？比如我們要讀取該json文件cnblogs節點下的name值

{
  "LogPath": "C:\\Jeffcky_StudyEFCore\\logs",
  "Logging": {
    "IncludeScopes": false,
    "LogLevel": {
      "Default": "Debug",
      "System": "Information",
      "Microsoft": "Information"
    }
  },
  "cnblogs": {
    "name": "Jeffcky"
  }
}

此時我們通過配置類Configuration來讀取，同時我們需要將此類接口進行注入，下面兩種方式皆可：

            services.AddSingleton<IConfigurationRoot>(Configuration);
            services.AddSingleton<IConfiguration>(Configuration);

接下來同樣在控制器構造函數中進行獲取。

然后就是獲取該json中cnblogs節點下的數據了。

這種方式挺好，但是對於我們習慣了智能提示來說要是寫錯了單詞，還得檢查豈不麻煩，所以我們最終讀取json通過強類型來實現。在程序啟動時就加載我們自定義的json文件。

        public Startup(IHostingEnvironment env)
        {

            var builder = new ConfigurationBuilder()
                .SetBasePath(env.ContentRootPath)
                .AddJsonFile("appsettings.json", optional: true, reloadOnChange: true)
                .AddJsonFile($"appsettings.{env.EnvironmentName}.json", optional: true)
                .AddJsonFile("read.json")
                .AddEnvironmentVariables();
            Configuration = builder.Build();
        }

由於在讀取配置json需要一個根節點，所以我們將上述read.json文件進行如下修改：

{
  "cnblogs": {
    "Name": "jeffcky",
    "Age": 25
  }
}

然后在 ConfigureServices 方法中獲取該節點。

 services.Configure<Person>(Configuration.GetSection("cnblogs"));

此時在控制器構造函數就變成了如下這樣：

        private readonly Models.Person p;
        public ReadJsonController(IOptions<Models.Person> option)
        {
            p = option.Value;
        }

最終將直接讀取到json中配置的數據：

        [HttpPost]
        public IActionResult Json()
        {
            var age = p.Age;
            var name = p.Name;

            return View();
        }

一切都是那么簡單和自然。

總結

本節稍稍講解了下在.NET Core中如何實現強類型Configuration從而使得當程序啟動時直接將json文件進行加載到內存當中而非每次都去讀取文件來加載，希望對閱讀本文的你有稍稍幫助。