Spring Boot 및 IntelliJ 프로젝트 기본 디렉토리, 파일들 역할

 

---

 

Spring Boot 및 IntelliJ 프로젝트를 열었을 때

기본적으로 생성된 디렉터리들 역할은 무엇일까?

 

 

---

 

 

 

 

 

board-test

해당 프로젝트 파일의 이름

 

.gradle

개인 사용자의 Gradle 설정 및 캐시에 관련된 내용을 가진 디렉터리

gradle 빌드 도구의 캐시 및 빌드 실행에 필요한 임시 파일들을 저장한다.

 

.idea

해당 IDEA IDE를 사용하여 작업할 때 프로젝트 관련 설정 파일을 가진 디렉터리

프로젝트 구성, 모듈, 라이브러리 설정, 빌드 옵션 및 개발자가 IDE에서 설정한 기타 사용자 지정 정보가 포함된다.

일반적으로 Git과 같은 프로젝트 버전 관리 시스템에 포함시키지 않는다. (주로 로컬 환경에서만 사용한다.)

 

build

프로젝트를 빌드할 때 (컴파일, 테스트 실행, 패키징 등) 생성되는 결과물들을 담고 있는 디렉터리

빌드 과정에서 생성된 임시 파일과 최종 생성물들이 저장된다.

 

gradle

프로젝트 자체의 Gradle 설정 파일과 관련된 내용을 가진 디렉터리

 

src

소스 코드들 저장하는 디렉터리이다.

 

.gitignore

git 저장소에서 추적하지 않을 파일과 디렉터리를 지정한다.

즉 버전 관리하지 않아야 하 파일을 명시하는 곳이다.

 

build.gradle

gradle 빌드 도구에서 프로젝트 빌드 설정을 정의하는 스크립트 파일이다.

해당 파일은 gradle에게 프로젝트를 빌드하는 방법과 라이브러리 의존성, 플러그인 설정, 빌드 테스크 등을 지시한다.

해당 파일을 수정해서 프로젝트의 동작을 커스텀할 수 있다.

 

gradlew와 gradlew.bat

gradle 빌드 도구를 프로젝트 내에서 사용할 수 있도록 도와주는 스크립트 파일이다.

해당 파일은 gradle wrapper를 통해 gradle 빌드 도구를 실행시키는 데 사용된다.

두 파일은 같은 기능을 수행하지만 서로 다른 운영 체제에서 실행될 수 있도록 만들어져 있다.

 

gradlew  =  Unix 계열의 운영 체제(Linux, macOS)에서 사용된다.

gradlew.bat  =  Window운영 체제에서 사용된다. (.bat은 Windows 배치 파일의 확장자이다.)

 

HELP.md

프로젝트나 소프트웨어의 도움말이나 설명을 담고 있는 Markdown형식의 파일이다.

간단한 서식 지정과 링크, 이미지 삽입 등을 포함하여 쉽게 읽고 작성 가능하다.

주로 프로젝트에 대한 문서화와 사용자들이 프로젝트를 더 잘 사용하고 이해할 수 있도록 돕는다.

 

settings.gradle

gradle 빌드 도구에서 프로젝트 구성을 설정하는 데 사용되는 파일이다.

주로 다중 모듈 프로젝트에서 각 모듈을 식별하고 구성하는 데 사용되며,

일반적으로 gradle에게 프로젝트에 포함된 서브 프로젝트 또는 모듈의 목록과 위치를 지정할 수 있다.

 

External Libraries

해당 IDE에서 프로젝트에 사용되는 외부 라이브러리 및 종속성을 그룹화되어 쉽게 관리하고 이해할 수 있는 디렉터리이다.

 

Scratches and Consoles

IDEA에서 제공하는 기능 중 하나로 빠르게 코드를 테스트하고 실험할 수 있는 임시 작업 공간과 실행 중인 콘솔을 관리하는 데 사용되는 곳이다.

 

 

 

 

 

src / main

해당 프로젝트에서 주요 소스 코드와 리소스 파일을 포함하는 디렉터리이다.

주로 Maven이나 Gradle과 같은 빌드 도구에서 프로젝트의 디렉터리 구조를 설정할 때 사용된다.

 

src / main / java

주요 소스 코드를 저장하는 곳으로,

java와 같은 언어로 작성된 소스 코드를 저장하는 곳이다. (프로젝트의 핵심적인 기능과 로직을 저장하는 곳)

 

src / main / resources

리소스 파일들을 저장하는 곳으로,

프로젝트에 필요한 설정 파일, 이미지, XML, 프로퍼티 파일 등을 저장하는 곳이다.

(실행 시 필요한 정적 파일들이나 구성 파일들을 여기에 포함한다.)

 

src / main / resources / static

정적 리소스(HTML, CSS, JavaScript, 이미지 등)를 저장하는 디렉터리이다.

주로 front-end 부분에서 사용되는 파일들을 위치시킨다.

 

src / main / resources / tempates

템플릿 엔진으로 렌더링 되는 템플릿 파일들을 저장하는 디렉터리이다.

(ex : Thymeleaf, Freemarker, Mustache 등)

 

src / main / resources / application.properties

스프링 부트 애플리케이션의 설정을 관리하는 데 사용되는 파일이다.

주로 애플리케이션의 환경 변수, DB 연결 정보, 서버 포트, 로깅 설정 등과 같은 다양한 설정을 작성하는 곳이다.

스프링 부트에서 해당 파일을 이용해서 애플리케이션의 구성 요소들을 구성한다.

(DB 연결 정보를 설정, 서버의 포트를 지정하는 등의 작업)

 

최근 스프링 부트에서는 해당 파일 대신 YAML 형식의 application.yml 파일을 사용해서 설정을 관리하기도 한다.

두 파일은 기본적으로 같은 역할을 하지만 YAML 파일은 더 가독성이 좋고 복잡한 설정을 표현하기에 유용하다.

 

src / main / test

프로젝트에서 단위 테스트 및 통합 테스트 등을 위한 테스트 코드와 리소스 파일을 저장하는 디렉터리이다.

src / main / java와 같은 구조로 되어 있으며

src / main / java 디렉터리에서 테스트를 하기 위해 만든 테스트 파일은

데칼코마니처럼 java 디렉터리의 기존 위치와 같은 test 디렉터리에서 생성된다.