解決:RoleManagerModuleが原因の"HTTPヘッダーが送出された後にサーバーでCookieを変更することは..."例外

ASP.NET の RoleManagerModule が原因で "HTTP ヘッダーが送出された後にサーバーで Cookie を変更することはできません。" という例外が発生するケースがあることを、過去に投稿した。
http://devadjust.exblog.jp/3996026/

その後ここ最近に至るまで、上記記事にあるとおり、Response の Flush をしないことで回避できていた。
しかし、最近、巨大なコンテンツを返す ASP.NET ページをどうしても作成せざるを得ない状況に陥り、明示的な Flush 呼び出しの有無にかかわらずバッファがいっぱいになってブラウザへの返信が始まってしまうためであろう、再び "HTTP ヘッダーが送出された後にサーバーで Cookie を..." 例外と相見えることとなった。

そこで根本的治療を試みることにした。

もちろん、web.config の構成でロール情報を Cookie にキャッシュする設定を無効にすることでもよいのだが、そもそもの原因は RoleManagerModule が Cookie への書き込みを行うタイミングが遅すぎるからである。

そこで、RoleManagerModule を自作のクラスで置き換えることを考えてみた。

RoleManagerModule は IHttpModule インターフェースを備えたクラスに過ぎず、マシン既定の web.config で <httpModules> セクションにあらかじめ登録されているだけである。従って、各 Web アプリの web.config にて <httpModules> セクションを記述することで、独自実装のロールマネージャモジュールに差し替えることは容易である。

<system.web>
　<httpModules>
　　<remove name="RoleManager"/>
　　<add name="RoleManager" type="(ネームスペース含めた)クラス名, アセンブリ名(拡張子.dll不要)"/>
　</httpModules>
</system.web>

さて、ロールマネージャモジュールの独自実装であるが、RoleManagerModule という実装が存在する以上、本当にスクラッチでゼロから作る必要はないはずだ。

まず、Reflector for .NET(註1) を使ってざっくりと RoleManagerModule を調査してみた。
わかったことは、RoleManagerModule には OnEnter と OnLeave というプライベートメソッドがあり、各々、IHttpModule.Init 呼び出しのタイミングで HttpApplication の PostAuthenticateRequest イベント と EndRequest イベントのハンドラとして登録されることだ。
問題の Cookie 書き込みを行っている処理は EndRequest イベントのハンドラである OnLeave メソッド内であろう。

つまり、問題は、RoleManagerModule.OnLeave メソッドが、すでにブラウザへの返信が始まっている後かもしれない、HttpApplication.EndRequest イベントのタイミングで呼び出されていることだ。ハンドルするイベントを、HttpApplication.EndRequest イベントではなく、（ブラウザへ HTTP ヘッダを送信する直前の）HttpApplication.PreSendRequestHeaders イベントとすれば問題は解消されるはずである。

それではということで、RoleManagerModule の派生クラスを自作し、その自作派生クラスの IHttpModule.Init を組み替えてハンドルするイベントを変えてやれば一件落着、と考えた。
ところがどっこい、RoleManagerModule はなんと sealed されていて派生できないのである（ドキュメントにも明記されている）。

ということで、下記のとおりの次善案を考え出した。

• RoleManagerModule オブジェクトをメンバとして集約した、IHttpModule インターフェースを備える独自クラスを用意（特に基底クラスを持たない）
  
• IHttpModule.Init 呼び出しのタイミングで HttpApplication の PostAuthenticateRequest イベントと PreSendRequestHeaders イベントのハンドラを追加
  
• PostAuthenticateRequest イベント発生時は、メンバとして集約した RoleManagerModule オブジェクトの OnEnter メソッドを呼び出し
  
• PreSendRequestHeaders イベント発生時は、メンバとして集約した RoleManagerModule オブジェクトの OnLeave メソッドを呼び出し
  

このような実装であれば、実質処理は相変わらず RoleManagerModule に任せたまま、ただし各処理の呼び出しタイミングは組み替えることができる。

唯一のハードルは RoleManagerModule の OnEnter, OnLeave メソッドがプライベートである点だ。普通は、これらのプライベートメソッドは当該型のオブジェクト外部から呼び出すことができない。
しかし、公然の秘密というのか、プライベートメソッドは .NET のリフレクション機能を使えば呼び出せてしまう。

MethodInfo mi = typeof(クラス名).GetMethod("メソッド名",BindingFlags.Instance | BindingFlags.NonPublic);
mi.Invoke(メソッド呼び出し対象のオブジェクト,new object[]{ メソッドの引数 });

ということで、無事独自実装を実現し、差し替えに成功した。
これにより、RoleManagerModule が原因で "HTTP ヘッダーが送出された後にサーバーで Cookie を変更することはできません。" という例外発生を回避することができた。

---

註1
Reflector for .NET については、下記に詳しい。
Landscape - エンジニアのメモ 2005-10-11