플러그인 개발 기초 학습, Part 1: 기본 요소

목차

• 만들기부터 시작하자
• 수정
• 테스트와 디버깅
• 문자열 외부화하기
• manifest 정리하기
• 결론
• 참고자료
• 필자소개
• 의견

플러그인 개발 101 연재는 순전히 플러그인 개발에 관한 것이다. 그러나 본격적으로 시작하기 전에, 플러그인 개발을 할 수 있는 적당한 환경을 갖추었는지 확인할 필요가 있다. 먼저 할 일은 Eclipse.org에서 플러그인 개발 환경(Plug-in Development Environment: PDE)을 갖춘 이클립스 배포판을 다운로드하는 것이다. 이클립스 클래식 최신 버전 다운로드를 권장한다. 이 연재에서는 이클립스 V3.4(M5) 마일스톤 배포판을 사용할 것이다. 이 작업만 완료하면, 시작할 준비가 끝난 것이다(참고자료에서 이클립스를 어디서 찾을 수 있는지 익히고 만약 이클립스를 처음 접한다면 추가적인 배경 지식을 얻길 바란다).

플러그인 개발을 쉽게 이해하기 위해, 본 기사는 그림 1에 있는 작업 흐름도를 따를 것이다. 본 기사의 Part 1에서는 작업 흐름도 중 처음 다섯 개 과정을 살펴볼 것이다. 나머지는 Part 2에서 살펴볼 것이고 리치 클라이언트 애플리케이션(rich-client application)을 집중적으로 다룰 것이다.

플러그인 생성을 자세히 살펴보기 전에, 정확하게 플러그인이 무엇인지 논의해보자. 기술적으로, 플러그인은 독립적으로 실행 가능하며(self-contained) 자기 서술적인(self-describing) JAR(Java™ Archive)다. 플러그인을 실행하는 데 필요한 코드와 리소스를 묶고 있기 때문에 독립적으로 실행할 수 있다. 자신이 무엇이며, 세상으로부터 무엇을 필요로 하는지, 그리고 세상에 무엇을 기여할지에 대한 정보를 가지고 있기 때문에 자기 서술적이다. 플러그인 내부에서 보통 MANIFEST.MF와 plugin.xml 두 개의 서술 파일을 볼 수 있다.

만들기부터 시작하자

플러그인 개발 작업 흐름도의 첫 번째 부분은 플러그인 프로젝트 만들기다. 이클립스에서, New >Project... 메뉴 옵션을 사용하여 쉽게 이 작업을 할 수 있다. 마법사가 보이면, 생성하고자 하는 프로젝트 타입에Plug-in Project를 선택한다.

다른 이클립스 프로제트와 마찬가지로, 마법사는 프로젝트 이름을 입력하라고 요구한다. helloworld라고 하겠다. 그리고 타깃 플랫폼을 선택할 수 있는 옵션이 있다. 해당 문맥에서 타깃 플랫폼이란 단순하게 특정 이클립스 버전 용도인지 Equinox와 같은 OSGi 플랫폼 용도인지를 의미한다. 이 경우, 간단하게 이클립스 3.3 버전을 타깃으로 했다. 새 플러그인 프로젝트 마법사 다음 페이지는 플러그인 내용에 대한 것이다.

우리가 만들 플러그인을 이클립스에서 사용할 수 있게 하려면, 플러그인 내용 마법사 페이지에서 반드시 폼을 작성해야 한다. 플러그인 식별자는 여러분의 플러그인을 식별할 수 있는 유일한 값을 타나내는 필드다. 다른 어떤 플러그인도 같은 식별자를 사용할 수 없다. 플러그인 버전은 네 부분으로 나뉘어 있다(세 개의 숫자와 문자열 하나). 각각은 major.minor.service.qualifier로 구성된다(참고자료에서 이크립스 플러그인 버전 정하기 가이드를 참조하라). 플러그인 이름은 사람들이 읽기 편한 간단한 이름을 준다. 플러그인 제공자 필드는 플러그인 작성자에 대한 정보를 사람들이 읽기 편한 형태로 기입한다. 간략하게, 실행 환경(EE) 필드는 여러분의 번들을 실행할 수 있는 최소한의 JRE를 명시한다(참고자료).

마법사는 플러그인 활성자(activator)를 설정할 수 있는 옵션을 제공한다. 플러그인 활성자는 단순한 클래스로 플러그인 생명 주기를 제어한다(start-and-stop 메서드처럼 생각하라). 보통, 활성자를 사용하여 기본 설정을 하고 플러그인이 더 이상 필요 없어질 때 자원을 반납하는 용도로 사용한다. 여기서는, 활성자를 사용하여 플러그인이 사용할 UI를 만들도록 하여, RCP(Rich-Client Platform) 애플리케이션을 만들 것이다(참고자료 참조).

플러그인 생성 마지막 단계는 새 플러그인이 기반으로 할 템플릿(그림 4 참조)을 선택하는 것이다. 플러그인 생성에 익숙하다면 이 단계는 보통 생략할 것이다. 하지만, 처음 접하는 사람들은 어느 정도 시작점이 필요하다. 따라서 이클립스 SDK는 다양한 템플릿을 제공하여 쉽게 시작할 수 있도록 하고 있다. 여기서는, 기본 Hello World with a view 애플리케이션을 선택한다.

위로

수정

앞선 단계를 마친 다음, 새로운 플러그인이 워크스페이스에 추가됐을 것이다. 그리고 현재 새로 만든 플러그인을 다룰 때 도움을 주는 편집기(그림 5 참조)가 보일 것이다. 편집기의 첫 번째 페이지는 개요(Overview) 페이지다. 이 페이지에는 수정 가능한 플러그인 식별자를 포함하여 플러그인과 관련된 여러 가지 편집 가능한 목록을 가지고 있다. 예를 들어, 이전에 정의했던 식별자(ID)와 버전 필드 그리고 그림 4에서 살펴봤던 템플릿이 있다.

확장 기능과 확장 지점

플러그인 탐험하기 다음 단계는 확장 기능을 추가하는 것을 살펴보겠다. 하지만 자세히 살펴보기 전에, 먼저 확장 가능한 이클립스 플러그인과 관련된 두 가지 중요한 개념을 살펴보자. 간단하게 비유하자면, 확장 기능(extension)은 플러그로 확장 지점(extension point)은 소켓으로 생각할 수 있다. 각각의 확장 지점은 유일하고 적용하기 위해 필요한 조건을 정의하고 있다. 예를 들어, 이클립스는 org.eclipse.ui.editors 확장 지점(소켓)에 우리가 만든 편집기(플러그)를 끼워넣고 사용할 수 있다.

여기서는, 이클립스 도구 모음에 추가할 새로운 확장 기능을 만들 것이다. 그러기 위해 org.eclipse.ui.actionSets 확장 지점에 해당하는 템플릿(앞에서 플러그인을 만들 때 사용한 템플릿과 비슷한 개념)을 사용할 것이다. 플러그인 편집기의 개요 페이지에서 Extension/Extension Point Content 섹션에 있는 Extensions 링크를 선택한다. Add...를 클릭하고 기본값이 채워진 상태로 org.eclipse.ui.actionSets 템플릿(그림 6 참조)을 선택한다.

런타임

플러그인에서 중요한 부분으로 자기 서술을 하는 부분이다. 플러그인이 반드시 서술해야 하는 것 중 하나는 외부에 제공하느냐다. 이클립스 문맥에서 이를 공개한 패키지들(exported packages)이라고 한다. 우리의 플러그인에서, 다른 플러그인들이 우리 플러그인 내부에 의존하는 패키지들을 참조할 수 있도록 다른 플러그인들에게 어떤 패키지들을 공개할지 결정해야 한다. 또한 공개한 패키지들을 내부에서만 사용할 것으로 설정할 수도 있는데, 이것은 플러그인 개발자들에게 해당 패키지들은 API로 생각하고 있지 않다고 말하는 것과 같다. 공개한 패키지들을 설정하려면, manifest 편집기에 있는 런타임(Runtime) 페이지를 이용한다.

의존성

앞선 절에서, 플러그인이 반드시 자신의 기능을 세상에 알리기 위해 해야 하는 일을 설명했다. 자, 이제 다른 플러그인에서 앞에서 말한 기능을 사용하고 싶다고 상상해보자. 해당 기능을 사용하고 싶다는 것을 어떻게 표현할 것인가? 이클립스 문맥에서는 의존성(dependencies)으로 표현한다. 가장 간단한 경우, 플러그인들이 다른 플러그인에 의존할 수 있다. 예를 들어, 만약 여러분의 편집기를 이클립스에서 사용하고 싶다면,org.eclipse.ui.editors 플러그인에 의존해야 할 것이다. 의존성을 기술하려면, 플러그인 편집기의 의존성(Dependencies) 페이지를 사용해야 한다.

다른 플러그인에 의존할 때 알아야 할 것은, 플러그인들이 공개한 패키지들에만 선택할 수 있다는 것이다(의존성 페이지의 불러올 패키지(Imported Packages) 부분을 참조하라). 이 부분은 더 어려운 주제인데 여러분의 플러그인이 특정 구현체에 묶이는 것을 원하지 않을 때 유용하다. 예를 들어, XML 파서가 제공하는 com.company.xml.parser 패키지에 의존한다고 생각해보자. 이 때 각기 다른 환경에서 사용할 수 있는 두 개의 플러그인 com.company.xml.parser.mobile과 com.company.xml.parser.desktop 이라는 동일한 XML 파서의 서로 다른 구현체를 머리속에 떠올려보자.

소스 편집기

런타임과 의존성 페이지는 MANIFEST.MF 파일에 기술되어 있는 중요 정보를 가시화해 보여준 것이다. 이 파일 소스를 직접 편집하고자 하는 고급 사용자들을 위해, PDE는 소스 편집기를 제공한다. 소스 편집기는 플러그인 manifest 정의에 사용하는 다양한 헤더에 코드 완성 기능을 제공한다.

위로

테스트와 디버깅

플러그인 탐험 다음 단계는 테스트와 디버깅이다. 플러그인 테스트 용도로, 이클립스와 PDE는 자기 호스팅(self-hosting)이라는 개념을 가지고 있다. 자기 호스팅은 간단하게 현재 작업하는 플러그인을 탑재한 새로운 이클립스를 실행하는 것을 말한다. 물론 이 과정에서 실제로는 어떤 플러그인도 공개하거나 배포하지 않는다. 새로운 이클립스를 실행하려면, 개요 페이지에서 테스팅(Testing) 부분(개요 페이지에 있는 Launch an Eclipse application 참조)에서 새로운 런타임 워크벤치를 시작하면 된다. 몇 초 후에, 여러분의 플러그인 샘플 액션이 도구 모음에 추가된 채 새로운 워크벤치 팝업이 뜨는 걸 볼 수 있을 것이다.

디버그 모드에서 자기 호스팅 상태의 플러그인을 실행하려면, 개요 페이지의 테스팅 섹션에서 Launch an Eclipse application in debug mode 링크를 클릭하면 된다. 실제로 여러분의 플러그인을 디버깅하려면, 관련된 중단점을 설정할 필요가 있다. 이클립스에서 디버깅을 처음 해본다면, developerWorks 기사 "Debugging with the Eclipse Platform"을 추천한다. 이 문서가 처음해보는 독자들에게 도움이 될 것이다(참고자료 참조).

플러그인 실행이나 디버깅에 대해 더 상세한 옵션을 설정하려면, 실행 설정(Launch Configuration) 창으로 이동한다. 이 창은 Run > Run Configurations... 메뉴 옵션을 선택하면 볼 수 있다. 여러분의 플러그인과 관련 있는 실행 설정 타입은 "Eclipse Application"이다. 우리가 실제 실행하고 싶은 것이 이클립스 애플리케이션이기 때문이다(그림 11 참조). 실행 설정에서, 여러분은 인자와 같은 것들을 설정할 수 있으며 애플리케이션을 실행할 때 사용할 JRE를 제어할 수 있다.

위로

문자열 외부화하기

플러그인 개발에서 가장 흔히 하는 작업이 국제화다. 여러분의 플러그인이 유용하고 많은 사람이 사용하면, 여러분의 플러그인을 여러 언어 환경에서 동작할 수 있도록 해달라는 요청을 받게 될 것이다. 고맙게도, 플러그인과 관련된 문자열을 외부화할 때 필요한 상당량의 작업이 최소화되었다. PDE 안에서 플러그인 개요 페이지에서 마우스 오른쪽 버튼을 클릭하고 Externalize Strings... 메뉴 아이템을 선택하면 마법사를 볼 수 있다. 선택하면, 외부화와 관련된 모든 문자열을 보여주는 화면을 볼 수 있다.

실제로, 이것은 plugin.properties 파일(외부로 빼낸 문자열들을 담고 있다)을 플러그인 내부에 생성하고 MANIFEST.MF 파일에Bundle-Localization 헤더를 추가한다. Bundle-Localization 헤더를 사용하여 간단하게 외부화한 문자열들의 이름과 부가적인 위치를 설정할 수 있다. 여기서는, Bundle-Localization에 "plugin,"이라고 설정했는데, 이것은 다양한 지역의 문자열이 plugin.properties(그림 13 참조), plugin_fr.properties, plugin_de.properties 같은 파일에 존재할 수 있다는 것을 뜻한다. 파일 이름에서 밑줄 다음에 오는 문자는 지역 정보를 나타낸다.

이게 다다! 플러그인과 관련된 국제화와 관련된 모든 것을 살펴봤다. 좀 더 많은 정보를 원한다면, 다소 오래되긴 했지만 여전히 유효한 이클립스 코너의 기사 "How to Internationalize your Eclipse Plug-in" 과 "How to Test Your Internationalized Eclipse Plug-In"을 추천한다(참고자료 참조).

위로

manifest 정리하기

우리 여행의 다음 목적지는 manifest 파일들(MENIFEST.MF와 plugin.xml)을 몇 가지 베스트 프랙티스로 정리하는 것이다. PDE는 개요 페이지의 Exporting 섹션을 통해 그와 관련된 편리한 마법사를 제공한다. 마법사가 뜨면(그림 14 참조), 선택할 수 있는 다양한 옵션이 보일 것이다. 기본값들이 보통 타당하지만, plugin.properties 파일에 키값이 없는지 확인하는 것과 같은 특정 옵션들이 있을 수 있는데 이것들이 매우 유용하다.

위로

결론

전체적으로, 본 기사의 미션은 몇몇 베스트프랙티스를 기반으로 플러그인 개발 기본 요소를 소개하는 것이다. 우리는 샘플 플러그인을 만들고 일반적인 플러그인 개발 작업 흐름도를 통해 이를 달성했다. 작업 흐름도를 다 익히고 나면, 플러그인을 개발하는 것이 더 쉬워질 것이고 Organize Manifest 마법사와 같이 베스트프랙티스를 사용하여 유지보수 할만큼 익숙해질 것이다. Part 2에서는 리치 클라이언트 애플리케이션 개발을 할 때 이용할 수 있는 도구 사용법과 그림 1에서 살펴보았던 플러그인 개발 작업 흐름도 나머지 부분들을 끝낼 것이다.

참고자료

교육

• OSGi Alliance에 대해 공부하라.
  
  
• 이클립스 재단 위키에 있는 Eclipse Plug-in Versioning을 학습하라.
  
  
• 이클립스 재단 위키에 있는 Eclipse EE guide를 참조하라.
  
  
• Eclipse Rich Client Platform을 공부하라.
  
  
• 이클립스 SDK를 더 자세히 알고 싶다면, 이클립스 재단 문서 "Platform Extension Points"를 참조하라.
  
  
• 이클립스에서 디버깅하는 데 도움이 필요한가? "Eclipse 플랫폼에서의 디버깅"을 참조하라.
  
  
• 플러그인 국제화와 관련된 좋은 배경 지식을 이클립스 재단 기사 "How to Internationalize your Eclipse Plug-In"과 "How to Test Your Internationalized Eclipse Plug-In"을 참조할 수 있다.
  
  
• "Eclipse 추천 도서 리스트"를 확인하라. 
  
  
• developerWorks에서 모든 이클립스 기사를 검색하라.
  
  
• 이클립스를 처음 사용하는가? developerWorks 기사 "Eclipse Platform 시작하기"를 참조하여 그 기원과 아키텍처 그리고 플러그인을 사용하여 어떻게 이클립스를 확장할 수 있는지 학습하라.
  
  
• IBM developerWorks의 Eclipse 프로젝트 리소스를 확인하고 이클립스 실력을 높이라.
  
  
• 소프트웨어 개발자들의 흥미로운 인터뷰와 논의에 관심이 있다면, developerWorks 포드캐스트를 확인하라.
  
  
• developerWOrks의 기술 행사와 웹 캐스트를 통해 최신 정보를 유지하라.
  
  
• IBM과 오픈 소스 기술들 그리고 무료로 사용할 수 있는 제품 기능에 대해 developerWorks On demand demos에서 보고 학습하라.
  
  
• IBM 오픈 소스 개발자들이 관심있어 하는 전 세계의 커퍼런스, 전시회, 웹 캐스트와 그 외 각종 행사를 확인하라.
  
  
• 한국 developerWorks 오픈 소스 영역을 방문하여 방대한 양의 하우투 문서, 도구 그리고 오픈 소스 기술을 사용하여 개발하는 데 도움이 되는 프로젝트 업데이트를 확인하고 IBM 제품과 함께 사용하라.
  
  

제품 및 기술 얻기

• Eclipse distribution containing the Plug-in Development Environment (PDE)를 이클립스 재단에서 다운로드하라.
  
  
• 플러그인을 찾아볼 때 가장 먼저 들릴 곳은 Eclipse Foundation's project list다.
  
  
• 플러그인을 찾아볼 떄 두 번째로 들릴 곳은 Eclipse Plug-in Central(EPIC)이다.
  
  
• IBM alphaWorks의 Eclipse technology downloads에서 가장 최신 정보를 확인하라.
  
  
• 이클립스 재단에서 이클립스 플랫폼과 기타 제품을 다운로드하라.
  
  
• IBM 제품 평가판을 다운로드하고 애플리케이션 개발 도구와 DB2®, Lotus®, Rational®, Tivoli®, 그리고 WebSphere® 미들웨어 제품을 사용하라.
  
  
• 다운로드하거나 DVD로 이용할 수 있는 IBM 시험판 소프트웨어로 다음 오픈 소스 프로젝트를 개선하라.
  
  

토론

• Eclipse Platform newsgroups는 이클립스와 관련하여 논의할 것이 있을 때 가장 먼저 들려야 할 곳이다(이 링크를 선택하면 여러분의 기본 유즈넷 뉴스 리더 애플리케이션이 실행되고 eclipse.platform을 열 것이다).
  
  
• Eclipse newsgroups는 이클립스를 사용하고 확장하는 데 관심있는 사람들을 위한 다양한 참고자료가 있다.
  
  
• developerWorks 블로그에 가입하고 developerWorks 커뮤니티에 참여하라.