🌱 Spring Boot 초기 세팅 (Gradle, IntelliJ)

Spring Boot 프로젝트를 진행하며, 초기 세팅동안 겪은 일들을 정리해보았다.

Project 생성

스프링 부트 프로젝트 생성은 아주 편리하다!
start.spring.io 활용해서 위 사진과 같이 프로젝트를 생성하였다.
Dependancy는 Lombok, Spring Web, Spring Data JPA, Spring Data JDBC, MySQL Driver + Spring Security만 기본으로 추가하고 이후에 필요에 따라 build.gradle에 추가하여 사용하였다.

처음 IntelliJ를 사용해 프로젝트를 열면 왕창 다운로드하고 빌드하는데 시간이 꽤나 걸린다. 끝나고 파일을 클릭해 보면 거의 모든 파일이 빨간색이다. 이것 저것 설정이 필요하다.

IntelliJ 세팅

Code Style

코드 스타일을 google style guide로 맞추었다.
Settings - Editor - Code Style - Java 에서 톱니바퀴를 통해 google style guide를 적용시키고 Indent랑 Tab size를 4로 변경해준다.
다른 블로그를 보면 이 외에도 자세하게 설명이 되어 있어, 참고해서 세팅하였다.

환경 변수

프로젝트 환경변수 값들을 .env가 아닌 Environment variables를 활용해 지정하였다. 이는 .env 파일을 굳이 .gitignore에 추가해 숨길 필요 없어 편리했다.

프로젝트에서 DB, JWT, S3, OAuth(Kakao, Naver)등과 관련된 중요한 변수들을 저장해주었고, 해당 내용은 팀원들과 따로 공유해 통일시켰다.

Run/Debug Configurations에서 편집할 수 있으며, 가장 편리한 방법으로 실행 버튼 옆 토글을 눌러서 Edit Configurations... 버튼을 눌러 들어갈 수 있다.

환경 설정

Settings - Build, Execution, Deployment - Build Tools - Gradle에서 gradle로 되어있던 Build and run using과 Run tests using을 모두 Intellij IDEA로 변경한다. 해당 부분을 변경하지 않을 경우 JUnit test의 세세한 결과를 한 눈에 확인할 수 없다.

실행 오류

여기까지하고 MainApplication을 실행해보았을 때, 정상적으로 서버가 실행되지 않는다. 이유는 JDBC url이 설정되지 않아서 인데, MySQL의 경우 application.properties에 아래와 같이 작성해주면 된다.

spring.jpa.database=mysql
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://${DB_HOST}:3306/${DB_NAME}?useSSL=false&serverTimezone=Asia/Seoul&allowPublicKeyRetrieval=true
spring.datasource.username=${DB_USER}
spring.datasource.password=${DB_PASSWORD}
spring.jpa.hibernate.ddl-auto=update
spring.jpa.generate-ddl=true
spring.jpa.show-sql=true
logging.level.org.hibernate=info
spring.jpa.database-platform=org.hibernate.dialect.MySQL8Dialect

이렇게 작성하고 실행한 뒤 localhost:8080 확인하면 서버가 띄워져 있다! 다만 로그인 화면이 자동으로 뜰 것이다.

Spring Security

로그인 화면은 콘솔을 자세히 보면 아래와 같은 내용을 확인할 수 있다.
Using generated security password: !@#$%^$%$&
user에 'user', password에 여기 뜬 비밀번호를 그대로 복사해 붙이면 접속이 가능하다.

개발 동안 불편하고 필요하지 않다라고 느낀다면 build.gradle에서

implementation 'org.springframework.boot:spring-boot-starter-security'
testImplementation 'org.springframework.security:spring-security-test'

이 두개를 제거하고 개발을 진행하면 된다. 로그인 창이 뜨지 않는다!

Hibernate 5.6.7

사실 여기까지하면 로컬에서 개발하기까지의 셋팅은 다 된 상태이지만, hibernate 5.6.7을 사용하면 개발 도중 문제가 발생할 수 있다. 바로 like나 containing 기능을 가진 쿼리를 사용할 때 발생하는 문제이다.
첫 번째 조회에서는 문제가 없지만 두 번 이상의 조회에서는 에러가 발생한다.

이를 해결하기 위해서 build.gradle의 plugin 중 id 'io.spring.dependency-management' version을 '0.6.0.RELEASE'로 바꾸어주어야 한다.
이후 Project structure - Modules에서 Gradle: org.hibernate: hibernate-core 5.6.7을 삭제하면 된다.

사실 위와 같은 방법으로 해결이 되지 않을 수 있으니, 이전 버전 모듈 삭제 후 그냥 build.gradle에 아래와 같이 넣어서 설치해주면 직빵으로 해결된다.
implementation 'org.hibernate:hibernate-core:5.6.1.Final'

셋팅 완료!

🎉🎉🎉