アプリの構成

[アーティクル]
06/08/2023

ヒント

このコンテンツは電子ブック、Azure の「ASP.NET Web Forms 開発者向け Blazor」からの抜粋です。これは .NET Docs から閲覧するか、オフラインで読める無料ダウンロードの PDF としても入手できます。

Web Forms にアプリ構成を読み込む主な方法は、web.config ファイルのエントリ (サーバー上または web.config によって参照される関連する構成ファイルのいずれか) を使用することです。静的な ConfigurationManager オブジェクトを使用して、アプリの設定、データリポジトリ接続文字列、アプリに追加されるその他の拡張構成プロバイダーとやりとりすることができます。一般的に、アプリ構成との対話は次のコードのようになります。

var configurationValue = ConfigurationManager.AppSettings["ConfigurationSettingName"];
var connectionString = ConfigurationManager.ConnectionStrings["MyDatabaseConnectionName"].ConnectionString;

ASP.NET Core およびサーバー側の Blazor では、アプリが Windows IIS サーバーでホストされている場合、web.config ファイルが存在する可能性があります。ただし、この構成には ConfigurationManager の対話は存在せず、他の構造化されたアプリ構成を他のソースから受け取ることができます。構成の収集方法と、web.config ファイルから構成情報にアクセスできる方法を見てみましょう。

構成元

ASP.NET Core では、アプリに使用できる多くの構成ソースがあることを認識しています。このフレームワークでは、既定でこれらの機能のうち最適なものをユーザーに提供しようとします。 ASP.NET Core によって、これらのさまざまなソースから構成を読み取り集計します。同じ構成キーについて後から読み込まれる値が、以前の値よりも優先されます。

ASP.NET Core は、クラウドに対応し、オペレーターと開発者の両方にとってアプリの構成が容易になるように設計されています。 ASP.NET Core は環境を認識し、Production または Development のどちらの環境で実行されているか認識します。環境インジケーターは、ASPNETCORE_ENVIRONMENT システム環境変数で設定されます。値が構成されていない場合、アプリは既定で Production 環境で実行されます。

アプリは環境の名前に基づいて、複数のソースから構成をトリガーおよび追加できます。既定では、構成は次のリソースから記載されている順に読み込まれます。

appsettings.json ファイル (存在する場合)
appsettings.{ENVIRONMENT_NAME}.json ファイル (存在する場合)
ディスク上のユーザーシークレットファイル (存在する場合)
環境変数
コマンドライン引数

appsettings.json 形式とアクセス

appsettings.json ファイルは、次の JSON のように構造化された値を使用して階層化できます。

{
  "section0": {
    "key0": "value",
    "key1": "value"
  },
  "section1": {
    "key0": "value",
    "key1": "value"
  }
}

上記の JSON が提供された場合、構成システムでは子の値がフラット化され、完全修飾された階層パスが参照されます。階層内の各プロパティは、コロン (:) 文字で区切られます。たとえば、構成キー section1:key0 は、section1 オブジェクトリテラルの key0 値にアクセスします。

ユーザーシークレット

ユーザーシークレットは、次のようなものです。

アプリ開発フォルダーの外部にある、開発者のワークステーション上の JSON ファイルに格納されている構成値。
Development 環境での実行時にのみ読み込まれる。
特定のアプリに関連付けられる。
.NET CLI の user-secrets コマンドを使用して管理される。

user-secrets コマンドを実行して、シークレットストレージ用にアプリを構成します。

dotnet user-secrets init

上記のコマンドによって UserSecretsId 要素がプロジェクトファイルに追加されます。要素には GUID が含まれており、これを使用してシークレットをアプリに関連付けます。その後、set コマンドを使用してシークレットを定義できます。次に例を示します。

dotnet user-secrets set "Parent:ApiKey" "12345"

上記のコマンドによって、開発者のワークステーションで値 12345 の Parent:ApiKey 構成キーが使用できるようになります。

ユーザーシークレットの作成、格納、および管理の詳細については、「ASP.NET Core の開発におけるアプリシークレットの安全な格納」を参照してください。

環境変数

アプリケーション構成に読み込まれる次の値のセットは、システムの環境変数です。システムの環境変数のすべての設定は、構成 API を使用してアクセスできるようになりました。アプリ内で読み取られるときに、階層値はフラット化され、コロン文字で区切られます。ただし、一部のオペレーティングシステムではコロン文字の環境変数名を使用できません。 ASP.NET Core では、2 つのアンダースコア (__) を持つ値をアクセス時にコロンに変換することによって、この制限に対処します。上記のユーザーシークレットセクションの Parent:ApiKey 値は、環境変数 Parent__ApiKey でオーバーライドできます。

コマンドライン引数

構成は、アプリを起動するときにコマンドライン引数として指定することもできます。設定する構成値の名前と構成する値を示すには、二重ダッシュ (--) またはスラッシュ (/) 表記を使用します。構文は次のコマンドのようになります。

dotnet run CommandLineKey1=value1 --CommandLineKey2=value2 /CommandLineKey3=value3
dotnet run --CommandLineKey1 value1 /CommandLineKey2 value2
dotnet run Parent:ApiKey=67890

web.config のリターン

アプリを IIS の Windows にデプロイした場合、web.config ファイルでは引き続き、アプリを管理するよう IIS が構成されます。既定では、IIS では ASP.NET Core モジュール (ANCM) への参照が追加されます。 ANCM は、Kestrel web サーバーの代わりにアプリをホストするネイティブ IIS モジュールです。この web.config セクションは、次の XML マークアップのようになります。

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <location path="." inheritInChildApplications="false">
    <system.webServer>
      <handlers>
        <add name="aspNetCore" path="*" verb="*" modules="AspNetCoreModuleV2" resourceType="Unspecified" />
      </handlers>
      <aspNetCore processPath=".\MyApp.exe"
                  stdoutLogEnabled="false"
                  stdoutLogFile=".\logs\stdout"
                  hostingModel="inprocess" />
    </system.webServer>
  </location>
</configuration>

アプリ固有の構成は、aspNetCore 要素内に environmentVariables 要素を入れ子にすることによって定義できます。このセクションで定義されている値は、環境変数として ASP.NET Core アプリに提示されます。この環境変数は、アプリの起動のそのセグメント中に適切に読み込まれます。

<aspNetCore processPath="dotnet"
      arguments=".\MyApp.dll"
      stdoutLogEnabled="false"
      stdoutLogFile=".\logs\stdout"
      hostingModel="inprocess">
  <environmentVariables>
    <environmentVariable name="ASPNETCORE_ENVIRONMENT" value="Development" />
    <environmentVariable name="Parent:ApiKey" value="67890" />
  </environmentVariables>
</aspNetCore>

アプリ内の構成を読み取る

ASP.NET Core では IConfiguration インターフェイスを通じてアプリ構成が提供されます。この構成インターフェイスは、Blazor コンポーネント、Blazor ページ、および構成へのアクセスを必要とするその他の ASP.NET Core マネージドクラスによって要求される必要があります。 ASP.NET Core フレームワークでは、以前構成した解決済みの構成がこのインターフェイスに自動的に設定されます。 Blazor ページまたはコンポーネントの Razor マークアップでは、次のように .razor ファイルの先頭に @inject ディレクティブを使用して IConfiguration オブジェクトを挿入できます。

@inject IConfiguration Configuration

この前のステートメントにより、IConfiguration オブジェクトは Razor テンプレートの残りの部分を通じて Configuration 変数として使用できるようになります。

個々の構成設定は、インデクサーパラメーターとして検索される構成設定の階層を指定することで、読み取ることができます。

var mySetting = Configuration["section1:key0"];

前の例の section1 の構成を取得する GetSection("section1") と同様の構文で、特定の場所のキーのコレクションを取得する GetSection メソッドを使用して、構成セクション全体を取得できます。

厳密に型指定された構成

Web Forms では、ConfigurationSection 型とそれに関連付けられている型から継承される、厳密に型指定された構成の型を作成できました。 ConfigurationSection では、これらの構成値に対していくつかのビジネスルールと処理を構成できます。

ASP.NET Core では、構成値を受け取るクラス階層を指定できます。これらのクラスは次のようなものです。

親クラスから継承する必要はありません。
キャプチャする構成構造のプロパティおよび型参照に一致する public プロパティが含まれている必要があります。

以前の appsettings.js サンプルでは、次のクラスを定義して値をキャプチャできます。

public class MyConfig
{
    public MyConfigSection section0 { get; set;}

    public MyConfigSection section1 { get; set;}
}

public class MyConfigSection
{
    public string key0 { get; set; }

    public string key1 { get; set; }
}

このクラス階層は、Startup.ConfigureServices メソッド (または、services ではなく、builder.Services プロパティを使用した Program.cs 内の適切な場所) に次の行を追加することによって設定することができます。

services.Configure<MyConfig>(Configuration);

アプリの残りの部分では、厳密に型指定された構成設定を受け取るために、クラスに入力パラメーターを追加したり、型 IOptions<MyConfig> の Razor テンプレート内に @inject ディレクティブを追加したりできます。 IOptions<MyConfig>.Value プロパティは、構成設定から設定された MyConfig 値を生成します。

@inject IOptions<MyConfig> options
@code {
    var MyConfiguration = options.Value;
    var theSetting = MyConfiguration.section1.key0;
}

Options 機能の詳細については、ASP.NET Core のオプションパターンのドキュメントを参照してください。

前へ次へ

アプリの構成

構成元

appsettings.json 形式とアクセス

ユーザーシークレット

環境変数

コマンドライン引数

web.config のリターン

アプリ内の構成を読み取る

厳密に型指定された構成

フィードバック

その他のリソース

アプリの構成

構成元

appsettings.json 形式とアクセス

ユーザー シークレット

環境変数

コマンド ライン引数

web.config のリターン

アプリ内の構成を読み取る

厳密に型指定された構成

フィードバック

その他のリソース

ユーザーシークレット

コマンドライン引数