【Blazor】 appsettings.jsonの使い方

appsettings.jsonは、アプリケーションの設定情報ファイルです。 Blazor Serverプロジェクトでは、プロジェクト作成時から、デフォルトで存在しています。

WebAssemblyでは、セキュリティ的なリスクがあるため、デフォルトでは存在していません。 具体的な理由としては、wwwrootへ appsettings.json を配置しなければならないため、ブラウザの開発ツール等から 中身が見えてしまうことが考えられます。

DBの接続文字列等を appsettings.json 記載してしまうと、インシデントになるため、そういったリスクを抑えるためにも 扱いには気を付ける必要があります。

appsettings.jsonのファイルを以下のようなコードに変更します。

{
  "Setting": {
    "Setting1": "Value1（appsettings.json）",
    "Setting2": "Value2（appsettings.json）",
    "Setting3": "Value3（appsettings.json）"
  }
}

続いて、appsettings.jsonのSettingの構造に対応したクラスを作成します。

namespace Blazor_GetAppSettingsJson.Entities
{
    public class Setting
    {
        public string Setting1 { get; set; }
        public string Setting2 { get; set; }
        public string Setting3 { get; set; }
    }

}

Blazorにはプロパティやクラス名をappsettings.jsonの値と揃えることで、値が自動的にマッピングされる仕組みが備わっています。 名称が不一致にならないように、注意してください。

最後に、Program.csに appsettings.jsonの値をページから参照できるようにサービス登録を行います。

using Blazor_GetAppSettingsJson.Data;
using Blazor_GetAppSettingsJson.Entities;

var builder = WebApplication.CreateBuilder(args);

// Add services to the container.
builder.Services.AddRazorPages();
builder.Services.AddServerSideBlazor();
builder.Services.AddSingleton<WeatherForecastService>();

// ↓↓↓　【ここにコードを追加】　　　　　　　　　　　　　　　　　　　　　　　　　↓↓↓
// ↓↓↓　appsettings.jsonからSettingの構造を読み込み、Settingクラスにマッピング　↓↓↓
builder.Services.Configure<Setting>(builder.Configuration.GetSection("Setting"));

var app = builder.Build();

// Configure the HTTP request pipeline.
if (!app.Environment.IsDevelopment())
{
    app.UseExceptionHandler("/Error");
    // The default HSTS value is 30 days. You may want to change this for production scenarios, see https://aka.ms/aspnetcore-hsts.
    app.UseHsts();
}

app.UseHttpsRedirection();

app.UseStaticFiles();

app.UseRouting();

app.MapBlazorHub();
app.MapFallbackToPage("/_Host");

app.Run();

13行目に、builder.Services.Configure＜Setting＞(builder.Configuration.GetSection("Setting"))"を新規で追加しています。 builder.Configuration.GetSection("Setting")でappsettings.jsonのSettingを取得し、 それをSettingクラスに、反映してします。

動作確認を行うために、Settings.razorページを作成し、appsettings.jsonの値を表示します。 コードは以下のようになります。

@page "/settings"
@using Blazor_GetAppSettingsJson.Entities
@using Microsoft.Extensions.Options
@inject IOptions<Setting> Options

<h3>appsettings.jsonの設定値取得</h3>
<p>Setting1: @Options.Value.Setting1</p>
<p>Setting2: @Options.Value.Setting2</p>
<p>Setting3: @Options.Value.Setting3</p>

Program.csで登録したサービスの値は、IOptionインターフェース経由で取得することができます。 実際に実行すると、以下のような画面になります。

appsettings.jsonには、開発環境や運用環境で使い分けることができる仕組みが用意されています。

Blazorでは、appsettings.Development.jsonやappsettings.Production.jsonといった 命名規則に沿ったファイルを作成することで、自動的に使い分けを行うようになっています。

開発環境の場合

開発環境用の設定ファイルを使用したい場合は、appsettings.Development.jsonを用意します。

appsettings.Development.jsonは、初期状態で作成されています。 エディタ上では、appsettings.jsonに内包されているような状態になっています。

appsettings.XXXXXXX.jsonという命名規則でファイルを作成すると、このような状態になります。

appsettings.XXXXXXX.jsonは、appsettings.jsonに同じデータが存在している場合、その項目を上書きします。 これは、appsettings.XXXXXXX.jsonの方が優先順位が高いためです。 例えば、appsettings.Development.jsonが以下のような構造だったとします。

{
  "Setting": {
    "Setting2": "Value2（appsettings.Development.json）"
  }
}

前回のセクションで解説したappsettings.jsonと比較してみると、SettingのSetting2が重複しています。 そのため、実行すると、以下のようになります。

Setting2の値だけ、appsettings.jsonの値が上書きされていることが確認できると思います。

デバッグするときにに、appsettings.Development.jsonが使用される理由は、デバッグの環境変数で設定されているためです。 環境変数の確認するには、まず[プロジェクト]→[(プロジェクト名)のプロパティ]を開きます。

[デバッグ]の[全般]の[デバッグ起動プロファイルUIを開く]を選択します。

[デバッグ起動プロファイルUIを開く]を選択すると、以下のような画面が表示されます。

[環境変数]にデフォルトでは、ASPNETCORE_ENVIRONMENT=DEVELOPMENTと書かれていると思います。 このDEVELOPMENTの部分が、appsettings.XXXXXXX.jsonのXXXXXXXの部分に該当します。

デバッグで使用されるappsettings.XXXXXXX.jsonを変更したい場合は、この環境変数を修正してください。

運用・本番環境の場合

運用（本番）環境の場合、appsettings.Production.jsonを用意します。 この命名規則で設定ファイルを作成すると、デプロイしたアプリケーションはこちらの設定ファイルを優先されるようになります。

appsettings.Production.jsonの動きを検証するために、 以下のようなデータ構造で作成します。

{
  "Setting": {
    "Setting3": "Value3（appsettings.Production.json）"
  }
}

SettingのSetting3がappsettings.jsonのデータと重複しているので、 デプロイ後のアプリケーションを実行すると以下のようになります。

Setting3の値だけ、appsettings.jsonの値が上書きされていることが確認できると思います。 運用・本番環境のみに設定したい項目は、appsettings.Production.jsonを利用するようにしてください。

今回は、appsettings.jsonの使い方について解説しました。 環境によって、データベースの接続先を変えたい場合などに、活用できると思います。

是非用途に合わせて、使ってみてください。