기본 콘텐츠로 건너뛰기

[VSIX] Visual Studio 확장에 대해서... #4 Wizard 추가

Add a wizard on template

이전 게시글에서 메뉴와 명령 처리를 설정해서 검증하였다. 이번에는 INI 파일을 단순히 추가하던 기능에 추가하는 과정에서 Culture 정보를 선택할 수 있는 화면을 제공하고 이 화면에서 선택된 Culture를 추가된 파일에 적용하는 구성을 알아보도록 한다.

즉, 쉽게 이야기를 하면 기존 템플릿 처리는 Visual Studio의 내장 마법사를 통해서 처리를 했지만, 이번에는 사용자 정의 마법사 (Custom Wizard)를 구동시켜서 템플릿에 추가적인 정보를 제공할 수 있도록 한다는 것이다.

Add a library project

Wizard 는 Visual Studio 에서 호출이 되기 때문에 관련된 정보가 vstemplate 파일에 지정되어야 한다. 따라서 별도의 클래스 라이브러리 프로젝트를 추가하여 작업을 하도록 한다.
프로젝트 생성은 따로 설명을 하지 않고 순차적인 처리를 정리해 놓도록 한다.
  • FDTWorksTool.Library 라는 이름의 클래스 라이브러리 프로젝트 (나중에 WPF UI 를 추가할 것이다) 를 생성한다.
  • 자동으로 생성된 클래스 파일은 지운다.
  • 프로젝트를 선택하고 "기존 항목 추가"를 선택하여 서명할 키 파일을 앞에서 생성했던 FDTWorksTool 패키지 프로젝트 경로를 이동하여 "*.snk" 파일을 링크로 추가한다.
  • 프로젝트 속성 창을 열고 "서명" 섹션에서 방금 등록한 snk 파일을 지정하도록 한다.
  • 참조에 "Microsoft.VisualStudio.TemplateWizardInterface" 어셈블리를 추가한다.
아래의 그림은 생성된 클래스 라이브러리 프로젝트를 보여주고 있다.


Modify package project

패키지 프로젝트에서는 Wizard를 사용할 수 있도록 위에서 만든 Library 를 추가해 주어야 한다.
  • 참조에 Library Project를 추가한다.
  • 전체 빌드를 수행한다.
프로젝트 추가에 따른 기본적인 작업은 위의 단계를 수행하면 된다. 이제 부터는 실제 사용을 위한 설정들을 하여야 하는데, vsixmanifest 파일에 위의 Library 프로젝트를 포함시키기 위해서는 서명된 어셈블리의 전체 이름을 적어 주어야 한다. 그러나 서명된 PublicKeyToken을 모르기 때문에 빌드된 경로에서 다음의 명령을 수행해서 확인해야 한다.

sn -T FDTWorksTool.Library.dll

또는 이전에 게시했던 글에서 설명한 것과 같이 Visual Studio에 외부 툴을 등록해 놓았다면 쉽게 알아낼 수도 있다. 위의 명령을 통해서 알아낸 정보를 기준으로 vsixmanifest 파일에 아래와 같이 추가해 주도록 한다.

<asset type="Microsoft.VisualStudio.Assembly" path="FDTWorksTool.Library.dll" assemblyname="FDTWorksTool.Library, Version=1.0.0.0, Culture=neutral, PublicKeyToken=7004626c205960e6"></asset>

*** 단, Visual Studio 에서 제공하는 vsixmanifest 관리자를 사용해서 처리하는 경우는 꼭 위와 같이 할 필요는 없다. (위의 예제는 수동으로 설정하는 것을 기준으로 하고 있다)

Creating the wizard dialog

지금까지 작업으로 패키지와 마법사가 위치할 라이브러리 프로젝트도 생성하고 설정하였으므로 이제는 실제 사용할 마법사 화면을 구성해 보도록 한다.

요즘은 WPF 를 사용하는 빈도가 높으니 WPF 로 화면을 아래와 같이 구성해 보도록 한다. "새 항목 추가" 를 통해서 "WPF Windows" 를 추가하고 파일의 이름은 "IniWizardDialog.xaml" 이라고 지정한다. 그리고 생성된 기본 XAML 파일을 아래의 그림과 같이 구성하도록 한다. (예제에서는 "Wizards" 라는 폴더를 추가하고 그 밑에 생성한 것이다, 그리고 관련된 XAML 어셈블리도 참조에 추가해 주어야 한다)


위의 코드에서 명시한 것과 같이 실제 동작 처리는 Code Behind (FDTWorksTool.Library.Wizards.IniWizardDialog.xaml.cs)에서 처리를 한다.

만들어진 XAML 태그를 보면 알 수 있는 것처럼 ComboBox를 사용하고 있다. 단순하게 Value/Text 쌍의 데이터를 바인딩하고 싶은데 XAML 에서 제공하는 것은 UI 관련해서 설정이 복잡하므로 단순한 클래스를 하나 만들어서 처리하도록 한다.

새로운 클래스를 추가하고 이름을 "ComboItemPair.cs"로 지정하고 아래의 그림과 같이 코드를 구성하도록 한다.


Key 는 실제 선택되었을 때 사용할 값이고, Description은 ComboBox 에 보여줄 정보라고 생각하면 된다.

이제 XAML 파일의 Code Behind 코드를 아래의 그림과 같이 마무리를 해 주도록 한다.


Creating the wizard

마법사로 사용할 화면도 완성이 되었으므로 Visual Studio가 패키지에서 추가한 마법사를 인식하고 사용할 수 있도록 Wizard 를 만들고 설정해 주어야 한다.

위에서 만들었던 라이브러리 프로젝트를 선택하고 참조에 아래와 같은 최소한 2개의 참조가 있는지 확인한다. 없다면 추가하도록 한다.

  • Microsoft.VisualStudio.TemplateWizardInterface - IWizard 인터페이스
  • EnvDTE - Visual Studio IDE

참조 설정이 끝났으면 "새 항목 추가" 를 통해서 클래스 파일을 "IniWizard.cs" 라는 이름으로 추가하고 아래의 그림과 같이 코드를 작성하면 된다.


아주 단순한 마법사이기 때문에 IWizard의 모든 메서드를 다 구현하지 않아도 된다. 필수적인 몇 가지만 구현해도 기본적인 처리는 가능하다. 위의 코드 중에서 잘 보아야 하는 부분은 다음과 같다.

  • replacementsDictionary - 템플릿 내에서 Visual Studio 가 제공하는 변수들과 치환하기 위한 정보이므로 여기에 추가적인 값들을 포함시켜서 템플릿 파일로 전달할 수 있다.
  • "$iniSelectedCulture$" 라는 이름으로 마법사 다이얼로그에서 사용자가 선택한 값이 전달될 수 있도록 replacementDictionary 에 추가했다.
이제 추가된 사용자 선택 값을 사용하기 위해서는 INIParserTemplate 프로젝트에 존재하는 iniTemplate.tini 파일을 열어서 다음과 같이 설정하면 값이 치환된다.


이제 배포되고 사용될 때 Visual Studio 가 마법사를 인식할 수 있도록 설정만 하면 된다. INIParserTemplate 프로젝트에서 .vstemplate 파일을 열고 아래의 그림과 같이 마법사에 대한 정보를 설정해 주도록 한다.



모든 작업이 완료되었으므로 실행을 해서 "새 항목 추가"를 해 보면 아래의 그림과 같이 마법사 다이얼로그가 나타나는 것을 확인할 수 있다.


그리고 OK 버튼을 누르면 아래의 그림과 같이 환경 설정에 사용할 INI 파일이 생성된 것을 확인할 수 있다.


댓글