開発時と本番環境とで Windows Azure Storage サービスの接続文字列を切り替える

Azure ストレージサービスとストレージエミュレータ

Windows Azure が提供する、NoSQL な Key-Value ストアやバイナリファイル、メッセージキューを保管する Storage サービス。

この Windows Azure Storage サービスを利用した ASP.NET Web アプリを開発する際は、手元のPCのローカル開発環境上に「Windows Azure Storage Emulator」を予めインストールしておき、このローカルのエミュレータを利用して開発を行うことが多いと思う。

そして本番環境に設置する際には、本物の Azure Storage サービスに接続するように設定すればよいように、アプリを作りこめばよかろう。

ローカルのストレージエミュレータに接続するには?

Azure Storage サービスに接続するには、Storage Account の Name と Key を引数に資格情報を構築し、Storage Account オブジェクトを生成して、そこから Table や Bolb、Queu といったストレージにアクセスすることになる。

var appSettings = ConfigurationManager.AppSettings;

var credentials = new StorageCredentials(

      appSettings["accountName"],

      appSettings["accountKey"]);

var storageAccount = new CloudStorageAccount(credentials, 

            useHttps: true);

var tableClient = storageAccount.CreateCloudTableClient();

※ConfigurationManager.AppSettingsを使ったキー情報へのアクセスについては以前の投稿を参照。

さてところで、先に述べたようにローカルの Storage Emulator を使った開発作業を進めるにあたり、アプリからその Storage Emulator に接続するにはどうしたらよいか。

DevelopmentStorageAccount? でも酷くない?

インターネット上の情報を検索したり、某書籍を参照すると、以下のように CloudStorageAccount クラスが提供する DevelopmentStorageAccount 静的プロパティとして公開されている Storage Account を使うとよい、という情報がキャッチされる。

var storageAccount = CloudStorageAccount.DevelopmentStorageAccount;

var tableClient = storageAccount.CreateCloudTableClient();

だがちょっと待ってほしい。


上記のコード例を見て一目瞭然なように、開発用に Storage Emurator に接続するコードと、本物の Storage サービスに接続するコードとが、まるっきり違っている。

開発時と本番環境へのリリース時とで、ソースコードの切替をしろということなのだろうか?

たしかにプリプロセッサを使えばできなくはないが...。

#if DEBUG

var storageAccount = CloudStorageAccount.DevelopmentStorageAccount;

#else

var appSettings = ConfigurationManager.AppSettings;

var credentials = new StorageCredentials(

      appSettings["accountName"],

      appSettings["accountKey"]);

var storageAccount = new CloudStorageAccount(credentials,

            useHttps: true);

#endif

var tableClient = storageAccount.CreateCloudTableClient();

あるいはまた、appSettings 構成に設定があるかないかで if 文で分岐することもできる。

var storageAccount = default(CloudStorageAccount);

var appSettings = ConfigurationManager.AppSettings;

if (appSettings["accountName"] == null) {

    storageAccount = CloudStorageAccount.DevelopmentStorageAccount;

} else {

    var credentials = new StorageCredentials(

      appSettings["accountName"],

      appSettings["accountKey"]);

    storageAccount = new CloudStorageAccount(credentials,

            useHttps: true);

}

var tableClient = storageAccount.CreateCloudTableClient();

それにしてもちょっと
不恰好
で、しかも、
やりたいことに対してコード量が多過ぎ
ではないか?

接続文字列を使おう!

実はもっと格段にスマートな実装方法がある。

Azure Storage サービスの Storage Account を生成するにあたり、
「接続文字列」を使う
というものだ。

論より証拠。

まずはコードはこんな感じ。

var appSettings = ConfigurationManager.AppSettings;

var storageAccount = CloudStorageAccount.Parse(

        appSettings["storageAccount"]);

var tableClient = storageAccount.CreateCloudTableClient();

今まで掲載してきたサンプルコードのどれよりも、いちばんシンプルだ。

そして、web.config の appSettings セクションに、こんな感じで「接続文字列」でどの Azure Storage に接続するのかを指定するのだ。

<appSettings>

  <add

    key="StorageAccount"

    value="DefaultEndpointsProtocol=https;AccountName=*;AccountKey=*" />

</appSettings>

さらに、Storage Emurator につなぐときは、この「接続文字列」を以下のように "UseDevelopmentStorage=true"
に書き換えるだけ!

<appSettings>

  <add key="StorageAccount"

    value="UseDevelopmentStorage=true" />

</appSettings>

これだけである。

バージョン管理には、上記後者の value="UseDevelopmentStorage=true" で記載した web.config で登録しておくといいだろう。

Azure Websites や AppHarbor などの PaaS に本番リリースする際は、その PaaS の管理 Web コンソールから本番用のストレージアカウントをアプリケーション構成に設定すればよい。

PaaS ではない自社サーバーや各種レンタルサーバー系などに配置する際は、web.config - appSettings セクションの file 属性の機能を使って、外部ファイルにストレージアカウント情報を記述するか、構成情報の変換機能を使ってもよいかもしれない。

まとめ

• Windows Azure ストレージサービスに接続する資格情報は「接続文字列」形式で持ち歩く
• 保存先は web.config - appSettings セクションが自分としてはお勧め
• その接続文字列を CloudStorageAccount.Parse() に渡せば、Storage Account オブジェクトが手に入り、Azure ストレージにアクセスできるようになる
• ローカル開発環境のストレージエミュレータに接続したい場合は、接続文字列として "UseDevelopmentStorage=true" を指定すればOK!

自分がであったサンプルコードでは、といってもたかだか数本だけれども、とにかく、どういうわけかどのサンプルコードも CloudStorageAccount.DevelopmentStorageAccount を使っていた。

何か理由があるのかもしれないが、自分にはわからなかった。

そして、ローカルのストレージエミュレータに接続するための接続文字列の形式をネットで検索しても、自分の検索キーワードがよろしくないのか、なかなかこれといった情報にヒットしなかった。

あちこちさまよって、ようやく stackoverflow.com で答えを探し当てた記憶がある。

ということで、自分でも忘れないようにメモがてらの投稿。