原文連結:blog.zhuliang.ltd/back-end/co…
以下示例基於 .net core 2.2
ASP.NET MVC示例
asp.net mvc已經內部實現了對配置appsettings.json檔案的使用,builder預設支援熱更新。
使用示例:
假設appsettings.json內容為:
{
"Logging": {
"LogLevel": {
"Default": "Warning"
}
},
"AllowedHosts": "*"
}
複製程式碼
- 新建一個跟appsettings.json結構保持一致的類,如:
namespace webapp.Models
{
public class AppsettingsModel
{
public Logging Logging { get; set; }
public string AllowedHosts { get; set; }
}
public class Logging
{
public LogLevel LogLevel { get; set; }
}
public class LogLevel
{
public string Default { get; set; }
}
}
複製程式碼
- 在Startup.cs中進行依賴注入
public void ConfigureServices(IServiceCollection services)
{
services.Configure<CookiePolicyOptions>(options =>
{
options.CheckConsentNeeded = context => true;
options.MinimumSameSitePolicy = SameSiteMode.None;
});
// 依賴注入
services.Configure<AppsettingsModel>(Configuration);
services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_1);
}
複製程式碼
- 在controller中呼叫:
public class TestController : Controller
{
private readonly AppsettingsModel _appsettingsModel;
//若要使用熱更新,則入參調整為 IOptionsSnapshot<T>
public TestController(IOptions<AppsettingsModel> appsettingsModel)
{
_appsettingsModel = appsettingsModel.Value;
}
public IActionResult Index()
{
return View("Index", _appsettingsModel.Logging.LogLevel.Default);
}
}
複製程式碼
如何覆寫預設行為?如取消熱更新支援,方法如下:
假設測試controller為
public class TestController : Controller
{
private readonly AppsettingsModel _appsettingsModel;
//使用的是:IOptionsSnapshot<T>
public TestController(IOptionsSnapshot<AppsettingsModel> appsettingsModel)
{
_appsettingsModel = appsettingsModel.Value;
}
public IActionResult Index()
{
return View("Index", _appsettingsModel.Logging.LogLevel.Default);
}
}
複製程式碼
public class Program
{
public static void Main(string[] args)
{
CreateWebHostBuilder(args).Build().Run();
}
public static IWebHostBuilder CreateWebHostBuilder(string[] args) =>
WebHost.CreateDefaultBuilder(args)
.ConfigureAppConfiguration((context, config) => //1.通過該方法來覆蓋配置
{
//2.重新新增json配置檔案
config.AddJsonFile("appsettings.json", false, false); //3.最後一個引數就是是否熱更新的布林值
})
.UseStartup<Startup>();
}
複製程式碼
- 這個時候,人為將熱更新給關閉了,此時更新json檔案後,修改後的內容不會更新到系統中。
控制檯示例
對於console專案,預設是沒有這個dll的,需要自行從nuget安裝
從nuget中安裝:Microsoft.AspNetCore.All (注意,末尾不是dll,而是all)
在專案中引入:Microsoft.Extensions.Configuration; 並使用ConfigurationBuilder來構建配置。
使用應用程式引數
在控制檯專案屬性中增加name和class引數:
使用:
class Program
{
static void Main(string[] args)
{
var builder = new ConfigurationBuilder()
.AddCommandLine(args);
var configuration = builder.Build();
Console.WriteLine($"name:{configuration["name"]}"); //name:CLS
Console.WriteLine($"class:{configuration["class"]}"); //class:Class_A
Console.Read();
}
}
複製程式碼
使用鍵值對列舉(這裡以字典來說明)
class Program
{
static void Main(string[] args)
{
var dict = new Dictionary<string, string>
{
{"name","MC"},
{"class","CLASS_MC"}
};
var builder = new ConfigurationBuilder()
// .AddCommandLine(args)
.AddInMemoryCollection(dict);
var configuration = builder.Build();
Console.WriteLine($"name:{configuration["name"]}");//name:MC
Console.WriteLine($"class:{configuration["class"]}"); //class:CLASS_MC
Console.Read();
}
}
複製程式碼
注意事項:
- 這裡需要注意下,雖然 AddCommandLine 和 AddInMemoryCollection 可以同時呼叫,但不同的使用次序,效果是不一樣的(後一個會覆蓋前一個的內容---淺覆蓋),如:
/*
假設 在專案屬性中,定義的內容為:name=CLS,class=CLASS_CLS,grade="mygrade"
在程式碼中,dict的內容為:name=MC,class=CLASS_MC
*/
//對於程式碼:
var builder = new ConfigurationBuilder()
.AddCommandLine(args)
.AddInMemoryCollection(dict);
var configuration = builder.Build();
Console.WriteLine($"name:{configuration["name"]}");//name:MC
Console.WriteLine($"class:{configuration["class"]}"); //class:CLASS_MC
Console.WriteLine($"grade:{configuration["grade"]}"); //grade:mygrade
//對於程式碼:
var builder = new ConfigurationBuilder()
.AddInMemoryCollection(dict)
.AddCommandLine(args);
var configuration = builder.Build();
Console.WriteLine($"name:{configuration["name"]}");//name:CLS
Console.WriteLine($"class:{configuration["class"]}"); //class:CLASS_CLS
Console.WriteLine($"grade:{configuration["grade"]}"); //grade:mygrade
複製程式碼
- 另外,需要注意,如果用dotnet命令來執行CommandLineSample.dll,那麼“應用程式引數”需要直接跟在命令的後面,如:
- 另外如果AddInMemoryCollection和AddCommandLine同時使用,那麼需要將AddCommandLine最後呼叫,否則一旦被覆蓋了,再用dotnet來呼叫,會沒有效果。
dotnet CommandLineSample.dll name=111 class=222 grade="my grade"
複製程式碼
使用JSON檔案
- 在專案根目錄建立“jsconfig1.json”,同時修改該檔案的屬性:
- 複製到輸出目錄:始終複製
- 生成操作:內容
JSON檔案內容:
{
"Class": "Class A",
"PersonInfo": {
"name": "my name",
"age": "12"
},
"Hobbies": [
{
"Type": "Family",
"HobbyName": "Piano"
},
{
"Type": "Personal",
"HobbyName": "Singing"
}
]
}
複製程式碼
static void Main(string[] args)
{
var builder = new ConfigurationBuilder()
.AddJsonFile("jsconfig1.json");
var configuration = builder.Build();
Console.WriteLine($"name:{configuration["PersonInfo:name"]}");
Console.WriteLine($"class:{configuration["class"]}");
Console.WriteLine($"age:{configuration["PersonInfo:age"]}");
//注意下呼叫引數時的格式:"{引數Key}:{陣列索引}:{子項引數Key}"
Console.WriteLine($"FamilyHobby:{configuration["Hobbies:0:HobbyName"]}");
Console.WriteLine($"PersonalHobby:{configuration["Hobbies:1:HobbyName"]}");
Console.Read();
}
複製程式碼