.net5 core webapi項目實戰之十八：配置文件的讀取

.net5 core 中的配置文件都是JSON格式的，這種格式具有對象化的特征，書寫更簡潔，且被大多數語言支持，

非常適合在微服務架構下使用。配置文件的讀取有兩種方式，

一種是傳統的Configuration模式，另一種是Option模式，下面分別介紹。

 

准備工作：

在解決方案資源管理器的根目錄下打開 appsettings.json 文件，加入如下代碼：

{
  "ConnectionString": {
    "MySql": "server=localhost;user=root;pwd=123;database=webapidemo",
    "SqlServer": "server=localhost;database=webapidemo;integrated security=false;uid=sa;pwd=123",
    "Oracle": "Provider=OraOLEDB.Oracle;Data Source=127.0.0.1:1521/webapidemo;User Id=admin;Password=123;"
  }
}

在配置文件中定義了三種數據庫的連接字符串信息，下面看如何讀取這些信息。

 

一、Configuration模式

1. 引用using Microsoft.Extensions.Configuration; 名稱空間

2. 在UsersController.cs的構造函數中注入 Configuration 服務，代碼如下（紅色標注）：

    public class UsersController : ControllerBase
    {
        private IWebHostEnvironment _env;
        private ILogger<UsersController> _logger;
        private readonly IConfiguration _configuration;
        private IUserDao _userDao;
        public UsersController(IWebHostEnvironment env, ILogger<UsersController> logger, IConfiguration configuration, IUserDao userDao)
        {
            _env = env;
            _logger = logger;
            _configuration = configuration;
            _userDao = userDao;
        }

        //...   
    }

3. 新增終結點 ReadConfiguration( ) ，路由屬性是 [Route("configuration")]，代碼如下：

        [Route("configuration")]
        [HttpGet]
        [AllowAnonymous]
        public ContentResult ReadConfiguration()
        {
            string mySql = _configuration["ConnectionString:MySql"];
            string sqlServer = _configuration["ConnectionString:SqlServer"];
            string oracle = _configuration["ConnectionString:Oracle"];

            string allcs = "MySql:" + mySql + Environment.NewLine + 
                    "SqlServer:" + sqlServer + Environment.NewLine + 
                    "Oracle:" + oracle + Environment.NewLine;

            return Content(allcs);
        }

編碼很簡單，使用IConfiguration的實例用索引的方式就可以讀取配置信息了，

配置文件中多層嵌套的值只需要按由外到里的順序用冒號"："分割。

打開POSTMAN訪問網址：http://localhost:52384/api/users/configuration，結果如下：

 

二、Option模式

此模式是將配置信息讀取到自定義的類中，然后以服務的形式提供給外部使用，步驟如下：

1 . 在解決方案根目錄中新建Options的文件夾，在里面新增一個類文件 ConnectionStringOptions.cs

 2 . ConnectionStringOptions.cs中代碼如下：

    public class ConnectionStringOptions
    {
        public const string ConnectionString = "ConnectionString";

        public string MySql { get; set; }
        public string SqlServer { get; set; }
        public string Oracle { get; set; }
    }

3. 新增終結點 ReadOption( ) ，路由屬性是 [Route("option")]，代碼如下：

        [Route("option")]
        [HttpGet]
        [AllowAnonymous]
        public ContentResult ReadOption()
        {
            ConnectionStringOptions csOptions = new ConnectionStringOptions();
            _configuration.GetSection(ConnectionStringOptions.ConnectionString).Bind(csOptions);

            //也可以用泛型的Get( )方法
            //csOptions = _configuration.GetSection(ConnectionStringOptions.ConnectionString)
                                                     .Get<ConnectionStringOptions>();


            string allcs = "===Option===" + Environment.NewLine +
                    "MySql:" + csOptions.MySql + Environment.NewLine +
                    "SqlServer:" + csOptions.SqlServer + Environment.NewLine +
                    "Oracle:" + csOptions.Oracle + Environment.NewLine;

            return Content(allcs);
        }

使用_configuration的 GetSection( ) 方法獲取指定區間的配置信息，

然后調用Bind()方法將配置文件中的值綁定到我們定義的類ConnectionStringOptions.cs的實例上。

（注：類中的屬性名必須和配置文件中的屬性名相同，使用的時候直接訪問實例的屬性就可以了）。

打開POSTMAN訪問網址：http://localhost:52384/api/users/option，結果如下：

 4 . 在ReadOption( ) 方法中，建立配置文件到 ConnectionStringOptions 實例的映射是通過如下兩行代碼實現的：

            ConnectionStringOptions csOptions = new ConnectionStringOptions();
            _configuration.GetSection(ConnectionStringOptions.ConnectionString).Bind(csOptions);

還有一種更好的處理方式是將 ConnectionStringOptions 注冊到Service容器中，

在調用的地方通過構造函數注入的方式來使用，步驟如下：

第1步：在Startup.cs的構造方法中注入 Configuration 的實例，代碼如下：

    public class Startup
    {
        public IConfiguration Configuration { get; }


        public Startup(IConfiguration configuration)
        {
            Configuration = configuration;
        }

    
        //...
    }

第2步：在Startup.cs文件的 ConfigureServices( ) 方法中注冊 ConnectionStringOptions 服務，代碼如下（紅色標注）：

        public void ConfigureServices(IServiceCollection services)
        {
            services.AddControllers();
     
            services.AddScoped<IUserDao, MySqlUserDao>();

            services.Configure<ConnectionStringOptions>(  //使用泛型方法來獲取自定義類的實例
                Configuration.GetSection(ConnectionStringOptions.ConnectionString)
            );
             
            services.AddAuthentication(JwtBearerDefaults.AuthenticationScheme).AddJwtBearer(
                //設置Token解析的參數
                options =>
                {
                    options.TokenValidationParameters = new TokenValidationParameters()
                    {
                        ValidateIssuer = false, //不驗證 issuer，因為 GenerateJwtToken() 方法生成的Token中issuer = null
                        ValidateAudience = false, //同上

                        //如果希望 Token 在規定時間后失效請設置成 true
                        //本例中 GenerateJwtToken()方法設置的值是 new DateTime(2020, 3, 1)
                        ValidateLifetime = false,

                        //需要驗證簽名key並與 GenerateJwtToken() 方法中的key保持一致
                        ValidateIssuerSigningKey = true,
                        IssuerSigningKey = new SymmetricSecurityKey(Encoding.UTF8.GetBytes("abcdefghijklmn1234567890"))
                    };
                }
            );
        }

第3步：在UsersController.cs中引用名稱空間 using Microsoft.Extensions.Options;

第4步：在UsersController.cs的構造函數中注入 ConnectionStringOptions 服務，代碼如下（紅色標注）：

    public class UsersController : ControllerBase
    {
        private IWebHostEnvironment _env;
        private ILogger<UsersController> _logger;
        private readonly IConfiguration _configuration;
        private readonly ConnectionStringOptions _options;
        private IUserDao _userDao;
        public UsersController(IWebHostEnvironment env, 
            ILogger<UsersController> logger, 
            IConfiguration configuration, 
            IOptions<ConnectionStringOptions> options,
            IUserDao userDao)
        {
            _env = env;
            _logger = logger;
            _configuration = configuration;
            _options = options.Value;
            _userDao = userDao;
        }

         //...   

    }

 第5步：新增終結點 ReadOption2( ) ，路由屬性是 [Route("option2")]，代碼如下：

        [Route("option2")]
        [HttpGet]
        [AllowAnonymous]
        public ContentResult ReadOption2()
        { 
            string allcs = "===Option2===" + Environment.NewLine +
                    "MySql:" + _options.MySql + Environment.NewLine +
                    "SqlServer:" + _options.SqlServer + Environment.NewLine +
                    "Oracle:" + _options.Oracle + Environment.NewLine;

            return Content(allcs);
        }

直接使用構造函數中注入的ConnectionStringOptions實例 _options。

打開POSTMAN訪問網址：http://localhost:52384/api/users/option2，結果如下：

和前面得到的結果一致。