Core篇——初探Core配置管理

文章目录

1、命令行配置

2、Json文件配置

3、配置文件文本至C#对象实例的映射

4、配置文件热更新

5、总结

 命令行的配置

　我们首先来创建一个.net core 的控制台项目，然后引入.net core all 包（Install-Package Microsoft.AspNetCore.All -Version 2.0.3），接下来添加系统参数。右键项目属性，调试，如下图(这里的参数为 =》name=lmc age=15)：接下来，我们控制台打印一下

static void Main(string[] args)
{
    //系统参数
    var builder = new ConfigurationBuilder()
        .AddCommandLine(args);
    var configration = builder.Build();
    Console.WriteLine($"name :{configration["name"]}");
    Console.WriteLine($"age :{configration["age"]}");
    Console.ReadLine();
}

 接下来让我们把应用程序参数删除，从内存中添加默认参数。ConfigurationBuilder对象的AddInMemoryCollection方法接收一个键值对的数组，我们这里用一个字典来初始化默认参数

        static void Main(string[] args)
        {    
            //默认参数
            var dic = new Dictionary<string, string>
            {
                { "name","liumengchen"},
                { "age","18"}
            };
            //系统参数
            var builder = new ConfigurationBuilder()
                .AddInMemoryCollection(dic)             //从内存中加载参数配置
                .AddCommandLine(args);
            var configration = builder.Build();
            Console.WriteLine($"name :{configration["name"]}");
            Console.WriteLine($"age :{configration["age"]}");
            Console.ReadLine();
        }

Json文件配置

　　我们在项目中添加一个"MyClass.json" 文件，ConfigurationBuilder的扩展方法AddJsonFile添加json配置文件，我们看到ConfigurationRoot的Providers中存储着json文件读取出来的数据，然后让我们来打印一下=》

            var builder = new ConfigurationBuilder()
                .AddJsonFile("MyClass.json");
            var configRetion = builder.Build();

            Console.WriteLine($"classId:{configRetion["classId"]}");

            var entitys = configRetion.Providers;
            
            Console.WriteLine("**************************指定索引打印**************************");
            Console.WriteLine($"studentId:{configRetion["student:0:id"]}");
            Console.WriteLine($"studentname:{configRetion["student:0:name"]}");
            Console.WriteLine($"studentId:{configRetion["student:1:id"]}");
            Console.WriteLine($"studentname:{configRetion["student:1:name"]}");
            Console.WriteLine($"studentId:{configRetion["student:2:id"]}");
            Console.WriteLine($"studentname:{configRetion["student:2:name"]}");

 配置文件文本至C#对象实例的映射

　　创建一个空的mvc项目，将上一步的json文件 复制到这个项目中，并且改名为appsettings.json（因为Program.cs 中  BuildWebHost方法中，默认将appsettings.json写入配置）。然后我们创建一个类，名字叫做MyClass=>

    public class MyClass
    {
        public string classId { get; set; }
        public List<student> student { get; set; }
    }
    public class student
    {
        public int id { get; set; }
        public string name { get; set; }
    }

我们在Startup 中添加一个 IConfiguration，然后再构造函数中注入

    public class Startup
    {
        public IConfiguration configuration { get; set; } 
        public Startup(IConfiguration Configuration)
        {
            this.configuration = Configuration;
        }

接下来，我们读取配置文件中的内容

        public void Configure(IApplicationBuilder app, IHostingEnvironment env)
        {
            if (env.IsDevelopment())
            {
                app.UseDeveloperExceptionPage();
            }

            app.Run(async (context) =>
            {
                MyClass myClass = new MyClass();
                configuration.Bind(myClass); //这里的Bind方法，将配置文件中的内容绑定到myClass实例
                await context.Response.WriteAsync($"classId:{myClass.classId}");
                await context.Response.WriteAsync($"studentId:{myClass.student[0].id}");
                await context.Response.WriteAsync($"studentname:{myClass.student[0].name}");
                await context.Response.WriteAsync($"studentId:{myClass.student[1].id}");
                await context.Response.WriteAsync($"studentname:{myClass.student[1].name}");
                await context.Response.WriteAsync($"studentId:{myClass.student[2].id}");
                await context.Response.WriteAsync($"studentname:{myClass.student[2].name}");
            });
        }

 接下来我们将配置文件读取到MVC的视图中去。首先添加一个Home控制器，在控制器中注入MyClass,代码修改为如下：

    public class HomeController : Controller
    {
        public readonly MyClass _myClass;
        public HomeController(IOptions<MyClass> myClass)
        {
            _myClass = myClass.Value;
        }
        public IActionResult Index()
        {
            return View(_myClass);
        }
    }

修改我们的startup.cs 和添加Index.cshtml，将视图的model设置为MyClass

        public void ConfigureServices(IServiceCollection services)
        {
            services.Configure<MyClass>(configuration); //注册IConfiguration，让控制器中IOptions读到appsettings
            services.AddMvc();
        }

        // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
        public void Configure(IApplicationBuilder app, IHostingEnvironment env)
        {
            if (env.IsDevelopment())
            {
                app.UseDeveloperExceptionPage();
            }
            app.UseMvcWithDefaultRoute();//添加路由中间件
            app.UseMvc(routes =>
            {
                routes.MapRoute(
                    name: "default",
                    template: "{controller=Home}/{action=Index}/{id?}");
            });
　　　　　　}

@model MVCConfigApplication.MyClass

@{
    ViewData["Title"] = "Index";
}

<h2>Index</h2>

<h4>Class Id:@Model.classId</h4>

@foreach(var entity in @Model.student)
{
    <ul>
        <li>studentId:@entity.id</li>
        <li>studentId:@entity.name</li>
    </ul>

}

接下来让我们来看一下结果=》

当然，我们也可以不使用控制器，在视图中直接注入MyClass。我们在HomeController中删除依赖注入的代码，修改Index.cshtml代码如下：

    public class HomeController : Controller
    {
        public IActionResult Index()
        {
            return View();
        }
    }

@using Microsoft.Extensions.Options
@inject IOptions<MVCConfigApplication.MyClass> MyClass

@{
ViewData["Title"] = "Index";
}

<h2>Index</h2>
<h4>Class Id:@MyClass.Value.classId</h4>
@foreach(var entity in @MyClass.Value.student)
{
        <ul>
            <li>studentId:@entity.id</li>
            <li>studentId:@entity.name</li>
        </ul>

}

配置文件热更新

将IOptions 改为IOptionsSnapshot

 在asp.net core 中，WebHost.CreateDefaultBuilder(args)  方法中，默认加载appsettings.json文件，并且将是否更改重新加载设置为true

 这里是github webhost.cs源码： 

所以我们想关闭热更新只需要将WebHost的ConfigureAppConfiguration方法中 config.AddJsonFile第三个参数设置为false就可以了。=》 config.AddJsonFile("appsettings.json", false, false);

总结一下

在框架配置中，有两个最重要的对象。第一个是IConfigurationSource，第二个是IConfigurationProvider。IConfigurationSource 在实例化 ConfigurationBuilder时候，可以把不同的Source添加至builder,例如Program中的BuildWebHost方法，最后使用生成器模式统一生成（Build），追加到IConfigurationProvider当中。读取时候，就根据IConfigurationProvider当中是否存在"Key"，把对应的值读取出来。

 Jesse博客学习笔记。传送门=》 http://video.jessetalk.cn/