循序漸進學.Net Core Web Api開發系列【6】:配置檔案appsettings.json
阿新 • • 發佈:2018-12-29
系列目錄
一、本篇概述
本篇描述appsettings.json的使用,包括:
1、配置的基本讀取
2、讀取配置資訊到自定義的物件
3、自定義配置檔案
一、配置的基本讀取
要讀取的配置檔案內容如下:
{ "ConnString": "MySQL Connect String", "Logging": { "IncludeScopes": false, "Debug": { "LogLevel": { "Default": "Warning" } }, "Console": { "LogLevel": { "Default": "Warning" } } }, "SystemConfig": { "UploadFile": "d:\\files", "AnnexUrl": "http://192.168.0.177:81/", "Admin": { "Name": "admin", "Age": "31", "Allow": "True" }, "DefaultPassword": "123456" } }
讀取配置檔案的方法如下:
public class Startup { public Startup(IConfiguration configuration,IHostingEnvironment env) { Configuration = configuration; _env = env; } public IConfiguration Configuration { get; } public IHostingEnvironment _env { get; } // This method gets called by the runtime. Use this method to add services to the container. public void ConfigureServices(IServiceCollection services) { services.AddMvc();
var ConnString = Configuration["ConnString"]; var UploadFile = Configuration.GetSection("SystemConfig")["UploadFile"]; var AdminName = Configuration.GetSection("SystemConfig").GetSection("Admin")["Name"]; } }
還有一種讀法:
ConnString = Configuration["ConnString"]; UploadFile = Configuration["SystemConfig:UploadFile"]; AdminName = Configuration["SystemConfig:Admin:Name"];
這裡Startup類在構造時已經幫我們注入了Configuration,如果要在自己的Controller內使用,需要自己注入。
public class ValuesController : Controller { private IConfiguration _configuration; public ValuesController(IConfiguration configuration) { _configuration = configuration; } [HttpGet] public IEnumerable<string> Get() { var ConnString = _configuration["ConnString"]; return new string[] { "value1", "value2" }; } }
二、讀取配置資訊到自定義的物件
新建一個類,用來儲存配置資訊,類的結構應和配置檔案一致。
public class SystemConfig { public String UploadFile { get; set; } public String AnnexUrl { get; set; } public User Admin { get; set; } public String DefaultPassword { get; set; } } public class User { public String Name { get; set; } public int Age { get; set; } public bool Allow { get; set; } }
在startup類的ConfigureServices方法內,提供如下程式碼:
public class Startup { public Startup(IConfiguration configuration) { Configuration = configuration; } public IConfiguration Configuration { get; } public void ConfigureServices(IServiceCollection services) { services.AddMvc(); services.AddOptions(); services.Configure<SystemConfig>(Configuration.GetSection("SystemConfig")); } } }
然後在Controller中進行注入並使用。
public class ValuesController : Controller { private IOptions<SystemConfig> _setting; public ValuesController( IOptions<SystemConfig> setting) { _setting = setting; } [HttpGet("setting")] public IEnumerable<string> GetSetting() { var UploadFile = _setting.Value.UploadFile; var AdminName = _setting.Value.Admin.Name; var AdminAge = _setting.Value.Admin.Age; var AdminAllow = _setting.Value.Admin.Allow; return new string[] { "value1", "value2" }; } }
可以看到,這樣在業務方法內通過 _setting 來都取配置資訊就非常方便了。
三、自定義配置檔案
以上操作的是系統預設的配置檔案appsettings.json。如果我們需要增加自己的配置檔案該如何處理?
新建一個配置檔案:mysetting.json
{ "ConnString": "MySQL Connect String", "SystemConfig": { "UploadFile": "d:\\myfiles", "AnnexUrl": "http://192.168.0.177:81/my", "Admin": { "Name": "myadmin", "Age": "131", "Allow": "False" }, "DefaultPassword": "654321" } }
在Startup類的ConfigureServices方法輸入以下程式碼:
public class Startup { public Startup(IConfiguration configuration,IHostingEnvironment env) { Configuration = configuration; _env = env; } public IConfiguration Configuration { get; } public IHostingEnvironment _env { get; } public void ConfigureServices(IServiceCollection services) { services.AddMvc(); var rootpath = _env.ContentRootPath; var builder = new ConfigurationBuilder() .SetBasePath(_env.ContentRootPath) .AddJsonFile("mysetting.json",optional: true, reloadOnChange: true) .AddEnvironmentVariables(); var MyConfiguration = builder.Build(); services.AddOptions(); services.Configure<SystemConfig>(MyConfiguration.GetSection("SystemConfig")); } }
用自己建立的Configuration進行服務的註冊,建立過程中需要用到IHostingEnvironment,這個物件在Startup類構建時進行注入。
剩下的用法和預設配置用法就一樣了。