Tôi đã xác định một số giá trị trong của mình appsettings.jsoncho những thứ như chuỗi kết nối cơ sở dữ liệu, vị trí webapi và những thứ tương tự khác cho môi trường phát triển, dàn dựng và trực tiếp.
Có cách nào để có nhiều appsettings.jsontệp (như appsettings.live.json, v.v., v.v.) và ứng dụng asp.net chỉ 'biết' cái nào để sử dụng dựa trên cấu hình bản dựng mà nó đang chạy không?
Câu trả lời:
Bạn có thể sử dụng biên dịch có điều kiện:
public Startup(IHostingEnvironment env)
{
var builder = new ConfigurationBuilder()
.SetBasePath(env.ContentRootPath)
.AddJsonFile("appsettings.json", optional: true, reloadOnChange: true)
#if SOME_BUILD_FLAG_A
.AddJsonFile($"appsettings.flag_a.json", optional: true)
#else
.AddJsonFile($"appsettings.no_flag_a.json", optional: true)
#endif
.AddEnvironmentVariables();
this.configuration = builder.Build();
}
Tôi đã thêm ảnh chụp màn hình của môi trường làm việc, vì tôi đã tốn vài giờ R&D.
Đầu tiên, thêm khóa vào launch.jsontệp của bạn .
Xem ảnh chụp màn hình bên dưới, tôi đã thêm Developmentlàm môi trường của mình.
Sau đó, trong dự án của bạn, hãy tạo một appsettings.{environment}.jsontệp mới bao gồm tên của môi trường.
Trong ảnh chụp màn hình sau, hãy tìm hai tệp khác nhau có tên:
appsettings.Development.JsonappSetting.json
Và cuối cùng, cấu hình nó cho StartUplớp của bạn như thế này:
public Startup(IHostingEnvironment env)
{
var builder = new ConfigurationBuilder()
.SetBasePath(env.ContentRootPath)
.AddJsonFile("appsettings.json", optional: false, reloadOnChange: true)
.AddJsonFile($"appsettings.{env.EnvironmentName}.json", optional: true)
.AddEnvironmentVariables();
Configuration = builder.Build();
}
Và cuối cùng, bạn có thể chạy nó từ dòng lệnh như sau:
dotnet run --environment "Development"
nơi "Development"là tên của môi trường của tôi.
IWebHostEnvironmentthay thế.
Bạn có thể sử dụng CreateDefaultBuildernó sẽ tự động xây dựng và chuyển một đối tượng cấu hình cho lớp khởi động của bạn:
WebHost.CreateDefaultBuilder(args).UseStartup<Startup>();
public class Startup
{
public Startup(IConfiguration configuration) // automatically injected
{
Configuration = configuration;
}
public IConfiguration Configuration { get; }
/* ... */
}
CreateDefaultBuildertự động bao gồm tệp thích hợp để thêm tệp cài đặt ứng dụng riêng cho từng môi trường:appsettings.Environment.json
Sau đó, đặt ASPNETCORE_ENVIRONMENT biến môi trường khi chạy / gỡ lỗi
Tùy thuộc vào IDE của bạn, có một số nơi các dự án dotnet truyền thống tìm kiếm các biến môi trường:
Đối với Visual Studio, đi tới Dự án> Thuộc tính> Gỡ lỗi> Biến môi trường:
Đối với Mã Visual Studio , hãy chỉnh sửa .vscode/launch.json> env:
Sử dụng Cài đặt Khởi chạy , chỉnh sửa Properties/launchSettings.json> environmentVariables:
Cũng có thể được chọn từ Thanh công cụ trong Visual Studio
Sử dụng dotnet CLI , sử dụng cú pháp thích hợp để đặt các biến môi trường cho mỗi hệ điều hành của bạn
Lưu ý : Khi một ứng dụng được khởi chạy với dotnet run ,
launchSettings.jsonsẽ được đọc nếu có vàenvironmentVariablescác cài đặt trong launcher.json sẽ ghi đè các biến môi trường.
Host.CreateDefaultBuilderlàm việc?.NET Core 3.0 được thêm vào Host.CreateDefaultBuildertrong các tiện ích mở rộng nền tảng sẽ cung cấp khởi chạy mặc định trong IConfigurationđó cung cấp cấu hình mặc định cho ứng dụng theo thứ tự sau:
appsettings.jsonbằng cách sử dụng nhà cung cấp cấu hình JSON .appsettings.Environment.jsonbằng cách sử dụng nhà cung cấp cấu hình JSON . Ví dụ:
appsettings.Production.jsonhoặc làappsettings.Development.json- Bí mật của ứng dụng khi ứng dụng chạy trong môi trường Phát triển.
- Các biến môi trường sử dụng trình cung cấp cấu hình Biến môi trường .
- Đối số dòng lệnh sử dụng trình cung cấp cấu hình dòng lệnh .
Trong ASP.NET Core, bạn nên sử dụng Biến môi trường thay vì xây dựng cấu hình cho appsettings.json thích hợp
Nhấp chuột phải vào bạn dự án> Thuộc tính> Gỡ lỗi> Biến môi trường
ASP.NET Core sẽ sử dụng tệp appsettings.json thích hợp:
Bây giờ bạn có thể sử dụng Biến môi trường đó như sau:
public Startup(IHostingEnvironment env)
{
var builder = new ConfigurationBuilder()
.SetBasePath(env.ContentRootPath)
.AddJsonFile("appsettings.json", optional: true, reloadOnChange: true)
.AddJsonFile($"appsettings.{env.EnvironmentName}.json", optional: true)
.AddEnvironmentVariables();
Configuration = builder.Build();
}
Lưu ý : Nếu bạn sử dụng câu trả lời của @ Dmitry , bạn có thể gặp sự cố, ví dụ: khi ghi đè các giá trị appsettings.json trên Azure.
Bạn có thể sử dụng các biến môi trường và ConfigurationBuilderlớp trong hàm tạo của mình Startupnhư sau:
public Startup(IHostingEnvironment env)
{
var builder = new ConfigurationBuilder()
.SetBasePath(env.ContentRootPath)
.AddJsonFile("appsettings.json", optional: true, reloadOnChange: true)
.AddJsonFile($"appsettings.{env.EnvironmentName}.json", optional: true)
.AddEnvironmentVariables();
this.configuration = builder.Build();
}
Sau đó, bạn tạo một appsettings.xxx.jsontệp cho mọi môi trường bạn cần, với "xxx" là tên môi trường. Lưu ý rằng bạn có thể đặt tất cả các giá trị cấu hình chung vào appsettings.jsontệp "bình thường" của mình và chỉ đặt nội dung cụ thể của môi trường vào các tệp mới này.
Bây giờ bạn chỉ cần một biến môi trường được gọi ASPNETCORE_ENVIRONMENTvới một số giá trị môi trường cụ thể ("live", "staging", "production", bất cứ điều gì). Bạn có thể chỉ định biến này trong cài đặt dự án cho môi trường phát triển của mình và tất nhiên bạn cũng cần đặt biến này trong môi trường dàn dựng và sản xuất của mình. Cách bạn thực hiện ở đó tùy thuộc vào loại môi trường này.
CẬP NHẬT: Tôi vừa nhận ra rằng bạn muốn chọn appsettings.xxx.jsondựa trên cấu hình bản dựng hiện tại của mình . Điều này không thể đạt được với giải pháp đề xuất của tôi và tôi không biết liệu có cách nào để làm điều này hay không. Tuy nhiên, cách "biến môi trường" hoạt động và cũng có thể là một thay thế tốt cho cách tiếp cận của bạn.
Chỉ là bản cập nhật cho người dùng .NET core 2.0, bạn có thể chỉ định cấu hình ứng dụng sau cuộc gọi tới CreateDefaultBuilder:
public class Program
{
public static void Main(string[] args)
{
BuildWebHost(args).Run();
}
public static IWebHost BuildWebHost(string[] args) =>
WebHost.CreateDefaultBuilder(args)
.ConfigureAppConfiguration(ConfigConfiguration)
.UseStartup<Startup>()
.Build();
static void ConfigConfiguration(WebHostBuilderContext ctx, IConfigurationBuilder config)
{
config.SetBasePath(Directory.GetCurrentDirectory())
.AddJsonFile("config.json", optional: false, reloadOnChange: true)
.AddJsonFile($"config.{ctx.HostingEnvironment.EnvironmentName}.json", optional: true, reloadOnChange: true);
}
}
ASPNETCORE_ENVIRONMENT. Giá trị là những gì sẽ được thay thế cho ctx.HostingEnvironment.EnvironmentName}. Vì vậy, nếu bạn đặt giá trị đó trong thuộc tính thành 'Sản xuất', dự án sẽ tìm kiếm config.Production.jsontệp trong thư mục gốc. Để biết thêm thông tin, vui lòng xem liên kết
Error CS0266 Cannot implicitly convert type 'Microsoft.AspNetCore.Hosting.IWebHost' to 'Microsoft.AspNetCore.Hosting.IWebHostBuilder'. An explicit conversion exists (are you missing a cast?) trong WebHost.CreateDefaultBuiler (...
Tạo nhiều tệp như:appSettings.$(Configuration).json
appSettings.staging.jsonappSettings.production.jsonTạo một sự kiện xây dựng trước trên dự án sao chép tệp tương ứng vào appSettings.json:
copy appSettings.$(Configuration).json appSettings.json
Chỉ sử dụng appSettings.jsontrong Trình tạo cấu hình của bạn:
var builder = new ConfigurationBuilder()
.SetBasePath(env.ContentRootPath)
.AddJsonFile("appsettings.json", optional: false, reloadOnChange: true)
.AddEnvironmentVariables();
Configuration = builder.Build();
Bạn có thể thêm tên cấu hình như ASPNETCORE_ENVIRONMENTtrong launchSettings.jsonnhư sau
"iisSettings": {
"windowsAuthentication": false,
"anonymousAuthentication": true,
"iisExpress": {
"applicationUrl": "http://localhost:58446/",
"sslPort": 0
}
},
"profiles": {
"IIS Express": {
"commandName": "IISExpress",
"environmentVariables": {
ASPNETCORE_ENVIRONMENT": "$(Configuration)"
}
}
}
Đây là phiên bản phù hợp với tôi khi sử dụng ứng dụng bảng điều khiển mà không có trang web:
var builder = new ConfigurationBuilder()
.SetBasePath(Directory.GetCurrentDirectory())
.AddJsonFile("appsettings.json", optional: true, reloadOnChange: true)
.AddJsonFile($"appsettings.{Environment.GetEnvironmentVariable("ASPNETCORE_ENVIRONMENT")}.json", optional: true);
IConfigurationRoot configuration = builder.Build();
AppSettings appSettings = new AppSettings();
configuration.GetSection("AppSettings").Bind(appSettings);
Tệp .vscode / khởi chạy.json chỉ được sử dụng bởi Visual Studio cũng như tệp /Properties/launchSettings.json. Không sử dụng các tệp này trong sản xuất.
Tệp khởi chạySettings.json:
chứa cài đặt hồ sơ.
Để sử dụng tệp 'appSettings.QA.json' chẳng hạn. Bạn có thể sử dụng 'ASPNETCORE_ENVIRONMENT'. Làm theo các bước dưới đây.