ASP.NET Web API コントローラにてバイナリコンテンツを返す方法

表題の件、毎回やり方を忘れてはネット検索しているので、自分用にメモ。

なお、ASP.NET Core ではなく、従来からの ASP.NET における話題。

まずは結論から

ASP.NET Web API コントローラにてバイナリコンテンツを返すには、API コントローラのアクションメソッドについて、以下のようなコードを書けばよい。

• アクションメソッドの戻り値は HttpResponseMessage 型とする。
  
• 返したいバイナリコンテンツを ByteArrayContent でラップする。
  
• さらに、適宜、コンテンツタイプを ByteArrayContent オブジェクトに設定する。
  
• Request オブジェクトの CreateResponse メソッドで、応答オブジェクトを作る。
  
• この応答オブジェクトに、返したいコンテンツをラップした ByteArrayContent オブジェクトを設定する。
  
• こうして作成した応答オブジェクトを、アクションメソッドの戻り値として返す。
  

public class FooController : System.Web.ApiController

{

// HTTP GET /api/Foo

public HttpResponseMessage Get()

{

...

var bytes = new byte[] { /* バイナリコンテンツのバイト列 */ };

var content = new ByteArrayContent(bytes);

content.Headers.ContentType =
MediaTypeHeaderValue.Parse("application/octet-stream");

var res = this.Request.CreateResponse();

res.Content = content;

return res;

}

}

うまくいかない例

ちなみに下記コードでは期待した動作とならない。

public class FooController : System.Web.ApiController

{

// HTTP GET /api/Foo

public byte[] Get()

{

...

var bytes = new byte[] { /* バイナリコンテンツのバイト列 */ };

return bytes;

}

}

上記コードだと、返したいバイナリコンテンツのバイト列が、JSON (ないしは XML) 形式で返されてしまうからである。

もちろん、たいていの場合、ASP.NET Web API コントローラの仕組みとしては、任意の型の戻り値が JSON (or XML) で返却されるのはうれしい仕様である。

しかし、今回のようにバイナリコンテンツを返したい場合には融通が利かず、先に書いたとおりの実装を記述しなければならないようだ。

もっとうまい方法がありますか？

それにしても、たかだかバイナリコンテンツを返すだけなのに記述量がちょっと多い気がする。

もしかしてもっとスマートに実装できるのだろうか?

個人的には下記の妄想例のように、アクションメソッドに属性指定することで、バイナリコンテンツを返すことができたらいいのにな、とか思ってしまった。

public class FooController : System.Web.ApiController

{

// HTTP GET /api/Foo

// ※こんな属性や仕組みはないのだけれど、

// 　こんな風に書けたらいいな！という妄想

// 　(まさか、もしかして既にあったりする?)

[ByteArrayContent("application/octet-stream")]

public byte[] Get()

{

...

var bytes = new byte[] { /* バイナリコンテンツのバイト列 */ };

return bytes;

}

}

そもそも API コントローラでバイナリコンテンツを返す？

ところで、そもそも API コントローラでバイナリコンテンツを返す需要があるのか、はたまた、API コントローラからはバイナリコンテンツを返すべきではないのでは、といった議論もあろうかと思う。

まず需要についてだが、昨今の SPA (Single Page Application) 実装におけるクライアント側からサーバー側 API の呼び出しにおいて「チケットの QR コード画像を動的生成して返したい」であるとか、「現在ログインユーザーのプロフィール画像を返したい」など需要はあるように思う。

MVC コントローラから返すなら容易だけれども...

そうしたときに、ASP.NET MVC コントローラであれば、File 拡張メソッドで容易にバイナリコンテンツを返すことができる。

よって、Web API コントローラでの実装にこだわらずに、MVC コントローラで実装すればいいのかもしれない。

しかし昨今の SPA 実装だと、サーバー側実装は MVC コントローラは無くて、Web API コントローラだけ、ということも多い。

そんな背景下、バイナリコンテンツを返すためだけに MVC コントローラを追加実装するのもどうかと思う次第。

CDN とか使うのでは?

また、それなりのアクセス数・負荷が見込まれるような Web アプリ・サイトの場合、そのようなバイナリコンテンツはこれらコントローラ類で処理していると性能が追い付かないであろう。

このようなケースでは、CDN にそのようなバイナリコンテンツを配信しておいて処理を移譲する、といったような策を打つべきだろう。

とはいえ、中小社内向けや B2B でユーザー数が限定されているよううな場合は、CDN をはじめあまり連携サービスを増やさずに Web アプリ本体だけで完結していることも、サーバーへの配置などの取り扱いが簡潔になるので、それはそれで価値があると思う。

2017年7月10日 追記

ASP.NET Core ならもっと簡単だった。詳しくはこちら。