详解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文件jb51节点下的name值

{
 "logpath": "c:\\jeffcky_studyefcore\\logs",
 "logging": {
 "includescopes": false,
 "loglevel": {
  "default": "debug",
  "system": "information",
  "microsoft": "information"
 }
 },
 "jb51": {
 "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文件进行如下修改：

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

然后在 configureservices 方法中获取该节点。

 services.configure<person>(configuration.getsection("jb51"));

此时在控制器构造函数就变成了如下这样：

  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文件进行加载到内存当中而非每次都去读取文件来加载，希望对阅读本文的你有稍稍帮助。

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持。