프로그래밍을 하는 데 있어서 라이브러리 라는 용어를 자주 사용하게 됩니다. 라이브러리는 “도서관” 이라는 의미겠지만, coding 에서 의미는 조금 상이합니다. 이번 내용은 Spring boot에 국한되는 내용은 아니고 최근 java프로젝트의 추세대로 설명을 하였습니다.
https://github.com/linkeverything/studySpringBoot/tree/0020-add-library
위 경로에서 다운로드 받아서 진행하는 경우, branch 를 반드시 확인하시고 다운로드(checkout) 받으시기 바랍니다. 각 게시글에 맞는 branch 로 생성되어 있으므로 해당 branch를 받는 것이 이해해 도움이 됩니다.
이번 포스트의 내용은 위 github repository 에 추가한 내용이 없습니다. 개념 설명 위주이니 그냥 내용 자체만 보아도 무방합니다.
라이브러리?
라이브러리란, 특정 프로그램의 확장된 기능을 사용하기 위해서, 개발 편의성을 향상시켜주거나 공개하고 싶지 않은 모듈의 캠슐화를 위해서 사용하는, 몇몇 객체이거나 함수들의 집합을 의미합니다. 개발 편의성을 위해서 사용하는 경우도 많고, 라이브러리 없이는 새롭게 모두 개발해야 한다는 점에 있어서는 개발 생산성을 향상시켜줍니다. 하지만 라이브러리 자체에 존재하는 오류나 버그(bug)요소 때문에 프로그램에 부정적인 영향을 줄 수도 있기 때문에 특정한 라이브러리를 도입하기 위해서는 충분히 확인 및 검증 절차를 거쳐서 사용해야 합니다.
라이브러리는 일반적으로 자주 사용되는 몇몇의 라이브러리들이 있고, 개인 개발자들이 이를 확장해 놓은 또 다른 라이브러리들도 존재합니다. 또한 facebook, twitter 등과 같은 open API 를 제공하는 업체에서도 java등의 프로그램과 연동하기 위해서 라이브러리를 제공하는 경우도 있습니다.
오래 전, Java 언어로 된 프로그래밍을 하는 데 있어서, 특정 라이브러리를 사용하려면 lib 혹은 libs 폴더를 만들고, 이를 class path / build path에 추가해 주고 사용해 왔습니다. 이는 특정한 IDE에 국한되는 방식이기도 할 뿐 아니라, 개발자들이 모두 동일한 환경을 구축해야만 동일한 결과를 얻을 수 있다는 점에서 한계점이 있었습니다. 또한 프로그램 자체를 공유해야 하는 경우에 이 라이브러리들까지 모두 다 압축해서 전달해야 하는 등으로 불편함도 있었습니다.
이러한 불편함을 해소하기 위해서 도입된 방식이 Maven 그리고 Gradle 이라고 볼 수 있습니다. 두 빌드 방식간에 차이점이나 우열관계는 없지만, 개발하려는 프로그램의 형태에 따라서 특정 방식을 선호하는 경우도 있으니 참고하시기 바랍니다.
최근에 제 경험상으로는 android 계열은 gradle빌드를 선호하고 android studio 의 기본값도 gradle 빌드인 것으로 알고 있습니다. Spring Boot 계열은 gradle이 우세한 것 같지만, spring 쪽에서는 비등비등하게 사용되는 것 같습니다.
기본사항
라이브러리 사용에 있어서의 기본 사항에 대해서 조금 설명하겠습니다. 시간이 지나서 조금 사용하다 보면 자연스럽게 얻어지는 정보들이지만 미리 알고 있으면 조금 더 편리할 수 있습니다.
어디서 찾지
보통의 경우에 라이브러리를 검색하는 것이 선행되지는 않을 겁니다. 특정 기능 등을 검색하고, 그 기능을 구현하는 방법을 찾다 보니, 이미 유사한 기능을 구현해놓은 라이브러리를 찾게 될 것입니다. 그렇다면 그 라이브러리 자체에 대한 이름을 알게 되었을 분, 막상 라이브러리를 도입하려면 난감한 상황이 됩니다.
저는 이렇게 알게 된 라이브러리에 대해서 MVN Repository라는 곳에서 찾습니다. 이 곳이 실제 Maven / Grdle이 다운로드 받는 경로가 될 것입니다(mvncentral). 이 페이지에 접속하면 다음과 같은 화면이 나타납니다.
여기서 위 검색창에 찾고자 하는 라이브러리를 검색합니다. 저는 예시로 ‘apache common’ 을 검색하였습니다.
그리고 아래 검색된 결과 중에서 ‘Apache Commons IO’ 를 선택합니다. 그리고 나면 아래처럼 버전이 쭉 나오게 됩니다. 본인이 사용하고자 하는 특정 버전이 있다면 그 버전을 선택하고 최신 버전을 사용한다면 가장 위에 있는 버전을 눌러줍니다.
이제 아래처럼 Maven 인지, Gradle인지를 구분하여 어떻게 문구를 넣어줘야 하는지를 판단합니다.
이제 본인의 소스 코드를 돌아와서 build.gradle에 해당 내용을 추가해 줍니다. 추가하고나서는 Load Gradle Changes(⇧⌘I)를 해주어야 프로젝트 코드 내에서 사용이 가능합니다.
...
dependencies {
implementation 'org.springframework.boot:spring-boot-starter-web'
compile group: 'commons-io', name: 'commons-io', version: '2.8.0'
implementation 'org.springframework.boot:spring-boot-starter'
testImplementation 'org.springframework.boot:spring-boot-starter-test'
}
...
로컬 다운로드 위치
위와 같이 build.gradle 파일에 내용을 추가하고 나서 Load Gradle Changes(⇧⌘I) 를 해주면 Eclipse 나 IntelliJ IDEA 같은 IDE 내에서 자동으로 classpath 에 추가해 주고 해당 라이브러리를 사용하는 것으로 간주하게 됩니다. (즉, 라이브러리의 특정 컴포넌트를 사용하는 데 있어서 빨간 밑줄이 생기지 않는 상태가 됩니다.)
그런데 내가 개발하고 있는 프로젝트에는 그 어디에도 라이브러리가 다운로드 받아있지 않은 것으로 보입니다. 예전 기억을 더듬어 보면 *.jar 파일을 프로젝트 하위의 어떤 폴더에 넣어주고, 그 폴더를 classpath에 잡아주어야 할 텐데, 흔히 알고 있는 lib 나 libs 폴더도 보이지 않고, 하위 폴더 어디에도 *.jar 파일이 있지 않습니다.
아래에서 설명하는 사용자 폴더는 다음 위치를 의미합니다.
- Windows : C:\Users\{사용자 이름}\
- Linux or MacOS : /Users/{사용자 이름}/
gradle
gradle 빌드를 사용하게 되면 사용자 폴더 아래에 .gradle 폴더 하위에 원격 repository에서 다운로드 받은 라이브러리가 다운로드 되게 됩니다.
IDE에서 Project Structure에 들어가면 다음과 같이 라이브러리의 위치를 확인할 수 있습니다.
폴더 위치가 그냥 알아보기에는 조금 어렵지만 그래도 각 파일이 어디에 위치해 있는지를 확인할 수 있습니다.
maven
maven 빌드를 사용하는 경우에는 사용자 폴더 아래에 .m2 폴더가 다운로드 위치가 됩니다.
.m2/repository 경로에 들어가 보면, 그 하위에 위에서 선언햇던 group 이름으로 나열되어 있고, 버전별로 다운로드 받은 *.jar 파일을 확인할 수 있습니다.
다운로드 폴더의 정리
위에서 살펴본 .gradle, .m2 폴더는 모두 다운로드 저장소, 정확하게는 Local Repository 입니다. 원격지에 파일이 있는 것은 맞지만, 빌드 편의성과 IDE에서 빌드 에러를 방지하는 것을 위해 로컬 경로에 미리 다운로드 받아두는 곳입니다.
위에서 살펴본 commons-io 와 같은 라이브러리에 대해서 2.6, 2.8 … 등으로 버전이 올라가게 되면 그 하위 버전은 삭제되지 않습니다. 즉, 저 두 폴더는 일반적으로 증가하기만 할 뿐, 줄어들지는 않습니다.
Maven이나 Gradle모두 빌드 시점에 해당 라이브러리가 없으면 새로 다운로드를 받기 때문에 개발자들간 공동 작업에도 편리하고 PC를 포멧해도 내가 작성한 코드만 잘 보관하고 있으면 되기 때문에 편리합니다. 역으로 이야기하자면, 위의 두 Local Repository .gradle, .m2 폴더는 삭제하더라도 다시 다운로드 받으므로, 종종 삭제해 주면 조금 더 가볍게 사용이 가능합니다. (물론 지우지 않아도 요즘 PC성능이 워낙 좋아서 크게 문제는 없습니다.)
사용법
라이브러리를 사용하는 방법에 대해서 조금 더 깊이있게 살펴보도록 하겠습니다. 가장 많이 사용되는 build 방식이 gradle과 maven이므로 이 두 가지에 대해서 기술합니다. 우선 앞서 살펴본 mvnrepository 페이지에서 아래 두 가지 내용을 확인합니다.
<!-- https://mvnrepository.com/artifact/commons-io/commons-io -->
<dependency>
<groupId>commons-io</groupId>
<artifactId>commons-io</artifactId>
<version>2.8.0</version>
</dependency>
// https://mvnrepository.com/artifact/commons-io/commons-io
compile group: 'commons-io', name: 'commons-io', version: '2.8.0'
위 사항을 정리하면 아래와 같습니다.
- group (groupId) :
commons-io - name (artifactId) :
commons-io - version :
2.8.0
Gradle
gradle은 위 정보들을 가지고 한 줄로 입력이 가능합니다. 위 처럼 mvnrepository에 있는 내용을 dependencies{ } 부분에 넣어주면 됩니다.
compile group: 'commons-io', name: 'commons-io', version: '2.8.0'
이를 조금 더 간편하게 적으려면 다음과 같이 넣어주면 됩니다.
compile '{group}:{name}:{version}'
compile 'commons-io:commons-io:2.8.0'
이 예시에서 사용한 ‘compile’ 은 gradle 3.X 부터 deprecate 되었습니다. 그 대신 ‘implementation’을 사용합니다.
Maven
maven 역시 gradle과 유사하게
Maven 과 grdle 전환
위에서 본 것 처럼, maven과 gradle은 그 문법척인 차이가 다소 존재할 뿐 사용방법은 동일합니다. 따라서 둘 간에 쉽게 전환할 수 있으며 참고자료 부분의 내용을 참고하시면 될 것 같습니다.
참고자료 및 출처
- How to Convert Maven to Gradle and Vice Versa : https://dzone.com/articles/how-to-convert-maven-to-gradle-and-vice-versa
- Converting Gradle Build File to Maven POM : https://www.baeldung.com/gradle-build-to-maven-pom
Leave a comment