详解ASP.NET Core实现强类型Configuration读取配置数据

 更新时间:2017年05月03日 08:25:58   作者:Jeffcky  
本篇文章主要介绍了详解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文件进行加载到内存当中而非每次都去读取文件来加载,希望对阅读本文的你有稍稍帮助。

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

相关文章

  • .NetCore Web Api 利用ActionFilterAttribute统一接口返回值格式及问题解析

    .NetCore Web Api 利用ActionFilterAttribute统一接口返回值格式及问题解析

    在实际项目开发过程中,统一API返回值格式对前端或第三方调用将是非常必要的,在.NetCore中我们可以通过ActionFilterAttribute来进行统一返回值的封装,对.NetCore Web Api 统一接口返回值格式相关知识感兴趣的朋友一起看看吧
    2022-03-03
  • asp.net(C#)函数对象参数传递的问题

    asp.net(C#)函数对象参数传递的问题

    我们知道在.net里class是引用类型,在函数参数表中的对象传递的都是对象的引用,所以在函数体内对其对象参数的修改会影响函数外对应的对象本身,例如下面的程序.
    2009-12-12
  • asp.net XML文件操作实现代码

    asp.net XML文件操作实现代码

    这几天在项目中用到了XML文件配置存储一些基本信息,如:参数、表格等一些信息存储。由于记录不是很多,所以用此文件来代替数据库中设计的表结构。
    2009-12-12
  • Visual Studio 2017设置版权的方法

    Visual Studio 2017设置版权的方法

    这篇文章主要为大家详细介绍了Visual Studio 2017设置版权的方法,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-03-03
  • .Net Core静态文件资源的使用

    .Net Core静态文件资源的使用

    这篇文章介绍了.Net Core静态文件资源的使用方法,文中通过示例代码介绍的非常详细。对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2022-07-07
  • ASP.NET检测到不安全 Request.Form 值解决方案汇总

    ASP.NET检测到不安全 Request.Form 值解决方案汇总

    这篇文章主要介绍了ASP.NET检测到不安全 Request.Form 值解决方案汇总 ,十分的全面,需要的朋友可以参考下
    2015-06-06
  • asp.net简单实现单点登录(SSO)的方法

    asp.net简单实现单点登录(SSO)的方法

    这篇文章主要介绍了asp.net简单实现单点登录(SSO)的方法,结合简单实例形式较为详细的分析了单点登录的原理与asp.net的相关实现技巧,需要的朋友可以参考下
    2015-12-12
  • ASP.NET微信开发(接口指南)

    ASP.NET微信开发(接口指南)

    这篇文章详细介绍了ASP.NET微信开发接口指南,微信公众平台的开发较为简单,感兴趣的小伙伴们可以参考一下
    2015-12-12
  • asp.net防止刷新时重复提交(可禁用工具条刷新按钮)

    asp.net防止刷新时重复提交(可禁用工具条刷新按钮)

    前段时间遇到了需要禁用刷新的需求,f5按钮就不说了,简单的js就能把它禁用,但是工具条上的刷新按钮却防止不了啊,不过本文介绍的一种方法却可以解决此问题,感兴趣的朋友可以了解下啊,希望本文对你有所帮助
    2013-01-01
  • asp.net分页控件使用详解【附实例下载】

    asp.net分页控件使用详解【附实例下载】

    本篇文章主要对asp.net创建事务的方法进行实例介绍,具有很好的参考价值,需要的朋友一起来看下吧
    2016-12-12

最新评论