[개발 환경 설정] 스프링 부트 프로젝트 생성 및 IntelliJ 사용법

[seungriyou]

편리하게 스프링 부트 프로젝트 생성하기

https://start.spring.io/

• 스프링 부트 버전: 3.2.1
• 자바: 17
• project: Gradle - Groovy
• dependencies: Spring Web, Thymeleaf 등

gradle 의존관계 보기

./gradlew dependencies --configuration compileClasspath

IntelliJ

프로젝트 열기 및 설정

build.gradle 파일을 선택하면 project로 불러올 수 있다.

이미 작성되어 있는 메인 메서드를 실행하면 된다.

빌드 및 실행 시 Gradle 사용하지 않도록 변경

스프링 부트 3.2 이상

다음과 같이 Gradle과 내가 설치한 자바 17로 설정한다. 자바의 경우에는 디폴트 값인 Project 값을 따라가도록 해도 될 것 같다.

스프링 부트 3.2 미만

IntelliJ를 사용하면 빌드 시 Java를 직접 사용하지 않고 gradle을 사용하는 경우가 있다. 이렇게 하면 느릴 수 있기 때문에 다음과 같이 설정을 변경한다.

저장 시 자동 코드 포맷팅

ref

- https://velog.io/@ppinkypeach/IntelliJ에-Google-Java-Style-format-적용하기 - https://yeon-kr.tistory.com/197

1. Google의 Java Style Guide를 따르기 위해 다음의 링크에서 xml 파일 다운로드 받는다.

   https://github.com/google/styleguide/blob/gh-pages/intellij-java-google-style.xml

2. Preferences - Editor - Code Style - Java에서 다운 받은 xml 파일을 불러온다.

   

3. 다음과 같이 Scheme을 새로 불러온 GoogleStyle로 설정한다.

   

4. (Mac 기준) option + command + l 단축키를 통해 코드를 포맷팅 할 수 있다.

5. 코드 저장 시 자동으로 코드 포맷팅을 수행하려면, Preferences - Tools - Actions on Save에서 다음과 같이 설정한다.

   Reformat code, Optimize imports

   

6. IntelliJ를 종료 후 재시작하고, 저장 시에 코드 포맷팅이 잘 이루어지는지 확인한다.

lombok

1. build.gradle이나 스프링 프로젝트 생성시 lombok 추가

   //lombok 설정 추가 시작
   configurations {
       compileOnly {
           extendsFrom annotationProcessor
       }
   }
   //lombok 설정 추가 끝
   
   repositories {
       mavenCentral()
   }
   
   dependencies {
       implementation 'org.springframework.boot:spring-boot-starter'
   
       //lombok 라이브러리 추가 시작
       compileOnly 'org.projectlombok:lombok'
       annotationProcessor 'org.projectlombok:lombok'
       testCompileOnly 'org.projectlombok:lombok'
       testAnnotationProcessor 'org.projectlombok:lombok'
       //lombok 라이브러리 추가 끝
   
       testImplementation 'org.springframework.boot:spring-boot-starter-test'
   }

2. IntelliJ에서 lombok Plugin 설치

3. 다음과 같은 설정 창에서 Enable annotation processing 체크

   

테스트 코드 템플릿

tdd만 입력해도 테스트 코드 템플릿이 생성되도록 해보자.

1. Preferences - Editor - Live Templates에 custom group을 생성하고, 그 밑에 live template을 생성한다.

2. 다음과 같이 작성한다. 언어는 Java로 설정한다.

   @Test
   public void $NAME$() throws Exception {
       // given
       $END$
       // when
   
       // then
   
   }

   

3. 이제 에디터에서 tdd를 입력 후 tab을 누르면 테스트 코드 템플릿이 나타난다.

[seungriyou]

새로운 프로젝트 불러올 때마다 다시 설정해야 할 것

1. 코드 저장 시 자동 코드 포맷팅

Rearrange Code도 하자

2. lombok 설정