如何在ASP.NET Core类库项目中读取配置文件详解

如何在ASP.NET Core类库项目中读取配置文件详解
 更新时间：2017年10月13日 09:05:21   作者：Jeffcky  

这篇文章主要给大家介绍了关于如何在ASP.NET Core类库项目中读取配置文件的相关资料，这是朋友提的一个问题，文中通过示例代码介绍的非常详解，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起看看吧。

前言
最近有朋友问如何在.net core类库中读取配置文件，当时一下蒙了，这个提的多好，我居然不知道，于是这两天了解了相关内容才有此篇文章的出现，正常来讲我们在应用程序目录下有个appsettings.json文件对于相关配置都会放在这个json文件中，但是要是我建立一个类库项目，对于一些配置比如密钥或者其他需要硬编码的数据放在JSON文件中，在.net core之前配置文件为web.config并且有相关的类来读取节点上的数据，现如今在.net core中为json文件，那么我们该如何做？本文就此应运而生。
.NET Core类库项目读取JSON配置文件
在应用程序目录下添加JSON文件是进行如下配置：

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

然后读取配置文件的节点，如下：

public void ConfigureServices(IServiceCollection services)
{

services.Configure<BlogViewModel>(Configuration.GetSection(“JeffckySettings”));
……
}

但是如果项目是在类库中呢，当然我们也可以将配置值放在应用程序下的appsettings.json中，但是为了不让其json文件中看起来显得非常臃肿同时在类库中的配置数据我们理应放在类库中来统一管理，所以我们得另外再想方案，总不能在类库中建立startup.cs类，再来实例化Configuration吧，这样想想应该也是可以，我没尝试过，难道就没有很简单的方式么，难道就不能像.net core之前用类来读取web.config我们只需要给出键而得到值吗？或者说通过强类型配置来统一管理配置数据，这个才应该是我们尝试的方向。好了，说了这么多，我们就开干。我们首先来复习下.net core中是如何获取应用程序路径的。
.NET Core获取应用程序路径
在.NET 4.X之前获取当前应用程序根目录路径和名称可以通过如下获取

var basePath = AppDomain.CurrentDomain.BaseDirectory;
var appName = AppDomain.CurrentDomain.ApplicationIdentity.FullName;

当然也可以通过如下来获取应用程序根目录而不是得到bin目录

Directory.GetCurrentDirectory()

在.net core中获取bin目录路径通过如下来获取更加简洁。

AppContext.BaseDirectory

在.NET 4.X之前获取应用程序集名称通过如下来获取：

Assembly.GetEntryAssembly().GetName().Name;

在.net core中通过如下来获取：

var name = typeof(T).GetTypeInfo().Assembly.GetName().Name;

版本通过如下来获取（.net core也一样）：

Assembly.GetEntryAssembly().GetName().Version.ToString()

在类库项目中我们利用强类型配置来实现读取配文件数据，我们首先需要下载如下扩展。

在ConfigurationBuilder类中如下一个Add添加方法：

//
// 摘要:
// Adds a new configuration source.
//
// 参数:
// source:
// The configuration source to add.
//
// 返回结果:
// The same Microsoft.Extensions.Configuration.IConfigurationBuilder.
public IConfigurationBuilder Add(IConfigurationSource source);

对于AddJsonFile扩展方法来添加JSON文件名，文件路径已经通过SetBasePath()方法来实现，一切配置都是基于IConfigurationBuilder接口，其中就有一个JsonConfigurationSource类，实现如下：

//
// 摘要:
// Represents a JSON file as an Microsoft.Extensions.Configuration.IConfigurationSource.
public class JsonConfigurationSource : FileConfigurationSource
{
public JsonConfigurationSource();

//
// 摘要:
// Builds the Microsoft.Extensions.Configuration.Json.JsonConfigurationProvider
// for this source.
//
// 参数:
// builder:
// The Microsoft.Extensions.Configuration.IConfigurationBuilder.
//
// 返回结果:
// A Microsoft.Extensions.Configuration.Json.JsonConfigurationProvider
public override IConfigurationProvider Build(IConfigurationBuilder builder);
}

我们再看其父类就有一个添加JSON文件路径的方法，如下：

所以我们从这里可以看出添加JSON文件的方法除了通过扩展方法来实现外还有直接实例化JsonConfigurationSource来实现，如下：

IConfiguration config = new ConfigurationBuilder()
.SetBasePath(currentClassDir)
.AddJsonFile(“appsettings.json”, false, true)
.Add(new JsonConfigurationSource { Path = “appsettings.json”, Optional = false, ReloadOnChange = true })
.Build();

上述添加JSON文件皆可，我发现添加JSON文件必须设置JSON文件所在的目录即必须首先要设置SetBasePath方法，否则会报如下错误：

我们搞个测试JSON文件放在当前项目（StudyEFCore.Data）中如下：

最终读取类库项目JSON配置文件，将其封装起来就成了如下这个样子：

public class JsonConfigurationHelper
{
public T GetAppSettings<T>(string key) where T : class, new()
{
var baseDir = AppContext.BaseDirectory;
var indexSrc = baseDir.IndexOf(“src”);
var subToSrc = baseDir.Substring(0, indexSrc);
var currentClassDir = subToSrc + “src” + Path.DirectorySeparatorChar + “StutdyEFCore.Data”;

IConfiguration config = new ConfigurationBuilder()
.SetBasePath(currentClassDir)
.Add(new JsonConfigurationSource { Path = “appsettings.json”, Optional = false, ReloadOnChange = true })
.Build();
var appconfig = new ServiceCollection()
.AddOptions()
.Configure<T>(config.GetSection(key))
.BuildServiceProvider()
.GetService<IOptions<T>>()
.Value;
return appconfig;
}
}

由上有一个还未解决的问题就是如何得到当前类库项目的路径，没有想到一个好的法子，不知看到此文的你有何高见。简短的调用则是如下：

var config = new JsonConfigurationHelper();
var person = config.GetAppSettings<Person>(“JeffckySettings”);
var name = person.Name;
var age = person.Age;

结果如下：

我们将其类修改为ConfigurationManager，然后将其GetAppSettings方法定义为静态方法，最后如下调用是不是满足了在.net core之前读取web.config中配置数据的问题。哈哈哈：

var person = ConfigurationManager.GetAppSettings<Person>(“JeffckySettings”);

总结
本节我们详细讲解了在.net core类库项目中如何读取JSON配置中的数据但是还是有点不足，你有何高见？

您可能感兴趣的文章:ASP.NET core Web中使用appsettings.json配置文件的方法.NET Core简单读取json配置文件.NET Core读取配置文件方式详细总结.NET Core 2.0迁移小技巧之web.config 配置文件示例详解实现core文件自动生成配置文件的方法.NET Core2.1如何获取自定义配置文件信息详解Asp.net Core与类库读取配置文件信息的方法.Net Core读取Json配置文件的实现示例asp.net core配置文件加载过程的深入了解ASP.NET Core中修改配置文件后自动加载新配置的方法详解

asp.net
core
配置文件

相关文章
asp.net 获取客户端浏览器访问的IP地址的实例代码本篇文章主要介绍了asp.net 获取客户端浏览器访问的IP地址的实例代码，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2017-07-07
解决asp.net ajax sys未定义的解决方法这个方法绝对it560原创，而且会让大家少走弯路，对于网上流传的webconfig配置错误的说法绝对是忽悠人，配置文件错误的记录大概是0.1% 2010-06-06
iis的http 500内部服务器错误的解决iis的http 500内部服务器错误是我们经常碰到的错误之一，它的主要错误表现就是asp程序不能浏览但htm静态网页不受影响。另外当错误发生时，系统事件日志和安全事件日志都会有相应的记录 2007-04-04
asp.net Checbox在GridView中的应用实例分析这篇文章主要介绍了asp.net Checbox在GridView中的应用,结合实例形式分析了GridView中添加与使用Checbox的相关技巧,具有一定参考借鉴价值,需要的朋友可以参考下 2016-07-07
JavaScript验证用户输入的是字符或数字及ASCII Chart应用我们可以根据onkeydown事件的event.keyCode即是ASCII Chart来判断字符或数字等,本文提供了相关键盘key对应的ASCII码,以供用户使用是参考及使用onpaste事件只能输入字符和数字防止粘贴等的，感兴趣的朋友可以了解下 2013-01-01
Community Server专题三：HttpModuleCommunity Server专题三：HttpModule… 2007-03-03
ADO.Net 类型化DataSet的简单介绍今天学习了类型化DataSet,笔记整理如下，需要的朋友可以参考一下 2013-04-04
比较完整的 asp.net 学习流程好多朋友想学习后台编程语言，但请注意的事，学习后台是个循序渐进的过程，不可能一下就到位，其实不只是asp.net其它的编程语言都需要下面的一些知识。 2009-06-06
在ashx文件中使用session的解决思路如果你要保证数据的安全性，你可以在ashx中使用session验证如：你的index.aspx中使用jquery回调ashx数据，那么在index.aspx page_load时session[checked]="true"，在ashx中验证session是否存在 2013-01-01
jquery.pagination +JSON 动态无刷新分页实现代码jquery.pagination +JSON 动态无刷新分页实现代码，需要的朋友可以参考下。 2011-12-12

最新评论