Klasa Program i Startup
.NET Core 2.x
Nie musisz wprowadzać nowego IConfigurationw Startupkonstruktorze. Jego implementacja zostanie wstrzyknięta przez system DI.
// Program.cs
public class Program
{
public static void Main(string[] args)
{
BuildWebHost(args).Run();
}
public static IWebHost BuildWebHost(string[] args) =>
WebHost.CreateDefaultBuilder(args)
.UseStartup<Startup>()
.Build();
}
// Startup.cs
public class Startup
{
public IHostingEnvironment HostingEnvironment { get; private set; }
public IConfiguration Configuration { get; private set; }
public Startup(IConfiguration configuration, IHostingEnvironment env)
{
this.HostingEnvironment = env;
this.Configuration = configuration;
}
}
.NET Core 1.x
Musisz powiedzieć, Startupaby załadować pliki appsettings.
// Program.cs
public class Program
{
public static void Main(string[] args)
{
var host = new WebHostBuilder()
.UseKestrel()
.UseContentRoot(Directory.GetCurrentDirectory())
.UseIISIntegration()
.UseStartup<Startup>()
.UseApplicationInsights()
.Build();
host.Run();
}
}
//Startup.cs
public class Startup
{
public IConfigurationRoot Configuration { get; private set; }
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();
this.Configuration = builder.Build();
}
...
}
Pobieranie wartości
Istnieje wiele sposobów na uzyskanie wartości skonfigurowanej w ustawieniach aplikacji:
- Prosty sposób używania
ConfigurationBuilder.GetValue<T>
- Korzystanie z wzorca opcji
Powiedzmy, że appsettings.jsonwyglądasz tak:
{
"ConnectionStrings": {
...
},
"AppIdentitySettings": {
"User": {
"RequireUniqueEmail": true
},
"Password": {
"RequiredLength": 6,
"RequireLowercase": true,
"RequireUppercase": true,
"RequireDigit": true,
"RequireNonAlphanumeric": true
},
"Lockout": {
"AllowedForNewUsers": true,
"DefaultLockoutTimeSpanInMins": 30,
"MaxFailedAccessAttempts": 5
}
},
"Recaptcha": {
...
},
...
}
Prosta droga
Możesz wstrzyknąć całą konfigurację do konstruktora swojego kontrolera / klasy (przez IConfiguration) i uzyskać żądaną wartość za pomocą określonego klucza:
public class AccountController : Controller
{
private readonly IConfiguration _config;
public AccountController(IConfiguration config)
{
_config = config;
}
[AllowAnonymous]
public IActionResult ResetPassword(int userId, string code)
{
var vm = new ResetPasswordViewModel
{
PasswordRequiredLength = _config.GetValue<int>(
"AppIdentitySettings:Password:RequiredLength"),
RequireUppercase = _config.GetValue<bool>(
"AppIdentitySettings:Password:RequireUppercase")
};
return View(vm);
}
}
Wzorzec opcji
ConfigurationBuilder.GetValue<T>Działa świetnie, jeśli trzeba tylko jedną lub dwie wartości w ustawieniach aplikacji. Ale jeśli chcesz uzyskać wiele wartości z ustawień aplikacji lub nie chcesz na stałe kodować tych ciągów kluczy w wielu miejscach, łatwiejsze może być użycie wzorca opcji . Wzorzec opcji używa klas do reprezentowania hierarchii / struktury.
Aby użyć wzorca opcji:
- Zdefiniuj klasy reprezentujące strukturę
- Zarejestruj wystąpienie konfiguracji, z którym te klasy są powiązane
- Wstrzyknij
IOptions<T>do konstruktora kontrolera / klasy, dla którego chcesz uzyskać wartości
1. Zdefiniuj klasy konfiguracyjne reprezentujące strukturę
Możesz zdefiniować klasy z właściwościami, które muszą dokładnie odpowiadać kluczom w ustawieniach aplikacji. Nazwa zajęć nie musi odpowiadać nazwie sekcji w ustawieniach aplikacji:
public class AppIdentitySettings
{
public UserSettings User { get; set; }
public PasswordSettings Password { get; set; }
public LockoutSettings Lockout { get; set; }
}
public class UserSettings
{
public bool RequireUniqueEmail { get; set; }
}
public class PasswordSettings
{
public int RequiredLength { get; set; }
public bool RequireLowercase { get; set; }
public bool RequireUppercase { get; set; }
public bool RequireDigit { get; set; }
public bool RequireNonAlphanumeric { get; set; }
}
public class LockoutSettings
{
public bool AllowedForNewUsers { get; set; }
public int DefaultLockoutTimeSpanInMins { get; set; }
public int MaxFailedAccessAttempts { get; set; }
}
2. Zarejestruj instancję konfiguracji
Następnie musisz zarejestrować tę instancję konfiguracyjną ConfigureServices()podczas uruchamiania:
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
...
namespace DL.SO.UI.Web
{
public class Startup
{
...
public void ConfigureServices(IServiceCollection services)
{
...
var identitySettingsSection =
_configuration.GetSection("AppIdentitySettings");
services.Configure<AppIdentitySettings>(identitySettingsSection);
...
}
...
}
}
3. Wstrzyknij IOptions
Na koniec na kontrolerze / klasie, dla której chcesz uzyskać wartości, musisz wstrzyknąć IOptions<AppIdentitySettings>przez konstruktor:
public class AccountController : Controller
{
private readonly AppIdentitySettings _appIdentitySettings;
public AccountController(IOptions<AppIdentitySettings> appIdentitySettingsAccessor)
{
_appIdentitySettings = appIdentitySettingsAccessor.Value;
}
[AllowAnonymous]
public IActionResult ResetPassword(int userId, string code)
{
var vm = new ResetPasswordViewModel
{
PasswordRequiredLength = _appIdentitySettings.Password.RequiredLength,
RequireUppercase = _appIdentitySettings.Password.RequireUppercase
};
return View(vm);
}
}