发布于 

dotNET Core：配置

在dotNET Core中默认情况下没有了之前版本的App.config和Web.Config文件，换成了新的json格式的配置文件。当然，如果想使用之前的方式也是可以的。下面说说在dotNET Core中各种使用配置的方法。

环境

  • 操作系统：macOS 10.13.5
  • dotNET Core：2.1

    使用原来的config文件

如果你还念旧，想使用之前的App.config或Web.config，可以导入System.Configuration.ConfigurationManager包，使用方式和之前一样。

-w788

1
2
3
4
5
6
7
8
9
10
using System.Configuration;
...
static void Main(string[] args)
{
     var connection = ConfigurationManager.ConnectionStrings["ConnectionStr"].ConnectionString;
     var mqHostName = ConfigurationManager.AppSettings["MQHostName"];
     Console.WriteLine($"connection:{connection}");
     Console.WriteLine($"mqHostName:{mqHostName}");
     Console.ReadLine();
}

命令行配置

1、创建一个控制台的应用程序NetCoreConfigDemo；
2、导入依赖包，可以按需导入，也可以直接导入Microsoft.AspNetCore的包，里面包含所有依赖的项；

-w1001

3、添加using Microsoft.Extensions.Configuration;引用；
4、代码如下：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
using System;
using Microsoft.Extensions.Configuration;
namespace NetCoreConfigDemo
{
    class Program
    {
        static void Main(string[] args)
        {
            var builder = new ConfigurationBuilder()
                .AddCommandLine(args);
            var configration = builder.Build();
            Console.WriteLine($"name:{configration["name"]}");
            Console.ReadLine();
        }
    }
}

5、运行时指定name参数，在命令行中可以正常打印出来

-w676

上面例子中的参数name是在启动程序是指定的，如果想要程序有一个默认的参数值，可以在程序中初始化一个字典类Dictionary，代码如下：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
using System;
using Microsoft.Extensions.Configuration;
using System.Collections.Generic;
namespace NetCoreConfigDemo
{
    class Program
    {
        static void Main(string[] args)
        {
            var dic = new Dictionary<string, string>() { { "name", "oec2003" } };
            var builder = new ConfigurationBuilder()
                .AddInMemoryCollection(dic)
                .AddCommandLine(args);
            var configration = builder.Build();
            Console.WriteLine($"name:{configration["name"]}");
            Console.ReadLine();
        }
    }
}

注意：AddInMemoryCollection必须放在AddCommandLine的前面，否则默认值会覆盖掉在外部指定的参数值。

Json文件配置

1、在控制台项目中添加json文件App.json，文件内容如下：

1
2
3
4
{
  "name": "oec2003"
}

2、设置App.json的属性

-w347

3、编写代码读取App.json文件内容

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
using System;
using Microsoft.Extensions.Configuration;
namespace NetCoreConfigDemo
{
    class Program
    {
        static void Main(string[] args)
        {
            var builder = new ConfigurationBuilder()
                .AddJsonFile("App.json");
            var configration = builder.Build();
            Console.WriteLine($"name:{configration["name"]}");
            Console.ReadLine();
        }
    }
}

使用强类型配置（将配置文件映射到类）

1、创建AspNetCore MVC项目NetCoreConfigWebDemo；
2、在appsettings.json文件中追加如下内容：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
  "Logging": {
    "LogLevel": {
      "Default": "Warning"
    }
  },
  "AllowedHosts": "*",
  //下面为新添加的内容
  "UserInfo": {
    "UserName": "oec2003",
    "Age": "18",
    "Address": "wuhan china"
  }
}

3、修改Startup类中的Configure方法；

1
2
3
4
5
6
7
8
9
10
11
public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
    ......
    //读取配置文件内容到UserInfo类
    var userInfo = new UserInfo();
    Configuration.GetSection("UserInfo").Bind(userInfo);

    Console.WriteLine($"Name:{userInfo.UserName}");
    Console.WriteLine($"Age:{userInfo.Age}");
    Console.WriteLine($"Address:{userInfo.Address}");
}

4、运行程序可以看到配置文件内容可以正常打印在控制台中

-w647

使用IOptions来做强类型配置

修改NetCoreConfigWebDemo项目Startup的ConfigureServices方法，添加对UserInfo类的注册

1
2
3
4
5
6
7
8
9
10
11
12
13
public void ConfigureServices(IServiceCollection services)
{
    services.Configure<CookiePolicyOptions>(options =>
    {
        options.CheckConsentNeeded = context => true;
        options.MinimumSameSitePolicy = SameSiteMode.None;
    });

    services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_1);

    //注册UserInfo类
    services.Configure<UserInfo>(Configuration.GetSection("UserInfo"));
}

在Controller中实现IOptions

1、在HomeContrller中添加对IOptions的注入

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Options;
namespace NetCoreConfigWebDemo.Controllers
{
    public class HomeController : Controller
    {
        private UserInfo _userInfo;
        public HomeController(IOptions<UserInfo> options)
        {
            _userInfo = options.Value;
        }
        
        public IActionResult Index()
        {
            return View(_userInfo);
        }
    }
}

2、Html模版的代码如下：

1
2
3
4
5
6
7
8
9
10
11
@model NetCoreConfigWebDemo.UserInfo;
@{
    ViewData["Title"] = "Home Page";
}
<h2>UserInfo</h2>
<ul>

    <li>UserName:@Model.UserName</li>
    <li>Age:@Model.Age</li>
    <li>Address:@Model.Address</li>
</ul>

在Html模版中实现IOptions

HomeController中不需要做任何事，直接在Html模版中注入IOptions

1
2
3
4
5
6
7
8
9
10
11
12
@using Microsoft.Extensions.Options;
@inject IOptions<NetCoreConfigWebDemo.UserInfo> userInfo;
@{
    ViewData["Title"] = "Home Page";
 }

<h2>UserInfo</h2>
<ul>
    <li>UserName:@userInfo.Value.UserName</li>
    <li>Age:@userInfo.Value.Age</li>
    <li>Address:@userInfo.Value.Address</li>
</ul>

运行效果如下图：

-w482

配置文件热更新

在原来的Asp.Net中如果修改了Web.config文件，网站会自动重新启动，自动重启会影响用户的访问，在dotNET Core中可以使用热更新的方式，让用户无感知的进行配置文件的更新。

实现的方式非常简单，只需要将上面代码的IOptions修改为IOptionsSnapshot就可以了。

1
2
3
4
5
6
7
8
9
10
11
12
@using Microsoft.Extensions.Options;
@inject IOptionsSnapshot<NetCoreConfigWebDemo.UserInfo> userInfo;
@{
    ViewData["Title"] = "Home Page";
 }

<h2>UserInfo</h2>
<ul>
    <li>UserName:@userInfo.Value.UserName</li>
    <li>Age:@userInfo.Value.Age</li>
    <li>Address:@userInfo.Value.Address</li>
</ul>

自定义ConfigurationProvider

dotNET Core虽然提供了很多种配置的Provider，但一些特殊场景下不能完全满足需求，我们可以通过扩展来实现自己的Provider，需要实现IConfigurationSource和IConfigurationProvider接口，下面以Redis配置为例，来实现自定义的Provider。

1、创建控制台项目NetCoreRedisConfigDemo；
2、创建RedisConfigSource类、RedisConfigProvider类、RedisConfigExtension类；

RedisConfigSource类

1
2
3
4
5
6
7
8
9
10
11
12
13
using System;
using Microsoft.Extensions.Configuration;

namespace NetCoreRedisConfigDemo
{
    public class RedisConfigSource : IConfigurationSource
    {
        public IConfigurationProvider Build(IConfigurationBuilder builder)
        {
            return new RedisConfigProvider();
        }
    }
}

RedisConfigProvider类

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
using Microsoft.Extensions.Configuration;
using System.Collections.Generic;
namespace NetCoreRedisConfigDemo
{
    public class RedisConfigProvider:ConfigurationProvider
    {
        public RedisConfigProvider()
        {
        }
        public override void Load()
        {
            Dictionary<string, string> dic = new Dictionary<string, string>()
            {
                {"HostName","localhost"},
                {"Port","6379"},
                {"Password","123456"}
            };

            Data = dic;
        }
    }
}

RedisConfigExtension类

1
2
3
4
5
6
7
8
9
10
11
12
13
14
using System;
using Microsoft.Extensions.Configuration;

namespace NetCoreRedisConfigDemo
{

    public static class RedisConfigExtension
    {
        public static IConfigurationBuilder AddRedisConfig(this IConfigurationBuilder builder)
        {
            return builder.Add(new RedisConfigSource());
        }
    }
}

3、在Main方法中可以使用我们自定义的Provider

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
using System;
using Microsoft.Extensions.Configuration;
namespace NetCoreRedisConfigDemo
{
    class Program
    {
        static void Main(string[] args)
        {
            var builder = new ConfigurationBuilder()
                .AddRedisConfig();
            var configration = builder.Build();
            Console.WriteLine($"HostName:{configration["HostName"]}");
            Console.WriteLine($"Port:{configration["Port"]}");
            Console.WriteLine($"Password:{configration["Password"]}");
            Console.ReadLine();
        }
    }
}

运行结果如下：

-w579

环境变量

在Web项目中，我们可以使用环境变量来区分开发环境、测试环境和生产环境，默认情况下会有一个开发环境的环境变量的配置

-w753

在Web项目的Statup类的Configure方法中有对环境变量的判断，可以根据不同的环境来处理不同的业务逻辑。

1
2
3
4
5
6
7
8
9
10
11
12
13
public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
	if (env.IsDevelopment())
	{
	    app.UseDeveloperExceptionPage();
	}
	else
	{
	    app.UseExceptionHandler("/Home/Error");
	    app.UseHsts();
	}
	......
}

另外一种情况，当我们的程序运行在Docker中，在容器启动时需要传入一些参数到程序内部，这是就需要使用环境变量，下面一个简单例子演示一下：

1、创建控制台程序NetCoreEnvironmentDemo；
2、Program类的代码如下：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
using System;
namespace NetCoreEnvironmentDemo
{
    class Program
    {
        static void Main(string[] args)
        {
            string name = Environment.GetEnvironmentVariable("name");
            string age = Environment.GetEnvironmentVariable("age");

            Console.WriteLine($"name:{name}");
            Console.WriteLine($"age:{age}");
            Console.ReadLine();
        }
    }
}

3、创建Dockerfile文件，内容如下：

1
2
3
4
5
FROM microsoft/aspnetcore
COPY . /app
WORKDIR /app
EXPOSE 80/tcp
ENTRYPOINT ["dotnet", "NetCoreEnvironmentDemo.dll"]

4、使用命令dotnet publish发布程序；
5、进入到publish目录，使用docker build -t envtest .命令将程序打包成镜像；
6、使用命令docker run -d -p 81:80 -e "name=oec2003" -e "age=18" --name envtest envtest:latest创建容器;
7、使用docker logs 容器id查看容器日志

-w905

总结

在dotNET Core中，配置的方式有多种，而且可以根据需要自行扩展，可以说能够满足各种类型的需求了。点击「查看源码」可以查看本文的示例代码。

许可协议

本文采用 署名-非商业性使用-相同方式共享 4.0 国际 许可协议，转载请注明出处。

分享文章