(11)ASP.NET Core 中的配置一(Configuration)
1.前言
asp.net core在应用程序上引入microsoft.extensions.configuration配置,可以支持多种方式配置,包括命令行配置、环境变量配置、文件配置、内存配置,自定义配置等等。下面我们就其中几个配置来聊聊。
2.命令行配置
commandlineconfigurationprovider在应用程序运行时会从(例如dos)命令行参数键值加载配置。要激活命令行配置,请在configurationbuilder的实例上调用addcommandline扩展方法。使用createdefaultbuilder初始化新的webhostbuilder时会自动调用addcommandline。
public class program { public static void main(string[] args) { createwebhostbuilder(args).build().run(); } public static iwebhostbuilder createwebhostbuilder(string[] args) => webhost.createdefaultbuilder(args) .configureappconfiguration((hostingcontext, config) => { // call other providers here and call addcommandline last. config.addcommandline(args); }).usestartup<startup>(); }
在program加入上述代码并在/home/index视图上添加如下代码后发布一个web版本挂载在iis上。
在控制台上输入dos命令行dotnet d:\release\core\testwebapp.dll commandlinekey1=value1配置键:commandlinekey1,值:value1的信息,会看到如下界面信息:
根据控制台监听站点连接,在浏览器上打开其中一个,比如打开https://localhost:5001/,会看到我们配置命令行信息:
3.文件配置
fileconfigurationprovider是从文件系统加载配置的基类。以下配置为应用程序提供专用于特定文件类型:ini配置、json配置、xml配置。
3.1 ini配置
iniconfigurationprovider在运行时会从ini文件键值对加载配置。若要激活ini文件配置,请在 configurationbuilder的实例上调用addinifile扩展方法,而冒号可用作ini文件配置中的节点分隔符。现在我们在coreweb根目录下添加一个ini配置文件(命名为config):
[section0] key0=value key1=value [section1] subsection:key=value [section2:subsection0] key=value [section2:subsection1] key=value
而应用程序在构建主机时会调用configureappconfiguration以指定应用程序配置(这里我们指定config.ini文件):
public class program { public static void main(string[] args) { createwebhostbuilder(args).build().run(); } public static iwebhostbuilder createwebhostbuilder(string[] args) => webhost.createdefaultbuilder(args) .configureappconfiguration((hostingcontext, config) => { config.setbasepath(directory.getcurrentdirectory()); config.addinifile( "config.ini", optional: true, reloadonchange: true); }) .usestartup<startup>(); }
从上述代码可以看到iconfigurationbuilder设置了文件访问初始路径。optional:文件是否可选;reloadonchange:如果文件更改,是否应重新加载配置。而通过启动应用程序时会看到如下配置信息:
3.2 json配置
jsonconfigurationprovider在运行时期间会从json文件键值对加载配置。若要激活json文件配置,请在configurationbuilder的实例上调用addjsonfile扩展方法。使用 createdefaultbuilder初始化新的webhostbuilder时,会自动调用addjsonfile两次,调用该方法(addjsonfile)来从以下文件加载配置,首先会读取appsettings.json该文件。而应用程序启动时是会默认调用对应的appsettings.{environment}.json环境版本的,例如appsettings.{environment}.json会根据ihostingenvironment.environmentname加载对应文件的环境版本(开发模式、生产模式等)。现在我们在coreweb根目录下添加一个json配置文件(命名为config):
{ "section0": { "key0": "key0value", "key1": "key1value" }, "section1": { "key0": "key0value", "key1": "key1value" }, "section2": { "subsection0": { "key0": "sub0key0value", "key1": "sub0key1value" }, "subsection1": { "key0": "sub1key0value", "key1": "sub1key1value" } } }
而应用程序在构建主机时会调用configureappconfiguration以指定除appsettings.json和appsettings.{environment}.json以外文件的应用程序配置(这里我们指定config.json文件):
public class program { public static void main(string[] args) { createwebhostbuilder(args).build().run(); } public static iwebhostbuilder createwebhostbuilder(string[] args) => webhost.createdefaultbuilder(args) .configureappconfiguration((hostingcontext, config) => { config.setbasepath(directory.getcurrentdirectory()); config.addjsonfile( "config.json", optional: true, reloadonchange: true); }) .usestartup<startup>(); }
而通过启动应用程序时会看到如下配置信息:
从上述信息可以看到,在我们指定config.json文件后,iconfigurationbuilder会额外多调用一次addjsonfile,加上前两次addjsonfile,一共是三次。
3.2.1getsection、getchildren和exists
(1)getsection:iconfiguration.getsection获取指定配置子节。下面我们通过一个示例来了解下:
public startup(iconfiguration configuration) { configuration = configuration; var configsection0 = configuration.getsection("section0"); var configsection1 = configuration.getsection("section0:key0"); }
而通过启动应用程序时会看到如下配置信息:
通过上述示例可以看到,iconfiguration.getsection仅仅是获取到json数据里面configsection0节点键和路径,并没有获取到它的节点值。若要获取section0:key0中的键值,请在调用getsection时提供完整节点路径,如获取configsection1键值示例。
(2)getchildren:获取指定配置树节点。下面我们通过一个示例来了解下:
public startup(iconfiguration configuration) { configuration = configuration; var configsection = configuration.getsection("section2"); var children = configsection.getchildren(); }
而通过启动应用程序时会看到如下配置信息:
getchildren获取了指定section2节点下所有节点。
(3)exists:使用configurationextensions.exists确定配置节点是否存在。下面我们通过一个示例来了解下:
public startup(iconfiguration configuration) { configuration = configuration; var sectionexists0 = configuration.getsection("section2").exists();//true var sectionexists1 = configuration.getsection("section2:subsection2").exists();//false }
而通过启动应用程序时会了解到section2配置节点如果存在就会返回true,反之则false;同理section2:subsection2路径配置节点亦一样。
3.3 xml配置
xmlconfigurationprovider在运行时会从xml文件键值对加载配置。若要激活xml文件配置,请在configurationbuilder的实例上调用addxmlfile扩展方法。现在我们在coreweb根目录下添加一个xml配置文件(命名为config):
<?xml version="1.0" encoding="utf-8" ?> <configuration> <section0> <key0>value</key0> <key1>value</key1> </section0> <section1> <key0>value</key0> <key1>value</key1> </section1> </configuration>
而应用程序在构建主机时调用configureappconfiguration以指定应用程序的配置(这里我们指定config.xml文件):
public class program { public static void main(string[] args) { createwebhostbuilder(args).build().run(); } public static iwebhostbuilder createwebhostbuilder(string[] args) => webhost.createdefaultbuilder(args) .configureappconfiguration((hostingcontext, config) => { config.setbasepath(directory.getcurrentdirectory()); config.addxmlfile( "config.xml", optional: true, reloadonchange: true); }) .usestartup<startup>(); }
而通过启动应用程序时会看到如下配置信息:
参考文献:
asp.net core 中的配置
上一篇: 鸡菇怎么做更好吃?
下一篇: 使用log4net记录ABP日志
推荐阅读
-
详解ASP.Net Core 中如何借助CSRedis实现一个安全高效的分布式锁
-
浅谈如何在ASP.NET Core中实现一个基础的身份认证
-
在ASP.NET Core中实现一个Token base的身份认证实例
-
asp.net core 一个中小型项目实战的起手式——Swagger配置
-
asp.net core中灵活的配置方式详解
-
(11)ASP.NET Core 中的配置一(Configuration)
-
ASP.NET Core 2.2 : 二十三. 深入聊一聊配置的内部处理机制
-
ASP.NET Core中实现用户登录验证的最低配置示例代码
-
ASP.NET Core 中的配置
-
ASP.NET Core 中的 ObjectPool 对象重用(一)