Help us understand the problem. What is going on with this article?

ASP.NET Core MVC における構成ファイル appsettings.json からの値取得

More than 1 year has passed since last update.

以前の以下の投稿で、Visual Studio 2017 において、標準でテンプレートに追加された ASP.NET Core MVC では、構成ファイル web.config から、JSON 形式の appsettings.json に変更されたことに触れました。

この appsettings.json ですが、もちろん、今までの web.config のように、カスタムでアプリケーション固有の構成情報を定義できます。

もちろん、以下の方法を使って、カスタムの構成情報を定義した JSON 形式ファイルを作成し、逆シリアライズにより構成情報をロードする方法もありますが、今回は、ASP.NET Core MVC で用意された機構を使った方法により値を取得します。

構成ファイルのロードは、Startup.Starup メソッドで定義されています。

Startup.cs
public class Startup
{
        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();

            //構成情報をプロパティに設定
            Configuration = builder.Build();
        }

        public IConfigurationRoot Configuration { get; }

}

この時、appsettings.json を以下のように定義したとします。

appsettings.json

{
  "UserSettings": {
    "IsDemoMode": false,
    "DefaultUser": {
      "Name": "羽柴 秀長",
      "Age": 51
    }
  },
  "Logging": {
    "IncludeScopes": false,
    "LogLevel": {
      "Default": "Warning"
    }
  }
}

Starup クラス内のスコープであれば、Configuration プロパティ経由で、値を取得できます。
IConfigurationRoot.GetValue<>() メソッド、もしくは、文字列の場合は、インデクサで、構成情報にアクセスできます。

Startup.cs
public class Startup
{

        public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory)
        {
            loggerFactory.AddConsole(Configuration.GetSection("Logging"));
            loggerFactory.AddDebug();

            //各構成情報の取得
            //ブール値のロード
            bool isDemoMode = this.Configuration.GetValue<bool>("UserSettings:IsDemoMode");
            //文字列値のロードは、インデクサで指定可能
            string defaultUserName = this.Configuration["UserSettings:DefaultUser:Name"];
            //int 値のロード
            int defaultUserAge = this.Configuration.GetValue<int>("UserSettings:DefaultUser:Age");


            if (env.IsDevelopment())
            {
                app.UseDeveloperExceptionPage();
                app.UseBrowserLink();
            }
            else
            {
                app.UseExceptionHandler("/Home/Error");
            }

            app.UseStaticFiles();

            app.UseMvc(routes =>
            {
                routes.MapRoute(
                    name: "default",
                    template: "{controller=Home}/{action=Index}/{id?}");
            });
         }
}

Starup.Configuration プロパティ経由での取得方法は、MVC のコントローラー側で利用できませんので、別の方法を利用します。

まず、JSON に対応するクラスを定義します。すべての構造に対するクラスではなく、構成情報単位で定義すると良いと思います。
例) ユーザー設定、ページ設定、DB 接続設定等の単位にクラスを定義する
この理由は、最後に説明したいと思います。

UserSettings.cs
    public class UserSettings
    {
        public bool IsDemoMode { get; set; }
        public DefaultUser DefaultUser { get; set; }
    }

    public class DefaultUser
    {
        public string Name { get; set; }
        public int Age { get; set; }
    }

このように、JSON に対応したクラスの定義を行う場合、JSON 文字列をコピーし、対象のクラス ファイル上で、[編集] - [形式を選択して貼り付け] - [JSON をクラスとして貼り付ける] を選択すると、クラスの定義をペースト出来るので便利です。
image.png

Startup.ConfigureServices メソッドにおいて、構成情報を定義したクラスにバインドします。

Startup.cs
public class Startup
{
    // This method gets called by the runtime. Use this method to add services to the container.
    public void ConfigureServices(IServiceCollection services)
    {
        // Add framework services.
        services.AddMvc();

        //構成情報から、UserSettings クラスへバインド
        services.Configure<UserSettings>(this.Configuration.GetSection("UserSettings"));    
    }
}

最後に、MVC のコントローラー側での構成情報の取得の実装です。
コンストラクターを定義し、Startup.ConfigureServices においてバインドを行ったクラスをラップする IOptions インターフェースを引数とします。

HomeController.cs
public class HomeController : Controller
{
    /// <summary>
    /// ユーザー設定情報を保持
    /// </summary>
    private readonly UserSettings _userSettings = null;

    /// <summary>
    /// コンストラクターを定義し、引数に構成情報を取得するクラスを定義する。
    /// </summary>
    /// <param name="userSettings"></param>
    public HomeController(IOptions<UserSettings> userSettings)
    {
        //ユーザー設定情報インスタンスをフィールドに保持
        this._userSettings = userSettings.Value;
    }

    public IActionResult Index()
    {
        return View(this._userSettings);
    }
}

ここで、すべての設定を持つクラスを定義し、引数で渡す方法もありますが、コントローラーで必要とする情報をコードで視覚化するためにも最小限の構成情報を渡すようにすることが良いと考えています。

もちろん、複数の構成情報クラスをバインドし、コントローラーのコンストラクターの引数で複数の構成情報クラスを取得することもできます。

単にコード量を減らすことが可読性をあげることではなく、意味読みできるコードこそ可読性が高いといえると考えています。

サンプル コードは、以下より参照ください。
https://github.com/Hiromasa-Masuda/dotnetcoreSample/tree/master/ConfigurationSample

Why not register and get more from Qiita?
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away
Comments
No comments
Sign up for free and join this conversation.
If you already have a Qiita account
Why do not you register as a user and use Qiita more conveniently?
You need to log in to use this function. Qiita can be used more conveniently after logging in.
You seem to be reading articles frequently this month. Qiita can be used more conveniently after logging in.
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away
ユーザーは見つかりませんでした