.Net Core 5.x Api开发笔记 -- 读取配置文件信息(四)

上节演示Autofac使用，连接：.Net Core 3.x Api开发笔记 -- IOC,使用Autofac实现依赖注入(三) 

本节演示如何读取应用配置信息，也就是读取 appsettings.json 文件中的配置信息

本节通过读取数据库配置文件做完演示：

第1步：在 appsettings.json 添加数据库配置文件

  //数据库连接字符串
  "DBConfig": {
    "DBType": "Mysql", //mysql、mssql、oracle
    "DBConnectionString": "Data Source=localhost;Database=MyShop;User Id=root;Password=123456;CharSet=utf8;port=3306", //mysql连接字符串
    "DBTimeout": 180, //180s  单位秒
    "RedisConnectionString": "127.0.0.1:6379,password=123456,abortConnect=false" //redis连接字符串
  }

第2步：新建一个类：DBConfig，用于存放上述配置文件内容

    public class DBConfig
    {
        /// <summary>
        /// 数据库类型  mysql、mssql、oracle
        /// </summary>
        public string DBType { get; set; }
        /// <summary>
        /// 链接字符串
        /// </summary>
        public string DBConnectionString { get; set; }
        /// <summary>
        /// 链接超时时间
        /// </summary>
        public string DBTimeout { get; set; }
        /// <summary>
        /// redis链接字符串
        /// </summary>
        public string RedisConnectionString { get; set; }

    }


    //全局配置
    public class SystemContext
    {
        /// <summary>
        /// 读取数据库配置文件
        /// </summary>
        public static DBConfig dbConfig { get; set; }

    }

第三步：在 Startup 文件中初始化配置文件内容

        public void ConfigureServices(IServiceCollection services)
        {
            services.AddControllers();

            //方式1
            //读取配置文件appsettings.json，将自定义节点绑定到DBConfig类中，在任意地方直接使用
            //配置文件更新，绑定的值不会实时更新
            SystemContext.dbConfig = Configuration.GetSection("DBConfig").Get<DBConfig>();

            //方式2 
            //将DBConfig对象注册到Service中，这样可以在Controller中注入使用
            //配置文件更新，绑定的值会实时更新
            services.Configure<DBConfig>(Configuration.GetSection("DBConfig"));
        }

上边有两种配置方式，可以任选一种，方式1不会实时更新配置文件内容，方式2会实时更新配置文件内容，根据业务需求自由选择

第四步：在应用中使用

        private readonly IOptionsSnapshot<DBConfig> dbConfig;   //通过注入方式读取配置文件

        public UserController(IOptionsSnapshot<DBConfig> _dbConfig)
        {
            dbConfig = _dbConfig;
        }

        [HttpGet]
        public async Task<IActionResult> GetConfig()
        {
            var result = await Task.Run(() =>
            {
                //方式1 读取配置文件  不会实施更新内容
                var dbType = SystemContext.dbConfig.DBType.ToLower();
                return dbType;
            });

            //方式2 读取配置文件  可以实施更新内容
            var result2 = dbConfig.Value.DBType.ToLower();

            return Ok("方式1：" + result + "，方式2：" + result2);
        }

最后测试结果显示，方式2 会跟随配置文件内容的变更实时更新，而方式1没有变化！

后记：

一个服务或者产品，往往需要三个环境：一个开发环境(Development)，一个测试环境(Staging)，一个生产环境(Production)，
这就不可避免的需要多个配置文件来匹配相应的环境，因为不可能三个环境都使用同一个配置，

解决办法如下： 在Startup中自定义加载 appsetting.json文件

public class Startup
{
    private IHostEnvironment CurrentEnvironment { get; set; }

    public Startup(IHostEnvironment env)
    {
        var builder = new ConfigurationBuilder()
            .SetBasePath(env.ContentRootPath)
            .AddJsonFile("appsettings.json", optional: false, reloadOnChange: true)
            .AddJsonFile($"appsettings.{env.EnvironmentName}.json", optional: true, reloadOnChange: true)
            .AddEnvironmentVariables();
        Configuration = builder.Build();
        CurrentEnvironment = env;
    }

    public IConfigurationRoot Configuration { get; }
。。。。。。

然后在项目里添加三个settings的json文件：

 使用时，在如下文件或者项目属性中更改变量即可。