Asp.Net Core入门之配置文件

ASP.NET Core配置框架已内建支持 JSON、XML 和 INI 配置文件，内存配置（直接通过代码设置值），环境变量配置等方式配置参数。

本文主要和大家讲一下我们在项目中常用的以配置文件的方式进行配置。本文以.NetCore2.2为例

配置文件包含了如下几种常用方式。

1.使用ASP.NET Core框架自带的IConfiguration应用程序配置，通过构造函数的方式注入并使用选择模式使用配置参数：Configuration[参数名称]

2.使用选项IOptions和配置对象方式

当你创建了一个Web API应用程序的时候，ASP.NET Core框架会默认为你提供一个配置文件：appsettings.json，并且框架默认指向了该配置文件；但是当你创建例如控制台应用程序的时候，可能就需要我们手动添加配置文件，并手动指向该配置文件。

指定项目配置文件方式：

在项目的Program文件中，添加ConfigureAppConfiguration中的代码：

 1 public static IWebHostBuilder CreateWebHostBuilder(string[] args) =>
 2             WebHost.CreateDefaultBuilder(args)
 3             .ConfigureAppConfiguration((hostcontext, config) =>
 4             {
 5                 //获取项目环境
 6                 var env = hostcontext.HostingEnvironment;
 7                 config.SetBasePath(env.ContentRootPath);
 8                 //指定项目配置文件  属性reloadOnChange表示配置文件发生变化的时候，项目自动重新加载。
 9                 config.AddJsonFile("appsettings.json", optional: true, reloadOnChange: true)
10             })
11             .UseStartup<Startup>();

对于指定多配置环境的项目（主要有开发环境Development和生产环境Production），可使用如下方式：

 1 public static IWebHostBuilder CreateWebHostBuilder(string[] args) =>
 2             WebHost.CreateDefaultBuilder(args)
 3             .ConfigureAppConfiguration((hostcontext, config) =>
 4             {
 5                 //获取项目环境
 6                 var env = hostcontext.HostingEnvironment;
 7                 config.SetBasePath(env.ContentRootPath);
 8                 //指定项目配置文件  属性reloadOnChange表示配置文件发生变化的时候，项目自动重新加载。
 9                 config.AddJsonFile("appsettings.json", optional: true, reloadOnChange: true)
10                           //指定项目不同环境下使用哪个配置文件（env.EnvironmentName主要有开发环境Development和生成环境Production），对于指定环境的配置文件非常有用
11                           .AddJsonFile($"appsettings.{env.EnvironmentName}.json", optional: true, reloadOnChange: true);
12                 //启用多环境配置
13                 config.AddEnvironmentVariables();
14             })
15             .UseStartup<Startup>();

指定配置文件之后，我们便可以具体使用配置参数：

针对如下配置文件appsettings.json：获取WebOptions—Name节点值

 "WebOptions": {
    "Name": "Production"
  },

  "Logging": {
    "LogLevel": {
      "Default": "Warning"
    }
  }
}

方式一，通过构造函数的方式注入IConfiguration配置接口，并使用

        public class Test : ITest
        {
            private readonly IConfiguration configuration;
            //构造函数方式注入
            public Test(IConfiguration _configuration)
            {
                configuration = _configuration;
            }
            public Task<string> Get()
            {
                //以选择模式的方式获取配置参数
                var name = configuration["WebOptions:Name"];
                //返回
                return Task.FromResult(name);
            }
        }

方式二·：使用选项IOptions和配置对象方式

首先，添加配置文件对应的实体类。这里的类名，属性名要对应配置文件参数名称。

    public class WebOptions
    {
        public string Name { get; set; }
    }

然后，在Start文件ConfigureServices类中，注册与Option绑定的配置实例。

1         public void ConfigureServices(IServiceCollection services)
2         {
3             //注册WebOptions配置实例
4             services.Configure<WebOptions>(Configuration.GetSection(nameof(WebOptions)));
5             services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_2);
6         }

最后，通过构造函数注入Options绑定配置，并使用。

 1     public class Test : ITest
 2     {
 3         private readonly WebOptions webOptions;
 4 
 5         /// <summary>
 6         /// 构造函数注入
 7         /// </summary>
 8         /// <param name="_webOptions"></param>
 9         public Test(IOptions<WebOptions> _webOptions)
10         {
11             webOptions = _webOptions.Value;
12         }
13 
14         public Task<string> Get()
15         {
16             //以对象的方式获取参数值
17             var name = webOptions.Name;
18             return Task.FromResult(name);
19         }
20     }