Visual StudioでDSLを使用する

はじめに

以前は、Visual Studioでの開発を簡素化するツールの開発について考えたことはありませんでした。また、開発に役立つさまざまなサードパーティユーティリティを作成することもよくありました。 しかし、いつものように、転換点が来ています。

かつては、専門的なソリューションを開発する必要があるプラットフォームを開発することがタスクでした。

柔軟な構成の可能性を制限することなく、プラットフォーム上のソリューションの開発を可能な限り簡素化したかったのです。

問題を解決するには、主に2つの方向がありました。

• カスタムソリューションツールを開発する
• 開発環境に組み込まれた支援ツールを作成する

独自のツール

このアプローチを使用すると、将来はコーディングせずに実行できます。 これは間違いなく、ソリューションの開発を簡素化および高速化し、エラーの可能性も減らします（もちろん、すべてがきれいに行われない限り）。

しかし、ツール開発者が直面する主な困難は、必要とされる可能性があるすべての必要な機能を可能な限り提供することです。

各ソリューションでは、重要なタスクが発生しますが、ツールを作成する段階では考えられません。 また、ユニバーサルツールを作成する場合、その複雑さが増し、作成のタイミングや使用の複雑さに影響します。

Visual Studioツール

補助ツールを使用する場合、必要な基本コードを可能な限り自動化し、システムの機能を拡張できるようにします。

しかし、このアプローチを使用するには、ソリューション開発者がより高い専門レベルを持っている必要があります。

私の選択

私が思いつくことができる長所と短所を比較検討した後、私は2番目のオプションを選ぶことにしました。 それは私にとって新しいものであり、本当に魅了されました。

次に、DSLを使用してVisual Studio 2010の支援ツールを作成する基本を説明します。 おそらくこれは、この分野のさらなる独立した研究にあなたを押し進めるでしょう。

予備

始める前に、次のディストリビューションをダウンロードしてインストールする必要があります。

• ビジュアルスタジオ
• Visual Studio SDK
• Visual Studio Visualization and Modeling SDK

問題の声明

まず、主な可能性の両方を述べ、このメカニズムが日常の課題を解決するためにどのように効果的であるかを示すことができる基礎に基づいた例を考え出す必要があります。

最初は、このタスクは初歩的なように思えましたが、考えてみると、すべてがそれほど単純ではないことに気付きました。 瞑想に時間を費やした後、私はまだ思いつきました。

WCFサービスを作成するレベルでクライアントサーバーアプリケーションを開発するのに役立つモデルを作成することを提案します。 もちろん、WCFの技術的な側面に重点を置くのではなく、オブジェクトモデルとして取り上げます。

プロジェクトの作成とデバッグ

自分でタスクを設定したら、これ以上考えずに、独自のプロジェクトを作成します。

いつものように、始めに、最愛のVisual Studio 2010を起動します。

プロジェクト作成ウィンドウに入り、プロジェクトタイプDomain-Specific Language Designerを選択します。





次に、ウィザードにより、作成するモジュールのタイプを選択するように求められます。 MinimalLanguageを選択します。 このタイプのプロジェクトでは、事前に作成された要素の最小数。これにより、要素をより早く取り除くことができます。







次に、ファイルの拡張子を設定する必要があります。 この拡張機能を使用して、ファイルをプロジェクトに追加します。

最後の貢献は、作成中のプロジェクトに関する合計情報です。

[完了]をクリックすると、事前に作成された要素を含むプロジェクトが開かれます。これは、例を示すために行われます。







プロジェクトをすぐにコンパイルして、テストしてみることができます。

このタイプのプロジェクトのテストとデバッグには、デバッグスタジオが使用されます。 [実行]をクリックするか、デバッグして実行すると、プロジェクトファイルのテストコピーが作成される追加のスタジオが開きます。

この例を試してみてください。

すべてをきれいにします

表示されたものはすべて私たちにとって特に有用ではないため、自動的に追加されたものはすべて削除します。

DSL Explorerに移動し、ドメインタイプの標準タイプを除くすべてを削除します。

結果は次のようになります。

ツールボックスの主なオブジェクトを説明しましょう

ドメインクラス -データオブジェクト。

名前付きドメインクラスは、Nameプロパティを含む名前付きデータオブジェクトです。 さらに、システムはこのプロパティをオブジェクトの名前として解釈し、その一意の名前を自動的に生成します。

Geometry Shape-ダイアグラムでデータオブジェクトをレンダリングするために使用される視覚的表現

コンパートメント形状 - 形状形状と同じ、外観が異なるだけ

関係の埋め込み -オブジェクトを所属関係に接続します

参照関係 -オブジェクトをオブジェクト参照タイプに接続します

継承 -接続の親タイプ、つまり、あるオブジェクトから別のオブジェクトへの継承

コネクタ -リンクビジュアライザー

ダイアグラム要素マップ -オブジェクトとリンクを視覚的表現でリンクするために使用

基本的なオブジェクトとそのマッピングの作成

当面の施設の作成を開始する前に、準備要素を作成する必要があります。

• デザイナーは、オブジェクトを視覚化するデザイナーです。 DSL Explorerで、 Editorオブジェクトを作成します。 その中にプロジェクトの拡張子を設定する必要があります（これはFileExtensionプロパティです）。これを「wcfw」にします。
• 図は、オブジェクトを表す主要な視覚化要素です。 WCFDiagramと呼びましょう。
• ルート要素（ Domain Class ）を作成する必要があります。その上で、以前に作成したエディター （これはルートクラスプロパティです）およびダイアグラム （これはクラス表現プロパティです）を構成する必要があります。 ルート要素に「WCFCollection」という名前を付けましょう。
• Explorerの動作 -DSL Explorerに似たもので、このタイプのファイルを操作するときに表示されます。

これは、ファイルを保存してプロジェクトをコンパイルできるようにするために必要な最小限のリストです。 ただし、コンパイルの前に、ファイルに加えられた変更に従ってコードを再生成する必要があります。 これを行うには、 ソリューションエクスプローラーで [すべてのテンプレートを変換]ボタンをクリックします。







すべてのコードは、 DslおよびDslPackageプロジェクトの GeneratedCodeフォルダーにある* .ttファイル（T4変換を記述する）から生成されます。 新しいオブジェクトが生成されたら、プロジェクトを収集して開始することさえできます。 同じプロジェクトで、同じデバッグスタジオが起動します。 実験プロジェクトに関連するファイルがプロジェクトに追加されたため、すべて削除できます。 ファイルタイプを（他のタイプと同様に）追加し、WCFWizardという名前で検索します。

「サービス」を記述するオブジェクトの作成

サービスオブジェクトを作成することから始めましょう。 これを行うには、ツールボックスから名前付きドメインクラス要素をドラッグし、「WCFService」と呼びます。 オブジェクトのNameプロパティを自動的に取得しました。IsElement Nameフラグは、このプロパティがオブジェクトの名前であることを示しています。

ドメインクラスと名前付きドメインクラスオブジェクトの基本的なプロパティを説明するときが来ました。

物件名	説明
アクセス修飾子	生成されたクラスへのアクセスのレベル。
基本クラス	基本クラス。 ここで別の作成されたオブジェクトを選択できます。生成されたコードでは、現在のクラスがベースオブジェクトによって指定されたクラスから継承されます。
カスタム属性	これは、追加の属性がオブジェクトにかかっている場所です。
説明	オブジェクトの説明。
表示名	ユーザーに表示されるオブジェクトの表示名。
二重派生を生成します	Trueの場合、2つのクラス（通常1つ）が生成されます。1つは必要なすべての実装を含む抽象クラスで、2つ目は内部に空の部分クラスを生成します。 これにより、将来ベースクラスで宣言される仮想関数を再定義できます。
カスタムコンストラクターがあります	Trueの場合、拡張クラスで必要なコンストラクターを定義する必要があります。 これは、オブジェクトを作成するときに追加のアクションを実行する必要がある場合に便利です。
継承修飾子	クラスを抽象化したり、クラスを継承しないようにすることができます。
お名前	クラスが生成されるこの名前を持つオブジェクトの名前。
名前空間	クラスの名前空間。

とりあえず、すべてのデフォルトのフィールドをそのままにします。 Domain Property要素の追加のプロパティを説明します

物件名	説明
ゲッターアクセス修飾子	プロパティへの読み取りアクセス権。
セッターアクセス修飾子	プロパティへの書き込みアクセス。
UIは読み取り専用ですか	プロパティを読み取り専用で表示します。
ブラウザです	プロパティをユーザーに表示するかどうか。
デフォルト値	デフォルトのフィールド値。
要素名プロバイダー	プロパティの値を提供する外部タイプ。 プロパティの値はIs Element NameがTrueである必要があります。 特定のアルゴリズムによって一意の名前を生成できます。
要素名です	プロパティはオブジェクトの名前です。 Trueの場合、初期値は一意に作成されます。
種類	ストレージに影響するフィールドのタイプ： なし-生成されたコードに通常の変数としてストレージが発生します 計算済み-フィールドが計算され、変数に保存されないことを示します。 計算を担当する関数を再定義する必要があります。 CustomStorage-カスタムストレージ。 データプロパティの受信と保存を担当する関数を再定義する必要があります
種類	プロパティのタイプ。 ドメインタイプで定義されたオブジェクトのリストからドロップダウンリストが生成されます（ DSL Explorerで見つけることができます）。 独自のオブジェクトを追加できます。

次に、WCFServiceをWCFCollectionの親関係に関連付ける必要があります。これは、WCFServiceがWCFCollectionに属していることを示します。 このため、 埋め込み関係をWCFCollectionからWCFServiceに拡張します。 その結果、写真に似たものが得られました。







「WCFCollectionHasWCFService」という名前のドメイン関係オブジェクトを作成しました。 このオブジェクトは、WCFCollectionとWCFServiceの関係を担当します。 このオブジェクトのすべてのプロパティはDomain Classに似ており、追加のプロパティを個別に説明します。

物件名	説明
重複を許可します	このプロパティがTrueに設定されている場合、WCFServiceオブジェクトに追加の埋め込み関係を作成できます。
基本関係	プロパティを継承する基本的な関係。
埋め込み中	接続が埋め込みであるかどうかを示します。

ドメイン関係の右側には 「WCFService / 0 .. *」（タイプDomain Role ）があります。ここで、WCFServiceはWCFServiceオブジェクトへの参照を含むWCFCollectionオブジェクトのプロパティの名前です。 0 .. *は、WCFCollectionにはゼロから無限までのWCFServiceが存在する可能性があることを示す接続の種類です。



ドメインリレーションシップの左側には 「WCFCollection / 1..1」（タイプDomain Role ）があります。WCFCollectionは、WCFCollectionオブジェクトへの参照を含むWCFServiceオブジェクトのプロパティの名前です。 1..1-WCFServiceがWCFCollectionオブジェクトへの参照を1つ（必須）だけ持つ必要があることを示す接続の種類。

ドメインロールは、バンドルに存在するロールを説明します。この例からわかるように、各オブジェクト（WCFServiceおよびWCFCollection）は、各側の接続の動作を説明する独自のロールを持っています。



ドメインロールオブジェクトの主な特徴を説明します。

物件名	説明
収集タイプ	オブジェクトを受け取るためのキーのタイプを設定できます。 この場合、リストを生成するのではなく、コレクションを生成します。
プロパティブラウザです	ユーザーのプロパティの可視性を決定します。
プロパティジェネレーター	プロパティが生成されるかどうかを決定します。
プロパティのカスタム属性	プロパティに属性を添付できます。
プロパティゲッターアクセス	読み取りアクセス権。
プロパティセッターアクセス	レコード上のプロパティにアクセスする権利。
多重度	作成されたオブジェクトの数を示します。 0 .. *-ゼロから無限まで 1..1-単一のコピーで 0..1-0から1 1 .. *-1から無限までの最小値
伝播コピー	バンドルをコピーすると、バンドル内でこのロールを所有するオブジェクトもコピーされます。
伝播を削除	バンドル内でこの役割を所有するオブジェクトも、バンドルが削除されるときに削除されます。
物件名	生成されたプロパティの名前。
ロールプレーヤー	ロールが属するオブジェクトのタイプ。

保存し、「すべてのテンプレートを変換」ボタンをクリックして、ソリューションを組み立てて開始します。 これで、WCFWizard Explorerを介してWCFService型のオブジェクトをWCFCollectionに追加し、名前を付けることができます。

チャート表示を作成する

オブジェクトがダイアグラムに表示されるようにするには、オブジェクトの視覚的表現を作成する必要があります。 これらの目的のために、 ツールボックス要素があります： ジオメトリ形状 、 コンパートメント形状 、 コネクタ 。 最初の2つはタイプDomain Classのオブジェクトをレンダリングし、最後はDomain Relationshipに使用されます。

コンパートメント形状要素を追加し、WCFServiceShapeという名前を付けます。 この要素には、視覚的表現に関与する多くのプロパティがありますが、生成されたクラスの拡張により、より柔軟な視覚的表現を生成することもできます。

オブジェクトをその表現に関連付けるには、 ダイアグラム要素マップ要素を使用して、WCFServiceとWCFServiceShape間の接続を拡張する必要があります。







コンパートメントシェイプに追加できるものを見てみましょう。

• コンパートメント-プロパティのコレクションを表示します。
• ドメインプロパティ-プロパティに表示されるプロパティ。
• Expand Collapse Decorator-内部コンテンツを折りたたんだり展開したりできる要素。
• アイコンデコレータ-画像を表示します。
• テキストデコレータ-テキスト出力。

テキストデコレータを追加し、NameDecoratorという名前を付けます。 次に、それをWCFServiceの特定のプロパティに関連付ける必要があります。そのために、 DSL Detailsウィンドウを使用します。 Diagram Element Mapを選択すると、バンドルに関する情報が表示されます。 [デコレータマップ]タブに移動して、NameDecoratorをアクティブにします。 WCFServiceプロパティを直接使用するため、 プロパティ要素を表示するパスは空のままにできますが、この要素を使用して、関連オブジェクトへのパスを設定し、そのプロパティを表示できます。 Displayプロパティ要素で、名前を選択します。







これで、WCFServiceは自身をチャートに表示することを学習しました。

ツールボックスにオブジェクトを置く

WCFWizard Explorerを使用してオブジェクトを追加できますが、見た目はあまり良くありません。 Toolboxを使用してオブジェクトを作成する機能を追加してみましょう。

DSLエクスプローラーに移動して、 エディターで新しいツールボックスタブを作成します。これをWCFWizard Elementsと名付けます。 これで、 Toolboxの要素のグループを作成しました。ここで、 接続ツール （接続用）と要素ツール （オブジェクト用）の2種類の要素を作成できます。

要素ツールタイプの要素を作成し、WCFServiceToolという名前を付け、リソースに既に存在するアイコンからアイコンを取得します。 最も重要なことは、ドラッグアンドドロップ時に作成されるオブジェクトを特徴付けるClassプロパティを設定することです。 WCFServiceを選択します。

これで、最初のオブジェクトがツールボックスに表示され、チャートに安全にドラッグアンドドロップできます。

「機能」を記述するオブジェクトの作成

上記のWCFServiceの場合と同様のアクションを、WCFFunctionという名前でのみ実行します。 そして、WCFCollectionにではなく、WCFFunctionを（ 埋め込み関係を使用して）WCFServiceにバインドします。 そして、次のようなものが得られます。







これで、サービスに関数を追加できますが、ダイアグラムには表示されません。 束にマッピングを追加します。

タイプConnectorのオブジェクト（プロパティで外部表示を構成できます）をドラッグし、 ダイアグラム要素マップを使用してWCFServiceHasWCFFunctionオブジェクトに関連付けます。

オブジェクトの型を記述するオブジェクトを追加して、関数のパラメーターと戻り値の型を設定します。

WCFTypeという名前のDomain Classオブジェクトを追加し、その中にNamespaceとTypeという2つのテキストプロパティを作成して、型の名前空間と型自体を指定します。 Inheritance Modifierプロパティをabstractに設定します。

また、WCFParamType（関数パラメーターのセットを表す）という名前のDomain Classオブジェクトを追加します。これは、WCFTypeから継承されます（ Base ClassパラメーターをWCFTypeに設定）。

WCFParamTypeの場合は、Nameプロパティを追加して関数内のパラメーター名を識別し、図に示すようにWCFServiceに関連付けます。







次に、WCFFunctionShapeオブジェクトで、コンパートメントを追加します（Paramと呼びましょう）。 WDSLFunctionとWCFFunctionShapeの間のリンクが強調表示されたDSL Detailsパネルに移動しましょう。 [コンパートメントマップ]タブを選択し、図のように構成します。







Displayed elements collection pathフィールドは、（バンドルを使用して）表示する要素のコレクションへのパスを示し、表示するプロパティの名前を指定します。

これで、簡単なコードの生成を開始するのに十分な情報が得られました。

この記事にはコード生成は含まれていませんが、さまざまな方法で実行できると言えます。

• T4を使用して生成します。
• 保存時にコードから直接生成します。

パッケージのビルドとデプロイ

Visual Studioに拡張機能をインストールする際の問題を明確にします。 DSLPackageプロジェクトをビルドすると、インストールパッケージであるvsix拡張子のファイルが取得されます。

プロジェクトをデプロイするには、 vsixファイルを実行して、 インストーラーの手順を実行するだけです。

その結果、拡張機能がVisual Studioに表示され、 拡張機能マネージャー （[ ツール ]メニューにあります）で表示できます。 ここで削除することもできます。

おわりに

私はこのツールの最小部分のみをカバーすることができましたが、これが誰かが独立した詳細な研究を行うことを奨励することを願っています。

このトピックが人々にとって興味深いものである場合、次のような問題をカバーする計画があります。

• メニュー項目を使用します。
• データの検証。
• コード生成。