MEF（Managed Extensibility Framework）を使用してAsp.Net WebFormsアプリケーションを開発する

MEFは、拡張可能なアプリケーションを作成するための優れたフレームワークです。これにより、実装を抽象化から簡単に分離し、アプリケーションの実行中に実装を追加/変更/削除（再構成）し、抽象化の複数の実装を操作し、モノリシックアプリケーションを独立した部分に分離することができます。

MEFの動作方法のほとんどの例は、コンソールまたはWPFアプリケーションです。なんで？この場合、構成可能な部品の寿命を制御するのが最も簡単だからです。 MEF自体がこれを処理し、開発者は例のタスクに集中します。

Webアプリケーションの状況は根本的に異なります。開発者はページ、コントロールなどを作成する責任を負いません。 Asp.netランタイムがすべてを処理します。

したがって、WebアプリケーションにMEFサポートを実装するには、両方のツールのアルゴリズムを組み合わせる必要があります。

既知のソリューション

MEFをWebFormsアプリケーションに使用する方法には解決策があります。ただし、この例にはいくつかの重要な制限があります。

開発者は、すべてのコントロール、ページ、およびユーザーコントロールを再継承する必要がありますが、これは常に可能ではありません
この例は、 HttpModule

およびHttpHandler

をサポートするソリューションを提供していません

高レベルのアーキテクチャ

ソリューションの目的は、再継承メカニズムを使用せずにMEFコンテナのサポートを実装し、 HttpModule

およびHttpHandler

サポートを提供することHttpHandler

。

上記のソリューションを拒否したという事実にもかかわらず、私はそれを基礎として使用します。これは、ローカル（リクエストごと）とグローバルの2つのコンテナを使用することを意味します。

要求が到着するたびに、asp.netランタイムは要求されたページまたはハンドラーを作成し、すべての依存コントロールを作成します。ページのすべての部分が作成された直後にインポートされた要素を初期化し、初期化されたすべてのインポートをローカルコンテナに保存することをお勧めします。

一方、 HttpModule

、アプリケーション全体の開始直後に1回作成されます。したがって、それらのインポートはできるだけ早く実行し、すべてのHttpModule

はグローバルコンテナに格納する必要があります。

実装

ページとコントロール

ページとそのすべての依存関係のインポート操作を実行するには、追加のHttpModule

を使用する必要があります。このモジュールでは、現在要求されているページのPre_Init

およびInit

ハンドラーを追加するPre_Init

あります。最初のハンドラーでは、ページ、マスターページ、ユーザーコントロールの構成を実行できます。 Init

イベントを使用すると、サーバーコントロールの構成を次のように実行できます。 Pre_Init

、まだ存在しません。

例：

public class ComposeContainerHttpModule : IHttpModule { public void Init(HttpApplication context) { context.PreRequestHandlerExecute += ContextPreRequestHandlerExecute; } private void ContextPreRequestHandlerExecute( object sender, EventArgs e) { Page page = HttpContext .Current.CurrentHandler as Page ; if (page != null ) { page.PreInit += Page_PreInit; page.Init += Page_Init; } } private void Page_Init( object sender, EventArgs e) { Page handler = sender as Page ; if (handler != null ) { CompositionBatch batch = new CompositionBatch(); batch = ComposeWebPartsUtils.BuildUpControls(batch, handler.Controls); ContextualCompositionHost.Container.Compose(batch); } } private void Page_PreInit( object sender, EventArgs e) { Page handler = sender as Page ; if (handler != null ) { CompositionBatch batch = new CompositionBatch(); batch = ComposeWebPartsUtils.BuildUp(batch, handler); batch = ComposeWebPartsUtils.BuildUpUserControls(batch, handler.Controls); batch = ComposeWebPartsUtils.BuildUpMaster(batch, handler.Master); ContextualCompositionHost.Container.Compose(batch); } } public void Dispose() { } } * This source code was highlighted with Source Code Highlighter .

最初にインポートがページに対して実行され、次にユーザーコントロールとマスターページに対して実行されます。最後に、サーバーコントロールとそのコントロールの再帰関数インポートが実行されます。

BuildUp(CompositionBatch batch, Object o)

メソッドは、 Object o

インポートされた要素Object o

かどうかを確認し、構成用のオブジェクトのリストに追加します。すべてのコントロールが処理されると、 CompositionBatch

オブジェクトを使用してコンテナを初期化できます。その後、すべてのインポートが初期化され、リクエストの存続期間中利用可能になります。

例：

public static class ComposeWebPartsUtils { public static CompositionBatch BuildUp(CompositionBatch batch, Object o) { ComposablePart part = AttributedModelServices.CreatePart(o); if (part.ImportDefinitions.Any()) { if (part.ExportDefinitions.Any()) throw new Exception( string .Format( "'{0}': Handlers cannot be exportable" , o.GetType().FullName)); batch.AddPart(part); } return batch; } public static CompositionBatch BuildUpUserControls(CompositionBatch batch, ControlCollection controls) { foreach (Control c in controls) { if (c is UserControl) batch = ComposeWebPartsUtils.BuildUp(batch, c); batch = BuildUpUserControls(batch, c.Controls); } return batch; } public static CompositionBatch BuildUpControls(CompositionBatch batch, ControlCollection controls) { foreach (Control c in controls) { batch = ComposeWebPartsUtils.BuildUp(batch, c); batch = BuildUpControls(batch, c.Controls); } return batch; } public static CompositionBatch BuildUpMaster(CompositionBatch batch, MasterPage master) { if (master != null ) batch = BuildUpMaster(ComposeWebPartsUtils.BuildUp(batch, master), master.Master); return batch; } } * This source code was highlighted with Source Code Highlighter .

注：

codeplexサイトの例で使用されているのと同じ手法（ PageHandlerFactory

を継承し、 GetHandler()

メソッドをオーバーライドするGetHandler()

使用することはできません。現時点では、ページのコントロールはまだ作成されていません。

Httphandler

ハンドラーには、すべてのインポートが満たされるイベントはありません。適切なHandlerFactory

を使用して、コードプレックスの例のページに対して行われたようにGetHandler()

メソッドをオーバーライドすることが理想的です。そして、そのようなクラスは存在しますが（ SimpleWebHandlerFactory

）、それは内部的なものです。 Microsoftプログラマーがこれを行った理由はわかりませんが、奇妙に見えます。ページのファクトリはパブリックです。

.netフレームワークに存在する代わりに、独自のファクトリSimpleWebHandlerFactory

実装する以外のオプションはありません。 HandlerFactory

の主な目標は、現在の要求に対してインスタンス化する必要がある型を決定することです。 HandlerFactory

は、要求されたリソースの解析を通じてのみ型を取得できます。そのため、 HttpHandler

コードを解析できるパーサーが必要です。幸いなことに、そのようなパーサーが存在し（ SimpleWebHandlerParser

）、パブリックであり、そのためのラッパー（ WebHandlerParser

）を作成するだけです。

以下は、 HttpHandler

構成を作成するアルゴリズムの操作を説明するシーケンス図ですHttpHandler

以下は、上記の機能を実装するクラスのコードです。

public class SimpleWebHandlerFactory : IHttpHandlerFactory { public virtual IHttpHandler GetHandler( HttpContext context, string requestType, string virtualPath, string path) { Type type = WebHandlerParser.GetCompiledType(context, virtualPath, path); if (!( typeof (IHttpHandler).IsAssignableFrom(type))) throw new HttpException( "Type does not implement IHttpHandler: " + type.FullName); return Activator.CreateInstance(type) as IHttpHandler; } public virtual void ReleaseHandler(IHttpHandler handler) { } } internal class WebHandlerParser : SimpleWebHandlerParser { internal WebHandlerParser( HttpContext context, string virtualPath, string physicalPath) : base (context, virtualPath, physicalPath) { } public static Type GetCompiledType( HttpContext context, string virtualPath, string physicalPath) { WebHandlerParser parser = new WebHandlerParser(context, virtualPath, physicalPath); Type type = parser.GetCompiledTypeFromCache(); if (type != null ) return type; else throw new HttpException( string .Format( "File '{0}' is not a web handler." , virtualPath)); } protected override string DefaultDirectiveName { get { return "webhandler" ; } } } public class ComposableWebHandlerFactory : SimpleWebHandlerFactory { public override IHttpHandler GetHandler( HttpContext context, string requestType, string virtualPath, string path) { IHttpHandler handler = base .GetHandler(context, requestType, virtualPath, path); if (handler != null ) { CompositionBatch batch = new CompositionBatch(); batch = ComposeWebPartsUtils.BuildUp(batch, handler); ContextualCompositionHost.Container.Compose(batch); } return handler; } } * This source code was highlighted with Source Code Highlighter .

HttpModule

前述したように、すべてのHttpModules

はアプリケーションの開始時に作成されます。したがって、アプリケーションの開始直後に構成を作成する必要があります。

例：

public class ScopedContainerHttpModule : IHttpModule { private CompositionContainer _container; public void Init(HttpApplication app) { ComposeModules(app); } private void ComposeModules(HttpApplication app) { CompositionBatch batch = ComposeWebPartsUtils.BuildUpModules(app); _container.Compose(batch); } } public static class ComposeWebPartsUtils { public static CompositionBatch BuildUpModules(HttpApplication app) { CompositionBatch batch = new CompositionBatch(); for ( int i = 0; i < app.Modules.Count - 1; i++) batch = BuildUp(batch, app.Modules.Get(i)); return batch; } } * This source code was highlighted with Source Code Highlighter .

HttpApplication

オブジェクトを取得し、そこからすべてのモジュールを抽出し、この情報に基づいてグローバルコンテナーに入力します。

そのため、ソリューションが機能するように、WebFormsプロジェクトのweb.configファイルに数行を追加する必要があります。

< httpHandlers > ...... < remove path ="*.ashx" verb ="*" /> < add path ="*.ashx" verb ="*" type ="common.composition.WebExtensions.ComposableWebHandlerFactory, common.composition" /> ...... </ httpHandlers > < httpModules > < add name ="ContainerCreator" type ="common.composition.WebExtensions.ScopedContainerHttpModule, common.composition" /> ...... < add name ="ComposeContainerModule" type ="common.composition.WebExtensions.ComposeContainerHttpModule, common.composition" /> </ httpModules > * This source code was highlighted with Source Code Highlighter .

デフォルトで存在する* .ashxファイルハンドラーを削除し、鉱山（ ComposableWebHandlerFactory

）を追加します。

ローカルおよびグローバルコンテナのインフラストラクチャを作成および初期化するContainerCreator

モジュールを追加しています。

ComposeContainerModule

は、ローカルコンテナを初期化するために使用されます。

以上です！

コントロールの継承を使用する必要はなく、メインプログラムに追加のコードを記述します。このソリューションは、Webフォームに基づく任意のWebプロジェクトに追加でき、表示されるすべての機能が利用可能になるようにweb.configのみを更新する必要があります。

例

サンプルのWebFomsAndMefから少し変更を加えたデモを使用しています。

各アプリケーション要素は、 [PartCreationPolicy(CreationPolicy.NonShared)]

属性を持つSampleCompositionPart

クラスをインポートします。これにより、インポート動作中にSampleCompositionPart

新しいインスタンスSampleCompositionPart

れます。このクラスには、Guidが返す単一のId

フィールドが含まれます。

アプリケーションは、現在表示されている要素（ページ、コントロール、ユーザーコントロール、ページマスターHttpHandler

およびHttpModule

のGuid値を表示します。

例：

///PageSample.aspx <asp:Content ID= "BodyContent" runat= "server" ContentPlaceHolderID= "MainContent" > <% =SamplePart.Id %> </asp:Content> ///PageSample.cs public partial class PageSample : System.Web.UI. Page { [Import] public SampleCompositionPart SamplePart { get ; set ; } } * This source code was highlighted with Source Code Highlighter .

ソースコードはこちらからダウンロードできます。

この記事が、asp.net WebFormsアプリケーションでのMEFの使用開始に役立つことを願っています。

All Articles