🕺🏾 🏏 🍯 AppDomainでプラグインを書くのは楽しい 👩🏿‍🤝‍👨🏻 🔃 💅🏾

アプリケーションのプラグインをどのくらいの頻度で作成しましたか？

この記事では、AppDomainを使用してプラグインを作成する方法と、クロスドメイン操作を説明したいと思います。既存のTCPChatアプリケーション用のプラグインを作成します。

誰が自転車をしたい-猫の下で前進。

チャットはこちらです。

また、ここでアプリケーションアーキテクチャについて読むことができます。この場合、モデルにのみ関心があります。根本的な変更はなく、主要なエンティティ（ Model Root / A PI / Team ）について知るだけで十分です。

アプリケーションに実装する必要があるものについて：

プラグインのコードは別のドメインで実行する必要がありますが、プラグインの助けを借りてコマンドのセットを拡張できる必要があります。

明らかに、コマンドはそれ自体では呼び出されないため、UIを変更する機能も追加する必要があります。これを行うために、メニュー項目を追加したり、独自のウィンドウを作成する機会を提供します。

最後に、リモートで任意のユーザーのスクリーンショットを撮ることができるプラグインを作成します。

AppDomainの目的は何ですか？

アプリケーションドメインは、制限された権限でコードを実行し、アプリケーションの実行中にライブラリをアンロードするために必要です。ご存知のように、アプリケーションドメインからアセンブリをアンロードすることはできませんが、ドメインをアンロードしてください。

ドメインをアンロードするために、それらの間の相互作用は最小限に抑えられます。

実際、次のことができます。

別のドメインでコードを実行します。
オブジェクトを作成し、値で昇格させます。
オブジェクトを作成し、参照により昇格させます。

プロモーションについて少し：

昇格は、参照または値によって発生します。

値があれば、すべてが比較的単純です。クラスは1つのドメインでシリアル化され、バイトの配列によって別のドメインに転送され、逆シリアル化され、オブジェクトのコピーが取得されます。同時に、アセンブリを両方のドメインにロードする必要があります。アセンブリをメインドメインに読み込まないようにする必要がある場合は、アプリケーションが既定のアセンブリ（AppDomain.BaseDirectory / AppDomainSetup.PrivateBinPath）を探すフォルダーのリストに、プラグインのあるフォルダーを追加しない方が良いでしょう。この場合、型が見つからなかったという例外が発生し、サイレントロードされたアセンブリを受け取りません。

リンクプロモーションを実行するには、クラスでMarshalByRefObjectを実装する必要があります。そのようなオブジェクトごとに、CreateInstanceAndUnwrapメソッドを呼び出した後、呼び出し側ドメインに代表が作成されます。これは、このオブジェクトのすべてのメソッドを含むオブジェクトです（フィールドはありません）。これらのメソッドでは、特別なメカニズムを使用して、別のドメインにある実際のオブジェクトのメソッドを呼び出します。したがって、メソッドはオブジェクトが作成されたドメインでも実行されます。また、代表者の寿命は限られていると言う価値があります。作成後、彼らは5分間生存し、メソッドを呼び出すたびに、彼らの寿命は2分間になります。レンタル時間を変更できます。このため、MarshalByRefObjectのInitializeLifetimeServiceメソッドをオーバーライドできます。

リンクプロモーションでは、プラグインを使用してメインアセンブリドメインに読み込む必要はありません。

フィールドに関する余談：

これは、オープンフィールドではなくプロパティを使用する理由の1つです。担当者を介してフィールドにアクセスできますが、すべて動作が遅くなります。さらに、これがより遅く動作するためには、クロスドメイン操作を使用する必要はありません。MarshalByRefObjectから継承するだけで十分です。

コード実行の詳細：

コードの実行は、 AppDomain.DoCallBack（）メソッドを使用して実行されます。

この場合、デリゲートは別のドメインに昇格されるため、これが可能であることを確認する必要があります。

これらは私が出くわした小さな問題です：

これはインスタンスメソッドであり、ホストクラスは昇格できません。ご存知のように、各署名付きメソッドのデリゲートには、2つのメインフィールド、クラスのインスタンスへのリンク、およびメソッドへのポインターが格納されます。
クロージャーを使用しました。デフォルトでは、コンパイラが作成するクラスはシリアライズ可能としてマークされておらず、 MarshalByRefObjectを実装していません。（段落1を参照）
MarshalByRefObjectからクラスを継承し、ドメイン1でクラスを作成し、そのインスタンスメソッドを別のドメイン2で実行しようとすると、ドメインの境界が2回交差し、コードがドメイン1で実行されます。

さあ始めましょう

まず、アプリケーションがダウンロードできるプラグインを見つける必要があります。 1つのアセンブリに複数のプラグインがある場合があり、各プラグインに個別のドメインを提供する必要があります。したがって、別のドメインでも動作する情報ローダーを作成する必要があります。ローダーの最後に、このドメインがアンロードされます。

プラグインに関するブート情報を保存するための構造は、Serializable属性でマークされています。ドメイン間で進みます。

[Serializable] struct PluginInfo { private string assemblyPath; private string typeName; public PluginInfo(string assemblyPath, string typeName) { this.assemblyPath = assemblyPath; this.typeName = typeName; } public string AssemblyPath { get { return assemblyPath; } } public string TypeName { get { return typeName; } } }

情報自体のローダー。 ProxyクラスがMarshalByRefObjectを継承していることに気付くかもしれません。そのフィールドは、入力および出力パラメーターに使用されます。そして、彼はブートローダードメインに作成されます。

  class PluginInfoLoader { private class Proxy : MarshalByRefObject { public string[] PluginLibs { get; set; } public string FullTypeName { get; set; } public List<PluginInfo> PluginInfos { get; set; } public void LoadInfos() { foreach (var assemblyPath in PluginLibs) { var assembly = AppDomain.CurrentDomain.Load(AssemblyName.GetAssemblyName(assemblyPath).FullName); foreach (var type in assembly.GetExportedTypes()) { if (type.IsAbstract) continue; var currentBaseType = type.BaseType; while (currentBaseType != typeof(object)) { if (string.Compare(currentBaseType.FullName, FullTypeName, StringComparison.OrdinalIgnoreCase) == 0) { PluginInfos.Add(new PluginInfo(assemblyPath, type.FullName)); break; } currentBaseType = currentBaseType.BaseType; } } } } } public List<PluginInfo> LoadFrom(string typeName, string[] inputPluginLibs) { var domainSetup = new AppDomainSetup(); domainSetup.ApplicationBase = AppDomain.CurrentDomain.BaseDirectory; domainSetup.PrivateBinPath = "plugins;bin"; var permmisions = new PermissionSet(PermissionState.None); permmisions.AddPermission(new ReflectionPermission(ReflectionPermissionFlag.MemberAccess)); permmisions.AddPermission(new SecurityPermission(SecurityPermissionFlag.Execution)); permmisions.AddPermission(new UIPermission(UIPermissionWindow.AllWindows)); permmisions.AddPermission(new FileIOPermission(FileIOPermissionAccess.PathDiscovery | FileIOPermissionAccess.Read, inputPluginLibs)); List<PluginInfo> result; var pluginLoader = AppDomain.CreateDomain("Plugin loader", null, domainSetup, permmisions); try { var engineAssemblyPath = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, @"bin\Engine.dll"); var proxy = (Proxy)pluginLoader.CreateInstanceAndUnwrap(AssemblyName.GetAssemblyName(engineAssemblyPath).FullName, typeof(Proxy).FullName); proxy.PluginInfos = new List<PluginInfo>(); proxy.PluginLibs = inputPluginLibs; proxy.FullTypeName = typeName; proxy.LoadInfos(); result = proxy.PluginInfos; } finally { AppDomain.Unload(pluginLoader); } return result; } }

ブートローダーの機能を制限するために、ドメインへの一連のアクセス許可をブートローダーに転送します。リストを見るとわかるように、3つの権限が設定されています。

ReflectionPermissionリフレクションを使用する許可。
マネージコードを実行するSecurityPermissionアクセス許可。
2番目のパラメーターで渡されたファイルを読み取るためのFileIOPermission許可。

一部のアクセス許可（ほとんどすべて）は、部分アクセスまたは完全アクセスとして指定できます。パーシャルは、解像度ごとに特定のリストを使用して与えられます。フルアクセス、または逆に禁止の場合、状態を個別に転送できます。

PermissionState.None-禁止します。

PermissionState.Unrestricted-完全な許可。

その他の許可についての詳細は、こちらを参照してください。ここでは、デフォルトドメインのパラメータを確認することもできます。

ドメインを作成するメソッドでは、AppDomainSetupクラスのインスタンスを渡します。彼には2つのフィールドのみが設定されています。これにより、デフォルトでアセンブリを探す必要がある場所がわかります。

さらに、ドメインを目立たないように作成した後、CreateInstanceAndUnwrapメソッドを呼び出して、アセンブリの完全な名前と型をパラメーターに渡します。このメソッドは、ローダードメインにオブジェクトを作成し、この場合は参照によってプロモーションを実行します。

プラグイン

私の実装のプラグインは、クライアントとサーバーに分かれています。サーバー側はコマンドのみを提供します。クライアントプラグインごとに個別のメニュー項目が作成され、サーバープラグインと同様に、チャットコマンドのセットを発行できます。

両方のプラグインには初期化メソッドがあり、モデル上でラッパーをプッシュして静的フィールドに保存します。コンストラクターでこれが行われないのはなぜですか？

ロードされるプラグインの名前は不明であり、オブジェクトが作成された後にのみ検出されます。その名前のプラグインが突然追加されましたか？その後、アンロードする必要があります。同名のプラグインがまだない場合は、初期化が実行されます。これにより、ダウンロードが成功した場合にのみ初期化が保証されます。

プラグイン自体の基本クラスは次のとおりです。

  public abstract class Plugin<TModel> : CrossDomainObject where TModel : CrossDomainObject { public static TModel Model { get; private set; } private Thread processThread; public void Initialize(TModel model) { Model = model; processThread = new Thread(ProcessThreadHandler); processThread.IsBackground = true; processThread.Start(); Initialize(); } private void ProcessThreadHandler() { while (true) { Thread.Sleep(TimeSpan.FromMinutes(1)); Model.Process(); OnProcess(); } } public abstract string Name { get; } protected abstract void Initialize(); protected virtual void OnProcess() { } }

CrossDomainObjectは、1つのメソッド（Process）のみを含むオブジェクトです。これにより、サポート技術スタッフの存続期間の延長が保証されます。チャット側では、プラグインマネージャーはすべてのプラグインに対して1分に1回呼び出します。プラグインの一部では、プラグイン自体がモデルラッパーのProcessメソッドへの呼び出しを提供します。

  public abstract class CrossDomainObject : MarshalByRefObject { public void Process() { } }

サーバーおよびクライアントプラグインの基本クラス：

  public abstract class ServerPlugin : Plugin<ServerModelWrapper> { public abstract List<ServerPluginCommand> Commands { get; } } public abstract class ClientPlugin : Plugin<ClientModelWrapper> { public abstract List<ClientPluginCommand> Commands { get; } public abstract string MenuCaption { get; } public abstract void InvokeMenuHandler(); }

プラグインマネージャーは、プラグインのアップロード、ダウンロード、所有を担当します。

ダウンロードを検討してください。

  private void LoadPlugin(PluginInfo info) { var domainSetup = new AppDomainSetup(); domainSetup.ApplicationBase = AppDomain.CurrentDomain.BaseDirectory; domainSetup.PrivateBinPath = "plugins;bin"; var permmisions = new PermissionSet(PermissionState.None); permmisions.AddPermission(new UIPermission(PermissionState.Unrestricted)); permmisions.AddPermission(new SecurityPermission( SecurityPermissionFlag.Execution | SecurityPermissionFlag.UnmanagedCode | SecurityPermissionFlag.SerializationFormatter | SecurityPermissionFlag.Assertion)); permmisions.AddPermission(new FileIOPermission( FileIOPermissionAccess.PathDiscovery | FileIOPermissionAccess.Write | FileIOPermissionAccess.Read, AppDomain.CurrentDomain.BaseDirectory)); var domain = AppDomain.CreateDomain( string.Format("Plugin Domain [{0}]", Path.GetFileNameWithoutExtension(info.AssemblyPath)), null, domainSetup, permmisions); var pluginName = string.Empty; try { var plugin = (TPlugin)domain.CreateInstanceFromAndUnwrap(info.AssemblyPath, info.TypeName); pluginName = plugin.Name; if (plugins.ContainsKey(pluginName)) { AppDomain.Unload(domain); return; } plugin.Initialize(model); var container = new PluginContainer(domain, plugin); plugins.Add(pluginName, container); OnPluginLoaded(container); } catch (Exception e) { OnError(string.Format("plugin failed: {0}", pluginName), e); AppDomain.Unload(domain); return; } }

ブートローダーと同様に、最初にドメインを初期化して作成します。次に、AppDomain.CreateInstanceFromAndUnwrapメソッドを使用して、オブジェクトを作成します。作成後、プラグインの名前が分析され、プラグインが既に追加されている場合は、プラグインを持つドメインがアンロードされます。そのようなプラグインがない場合、初期化されます。

マネージャーコードの詳細については、こちらをご覧ください。

非常に簡単に解決された問題の1つは、モデルへのプラグインアクセスを提供することでした。私のモデルルートは静的であり、別のドメインでは初期化されません。各ドメインのタイプと静的フィールドは異なります。

この問題は、モデルオブジェクトが保存されているラッパーを作成することで解決され、このラッパーのインスタンスは既に進行しています。モデルオブジェクトは、基本クラスMarshalByRefObjectに追加するだけで済みました。例外は、ラップする必要があったクライアントとサーバー（対称からのサーバー）APIです。クライアントAPIはプラグインマネージャーの後に作成され、アドオンをダウンロードする時点ではまだ存在していません。クライアントラッパーの例。

クライアントとサーバーのプラグイン用に、基本的なPluginManagerを実装する2つの異なるマネージャーを作成しました。どちらにもTryGetCommandメソッドがあり、そのようなIDを持つネイティブコマンドが見つからない場合、対応するAPIで呼び出されます。以下は、GetCommand APIメソッドの実装です。

コード

  public IClientCommand GetCommand(byte[] message) { if (message == null) throw new ArgumentNullException("message"); if (message.Length < 2) throw new ArgumentException("message.Length < 2"); ushort id = BitConverter.ToUInt16(message, 0); IClientCommand command; if (commandDictionary.TryGetValue(id, out command)) return command; if (ClientModel.Plugins.TryGetCommand(id, out command)) return command; return ClientEmptyCommand.Empty; }

プラグインの作成：

記述されたコードに基づいて、プラグインの実装を試みることができます。

メニュー項目をクリックして、ボタンとテキストフィールドのあるウィンドウを開くプラグインを作成します。ボタンハンドラでは、フィールドにニックネームを入力したユーザーにコマンドが送信されます。チームは写真を撮り、それをフォルダに保存します。その後、それをメインルームに入れて、答えを送ってください。

これはP2P相互作用であるため、サーバープラグインを記述する必要はありません。

まず、プロジェクトを作成し、クラスライブラリを選択します。さらに、リンク3つの主要なアセンブリ：Engine.dll、Lidgren.Network.dll、OpenAL.dllを追加します。正しいバージョンの.NET Frameworkを配置することを忘れないでください。3.5のチャットを収集します。したがって、プラグインも同じバージョン以下でなければなりません。

次に、2つのコマンドを提供するプラグインのメインクラスを実装します。また、メニュー項目ハンドラーはダイアログボックスを開きます。

プラグインマネージャがコマンドをサイドにキャッシュするため、プラグインがそれらへのリンクを保持する必要があることに注意してください。そして、Commandsプロパティは同じコマンドインスタンスを返しました。

  public class ScreenClientPlugin : ClientPlugin { private List<ClientPluginCommand> commands; public override List<ClientPluginCommand> Commands { get { return commands; } } protected override void Initialize() { commands = new List<ClientPluginCommand> { new ClientMakeScreenCommand(), new ClientScreenDoneCommand() }; } public override void InvokeMenuHandler() { var dialog = new PluginDialog(); dialog.ShowDialog(); } public override string Name { get { return "ScreenClientPlugin"; } } public override string MenuCaption { get { return " "; } } }

ダイアログボックスは次のようになります。

コード

 <Window x:Class="ScreenshotPlugin.PluginDialog" xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" Title="Screen" SizeToContent="WidthAndHeight" ResizeMode="NoResize"> <Grid> <Grid.RowDefinitions> <RowDefinition Height="Auto"/> <RowDefinition Height="Auto"/> </Grid.RowDefinitions> <TextBox Grid.Row="0" Margin="10, 10, 10, 5" MinWidth="200" Name="UserNameTextBox"/> <Button Grid.Row="1" Margin="10, 5, 10, 10" Padding="5, 2, 5, 2" Content=" " Click="Button_Click"/> </Grid> </Window>

  public partial class PluginDialog : Window { public PluginDialog() { InitializeComponent(); } private void Button_Click(object sender, RoutedEventArgs e) { ScreenClientPlugin.Model.Peer.SendMessage(UserNameTextBox.Text, ClientMakeScreenCommand.CommandId, null); } }

ファイルを転送するときは、APIを使用して既に作成されたチャット機能を使用しました。

  public class ClientMakeScreenCommand : ClientPluginCommand { public static ushort CommandId { get { return 50000; } } public override ushort Id { get { return ClientMakeScreenCommand.CommandId; } } public override void Run(ClientCommandArgs args) { if (args.PeerConnectionId == null) return; string screenDirectory = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "screens"); if (!Directory.Exists(screenDirectory)) Directory.CreateDirectory(screenDirectory); string fileName = Path.GetFileNameWithoutExtension(Path.GetRandomFileName()) + ".bmp"; string fullPath = Path.Combine(screenDirectory, fileName); using (Bitmap bmpScreenCapture = new Bitmap(Screen.PrimaryScreen.Bounds.Width, Screen.PrimaryScreen.Bounds.Height)) using (Graphics graphic = Graphics.FromImage(bmpScreenCapture)) { graphic.CopyFromScreen( Screen.PrimaryScreen.Bounds.X, Screen.PrimaryScreen.Bounds.Y, 0, 0, bmpScreenCapture.Size, CopyPixelOperation.SourceCopy); bmpScreenCapture.Save(fullPath); } ScreenClientPlugin.Model.API.AddFileToRoom(ServerModel.MainRoomName, fullPath); var messageContent = Serializer.Serialize(new ClientScreenDoneCommand.MessageContent { FileName = fullPath }); ScreenClientPlugin.Model.Peer.SendMessage(args.PeerConnectionId, ClientScreenDoneCommand.CommandId, messageContent); } }

最も興味深いのは、最後の3行です。ここでは、ルームにファイルを追加するAPIを使用します。その後、応答コマンドを送信します。ピアはメソッドオーバーロードと呼ばれ、バイトのセットを受け取ります。チャットのメインアセンブリでオブジェクトをシリアル化することはできません。

以下は、応答を受信するコマンドの実装です。彼女は貧しいユーザーのスクリーンショットを撮ったことをメインルーム全体に発表します。

  public class ClientScreenDoneCommand : ClientPluginCommand { public static ushort CommandId { get { return 50001; } } public override ushort Id { get { return ClientScreenDoneCommand.CommandId; } } public override void Run(ClientCommandArgs args) { if (args.PeerConnectionId == null) return; var receivedContent = Serializer.Deserialize<MessageContent>(args.Message); ScreenClientPlugin.Model.API.SendMessage( string.Format("    {0}.", args.PeerConnectionId), ServerModel.MainRoomName); } [Serializable] public class MessageContent { private string fileName; public string FileName { get { return fileName; } set { fileName = value; } } } }

プラグインを使用してプロジェクト全体を投稿できますが、どこにあるかわかりません。（githubの別のリポジトリの場合、非常に小さいため、私には思えます）。

UPD ：プラグインをgithubに投稿しました。

UPD 2 ：この記事では、プルを使用してプラグインの有効期間をサポートしていますが、これは奇妙です。 githubの実装では、後で通常のモデルを実装しました。

AppDomainでプラグインを書くのは楽しい

More articles: