使用 MEF 扩展 DSL

项目
06/19/2023

可以使用 Managed Extensibility Framework (MEF) 扩展域特定语言 (DSL)。你或其他开发人员将能够为 DSL 编写扩展，而无需更改 DSL 定义和程序代码。此类扩展包括菜单命令、拖放处理程序和验证。用户将能够安装 DSL，然后可选择为其安装扩展。

此外，在 DSL 中启用 MEF 时，可以更轻松地编写 DSL 的一些功能，即使这些功能都是与 DSL 一起构建的。

有关 MEF 的详细信息，请参阅 Managed Extensibility Framework (MEF)。

使 DSL 能够由 MEF 扩展

在 DslPackage 项目中创建一个名为 MefExtension 的新文件夹。向其中添加以下文件：

文件名：CommandExtensionVSCT.tt

重要

将此文件中的 GUID 设置为与 DslPackage\GeneratedCode\Constants.tt 中定义的 GUID CommandSetId 相同

<#@ Dsl processor="DslDirectiveProcessor" requires="fileName='..\..\Dsl\DslDefinition.dsl'" #>
<#
// CmdSet Guid must be defined before master template is included
// This Guid must be kept synchronized with the CommandSetId Guid in Constants.tt
Guid guidCmdSet = new Guid ("00000000-0000-0000-0000-000000000000");
string menuidCommandsExtensionBaseId="0x4000";
#>
<#@ include file="DslPackage\CommandExtensionVSCT.tt" #>

文件名：CommandExtensionRegistrar.tt

<#@ Dsl processor="DslDirectiveProcessor" requires="fileName='..\..\Dsl\DslDefinition.dsl'" #>
<#@ include file="DslPackage\CommandExtensionRegistrar.tt" #>

文件名：ValidationExtensionEnablement.tt

<#@ Dsl processor="DslDirectiveProcessor" requires="fileName='..\..\Dsl\DslDefinition.dsl'" #>
<#@ include file="DslPackage\ValidationExtensionEnablement.tt" #>

文件名：ValidationExtensionRegistrar.tt

如果添加此文件，则必须使用 DSL 资源管理器中 EditorValidation 中的至少一个开关在 DSL 中启用验证。

<#@ Dsl processor="DslDirectiveProcessor" requires="fileName='..\..\Dsl\DslDefinition.dsl'" #>
<#@ include file="DslPackage\ValidationExtensionRegistrar.tt" #>

文件名：PackageExtensionEnablement.tt

<#@ Dsl processor="DslDirectiveProcessor" requires="fileName='..\..\Dsl\DslDefinition.dsl'" #>
<#@ include file="DslPackage\PackageExtensionEnablement.tt" #>

在 Dsl 项目中创建一个名为 MefExtension 的新文件夹。向其中添加以下文件：

文件名：DesignerExtensionMetaDataAttribute.tt

<#@ Dsl processor="DslDirectiveProcessor" requires="fileName='..\..\Dsl\DslDefinition.dsl'" #>
<#@ include file="Dsl\DesignerExtensionMetadataAttribute.tt" #>

文件名：GestureExtensionEnablement.tt

<#@ Dsl processor="DslDirectiveProcessor" requires="fileName='..\..\Dsl\DslDefinition.dsl'" #>
<#@ include file="Dsl\GestureExtensionEnablement.tt" #>

文件名：GestureExtensionController.tt

<#@ Dsl processor="DslDirectiveProcessor" requires="fileName='..\..\Dsl\DslDefinition.dsl'" #>
<#@ include file="Dsl\GestureExtensionController.tt" #>

将以下行添加到名为 DslPackage\Commands.vsct 的现有文件：
```
<Include href="MefExtension\CommandExtensionVSCT.vsct"/>
```
在现有 <Include> 指令后插入行。
打开 DslDefinition.dsl。
在 DSL 资源管理器中，选择“编辑器\验证”。
在“属性”窗口中，请确保至少一个名为 Uses 的属性为 true。
在“解决方案资源管理器”工具栏中，单击“转换所有模板”。

附属文件显示在添加的每个文件下方。
生成并运行解决方案以验证其是否仍在工作。

DSL 现已启用 MEF。可以将菜单命令、笔势处理程序和验证约束编写为 MEF 扩展。可以将这些扩展与其他自定义代码一起写入 DSL 解决方案中。此外，你或其他开发人员可以编写单独的 Visual Studio 扩展来扩展 DSL。

为启用了 MEF 的 DSL 创建扩展

如果你有权访问自己或其他人创建的启用了 MEF 的 DSL，你可以为它编写扩展。扩展可用于添加菜单命令、笔势处理程序或验证约束。若要创作这些扩展，请使用 Visual Studio 扩展 (VSIX) 解决方案。该解决方案包含两个部分：一个生成代码程序集的类库项目和一个打包程序集的 VSIX 项目。

创建 DSL 扩展 VSIX

创建新的“类库”项目。
在新项目中，添加对 DSL 程序集的引用。
- 此程序集的名称通常以“.Dsl.dll”结尾。
- 如果你有权访问 DSL 项目，可以在目录 Dsl\bin\* 下找到程序集文件
- 如果你有权访问 DSL VSIX 文件，则可以通过将 VSIX 文件的文件扩展名更改为“.zip”来查找程序集。解压缩.zip文件。
添加对下列 .NET 程序集的引用：
- Microsoft.VisualStudio.Modeling.Sdk.11.0.dll
- Microsoft.VisualStudio.Modeling.Sdk.Diagrams.11.0.dll
- Microsoft.VisualStudio.Modeling.Sdk.Shell.11.0.dll
- System.ComponentModel.Composition.dll
- System.Windows.Forms.dll
创建新的“VSIX 项目”项目。
在“解决方案资源管理器”中，右键单击 VSIX 项目，然后选择“设为启动项目”。
在新项目中，打开 source.extension.vsixmanifest。
单击“添加内容”。在对话框中，将“内容类型”设置为“MEF 组件”，将“源项目”设置为你的类库项目。
向 DSL 添加 VSIX 引用。
1. 在 source.extension.vsixmanifest 中，单击“添加引用”
2. 在对话框中，单击“添加有效负载”，然后找到 DSL 的 VSIX 文件。 VSIX 文件在 DSL 解决方案中的 DslPackage\bin\* 中生成。
  
  这允许用户同时安装 DSL 和你的扩展。如果用户已安装 DSL，则只会安装你的扩展。
查看和更新 source.extension.vsixmanifest 的其他字段。单击“选择版本”，并验证是否设置了正确的 Visual Studio 版本。
将代码添加到类库项目。使用下一部分中的示例作为指南。

可以添加任意数目的命令、笔势和验证类。
若要测试扩展，请按 F5。在 Visual Studio 的实验实例中，创建或打开 DSL 的示例文件。

为 DSL 编写 MEF 扩展

可以在单独的 DSL 扩展解决方案的程序集代码项目中编写扩展。还可以在 DslPackage 项目中使用 MEF，作为 DSL 的一部分编写命令、笔势和验证代码的简便方法。

若要编写菜单命令，请定义一个实现 ICommandExtension 的类，并使用 DSL 中定义的特性作为该类的前缀，名为 YourDslCommandExtension。可以编写多个菜单命令类。

每当用户右键单击关系图时，都会调用 QueryStatus()。它应检查当前选择并设置 command.Enabled 以指示命令何时适用。

using System.ComponentModel.Composition;
using System.Linq;
using Company.MyDsl; // My DSL
using Company.MyDsl.ExtensionEnablement; // My DSL
using Microsoft.VisualStudio.Modeling; // Transactions
using Microsoft.VisualStudio.Modeling.Diagrams.ExtensionEnablement; // IVsSelectionContext
using Microsoft.VisualStudio.Modeling.ExtensionEnablement; // ICommandExtension

namespace MyMefExtension
{
  // Defined in Dsl\MefExtension\DesignerExtensionMetaDataAttribute.cs:
  [MyDslCommandExtension]
  public class MyCommandClass : ICommandExtension
  {
    /// <summary>
    /// Provides access to current document and selection.
    /// </summary>
    [Import]
    IVsSelectionContext SelectionContext { get; set; }

    /// <summary>
    /// Called when the user selects this command.
    /// </summary>
    /// <param name="command"></param>
    public void Execute(IMenuCommand command)
    {
      // Transaction is required if you want to update elements.
      using (Transaction t = SelectionContext.CurrentStore
              .TransactionManager.BeginTransaction("fix names"))
      {
        foreach (ExampleShape shape in SelectionContext.CurrentSelection)
        {
          ExampleElement element = shape.ModelElement as ExampleElement;
          element.Name = element.Name + " !";
        }
        t.Commit();
      }
    }

    /// <summary>
    /// Called when the user right-clicks the diagram.
    /// Determines whether the command should appear.
    /// This method should set command.Enabled and command.Visible.
    /// </summary>
    /// <param name="command"></param>
    public void QueryStatus(IMenuCommand command)
    {
      command.Enabled =
        command.Visible = (SelectionContext.CurrentSelection.OfType<ExampleShape>().Count() > 0);
    }

    /// <summary>
    /// Called when the user right-clicks the diagram.
    /// Determines the text of the command in the menu.
    /// </summary>
    public string Text
    {
      get { return "My menu command"; }
    }
  }
}

笔势处理程序

笔势处理程序可以处理从 Visual Studio 内部或外部的任何位置拖到关系图上的对象。以下示例允许用户将文件从 Windows 资源管理器拖到关系图上。它创建包含文件名的元素。

可以编写处理程序来处理来自其他 DSL 模型和 UML 模型的拖动。有关详细信息，请参阅如何：添加拖放处理程序。

using System.ComponentModel.Composition;
using System.Linq;
using Company.MyDsl;
using Company.MyDsl.ExtensionEnablement;
using Microsoft.VisualStudio.Modeling; // Transactions
using Microsoft.VisualStudio.Modeling.Diagrams;
using Microsoft.VisualStudio.Modeling.Diagrams.ExtensionEnablement;
using Microsoft.VisualStudio.Modeling.ExtensionEnablement;

namespace MefExtension
{
  [MyDslGestureExtension]
  class MyGestureExtension : IGestureExtension
  {
    public void OnDoubleClick(ShapeElement targetElement, DiagramPointEventArgs diagramPointEventArgs)
    {
      System.Windows.Forms.MessageBox.Show("double click!");
    }

    /// <summary>
    /// Called when the user drags anything over the diagram.
    /// Return true if the dragged object can be dropped on the current target.
    /// </summary>
    /// <param name="targetMergeElement">The shape or diagram that the mouse is currently over</param>
    /// <param name="diagramDragEventArgs">Data about the dragged element.</param>
    /// <returns></returns>
    public bool CanDragDrop(ShapeElement targetMergeElement, DiagramDragEventArgs diagramDragEventArgs)
    {
      // This handler only allows items to be dropped onto the diagram:
      return targetMergeElement is MefDsl2Diagram &&
      // And only accepts files dragged from Windows Explorer:
        diagramDragEventArgs.Data.GetFormats().Contains("FileNameW");
    }

    /// <summary>
    /// Called when the user drops an item onto the diagram.
    /// </summary>
    /// <param name="targetDropElement"></param>
    /// <param name="diagramDragEventArgs"></param>
    public void OnDragDrop(ShapeElement targetDropElement, DiagramDragEventArgs diagramDragEventArgs)
    {
      MefDsl2Diagram diagram = targetDropElement as MefDsl2Diagram;
      if (diagram == null) return;

      // This handler only accepts files dragged from Windows Explorer:
      string[] draggedFileNames = diagramDragEventArgs.Data.GetData("FileNameW") as string[];
      if (draggedFileNames == null || draggedFileNames.Length == 0) return;

      using (Transaction t = diagram.Store.TransactionManager.BeginTransaction("file names"))
      {
        // Create an element to represent each file:
        foreach (string fileName in draggedFileNames)
        {
          ExampleElement element = new ExampleElement(diagram.ModelElement.Partition);
          element.Name = fileName;

          // This method of adding the new element allows the position
          // of the shape to be specified:
          ElementGroup group = new ElementGroup(element);
          diagram.ElementOperations.MergeElementGroupPrototype(
            diagram, group.CreatePrototype(), PointD.ToPointF(diagramDragEventArgs.MousePosition));
        }
        t.Commit();
      }
    }
  }
}

验证约束

验证方法由 DSL 生成的 ValidationExtension 特性以及由 ValidationMethodAttribute 标记。方法可以出现在任何未由特性标记的类中。

有关详细信息，请参阅域特定语言中的验证。

using Company.MyDsl;
using Company.MyDsl.ExtensionEnablement;
using Microsoft.VisualStudio.Modeling.Validation;

namespace MefExtension
{
  class MyValidationExtension // Can be any class.
  {
    // SAMPLE VALIDATION METHOD.
    // All validation methods have the following attributes.

    // Specific to the extended DSL:
    [MyDslValidationExtension]

    // Determines when validation is applied:
    [ValidationMethod(
       ValidationCategories.Save
     | ValidationCategories.Open
     | ValidationCategories.Menu)]

    /// <summary>
    /// When validation is executed, this method is invoked
    /// for every element in the model that is an instance
    /// of the second parameter type.
    /// </summary>
    /// <param name="context">For reporting errors</param>
    /// <param name="elementToValidate"></param>
    private void ValidateClassNames
      (ValidationContext context,
       // Type determines to what elements this will be applied:
       ExampleElement elementToValidate)
    {
      // Write code here to test values and links.
      if (elementToValidate.Name.IndexOf(' ') >= 0)
      {
        // Log any unacceptable values:
        context.LogError(
          // Description:
          "Name must not contain spaces"
          // Error code unique to this type of error:
          , "MyDsl001"
          // Element to highlight when user double-clicks error:
          , elementToValidate);
} } } }

通过

使用 MEF 扩展 DSL

使 DSL 能够由 MEF 扩展

为启用了 MEF 的 DSL 创建扩展

创建 DSL 扩展 VSIX

为 DSL 编写 MEF 扩展

菜单命令

笔势处理程序

验证约束

反馈

其他资源

通过

使用 MEF 扩展 DSL

使 DSL 能够由 MEF 扩展

为启用了 MEF 的 DSL 创建扩展

创建 DSL 扩展 VSIX

为 DSL 编写 MEF 扩展

菜单命令

笔势处理程序

验证约束

相关内容

反馈

其他资源