이클립스에서 추가된 외부 라이브러리의 소스코드와 Javadoc추가하기

자바 프로그래밍의 장점 중 하나가, 오픈소스로 개발된 다양한 라이브러리들을 사용할 수 있다는 점이다.

자바 기반의 유용한 오픈소스 라이브러리 개발프로젝트를 하는 가장 큰 기관으로,  Apache Software Foundation을 들 수 있을 것이다. 아파치 웹서버를 만든 단체이다. 줄여서 ASF라고도 불리는데,  이 곳(http://projects.apache.org/indexes/alpha.html)에 가면, ASF에서 개발하는 전체 프로젝트 리스트를 볼 수 있다.

앞 포스팅에서 이야기한, 커멘드 라인 옵션들을 쉽게 처리해 주는 CLI 프로젝트도 ASF의 오픈소스 프로젝트 중 하나이다.

대부분의 오픈소스 프로젝트 사이트에 가면, 소스코드와 컴파일된 바이너리 파일들을 모두 다운을 받을 수 있는데, 해당 바이너리를 다운받아 압축을 풀고, 클래스파일들이 압축된 jar 파일을 이클립스 안에서, Referenced Libraries에 추가하면, 필요한 라이브러리 클래스를, 현재의 워크스페이스에서 바로 사용할 수 있다. 그런데, 바이너리만 추가하면, 이클립에서 제공해주는, 메서드 이름이나 클래스 이름에 마우스를 올려놓으면 나오는, 유용한 Javadoc 정보들을 볼 수가 없다. 그리고, 메서드 이름 더블 클릭한 다음에, F3키를 누르면, 해당 소스코드로 가는데, 이 때 Referenced Libraries에 있는 클래스를 사용할 때, 소스코드가 안나오고 클래스파일 자체를 보여주는 경우가 있다.

개발 한창 중에,  Javedoc정보가 없으면, 답답해서 인터넷에서 따로 찾아 보는 경우가 많은데, 대부분의 오픈소스 프로젝트에서는 바이너리 배포 파일에, 소스코드와 Javadoc Jar파일들을 함께 배포하기 때문에, 이클립스에서 간단한 설정만 해주면, 이클립스 안에서 Referenced Libraries에 있는 라이브러리의 소스코드와 Javadoc을 쉽게 추가 할 수 있다.

사실, Maven같은 빌드툴을 이용하면, 잘 알려진 외부 라이브러리를 Javadoc과 소스코드와 함께 이클립스 프로젝트 만들 때, 자동으로 추가 할 수 있다. 하지만 Maven 같은 빌드툴 사용이 나에게는 아직 좀 귀찮아서, 외부 라이브러리를 Javadoc과 소스코드와 함께, 이클립스에 수동으로 간단히 연결하는 법을  Commons Math 라이브러리를 추가하는 예로 정리해 보았다. Commons Math는 유용한 수학관련 공식이나, 통계 함수들을 제공을 해주는 ASF의 오픈소스 라이브러리다.

이 곳(http://commons.apache.org/proper/commons-math/download_math.cgi)에서 최신 버전(3.2)의 바이너리 파일을 다운받아 압축을 풀면, 아래의 파일들로 풀리게 된다.

이 중 commons-math-3.2.jar가 실제 라이브러리 파일이고, 나머지 jar파일들은 이름을 통해 어떤 역할의 파일들인지 쉽게 알 수 있을 것이다.  이 파일들 혹은 상위 폴더 전체를 Ctrl+C로 복사해서 이클립스의 Package Explorer안에 있는 프로젝트로 붙여 놓는다.

Package Explorer의 프로젝트 트리에서 Referenced Libraries에서 마우스 오른쪽 버튼을 누르고 " Build Path" >> "Configure Build Path"을 클릭하면 다음가 같은 창이 뜬다. 여기에서, add Jars를 클릭하면, 워크스페이스 안에 앞에서 옮긴 파일들 중 commons-math-.3.2jar 라이브러리를 추가하면, 목록에 jar파일이 추가된 것을 확인할 수 있다.

여기에 보면, commons-math-3.2.jar 아래 Source attachement:(none)과 Javadoc location: (None)이 있다. Source attachement:(none)을 선택한 다음 Edit을 누르고, Workspace location에서 앞에서 압축을 푼 commons-math3-3.2-sources.jar파일을 찾아 OK를 하면 소스코드가 연동이 되고, 비슷한 방법으로 Edit을 클릭하여 Javadoc in Archive를 선택하여, jar파일을 연결을 해주면 에디터 안에서 Math 라이브러리를 사용할 때, 연관된 Javadoc 내용들을 조회할 수 있게 된다. 혹은, 프로젝트 홈페이지에서 직접 웹브라우저를 통해 Javadoc을 볼 수 있을 경우에도, Edit을 눌러 Javadoc의 URL을 입력해 사용하는 것도 가능하다.

아래 그림은 외부 라이브러리 연결후 해당 라이브러리안에 있는 클래스의 메서드에 관한 Javadoc정보가 나오는 모습이다.

JC