[java] Maven을 사용하여 고품질 코드 작성하기

16 Nov 2023

java

Maven은 Java 프로젝트에서 의존성 관리와 빌드 자동화를 도와주는 강력한 도구입니다. 이 글에서는 Maven을 사용하여 고품질의 Java 코드를 작성하는 방법을 알아보겠습니다.

Maven이란?

Maven은 Apache Software Foundation에서 개발한 프로젝트 관리 도구입니다. Maven을 사용하면 프로젝트의 의존성 관리, 빌드 자동화, 테스트 실행 등 다양한 작업을 간편하게 수행할 수 있습니다.

Maven은 POM(Project Object Model) 파일을 통해 프로젝트의 구조와 의존성을 정의합니다. 이를 통해 Maven은 필요한 라이브러리를 자동으로 다운로드하고 관리하여 개발자가 직접 의존성을 관리하는 번거로움을 줄여줍니다.

Maven 프로젝트 생성

Maven 프로젝트를 생성하기 위해 다음과 같은 단계를 따릅니다.

Maven 설치: Maven 공식 웹사이트에서 Maven 설치 파일을 다운로드하고 설치합니다.
Maven 프로젝트 생성: 터미널 또는 명령 프롬프트에서 다음 명령을 실행하여 Maven 프로젝트를 생성합니다.

mvn archetype:generate -DgroupId=com.example -DartifactId=myproject -DarchetypeArtifactId=maven-archetype-quickstart -DinteractiveMode=false

위 명령어는 Maven Quickstart 아키타입을 사용하여 “com.example” 그룹 ID와 “myproject” 아티팩트 ID를 가진 새로운 프로젝트를 생성합니다.

프로젝트 구조 확인: Maven 프로젝트가 성공적으로 생성되면 프로젝트 폴더 안에 pom.xml 파일과 기본적인 구조가 생성된 것을 확인할 수 있습니다.

의존성 관리

Maven은 의존성 관리를 위해 중앙 저장소를 사용합니다. 의존하는 라이브러리의 정보를 pom.xml 파일에 추가하여 Maven이 해당 라이브러리를 자동으로 다운로드하고 관리하도록 할 수 있습니다.

아래는 pom.xml 파일에 의존성을 추가하는 예시입니다.

<dependencies>
    <dependency>
        <groupId>com.example</groupId>
        <artifactId>example-library</artifactId>
        <version>1.0.0</version>
    </dependency>
</dependencies>

Maven은 이러한 의존성 정보를 바탕으로 필요한 라이브러리를 다운로드하고 클래스패스에 추가하여 사용할 수 있도록 합니다.

빌드 자동화

Maven은 빌드 자동화를 위해 다양한 플러그인을 제공합니다. 이 플러그인을 사용하여 프로젝트의 소스 코드를 컴파일하고 패키징하며, 실행 가능한 JAR 파일 또는 WAR 파일로 빌드할 수 있습니다.

Maven의 가장 일반적인 빌드 명령어는 다음과 같습니다.

mvn clean package

위 명령어는 pom.xml 파일에 정의된 설정에 따라 프로젝트를 빌드하고, target 폴더에 결과물을 생성합니다.

코드 품질 검사

Maven은 코드 품질을 검사하기 위한 다양한 플러그인을 지원합니다. 이를 사용하여 코드 스타일, 정적 분석, 테스트 커버리지 등을 자동으로 검사할 수 있습니다.

예를 들어, pom.xml 파일에 아래와 같이 maven-checkstyle-plugin 플러그인을 추가하여 Checkstyle을 사용하여 코드 스타일을 검사할 수 있습니다.

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-checkstyle-plugin</artifactId>
            <version>3.1.2</version>
        </plugin>
    </plugins>
</build>

위 설정을 추가한 뒤에는 다음과 같은 명령어로 코드 스타일 검사를 수행할 수 있습니다.

mvn checkstyle:check

결론

Maven을 사용하여 Java 프로젝트를 관리하고 고품질의 코드를 작성하는 방법을 알아보았습니다. Maven을 제대로 활용하면 의존성 관리, 빌드 자동화, 코드 품질 검사 등의 작업을 간편하게 수행할 수 있습니다. 추가로 Maven을 사용하여 테스트, 배포, 문서화 등의 작업도 수행할 수 있으니 관심 있는 부분을 자세히 알아보시기 바랍니다.

참고 자료:

목차

Maven이란?

Maven 프로젝트 생성

의존성 관리

빌드 자동화

코드 품질 검사

결론