기본 콘텐츠로 건너뛰기

[ DSL ] Domain Specific Language - #2 DSL Authoring 솔루션 만들어 보기

아직 명확하게 DSL 특정 지우기에는 시기상조이기는 하지만 Visual Studio 에서 제공하는 DSL Tools 기능을 이용해서 솔루션을 만들어서 아주 간단하게 실체를 확인해 보도록 하자.

DSL Authoring Solution

  DSL 을 사용할 수 있도록 DSL 자체를 구성하는 작업을 “DSL Authoring” 이라고 한다. 즉, 배포된 DSL을 이용할 수 있도록 DSL 의 Shape, Connector 등의 기본 요소들을 구성하는 단계라고 보면 된다.

  이 작업을 위해서는 사용할 Visual Studio 버전에 맞는 “Visual Studio SDK” 가 미리 설치되어 있어야 한다. 설치가 되어 있다면 Visual Studio에서 새 프로젝트를 추가할 때 아래의 그림과 같이 “확장성” 부분이 있는 것을 볼 수 있다.


  "Domain-Specific Language Designer" 는 DSL 구성을 위한 프로젝트들로 구성된 솔루션을 만드는 템플릿이다. 프로젝트 이름과 위치를 설정한 후에 확인 버튼을 눌러서 계속 진행하면 프로젝트를 구성하기 위한 마법사가 진행된다.


  DSL 에 대한 Template 은 "Minimal"을 선택하고, DSL 이름은 "IssueStateModels" 라고 지정하도록 한다.

  위의 그림과 같이 DSL 을 구성하기 위한 여러 개의 템플릿들이 존재하는 것을 볼 수 있다. MSDN 에는 템플릿들에 대해서 아래의 표와 같이 설명하고 있다.

Template
Features
Description
Class Diagrams
  • Compartment shapes
  • Class inheritance
  • Relationship inheritance
  • Shape inheritance
  • Relationship properties
Use this solution template if your domain-specific language includes entities and relationships that have properties. This template creates a domain-specific language that resembles UML class diagrams. The main entities are classes and interfaces, together with association, generalization, and implementation relationships. A class or interface appears as a box that contains a list of attributes.
Component Diagrams
  • Ports
Use this solution template if your domain-specific language includes components, that is, parts of a software system. This template creates a domain-specific language that resembles UML component diagrams. The main entities are components and ports, which appear as small shapes on the outside of components.
Task Flow Diagrams
  • Image and geometry shapes
  • Swimlanes
Use this solution template if your domain-specific language includes workflows, states, or sequences. This template creates a domain-specific language that resembles UML activity diagrams. The main entity is an activity, and the main relationship is a transition between activities. The template includes several other elements such as start state, final state, and a synchronization bar.
Minimal Language
  • One class and shape
  • One relationship and connector
Use this solution template if your domain-specific language does not resemble the other templates. This template creates a domain-specific language that has two classes and one relationship, which are represented in the Toolbox as Box and Line. The class and the relationship each have an example string property.
Minimal WinForm Designer
  • A small model.
  • A Windows Form that displays the model.
Use this template if you want to build an application in which a DSL is bound to a Windows Form, rather than a graphical designer.
The form that acts as the user interface for the language is in the folder Dsl\UI.
You should build the project before opening the form designer.
Minimal WPF Designer
  • A small model
  • A Windows Presentation Foundation user interface that displays the model
Use this template if you want to build an application in which a DSL is bound to a WPF user interface, rather than a graphical designer.
The designer for the user interface is in the folder Dsl\UI.
You should build the project before opening the UI designer.
DSL Library
  • A minimal library
Use this template if you want to build a partial DSL definition that can be imported into other DSL definitions.

  위의 템플릿 설명에 따라서 작성하려고 하는 DSL 에 가장 근접하게 지원을 하는 템플릿을 선택하여 사용하면 된다. "다음" 버튼을 누르면 아래의 그림과 같이 새로운 모델을 생성했을 때 사용할 확장자를 결정하는 마법사 페이지가 나타난다.


  IssueStateModel 이라고 솔루션을 정했으므로 확장자는 위와 같이 "iss" 라고 임의로 정하도록 한다. "다음" 버튼을 누르면 아래의 그림과 같이 설정관련 마법사 페이지를 볼 수 있다.


  각각 새롭게 만든 DSL 을 의미하는 프로덕트의 이름과 회사명, Root Namespace 등을 임의대로 지정하고 "다음" 버튼을 누르면 아래의 그림과 같이 서명을 어떻게 할 것인지를 설정하는 마법사 화면이 나타난다.


  생성된 DSL 솔루션은 패키지 형태로 배포가 될 것이기 때문에 서명 처리가 필요한데, 별도의 서명 키가 없다면 새로 생성하도록 한다. "다음" 버튼을 누르면 전체 요약이 아래의 그림과 같이 보여진다.


  이제 "마침" 버튼을 누르면 아래의 그림과 같이 템플릿을 기준으로 생성된 솔루션과 DSL Designer 화면이 열려있는 것을 확인할 수 있다.

 

  왼쪽의 그림은 DSL 디자이너에 표현된 것들 중에서 왼쪽은 클래스와 연결선들, 오른쪽은 모양과 컨넥터들을 정의한 것들을 보여주고 있다. 오른쪽의 그림은 DSL Explorer 와 속성 창으로 DSL 모델과 모양들에 대한 구성과 각 항목들에 대한 속성들을 볼 수 있다. 그리고 두 번째 그림은 생성된 프로젝트로 DSL 이라는 프로젝트는 DSL Definition 을 위한 프로젝트이고, DSLPackage는 설치를 위한 패키지 프로젝트로 두 개의 프로젝트가 생성된 것을 확인할 수 있다.

  이렇게 생성된 프로젝트에 대해서 처리할 작업 대상은 아래와 같이 정리할 수 있다.
  • Issue State Designer - 작성된 DSL 을 이용할 사용자들이 사용할 수 있는 모델 정의 및 디자인
  • Code Generators - 모델에 따라서 코드를 생성할 수 있도록 하는 코드 템플릿
  • Serializer - 디자인된 모델을 파일 (*.iss) 로 저장하고 로드할 수 있도록 Serializer를 구성 (디자이너 뿐만 아니라 Generator 에서도 사용할 수 있도록)
  여기서 잠깐 정리하고 넘어가야 하는 것이 있다. 바로 "DSL 솔루션은 뭘까?" 라는 것이다.


위에서 확인한 것과 같이 "DSL", "DSLPackage" 라는 두 개의 프로젝트가 생성된 것을 알 수 있다. 이 중에서 DSL 프로젝트는 다음과 같은 기능을 제공해야 한다.
   * DSL 을 파일로 저장/로드 할 수 있는 Serializer/Deserializer 를 제공해야 한다.    * DSL Authoring 결과를 사용하는 어플리케이션에서 DSL 과 다이어그램에 대한 처리가 가능하도록 관련된 클래스들이 제공되어야 한다.    * DSL 이 처리될 때 코드를 생성할 수 있는 텍스트 템플릿을 구성할 수 있도록 지시 처리기를 제공해야 한다.    * Visual Studio 에서 DSL 을 편집할 수 있도록 필수적인 컴포넌트들을 제공해야 한다.
DSLPackage 프로젝트는 Visual Studio에서 DSL이 동작할 수 있도록 코드를 제공해야 한다. 그리고 다른 패키지 프로젝트와 동일한 기능들을 제공해야 한다.
   * 디자이너에서 열리는 DSL 파일 확장자 (*.iss)를 인식할 수 있도록 문서 처리기를 제공해야 한다.    * DSL 디자이너와 연동되는 메뉴 커맨드를 제공해야 한다.    * 새로운 DSL 인스턴스를 생성할 수 있도록 Item Template 을 제공해야 한다.
상기와 같이 각 프로젝트에는 "GeneratedCode" 라는 이름의 폴더가 존재한다. 이 폴더에는 확장자가 *.tt인 텍스트 템플릿 파일들이 존재한다. 이 파일들에 연결된 서브 항목을 열어보면 생성된 코드를 볼 수 있다. 대부분은 DSL Tools 가 설정된 폴더 밑에 있는 "TextTemplates" 파일을 Including 하는 형식으로 구성되어 있다. 모든 생성된 파일들은 "Dsl\DslDefinition.dsl" 로 부터 자동 생성된 것이다. 따라서 이 파일들을 수정해서 안 된다. 이후에 다시 생성되면 수정된 내용이 유실되기 때문이다.  이런 경우는 partial class 처리를 해서 수정된 내용을 유지할 수 있도록 하여야 한다.

  앞으로 하나씩 솔루션을 변경해서 원하는 기능들을 추가할 것이다. 지금은 단순히 F5를 눌러서 제대로 동작하는지만 검토해 보도록 한다. 당연한 말이지만 이 솔루션은 Visual Studio의 기능을 확장하는 것이기 때문에 Visual Studio 가 실행된다. 그리고 아래의 그림과 같이 DSL Model을 사용할 수 있도록 기본 솔루션이 생성되어 열린 것을 확인할 수 있다. 그리고 "Sample.iss" 와 "Test.iss" 파일이 존재한다. 이 파일들을 열어 보면 DSL 디자이너 화면이 나타나는 것을 볼 수 있다. ToolBox 를 열어 보면 DSL Authoring에서 구성한 요소들을 볼 수 있다.


  다음 게시 글에서는 실제로 DSL 을 정의하는 것부터 진행하도록 한다.

댓글

이 블로그의 인기 게시물

OData 에 대해서 알아보자.

얼마 전에 어떤 회사에 인터뷰를 하러 간 적이 있었다. 당시 그 회사는 자체 솔루션을 개발할 기술인력을 찾고 있었고 내부적으로 OData를 사용한다고 했다. 좀 창피한 이야기일 수도 있지만 나름 기술적인 부분에서는 많은 정보를 가지고 있다고 했던 것이 무색하게 OData란 단어를 그 회사 사장님에게서 처음 들었다. 작고, 단순한 사이트들만을 계속해서 작업을 하다 보니 어느덧 큰 줄기들을 잃어버린 것을 느끼기 시작했다. 명색이 개발이 좋고, 기술적인 기반을 만들려고 하는 인간이 단어조차도 모른다는 것은 있을 수 없는 것이라서 다시 새로운 단어들과 개념들을 알아보는 시간을 가지려고 한다. OData (Open Data Protocol) 란? 간단히 정리하면 웹 상에서 손쉽게 데이터를 조회하거나 수정할 수 있도록 주고 받는 웹(프로토콜)을 말한다. 서비스 제공자 입장에서는 웹으로 데이터를 제공하는 방식으로 각 포탈 사이트들이 제공하는 OPEN API 포맷을 독자적인 형식이 아니라 오픈된 공통규약으로 제공 가능하며, 개발자는 이 정보를 다양한 언어의 클라이언트 라이브러리로 어플리케이션에서 소비할 수 있도록 사용하면 된다. 공식 사이트는 www.odata.org 이며 많은 언어들을 지원하고 있다. 좀더 상세하게 정의를 해 보면 OData는 Atom Publishing Protocol  (RFC4287) 의 확장 형식이고 REST (REpresentational State Transfer) Protocol 이다. 따라서 웹 브라우저에서 OData 서비스로 노출된 데이터를 볼 수 있다. 그리고 AtomPub 의 확장이라고 했듯이 데이터의 조회만으로 한정되는 것이 아니라 CRUD 작업이 모두 가능하다. Example 웹 브라우저에서 http://services.odata.org/website/odata.svc 를 열어 보도록 하자. This XML file does not appear to have any style in...

C# 에서 Timer 사용할 때 주의할 점.

예전에 알고 지내시던 분의 질문을 받았다. Windows Forms 개발을 하는데, 주기적 (대략 1분)으로 데이터 요청을 하는 프로그램을 작성하기 위해서 Timer 를 사용하는데, 어떤 기능을 처리해야 하기 때문에 Sleep 을 같이 사용했다고 한다. 여기서 발생하는 문제는 Sleep 5초를 주었더니, Timer 까지 5초 동안 멈춘다는 것이다. Timer 라는 것은 기본적으로 시간의 흐름을 측정하는 기능이기 때문에 Sleep 을 했다고 해서 Timer 가 멈추는 일은 생겨서는 안된다. 그러나 실제 샘플을 만들어 보면 ... Timer 가 Sleep 만큼 동작이 멈추는 것을 확인할 수 있다. Windows Forms 는 UI Thread 를 사용하는 것으로 최적화 되어 있으며 여기서 Timer 를 쓰면 UI Thread 에 최적화된 System.Windows.Forms.Timer 가 사용된다. 여기서 문제의 발생이 시작되는 것이다. Sleep 을 사용하게 되면 UI Thread 가 Sleep 이 걸리기 때문에 여기에 속한 Timer 까지도 멈추는 것이다. 이런 문제를 해결하기 위해서는 System.Threading.Timer 를 사용해야 한다. 이 Timer 는 별도의 Thread 에서 동작하기 때문에 Sleep 의 영향을 받지 않는다. 언뜻 보면 쉬운 해결 방법인 것 같지만 Thread 가 분리되었기 때문에 Timer 가 돌아가는 Thread 에서 UI Thread 의 메서드나 컨트롤에 접근하기 위해서는 별도의 명령을 사용해야 하는 문제가 존재한다. 자~ 그럼 여기서 Timer 에 대해서 다시 한번 정리해 보도록 하자. .NET 에서 제공하는 Timer 들 .NET 에서는 기본적으로 3가지 Timer를 제공하고 있다. (MSDN) System.Windows.Forms.Timer - 사용자가 지정한 간격마다 이벤트를 발생시키며 Windows Forms 응용 프로그램에서 사용할 수 있도록 최적화 되어 있다. System...

[Logging] NLog 사용법 정리...

SCSF 에는 기본적으로 Enterprise Library가 사용된다. 예전에도 그랬지만 기능은 훌륭하고 많은 부분에서 최적화(?)된 것일지도 모르지만, 역시나 사용하기에는 뭔가 모르게 무겁고, 사용하지 않는 기능이 더 많다라는 느낌을 지울수가 없다. 이번 프로젝트도 SCSF를 기반으로 하고 있지만, Enterprise Library를 걷어내고 각 부분에 전문화된 오픈 소스를 사용하기로 하였다. 예전에는 Log4Net을 사용했지만, 대량 사용자 환경에서는 메모리 누수와 기타 문제점이 존재한다는 MS 컨설턴트(?)의 전해진 말을 들은 후로는 사용하지 않는다. 대안으로 사용하는 것이 NLog 이다. 조금 후에는 3.0 버전도 나온다고 홈 페이지에 기재되어 있지만, 그 때가 되면 프로젝트는 끝나기 때문에 현재 2.1.0 버전을 사용하기로 했다. [원본 출처] http://cloverink.net/most-useful-nlog-configurations-closed/ 위의 참조 자료에는 다양한 정보들이 존재하므로 꼭 링크를 통해서 관련된 정보를 확인하고 이해하는 것이 좋을 듯 하다. 여기서는 당장 필요한 부분만을 정리하도록 한다. [ Logger 찾기 ] 기본적으로 Logger가 존재하는 클래스를 기반으로 Logger 정보를 구성한다. Logger logger = LogManager.GetCurrentClassLogger(); 주로 Namespace 기반으로 Logger를 설정하는 경우에 유연하게 사용할 수 있다. 또 다른 방법으로는 지정한 문자열로 특정 Logger를 직접 선택하는 방법도 제공된다. 이를 혼용해서 Namespace와 직접 지정 방식을 같이 사용할 수도 있다. 물론 Logger 환경 설정에서 Wildcard (*)를 지정할 수도 있다. Logger logger = LogManager.GetLogger("Database.Connect"); Logger logger = LogManager.Get...