Maven 프로젝트의 표준 디렉터리 구조

• 8/6/2024
• 4 minutes to read

Maven은 자바 프로젝트를 관리하고 빌드하는 데 널리 사용되는 도구입니다. Maven 프로젝트에서는 코드와 리소스를 표준 디렉터리 구조에 맞춰 배치하여 프로젝트의 일관성을 유지하고 빌드 과정을 단순화할 수 있습니다. 이 문서에서는 Maven 프로젝트의 표준 디렉터리 구조에 대해 설명합니다.

디렉터리 구조

Maven 프로젝트의 표준 디렉터리 구조는 다음과 같습니다. JavaCampus 이름의 프로젝트로 가정합니다.

java-campus/
├── src/
│   ├── main/
│   │   ├── java/
│   │   ├── resources/
│   │   ├── filters/
│   │   └── webapp/
│   └── test/
│       ├── java/
│       ├── resources/
│       └── filters/
├── target/
├── pom.xml

디렉터리 구조 설명

1. java-campus/: 프로젝트의 루트 디렉터리입니다. 프로젝트의 모든 파일과 서브 디렉터리가 여기에 위치합니다.

2. src/: 소스 파일이 포함된 디렉터리입니다. 이 디렉터리 내에는 main과 test 디렉터리가 있습니다.

   • main/: 애플리케이션의 주요 소스 코드가 들어가는 디렉터리입니다.

     • java/: 애플리케이션의 Java 소스 코드가 포함됩니다. 패키지 구조에 따라 서브 디렉터리가 생성됩니다.
     • resources/: 애플리케이션에서 사용하는 리소스 파일(예: application.properties, XML, 템플릿, 정적 파일 등)이 포함됩니다. 이 파일들은 빌드 시 클래스패스에 포함됩니다.
     • filters/: 리소스 필터링에 사용되는 파일이 포함됩니다.
     • webapp/: 웹 애플리케이션의 정적 자원과 JSP 파일, HTML, CSS, JS 등이 포함됩니다. 이 디렉터리는 WAR 패키지를 생성할 때 사용됩니다.

   • test/: 테스트 소스 파일이 포함된 디렉터리입니다.

     • java/: 테스트용 Java 소스 코드가 포함됩니다. 통상적으로 JUnit이나 TestNG와 같은 테스트 프레임워크를 사용하는 테스트 클래스가 이곳에 위치합니다.
     • resources/: 테스트에 필요한 리소스 파일이 포함됩니다. 이 파일들은 테스트 클래스패스에 포함됩니다.
     • filters/: 테스트 리소스 필터링에 사용되는 파일이 포함됩니다.

3. target/: Maven이 빌드 과정을 통해 생성하는 출력물이 저장되는 디렉터리입니다. 이 디렉터리에는 컴파일된 클래스 파일, 패키징된 JAR 또는 WAR 파일, 생성된 문서 등이 포함됩니다. 일반적으로 이 디렉터리는 소스 컨트롤에 포함되지 않습니다.

4. pom.xml: Maven 프로젝트 객체 모델(Project Object Model) 파일입니다. 프로젝트의 메타데이터, 의존성, 플러그인 설정 등을 정의하며, Maven 빌드 프로세스를 관리하는 데 사용됩니다.

추가 설명

• 패키징 유형에 따른 구조: Maven 프로젝트는 JAR, WAR, EAR 등의 패키징 유형에 따라 구조가 조금씩 달라질 수 있습니다. 예를 들어, 웹 애플리케이션의 경우 src/main/webapp/ 디렉터리가 필요합니다.

• 표준을 따르는 이유: 표준 디렉터리 구조를 따르는 것은 Maven이 프로젝트를 일관되게 빌드하고 관리할 수 있게 하며, 팀 내 협업과 프로젝트 유지보수에 도움이 됩니다. Maven은 기본적으로 이 구조를 기대하기 때문에 추가적인 설정 없이도 빌드를 쉽게 진행할 수 있습니다.