MEF를 사용하여 DSL 확장
MEF(Managed Extensibility Framework)를 사용하여 DSL(도메인 특정 언어)을 확장할 수 있습니다. 사용자 또는 다른 개발자는 DSL 정의 및 프로그램 코드를 변경하지 않고도 DSL용 확장을 작성할 수 있습니다. 이러한 확장에는 메뉴 명령, 끌어서 놓기 처리기 및 유효성 검사가 포함됩니다. 사용자는 DSL을 설치한 다음 필요에 따라 확장을 설치할 수 있습니다.
또한 DSL에서 MEF를 사용하도록 설정하면 DSL을 사용할 때 DSL의 기능 중 일부를 작성하는 것이 더 쉬울 수 있습니다.
MEF에 대한 자세한 내용은 MEF(Managed Extensibility Framework)를 참조하세요.
MEF에서 DSL을 확장할 수 있도록 설정하는 방법
DslPackage 프로젝트 내에 MefExtension이라는 새 폴더를 만듭니다. 다음 파일을 추가합니다.
파일 이름:
CommandExtensionVSCT.ttImportant
이 파일의 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 탐색기에서 Editor\Validation을 선택합니다.
속성 창에서 사용하는 속성 중 하나 이상인지 확인합니다
true.솔루션 탐색기 도구 모음에서 모든 템플릿 변환을 클릭합니다.
보조 파일은 추가한 각 파일 아래에 나타납니다.
솔루션을 빌드 및 실행하여 계속 작동하는지 확인합니다.
이제 MEF 지원 DSL을 사용할 수 있습니다. 메뉴 명령, 제스처 처리기 및 유효성 검사 제약 조건을 MEF 확장으로 작성할 수 있습니다. DSL 솔루션에서 다른 사용자 지정 코드와 함께 이러한 확장을 작성할 수 있습니다. 또한 사용자 또는 다른 개발자는 DSL을 확장하는 별도의 Visual Studio 확장을 작성할 수 있습니다.
MEF 지원 DSL에 대한 확장 만들기
직접 만든 MEF 지원 DSL에 대한 액세스 권한이 있는 경우 이를 위한 확장을 작성할 수 있습니다. 확장은 메뉴 명령, 제스처 처리기 또는 유효성 검사 제약 조건을 추가하는 데 사용할 수 있습니다. 이러한 확장을 작성하려면 VSIX(Visual Studio 확장) 솔루션을 사용합니다. 이 솔루션에는 두 부분, 즉 코드 어셈블리를 빌드하는 클래스 라이브러리 프로젝트와 어셈블리를 패키지하는 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 참조를 추가합니다.
source.extension.vsixmanifest에서 참조 추가를 클릭합니다.
대화 상자에서 페이로드 추가를 클릭한 다음 DSL의 VSIX 파일을 찾습니다. VSIX 파일은 DSL 솔루션의 DslPackage\bin\*에 빌드됩니다.
이를 통해 사용자는 DSL 및 확장을 동시에 설치할 수 있습니다. 사용자가 이미 DSL을 설치한 경우에는 확장만 설치됩니다.
Source.extension.vsixmanifest의 다른 필드를 검토하고 업데이트합니다. 버전 선택을 클릭하고 올바른 Visual Studio 버전이 설정되어 있는지 확인합니다.
클래스 라이브러리 프로젝트에 코드를 추가합니다. 다음 섹션의 예제를 가이드로 사용합니다.
원하는 수의 명령, 제스처 및 유효성 검사 클래스를 추가할 수 있습니다.
확장을 테스트하려면 F5 키를 누릅니다. Visual Studio 실험적 인스턴스에서 DSL의 예제 파일을 만들거나 엽니다.
DSL용 MEF 확장 작성
별도의 DSL 확장 솔루션의 어셈블리 코드 프로젝트에 확장을 작성할 수 있습니다. DSL의 일부로 명령, 제스처 및 유효성 검사 코드를 작성하는 편리한 방법인 DslPackage 프로젝트에서 MEF를 사용할 수도 있습니다.
메뉴 명령
메뉴 명령을 작성하려면 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);
} } } }
관련 콘텐츠
피드백
출시 예정: 2024년 내내 콘텐츠에 대한 피드백 메커니즘으로 GitHub 문제를 단계적으로 폐지하고 이를 새로운 피드백 시스템으로 바꿀 예정입니다. 자세한 내용은 다음을 참조하세요. https://aka.ms/ContentUserFeedback
다음에 대한 사용자 의견 제출 및 보기