ASP.NETCoreでの構成のユースケース

アプリケーションの構成を取得するには、キーワード（キー値）アクセスメソッドを使用するのが一般的です。しかし、これは必ずしも便利ではありません。場合によっては、値がすでに設定されていて、アプリケーションを再起動せずに値を更新できる既製のオブジェクトをコードで使用する必要があります。この例は、ASP.NETCoreアプリケーションのミドルウェアとして構成を使用するためのテンプレートを提供します。



：私たちはあなたが材料に慣れることをお勧めします設定- Metanit、.NETのコアでどのように設定作品。

問題の定式化

実行時にJSON形式で構成を更新する機能を備えたASPNETCoreアプリケーションを実装する必要があります。構成の更新中、現在実行中のセッションは、以前の構成オプションで引き続き機能する必要があります。構成を更新した後、使用されているオブジェクトを更新するか、新しいオブジェクトに置き換える必要があります。



構成を逆シリアル化する必要があります。コントローラーからIConfigurationオブジェクトに直接アクセスしてはなりません。読み取られた値が正しいかどうかを確認する必要があります。読み取られていない場合は、デフォルト値に置き換える必要があります。実装はDockerコンテナで機能するはずです。

クラシック構成作業

GitHub：ConfigurationTemplate_1



プロジェクトは、ASP NET CoreMVCテンプレートに基づいています。JsonConfigurationProvider構成プロバイダーは、JSON構成ファイルを操作するために使用されます。操作中にアプリケーション構成を再ロードする機能を追加するには、パラメーター「reloadOnChange：true」を追加します。Startup.cs



ファイルで、次を置き換えます。

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

オン

public Startup(IConfiguration configuration)
 {         
   var builder = new ConfigurationBuilder()
    .AddJsonFile("appsettings.json", optional: false, reloadOnChange: true);
   configuration = builder.Build();
   Configuration = configuration;
  }

.AddJsonFile -JSONファイルを追加します。reloadOnChange：trueは、構成ファイルのパラメーターが変更されたときに、アプリケーションをリロードせずにリロードされることを示します。appsettings.json



ファイルの内容：

{
  "AppSettings": {
    "Parameter1": "Parameter1 ABC",
    "Parameter2": "Parameter2 ABC"  
  },
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft": "Warning",
      "Microsoft.Hosting.Lifetime": "Information"
    }
  },
  "AllowedHosts": "*"
}

アプリケーションコントローラは、構成に直接アクセスする代わりに、ServiceABCというサービスを使用します。ServiceABCは、構成ファイルから初期値を取得するクラスです。この例では、ServiceABCクラスに含まれるTitleプロパティは1つだけです。ServiceABC.cs



ファイルの内容：

public class ServiceABC
{
  public string Title;
  public ServiceABC(string title)
  {
     Title = title;
  }
  public ServiceABC()
  { }
}

ServiceABC を使用するには、ServiceABCをミドルウェアサービスとしてアプリケーションに追加する必要があります。次の式を使用して、サービスにアクセスするたびに作成されるAddTransientとしてサービスを追加します。

services.AddTransient<IYourService>(o => new YourService(param));

メモリやリソースを消費しない軽量サービスに最適です。構成パラメータを読み取るStartup.csがさ用いて行っIConfigurationのAppSettings：例えば値場所のフルパスを示すクエリ文字列を使用し、パラメータ1。Startup.cs



ファイルに、次を追加します。

public void ConfigureServices(IServiceCollection services)
{
  //  "Parameter1"    ServiceABC
  var settingsParameter1 = Configuration["AppSettings:Parameter1"];
  //  "Parameter1"            
  services.AddScoped(s=> new ServiceABC(settingsParameter1));
  //next
  services.AddControllersWithViews();
}

コントローラでServiceABC サービスを使用する例では、Parameter1値がhtmlページに表示されます。



コントローラでサービスを使用するには、サービスをコンストラクタファイルHomeController.csに追加します。

public class HomeController : Controller
{
  private readonly ILogger<HomeController> _logger;
  private readonly ServiceABC _serviceABC;
  public HomeController(ILogger<HomeController> logger, ServiceABC serviceABC)
    {
      _logger = logger;
      _serviceABC = serviceABC;
    }
  public IActionResult Index()
    {
      return View(_serviceABC);
    }

サービスの可視性を追加するServiceABCファイル_ViewImports.cshtml

@using ConfigurationTemplate_1.Services

Index.cshtmlを 変更して、ページにParameter1パラメーターを表示してみましょう。

@model ServiceABC
@{
    ViewData["Title"] = "Home Page";
}
    <div class="text-center">
        <h1>   ASP.NET Core</h1>
        <h4>   </h4>
    </div>
<div>        
    <p> ServiceABC,  
          Parameter1 = @Model.Title</p>
</div>

アプリケーションを起動しましょう：

結果

このアプローチは部分的に問題を解決します。このソリューションでは、アプリケーションの実行中に構成変更を適用することはできません。サービスは、起動時にのみ構成ファイルの値を受け取り、このインスタンスでのみ機能します。その結果、構成ファイルを後で変更しても、アプリケーションは変更されません。

シングルトンとしてのIConfigurationの使用

GitHub：ConfigurationTemplate_2



2番目のオプションは、IConfigurationを（シングルトンとして）サービスに配置することです。その結果、IConfigurationはコントローラーやその他のサービスから呼び出すことができます。AddSingletonを使用する場合、サービスは1回作成され、アプリケーションを使用する場合、呼び出しは同じインスタンスに送信されます。メモリリークやマルチスレッドの問題が発生する可能性があるため、この方法は細心の注意を払って使用してください。Startup.cs



の前の例のコードを新しいものに置き換えましょう。

services.AddSingleton<IConfiguration>(Configuration);

IConfigurationをシングルトンとしてサービスに追加します。

public void ConfigureServices(IServiceCollection services)
{
  //  IConfiguration     
  services.AddSingleton<IConfiguration>(Configuration);
  //  "ServiceABC"                          
  services.AddScoped<ServiceABC>();
  //next
  services.AddControllersWithViews();
}

IConfigurationを受け入れるようにServiceABC サービスのコンストラクターを変更します

public class ServiceABC
{        
  private readonly IConfiguration _configuration;
  public string Title => _configuration["AppSettings:Parameter1"];        
  public ServiceABC(IConfiguration Configuration)
    {
      _configuration = Configuration;
    }
  public ServiceABC()
    { }
}

アプリケーションを起動しましょう。AddScopedを使用してコンテナに追加されたServiceABC







サービスは、ページ要求ごとにクラスのインスタンスが作成されることを意味します。その結果、ServiceABCクラスのインスタンスがすべてのhttpリクエストで作成され、IConfiguration構成が再ロードされ、appsettings.jsonの新しい変更が適用されます。 したがって、アプリケーションの操作中に、Parameter1パラメーターを「NEW !!!」に変更する場合。Parameter1 ABC」の場合、次にスタートページにアクセスすると、新しいパラメーター値が表示されます。appsettings.json ファイルを変更した後、ページを更新しましょう。

結果

このアプローチの欠点は、各パラメーターを手動で読み取ることです。また、パラメータ検証を追加すると、appsettings.jsonファイルを変更した後ではなく、ServiceABCを使用するたびにチェックが実行されます。これは不要なアクションです。最良の場合、パラメータは、ファイルが変更されるたびに1回だけ検証する必要があります。

検証を伴う構成の逆シリアル化（IOptionsオプション）

GitHub：ConfigurationTemplate_3

オプションについてはこちらをご覧ください。



このオプションにより、ServiceABCを使用する必要がなくなります。代わりに、構成ファイルとClientConfigオブジェクトの設定を含むAppSettingsクラスが使用されます。 ClientConfigオブジェクトは、構成を変更した後に初期化する必要があります。既製のオブジェクトがコントローラーで使用されます。ClientConfigは、外部システムと対話するクラスであり、そのコードは変更できません。あなただけのデータデシリアライズした場合のAppSettingsクラスを、その後、ClientConfig

nullになります。したがって、読み取り構成イベントをサブスクライブし、ハンドラーでClientConfigオブジェクトを初期化する必要があります。



キーと値のペアの形式ではなく、特定のクラスのオブジェクトとして構成を転送するには、IOptionsインターフェイスを使用します。さらに、ConfigurationManagerとは対照的に、IOptionsを使用すると、個々のセクションを逆シリアル化できます。ClientConfigオブジェクトを作成するには、すべての構成が処理された後に実行されるIPostConfigureOptionsを使用する必要があります。 IPostConfigureOptionsは、構成が読み取られるたびに、最近では実行されます。ClientConfig.csを



作成しましょう：

public class ClientConfig
{
  private string _parameter1;
  private string _parameter2;
  public string Value => _parameter1 + " " + _parameter2;
  public ClientConfig(ClientConfigOptions configOptions)
    {
      _parameter1 = configOptions.Parameter1;
      _parameter2 = configOptions.Parameter2;
    }
}

ClientConfigOptions オブジェクトの形式でコンストラクターとしてパラメーターを受け取ります。

public class ClientConfigOptions
{
  public string Parameter1;
  public string Parameter2;
} 

AppSettings 設定クラスを作成し、その中にClientConfigBuild（）メソッドを定義してみましょう。これにより、ClientConfigオブジェクトが作成されます。AppSettings.cs



ファイル：

public class AppSettings
{        
  public string Parameter1 { get; set; }
  public string Parameter2 { get; set; }        
  public ClientConfig clientConfig;
  public void ClientConfigBuild()
    {
      clientConfig = new ClientConfig(new ClientConfigOptions()
        {
          Parameter1 = this.Parameter1,
          Parameter2 = this.Parameter2
        }
        );
      }
}

最後に処理される構成ハンドラーを作成しましょう。これを行うには、IPostConfigureOptionsから継承する必要があります。最後に呼び出されたPostConfigureはClientConfigBuild（）を実行し、ClientConfigを作成します。ConfigureAppSettingsOptions.cs



ファイル：

public class ConfigureAppSettingsOptions: IPostConfigureOptions<AppSettings>
{
  public ConfigureAppSettingsOptions()
    { }
  public void PostConfigure(string name, AppSettings options)
    {            
      options.ClientConfigBuild();
    }
}

現在、Startup.csでのみ変更を加える必要があります。変更は、ConfigureServices（IServiceCollectionサービス）関数にのみ影響します。



まず、appsettings.jsonのAppSettingsセクションを読みましょう。

// configure strongly typed settings objects
var appSettingsSection = Configuration.GetSection("AppSettings");
services.Configure<AppSettings>(appSettingsSection);

さらに、リクエストごとに、後処理を呼び出すことができるようにAppSettingsのコピーが作成されます。

services.AddScoped(sp => sp.GetService<IOptionsSnapshot<AppSettings>>().Value);

AppSettingsクラスの後処理をサービスとして追加しましょう。

services.AddSingleton<IPostConfigureOptions<AppSettings>, ConfigureAppSettingsOptions>();

Startup.csに コードを追加

public void ConfigureServices(IServiceCollection services)
{
  // configure strongly typed settings objects
  var appSettingsSection = Configuration.GetSection("AppSettings");
  services.Configure<AppSettings>(appSettingsSection);
  services.AddScoped(sp => sp.GetService<IOptionsSnapshot<AppSettings>>().Value);                                    
  services.AddSingleton<IPostConfigureOptions<AppSettings>, ConfigureAppSettingsOptions>();            
  //next
  services.AddControllersWithViews();
}

構成にアクセスするには、コントローラーからAppSettingsを挿入するだけで十分です。HomeController.cs



ファイル：

public class HomeController : Controller
{
  private readonly ILogger<HomeController> _logger;
  private readonly AppSettings _appSettings;
  public HomeController(ILogger<HomeController> logger, AppSettings appSettings)
    {
      _logger = logger;
      _appSettings = appSettings;
    }

Index.cshtmlを 変更して、lientConfigオブジェクトのValueパラメーターを表示してみましょう。

@model AppSettings
@{
    ViewData["Title"] = "Home Page";
}
<div class="text-center">
    <h1>   ASP.NET Core</h1>
    <h4>    ( IOptions)</h4>
</div>
<div>
    <p>
         ClientConfig,  
         = @Model.clientConfig.Value
    </p>
</div>

アプリケーションを起動し







ましょう：アプリケーションの操作中に、Parameter1パラメーターを「NEW !!!」に変更します。Parameter1 ABC "およびParameter2to " NEW !!! Parameter2 ABC "の場合、次に最初のページにアクセスすると、新しいValueプロパティが表示されます。

結果

このアプローチでは、パラメータを手動で繰り返すことなく、すべての構成値を逆シリアル化できます。各httpリクエストは、AppSettingsとlientConfigの独自のインスタンスで機能し、衝突の状況を排除します。IPostConfigureOptionsは、すべてのオプションが再読み取りされたときに最後に実行されることを保証します。このソリューションの欠点は、リクエストごとにClientConfigのインスタンスが常に作成されることです。これは、次の理由で実用的ではありません。実際、ClientConfigは、構成が変更された後にのみ再作成する必要があります。

検証を伴う構成の逆シリアル化（IOptionsを使用しない）

GitHub：IPostConfigureOptionsを 使用したConfigurationTemplate_4



使用アプローチにより、クライアントから要求を受信するたびにオブジェクトClientConfigが作成されます。これは十分に合理的ではありません。各リクエストは、appsettings.json構成ファイルが変更された場合にのみ変更される初期のClientConfig状態で機能します。これを行うには、IPostConfigureOptionsを破棄し、appsettings.jsonが変更されたときにのみ呼び出される構成ハンドラーを作成します。その結果、ClientConfigは1回だけ作成され、作成済みのClientConfigインスタンスがリクエストごとに提供されます。SingletonAppSettings クラスを作成します



リクエストごとに設定のインスタンスが作成される構成（シングルトン）。SingletonAppSettings.cs



ファイル：

public class SingletonAppSettings
{
  public AppSettings appSettings;  
  private static readonly Lazy<SingletonAppSettings> lazy = new Lazy<SingletonAppSettings>(() => new SingletonAppSettings());
  private SingletonAppSettings()
    { }
  public static SingletonAppSettings Instance => lazy.Value;
}

Startup クラスに戻り、IServiceCollectionインターフェイスへの参照を追加しましょう。

構成処理方法で使用されます

public IServiceCollection Services { get; set; }

ConfigureServices（IServiceCollectionサービス）を 変更して、IServiceCollectionへの参照を渡します。Startup.cs



ファイル：

public void ConfigureServices(IServiceCollection services)
{
  Services = services;
  //  AppSettings  
  var appSettings = Configuration.GetSection("AppSettings").Get<AppSettings>();
  appSettings.ClientConfigBuild();

シングルトン構成を 作成して、サービスコレクションに追加しましょう。

SingletonAppSettings singletonAppSettings = SingletonAppSettings.Instance;
singletonAppSettings.appSettings = appSettings;
services.AddSingleton(singletonAppSettings);     

AppSettings オブジェクトをScopedとして追加しましょう。リクエストごとに、シングルトンからのコピーが作成されます。

services.AddScoped(sp => sp.GetService<SingletonAppSettings>().appSettings);

完全にConfigureServices（IServiceCollectionサービス）：

public void ConfigureServices(IServiceCollection services)
{
  Services = services;
  //  AppSettings  
  var appSettings = Configuration.GetSection("AppSettings").Get<AppSettings>();
  appSettings.ClientConfigBuild();
  SingletonAppSettings singletonAppSettings = SingletonAppSettings.Instance;
  singletonAppSettings.appSettings = appSettings;
  services.AddSingleton(singletonAppSettings);             
  services.AddScoped(sp => sp.GetService<SingletonAppSettings>().appSettings);
  //next
  services.AddControllersWithViews();
}

次に、Configure（IApplicationBuilderアプリ、IWebHostEnvironment env）に構成用のハンドラーを追加します。トークンは、appsettings.jsonファイルの変更を追跡するために使用されます。OnChangeは、ファイルが変更されたときに呼び出される関数です。OnChange（）構成ハンドラー：

ChangeToken.OnChange(() => Configuration.GetReloadToken(), onChange);

まず、appsettings.jsonファイルを読み取り、AppSettingsクラスを逆シリアル化します。次に、サービスコレクションから、AppSettingsオブジェクトを格納するシングルトンへの参照を取得し、それを新しいものに置き換えます。

private void onChange()
{                        
  var newAppSettings = Configuration.GetSection("AppSettings").Get<AppSettings>();
  newAppSettings.ClientConfigBuild();
  var serviceAppSettings = Services.BuildServiceProvider().GetService<SingletonAppSettings>();
  serviceAppSettings.appSettings = newAppSettings;
  Console.WriteLine($"AppSettings has been changed! {DateTime.Now}");
}

アプリケーションを







起動しましょう：コンソールアプリケーションとして起動モードを選択すると、アプリケーションウィンドウに、構成ファイル変更イベントのトリガーに関するメッセージが表示され







ます。新しい値：

結果

このオプションは、より優れているのIPostConfigureOptionsをので、すべてのリクエストでではなく、構成ファイルを変更した後にのみオブジェクトをビルドできます。その結果、サーバーの応答時間が短縮されます。トークンがトリガーされると、トークンの状態がリセットされます。

デフォルトの追加と構成の検証

GitHub：ConfigurationTemplate_5



前の例では、appsettings.jsonファイルがない場合、アプリケーションは例外をスローするので、構成ファイルをオプションにして、デフォルト設定を追加しましょう。テンプレートから作成されたプロジェクトアプリケーションをVisulaStudioで公開すると、appsettings.jsonファイルがすべてのバイナリと同じフォルダに配置されるため、Dockerにデプロイするときに不便です。ファイルappsettings.jsonがconfig /に移動されました：

.AddJsonFile("config/appsettings.json")

appsettings.jsonなしでアプリケーションを起動できるようにするには、optiona lパラメーターをtrueに変更します。これは、この場合、appsettings.jsonの存在がオプションであることを意味します。Startup.cs



ファイル：

public Startup(IConfiguration configuration)
{
  var builder = new ConfigurationBuilder()
     .AddJsonFile("config/appsettings.json", optional: true, reloadOnChange: true);
  configuration = builder.Build();
  Configuration = configuration;
}

追加ます。public void ConfigureServices（IServiceCollectionサービス）の構成のデシリアライゼーションラインにappsettings.jsonファイルの不在を扱う場合：

 var appSettings = Configuration.GetSection("AppSettings").Get<AppSettings>() ?? new AppSettings();

IValidatableObject インターフェイスに基づいて構成検証を追加しましょう。構成パラメーターが欠落している場合は、デフォルト値が使用されます。IValidatableObject



からAppSettingsクラスを継承し、次のメソッドを実装しましょう。

public IEnumerable<ValidationResult> Validate(ValidationContext validationContext)

AppSettings.cs ファイル：

public IEnumerable<ValidationResult> Validate(ValidationContext validationContext)
{
  List<ValidationResult> errors = new List<ValidationResult>();
  if (string.IsNullOrWhiteSpace(this.Parameter1))
    {
      errors.Add(new ValidationResult("   Parameter1.  " +
        "   DefaultParameter1 ABC"));
      this.Parameter1 = "DefaultParameter1 ABC";
    }
    if (string.IsNullOrWhiteSpace(this.Parameter2))
    {
      errors.Add(new ValidationResult("   Parameter2.  " +
        "   DefaultParameter2 ABC"));
      this.Parameter2 = "DefaultParameter2 ABC";
    }
    return errors;
}

Startup クラスStartup.cs

ファイルから呼び出される構成チェックを呼び出すメソッドを追加します。

private void ValidateAppSettings(AppSettings appSettings)
{
  var resultsValidation = new List<ValidationResult>();
  var context = new ValidationContext(appSettings);
  if (!Validator.TryValidateObject(appSettings, context, resultsValidation, true))
    {
      resultsValidation.ForEach(
        error => Console.WriteLine($" : {error.ErrorMessage}"));
      }
    }

ConfigureServices（IServiceCollectionサービス） の構成検証メソッドへの呼び出しを追加しましょう。appsettings.jsonファイルがない場合は、AppSettingsオブジェクトをデフォルト値で初期化する必要があります。Startup.cs



ファイル：

var appSettings = Configuration.GetSection("AppSettings").Get<AppSettings>() ?? new AppSettings();

パラメータを確認しています。デフォルト値を使用すると、パラメーターを示すメッセージがコンソールに表示されます。

 //Validate            
this.ValidateAppSettings(appSettings);            
appSettings.ClientConfigBuild();

onChange（） で設定チェックを変更しましょう

private void onChange()
{                        
  var newAppSettings = Configuration.GetSection("AppSettings").Get<AppSettings>() ?? new AppSettings();
  //Validate            
  this.ValidateAppSettings(newAppSettings);            
  newAppSettings.ClientConfigBuild();
  var serviceAppSettings = Services.BuildServiceProvider().GetService<SingletonAppSettings>();
  serviceAppSettings.appSettings = newAppSettings;
  Console.WriteLine($"AppSettings has been changed! {DateTime.Now}");
}

appsettings.jsonファイルからParameter1キーを削除すると、ファイルを保存した後、パラメーターがないことを示すメッセージがコンソールアプリケーションウィンドウに表示されます。

結果

config フォルダー内の構成の場所のパスを変更することは良い解決策です。 1つのヒープにすべてのファイルを混在させないようにします。configフォルダーは、構成ファイルを格納するためにのみ定義されています。構成の検証を通じて、管理者向けにアプリケーションを展開および構成するタスクを簡素化しました。構成エラーの出力をログに追加すると、誤ったパラメーターが指定された場合、管理者は問題に関する正確な情報を受け取ります。プログラマーが最近例外を書き込み始めたときではありません。「問題が発生しました。」



構成を操作するための理想的なオプションはありません。すべては目前のタスクに依存し、各オプションには長所と短所があります。



すべての構成テンプレートはここから入手できます。



文献：

1. 正しいASP.NETコア
2. METANIT-構成。構成の基本
3. シングルトンデザインパターンC＃.netコア
4. .NETコアでの構成の再ロード
5. ASP.NET CoreRC2でのファイル変更に関する厳密に型指定されたオプションの再ロード
6. IOptionsを介したASP.NETコアアプリケーションの構成
7. METANIT-IOptionsを介して構成を渡す
8. IOptionsを介したASP.NETコアアプリケーションの構成
9. METANIT-モデルの自己検証