ASP.NET Core/設定ファイルのバックアップ(No.8)

設定ファイル †

appsettings.json †

{
  "UserSettings": {
    "IsDemoMode": false,
    "DefaultUser": {
      "Name": "山田 太郎",
      "Age": 33
    }
  },
  "Logging": {
    "IncludeScopes": false,
    "LogLevel": {
      "Default": "Warning"
    }
  }
}

↑

設定の参照 †

↑

Startup.cs †

Starup クラス内のスコープであれば、Configuration プロパティ経由で、値を取得できる

public Startup(IConfiguration configuration)
{
    Console.WriteLine(configuration.GetValue<string>("UserSettings:IsDemoMode"));
    Console.WriteLine(configuration.GetValue<string>("UserSettings:DefaultUser:Name"));

    Configuration = configuration;
}

↑

Controller †

アプリケーション構成情報（appsettings.json）を読み取る方法

↑

appsettings.jsonの例 †

{
    "UserName": "ユーザー名",
    "Password": "パスワード",
    "App":{
        "Window":{
            "Width": 800,
            "Height": 600
        }
    }
}

↑

GetValue?() で取得 †

public class HomeController : Controller 
{
    private readonly Configuration _configuration;
 
    public HomeController(IConfiguration configuration)
    {
        _configuration = configuration;
    }
 
    public IActionResult Index()
    {
        var userName = _configuration.GetValue<string>("UserName");  // ユーザー名
        var password = _configuration.GetValue<string>("Password");  // パスワード
        return View();
    }
}

↑

クラスにバインドして取得 †

↑

staticの共通メソッドから呼び出したい場合 †

staticメソッドを持つクラスを用意

public class AppSettings
{
    public static IConfiguration Configuration { get; set; }
 
    public static string UserName { get { return Configuration.GetValue<string>("UserName"); } }
    public static string Password { get { return Configuration.GetValue<string>("Password"); } }
}

Startup.cs

public class Startup
{
    public Startup(IConfiguration configuration)
    {
        Configuration = configuration;
        AppSettings.Configuration = configuration;      // 追加
    }
}

コントローラで取得

public class HomeController : Controller
{
    public IActionResult Index()
    {
        var userName = AppSettings.UserName;    // ユーザー名
        var password = AppSettings.Password;    // パスワード
        return View();
    }
}

↑

Controller以外 †

IOptionsをコンストラクタの引数で取る

ASP.NET Core/設定ファイル のバックアップ(No.8)

設定ファイル †

appsettings.json †

設定の参照 †

Startup.cs †

Controller †

appsettings.jsonの例 †

GetValue?() で取得 †

クラスにバインドして取得 †

staticの共通メソッドから呼び出したい場合 †

Controller以外 †

ASP.NET Core/設定ファイルのバックアップ(No.8)