Heroku に配置できる C#+ASP.NET Web アプリを開発する

はじめにお断り

はじめにお断りしておくが、本投稿は既にレガシーな、すでに枯れた技術の内容となりつつあるので、そのつもりでお付き合いいただきたい。

また、本投稿はタイトルのとおり、Web アプリの PaaS である Heroku 上に、C# による ASP.NET Web アプリを稼働させる話題だが、C# + ASP.NET を稼働させる PaaS としては、Microsoft Azure Webapps や AppHabor がある。
実のところ、こと C# + ASP.NET に限っては、Heroku よりもこれらの PaaS 上に配置するほうが優っていると思う。
なので、本投稿は誰得感満載な感じなのだが、ご容赦の程。

あと、本投稿では、開発環境は Windows OS + Visual Studio を前提としている。

"Heroku" とは

"Heroku"(へろく) とは、Web アプリを稼働させる用の PaaS のひとつ。

Heroku
https://www.heroku.com/

配置方法にはソース管理の git を用いる。
ローカルの git リポジトリにコミットしてある手元のソースコード一式を、Heroku 上に開設した個々の Web アプリごとに用意されているリモートの git リポジトリに push することで、Heroku上でのビルドと配置が行われる。

Heroku は、サービス開始当初は Ruby on Rails な Web アプリをホストするところから始まったそうだ。
今は Java、Node.js、Scala、Clojure、Python、PHPといった各種プログラミング言語をサポートしている。
そして、公式サポート外(※)ではあるが、C# による ASP.NET な Web アプリも配置可能となっている。

なお、Heroku は Debian 系列の Linux OS ディストリビューション上で Web アプリを稼働させる模様。
なので、C# + ASP.NET が動くといっても、Windows OS 上で動くのではなく、Linux 上の Mono の上で動くことになる。

※公式サポート言語一覧には掲載されておらず、後述のとおりカスタムのビルドパックを使う。

Heroku で ASP.NET

さて、ネット上を「heroku c#」などのキーワードで検索すると、Heroku 上で ASP.NET Web アプリを稼働させるにはどうしたらよいかを解説してくれている記事が、結構な件数が見つかる。

いずれの記事も要点としては、下記のような感じである。

• Mono 用のビルドパックを使用するよう Heroku のアプリ設定を構成しておく (これで mono ランタイムが導入され、git push した Visual Studio プロジェクトがビルドされるようになる )
• OWIN Self Hosting なコンソールアプリとして ASP.NET Web アプリを作り上げる
• 上記で作成したコンソールアプリを起動してリッスンするよう、Heroku への指示ファイル「Procfile」中に記述する

OWIN Self Hosting で Web サーバープロセスを作るべし、ということなので、ASP.NET MVC は使えないところに注意。
ASP.NET Web API 並びに SignalR はすでに OWIN ベースに移行しているので問題ない。
サーバー側での HTML レンダリングが必要であれば、ASP.NET MVC の代わりに Nancy を使うとよいだろう。
Nancy では Razor ビューエンジンも使える。

あと、現時点で自分が試した範囲では、残念ながら C# 6.0 は使えなかった。
ビルド済みのバイナリを Upload するのではなく、Heroku 上の Mono 環境でビルドされるので、その環境下では C# 6.0 の機能・構文は使えなかったということである。

なお Mono 用のビルドパックには、xsp Web サーバーも含まれているように見えたので、OWIN ベースの セルフホスト ASP.NET Web アプリに仕立てる必要があるのか疑問が残るのだが (xsp サーバーなら ASP.NET MVC も動作する)、この点は深追いしていない。

動くことには動くんだけど、開発が...

さてこのように先達の記事に倣って作り上げれば、たしかに Heroku 上で C# + ASP.NET な Web アプリが稼働する。

とはいえ、どうにも開発時の面倒くささというか、プロジェクト構造のいびつさというか、そういうものを感じてしまう。

先のネットの検索結果で見つかった記事では、まず、ASP.NET Web アプリプロジェクトとは別に、OWIN Self Hosting コンソールアプリのプロジェクトをもうひとつ作成している。
これらプロジェクトを同一ソリューション配下に置き、コンソールアプリのプロジェクトが Web アプリのプロジェクトを参照設定するわけだ。

もう既にこの時点で、"普通の" ASP.NET プロジェクトではなくなっている気がする。

なお、定型とはいえ、毎度 OWIN Self Hosting コンソールアプリを個別に作るのもどうかと思い、汎用の OwinHost NuGet パッケージの導入も試してみた。
しかし Heroku 上でのビルド/発行の振る舞いが、 ASP.NET プログラマが "普通" と感じるであろうものとは少々かけ離れていることから、 HTTP 500 Server Error となってしまった。

さらに、Heroku 上でのビルド/発行の仕様・振る舞いに対応するために、.html やら .js、.css といった静的コンテンツの「出力フォルダにコピー」を有効にする必要もある。
"普通の" ASP.NET プロジェクトではこんなことはしないだろう。

このように、ASP.NET Web アプリを Heroku 上で稼働させようとすると、Azure
Web Apps や AppHaobor といった PaaS、あるいは Windows Server OS 上で稼働させる場合と比べ、プロジェクトの構造がずいぶんと違ってくる。

すなわち、
"Heroku に配置" するためだけに、追加の手順・手間やノウハウが必要
となってしまっている。

これはどうにも気持ち悪い。

ということで、作っちゃったよ!

...以上の現状を打破すべく、諸事情あって「ASP.NET を Heroku 上で稼働させる用の汎用の OWIN Self Hosting コンソールアプリ」を結局作ることになった。

「Owin Host for Heroku」
という NuGet パッケージである。

この NuGet パッケージを使うと、以下のような手順になる。

• まずは普通に OWIN ベースな ASP.NET Web アプリを作り上げる (但し、Roslyn系の NuGet パッケージは削除し、C# 6 構文も使用しないこと)。
• 次にその Web アプリプロジェクトにて「PM> INstall-Package OwinHostForHeroku」などとして、「Owin Host for Heroku」NuGet パッケージを追加する。
• 「Owin Host for Heroku」NuGet パッケージ追加に伴い、ソリューションフォルダに Procfile も作成されるので、これも含めて変更を git commit。
• このローカルリポジトリを、(Mono用ビルドパック導入済の) Heroku アプリ上のリモートリポジトリに git push。

以上である。

追加のコンソールアプリプロジェクトを作成する必要もない。

静的コンテンツを出力フォルダにコピーする必要もない。

いつもどおりのプロジェクト形式で Visual Studio で F5 押下で IIS Express 上で実行&デバッグできる。

実装が Mono 上での OWIN Self Hosting 環境において互換性が保たれていれば、

"Owin Host for Heroku" NuGet パッケージを追加するだけ

で Heroku 上に配置できるのだ。

さらには、Heroku 上で稼働させるための固有の構造・処置が (OwinHostForHeroku の導入を除き) ないため、同じソースコード一式が Azure Web Apps や AppHarbor にもそのまま git push して配置・稼働させられる。

より詳細・具体的な手順については、"Owin Host for Heroku" のソースコード一式を収録している GitHub リポジトリの README を参照されたし。

Owin Host for Heroku - README
https://github.com/jsakamoto/OwinHostForHeroku#owin-host-for-heroku

また、Heroku・Azure Web Apps・AppHarbor のいずれにも git push 配置可能な ASP.NET Web アプリの実例として、GitHub で公開している「ちょまど問題 Web API サーバー」に "Owin Host for Heroku" を追加してみた。

ちょまど問題 Web API サーバー
https://github.com/jsakamoto/chomado-problem-server

上記 README には、「Deploy to Azure」ボタン、「Deploy to Heroku」ボタンの双方を掲載しており、いずれの PaaS にもマウスクリックで配置可能にしてある。

Owin Host for Heroku は何をしているか

Heroku 上に git push された Visual Studio プロジェクトは、Heroku 上でビルドされたのち、以下のようにファイル構造が構築され実行されるようだ。

まず、「/app」フォルダに、

• ソリューションフォルダ (というか、git リポジトリに登録されているソースのルートフォルダ) 直下の内容 (これに Procfile が含まれる) と、
• ビルドの結果、出力フォルダ (プロジェクトフォルダ直下の bin フォルダ) に生成されるファイル

が配置されるらしい。

そして「/app」フォルダをカレントフォルダとして、Procfile の「web: ～」で指定されているコマンドが実行される。

静的コンテンツや web.config が、(一般的な ASP.NET Web アプリプロジェクトの構成だと) Heroku上では /app フォルダには配置されないことに注意。
では静的コンテンツや web.config はどこに行ったのかというと、/app/_PublishedWebsites/{プロジェクト名} フォルダに "発行" されていた。

つまり、Heroku 上での /app/_PublishedWebsites/{プロジェクト名} フォルダが、一般的な ASP.NET プログラマにとっての「~/」にふさわしい内容となっている。

ところが先述のとおり、ホストプロセスは /app フォルダ上で起動される。

すなわち AppDomain.BaseDirectory が /app に、言い換えるとアプリ相対パス「~/」が物理パス「/app」にマッピングされた状態で稼働するため、"普通の" ASP.NET Web アプリプロジェクトはいろいろ破綻するわけである。

で、Owin Host for Hroku も例外ではなく、「/app」フォルダを AppDomain.BaseDirectory として起動せざるを得ない。

しかし Owin Host for Hroku は、Heroku 上での稼働を目的とした "特注品" である。

そこで Owin Host for Hroku の実装では、起動したら「/app/_PublishedWebsites/{プロジェクト名}」フォルダを探索するようにした。
もし発見できたら「/app/_PublishedWebsites/{プロジェクト名}」フォルダを BaseDirectory とした AppDomain を新たにもうひとつ作成して、その新規 AppDomain で Web サーバー機能を稼働させるようにしたのだ。

これで、アプリ相対パス「~/」が物理パス「/app/_PublishedWebsites/{プロジェクト名}」にマッピングされた状態で、ASP.NET Web アプリの AppDomain が開始する。
こうして "普通" の構造の ASP.NET Web アプリプロジェクトが、期待どおり・想定内の環境で動作するようにできた。

なお、Heroku 上での ASP.NET の稼働に関して、ビルドパックも用意されているし、わざわざちゃんと "発行" 処理も走っているようなのに、なぜ今日に至るまで「Owin Host for Heroku」のような仕組みがなかったのか、理由かはわからない...。
(Visual Studio ではない開発環境、Mono Devlop とかで作ったプロジェクトだと、不都合ないとか?)

まとめと補足

このように、Owin Host for Heroku を Install-Package するだけで、一般的な ASP.NET Web アプリの構成・構造や開発スタイルはそのままに、Heroku 上への git push 配置と稼働が可能となる。

なお、冒頭でも述べたとおり、Azure Web Apps や AppHarbor など、公式に ASP.NET に対応している PaaS があるのに、"わざわざ" Heroku を配置・稼働先に選定するシナリオは少々思い描きにくい。
※と言いつつ、"Owin Host for Heroku" NuGet パッケージのダウンロード数が伸びつつあるのが気になる...

「Heroku アカウントは持ってるけど、他の PaaS に手を出してる余裕ないなぁ」というレアケースには、Owin Host for Heroku によって Heroku 上でも C# + ASP.NET な Web アプリを載せることができるので、お役に立てば幸いである。

なお今となっては、OWIN ベースの ASP.NET Web アプリは既にレガシー化が始まってる。
本投稿時点で、次世代である ASP.NET5 および CoreFX は RC1 (リリース候補) に至り、すでに Go Live ライセンスで、本番環境用のアプリ開発に使用してよい状況となっている。

参考: ASP.NET 5はどうしてOWIN上に乗らなかったのか - xin9le.net
http://blog.xin9le.net/entry/2015/01/18/161631

今後は、Linux や MacOS などマルチプラットフォームな ASP.NET Web アプリの開発・配置・稼働は、本投稿のような Mono + OWIN Self Hosting ではなく、CoreFX + ASP.NET 5 が本命だとは思う。

ということで、どうしても Heroku で ASP.NET というテーマをやるんだったら
「Owin Host for Heroku」なんて作ってないで、ASP.NET5 対応のビルドパックのほうを作るべきでしたね? :P

[2015-12-08 追記]
Heroku のサポートから教えてもらいましたが、なんと、Heroku 公式の GitHub リポジトリにて、ASP.NET 5 の Buildpack が公開されているそうです。

ASP.NET 5 Buildpack
https://elements.heroku.com/buildpacks/heroku/dotnet-buildpack

なお現時点ではまだ自分は試していません。