C#、ASP.NET、TypeScript、AngularJS を中心にプログラミングに関した話題を諸々。
by @jsakamoto
検索
リンク
北海道のITコミュニティ - CLR/H 無聊を託つ
タグ
カテゴリ
最新の記事
ASP.NET Core S..
at 2017-10-30 22:29
ASP.NET Core 2..
at 2017-09-22 21:54
ASP.NET Core 1..
at 2017-09-08 23:04
Visual Studio ..
at 2017-09-08 21:42
Application In..
at 2017-08-30 23:15
最新のコメント
いえす、F#! F#! :)
by developer-adjust at 21:46
F#はAzure Not..
by 幻のK泉さん at 18:37
> 今、Setcronj..
by developer-adjust at 08:25
今、Setcronjob..
by Kibe at 03:23
Jichym 改め yi..
by yi at 23:00
バッチファイル(.bat..
by Jichym at 01:26
なるほど、そこにテコ入れ..
by developer-adjust at 21:25
キャッシュを制御するディ..
by Hallo Brother. at 13:08
おっと、これはぬかりまし..
by developer-adjust at 23:57
ClickOneのILs..
by 通りすがり at 14:13
記事ランキング
最新のトラックバック
Web API における..
from 松崎 剛 Blog
[Other]Code2..
from KatsuYuzuの日記
Developer @ ..
from .NET Clips
asp.netでrail..
from 4丁目より
F#でASP.NET M..
from ナオキにASP.NET(仮)
[B!] これはいい h..
from Twitter Mirror
[報告] Microso..
from .NET Clips
Developer @ ..
from .NET Clips
[F#]F# でブログア..
from 予定は未定Blog版
ASP.NET MVC ..
from ナオキにASP.NET(仮)
以前の記事
2017年 10月
2017年 09月
2017年 08月
2017年 07月
2017年 06月
2017年 05月
2017年 04月
2017年 02月
2017年 01月
2016年 12月
2016年 11月
2016年 10月
2016年 09月
2016年 08月
2016年 07月
2016年 06月
2016年 05月
2016年 04月
2016年 03月
2016年 02月
2016年 01月
2015年 12月
2015年 11月
2015年 10月
2015年 09月
2015年 08月
2015年 07月
2015年 05月
2015年 04月
2015年 03月
2015年 02月
2015年 01月
2014年 12月
2014年 11月
2014年 10月
2014年 09月
2014年 08月
2014年 06月
2014年 04月
2014年 03月
2014年 02月
2014年 01月
2013年 12月
2013年 10月
2013年 09月
2013年 08月
2013年 07月
2013年 06月
2013年 05月
2013年 04月
2013年 03月
2013年 02月
2013年 01月
2012年 12月
2012年 11月
2012年 10月
2012年 09月
2012年 08月
2012年 07月
2012年 06月
2012年 05月
2012年 04月
2012年 03月
2012年 02月
2012年 01月
2011年 12月
2011年 11月
2011年 10月
2011年 09月
2011年 08月
2011年 07月
2011年 06月
2011年 05月
2011年 04月
2011年 03月
2011年 02月
2011年 01月
2010年 12月
2010年 11月
2010年 10月
2010年 09月
2010年 08月
2010年 07月
2010年 06月
2010年 05月
2010年 04月
2010年 03月
2010年 02月
2010年 01月
2009年 12月
2009年 10月
2009年 09月
2009年 07月
2009年 06月
2009年 05月
2009年 04月
2009年 03月
2009年 02月
2009年 01月
2008年 12月
2008年 11月
2008年 10月
2008年 09月
2008年 08月
2008年 07月
2008年 06月
2008年 05月
2008年 04月
2008年 03月
2008年 02月
2008年 01月
2007年 12月
2007年 11月
2007年 04月
2007年 03月
2007年 02月
2007年 01月
2006年 11月
2006年 10月
2006年 09月
2006年 08月
2006年 07月
ファン
ブログジャンル
画像一覧
2016年 05月 31日

ASP.NET Core 1.0 のアプリケーション構成 (オプション) を動的に読み取る

ASP.NET Core 1.0 ではアプリケーション構成は型付けされる

ASP.NET Core 1.0 からは、アプリケーション構成(オプション)を読み取る方法が大幅に改築された。

まずはオプション値を表すクラスを記述し、そのオプション値の型にアプリケーション構成を逆シリアライズして、そうして生成されたオプション値を DI 機構を経由して受け取る、という "型付け" された形態になった。

詳しくは下記が大変参考になる。

ASP.NET Core 1.0 でオプションを柔軟に扱えるようになった話
http://blog.shibayan.jp/entry/20160529/1464456800

型がついてまわるので、文字列でアプリケーション構成のエントリ名を記述するのとは異なり、
  • インテリセンスが効くのはもちろん、
  • オプション値を参照している個所の特定や
    (同僚が書いたコード又は自分が3ヵ月前に書いたコードを保守するときは、これがとても心強い)、
  • エントリ名の変更といった仕様変更も楽勝
である。

※余談になるが、自分の場合、旧来の web.config 中の appSettings 構成セクションへのアクセスを静的型付けするために、SwissKnife.T4.AppSettings NuGet パッケージを多用してきた。


また、ASP.NET MVC コントローラクラスなどでは、DI 機構を通じてオプション値を入手するため、コントローラの単体テストの記述のしやすさに大きく貢献することだろう。

しかし実行時にエントリ名が決まることもある

このように、ASP.NET Core 1.0 から型付けを前提にアクセスすることになったアプリケーション構成(オプション)。
しかし、そうやたらとあるわけではないにせよ、まれに、実行時にエントリ名が決定されるような要件、言い換えると、文字列でエントリ名を指定してオプション値を入手しなければならないケースがある。

さきのしばやん先生のブログ記事でも触れられているが、"裏技的な感じ" はするものの、 IConfiguration を DI に追加すればこの要件に対応できると予想された。

ということで、試してみた。

IConfiguration を DI に登録してみる

DI 機構にて注入される "サービス" オブジェクトを DI 機構に登録するには、Startup クラスの ConfigureServices メソッド内でその登録処理を行う。

そこで、Startup クラスのコンストラクタにて別途 Configuration プロパティに初期化みの、IConfiguration インターフェースを備える "構成オブジェクト" を、ConfigureServices メソッド内で DI 機構に登録する。

具体的なコードは下記のとおり。
public void ConfigureServices(IServiceCollection services)
{
...
services.AddSingleton<IConfiguration>(this.Configuration);
}
以上で、ASP.NET MVC コントローラクラスなどで、コンストラクタ引数に IConfiguration 型の引数を記述しておくと、フレームワーク側にてこのコントローラクラスをインスタンス化するときに、先に DI 機構に登録されていた IConfiguration 型に対するオブジェクトが、この引数に渡される次第である。

具体的なコード例としては下記のとおり。
public class HomeController : Controller
{
private IConfiguration Config { get; }

public HomeController(IConfiguration config)
{
this.Config = config;
}

public IActionResult Index()
{
return View(this.Config["foo"]);
}
...
このコードを実行してみたところ、appsettings.json に「{"foo":"bar"}」が記述されていると、「this.Config["foo"]」は文字列 "bar" を返すことを確認できた。

このように、裏技感は否めないものの、実行時にエントリ名を示す文字列を組み立てて "動的" にアプリケーション構成を読み取ることが、DI 機構に IConfiguration オブジェクトを直接登録してしまうことで実現できた。

階層化されたオプションは?

ところで、appsettings.json が以下のように記述されていた場合、
{
"layer1":{
"layer2":{
"key1":"foo",
"key2":"bar"
}
}
}
いちばん末端の "key2" エントリの値 ( この例では "bar" ) を IConfiguration インターフェース経由で読み取るにはどうすればよいか?

先の HomeController の例でいうと、
this.Config.GetSection("layer1").GetSection("layer2")["key2"]
というコードで取得可能ではある。

しかしこれにはもっと簡易に書ける短縮構文があって、先の JSON の子要素をたどるのにコロン「:」でメンバ名を区切って記述すればそれでアクセス可能だ。

具体的には
this.Config["layer1:layer2:key2"]
で OK である。

GetValue 拡張メソッドも便利

ここまでは IConfiguration のインデクサ構文でアプリケーション構成を参照していた。

しかし参照方法としてはほかにもあり、「GetValue」という拡張メソッドも用意されている。

ここまでの例はすべて文字列としてアプリケーション構成を読み取っていたが、GetValue 拡張メソッドを使えば、
  • int や DateTime としてアプリケーション構成を読み取ってそれらの型で返してくれたり、
  • 指定した名前のエントリが実在しなかった場合の既定値を併せて指定できたり
など、便利なことも多い。

Microsoft.Extensions.Configuration 名前空間をインポート(using)すれば GetValue 拡張メソッドが使えるようになるので、いちどインテリセンスでどんなオーバーロードバージョンがあるのか眺めてみるのもよいかもしれない。

英字の大文字小文字は区別されない模様

あと、これらアプリケーション構成(オプション)機構は、そのエントリ名に関して、大文字小文字を区別しないようだ。

先の例でいえば、
this.Config["layer1:layer2:key2"]
this.Config["LAYER1:Layer2:kEY2"]
も、同じ結果を返す。

これは型付けしたオプション用クラスについても同じで、オプション用クラスのプロパティ名と、appsettings.json に記載されているプロパティ名とが、英大文字小文字が違っていてもバインドされる。

まとめ

IConfiguration オブジェクトを DI 機構に登録することで、実行時にエントリ名文字列を構築してアプリケーション構成を読み取るような要件にも対応できることが確かめられた。

一般的な用途では、基本的には型付けされたオプション機構を用いたほうが利が大きい。
とはいえ、場合・要件によってはここで紹介した技法も役に立つだろう。

以上、ご参考まで。
 
by developer-adjust | 2016-05-31 22:47 | .NET | Comments(0)