ASP.NET Core實(shí)現(xiàn)強(qiáng)類型Configuration讀取配置數(shù)據(jù)

前言

實(shí)現(xiàn)讀取JSON文件幾種方式，在項(xiàng)目中采取老辦法簡(jiǎn)單粗暴，結(jié)果老大過(guò)來(lái)一看，恩，這樣不太可取，行吧那我就用.NET Core中最新的方式諾，切記，適合的才是最好的，切勿懶。

.NET Core讀取JSON文件通過(guò)讀取文件方式

 當(dāng)我將VS2015項(xiàng)目用VS2017打開(kāi)后再添加控制器，此時(shí)會(huì)報(bào)錯(cuò)如下：

此時(shí)我們應(yīng)該在該項(xiàng)目中的.csproj中添加如下這一句才能解決此問(wèn)題：

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

我們?cè)谧x取存放JSON目錄時(shí)利用 IHostingEnvironment 類來(lái)實(shí)現(xiàn)，通過(guò)該類中的如下兩個(gè)屬性來(lái)獲取項(xiàng)目目錄：

            //獲取當(dāng)前項(xiàng)目所在目錄
            var contentPath = _hostingEnv.ContentRootPath;            //獲取wwwroot所在目錄
            var rootPath = _hostingEnv.WebRootPath;

我們?cè)诋?dāng)前項(xiàng)目下建立一個(gè)存放JSON的文件夾，如下：

在該json文件中，我們給出數(shù)據(jù)如下：

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

接下來(lái)則是讀取JSON文件并獲取數(shù)據(jù)了：

        [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();
        }

此時(shí)將完全讀取數(shù)據(jù)：

到今天我才發(fā)現(xiàn)匿名類型是只讀的，而不能賦值?！究尚Φ奈摇?/p>

上述是一種通過(guò)讀取Json文件的方式來(lái)讀取數(shù)據(jù)，當(dāng)每來(lái)一個(gè)請(qǐng)求則讀取一次文件，不太合適，所以老大說(shuō)不可取，那就用第二種諾。

.NET Core內(nèi)置讀取JSON文件

當(dāng)我們需要在其他控制器獲取 appsettings.json 中的值時(shí)我們是怎樣做的呢？比如我們要讀取該json文件cnblogs節(jié)點(diǎn)下的name值

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

此時(shí)我們通過(guò)配置類Configuration來(lái)讀取，同時(shí)我們需要將此類接口進(jìn)行注入，下面兩種方式皆可：

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

接下來(lái)同樣在控制器構(gòu)造函數(shù)中進(jìn)行獲取。

然后就是獲取該json中cnblogs節(jié)點(diǎn)下的數(shù)據(jù)了。

這種方式挺好，但是對(duì)于我們習(xí)慣了智能提示來(lái)說(shuō)要是寫(xiě)錯(cuò)了單詞，還得檢查豈不麻煩，所以我們最終讀取json通過(guò)強(qiáng)類型來(lái)實(shí)現(xiàn)。在程序啟動(dòng)時(shí)就加載我們自定義的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需要一個(gè)根節(jié)點(diǎn)，所以我們將上述read.json文件進(jìn)行如下修改：

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

然后在 ConfigureServices 方法中獲取該節(jié)點(diǎn)。

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

此時(shí)在控制器構(gòu)造函數(shù)就變成了如下這樣：

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

最終將直接讀取到j(luò)son中配置的數(shù)據(jù)：

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

一切都是那么簡(jiǎn)單和自然。

總結(jié)

本節(jié)稍稍講解了下在.NET Core中如何實(shí)現(xiàn)強(qiáng)類型Configuration從而使得當(dāng)程序啟動(dòng)時(shí)直接將json文件進(jìn)行加載到內(nèi)存當(dāng)中而非每次都去讀取文件來(lái)加載，希望對(duì)閱讀本文的你有稍稍幫助。