0. 프로젝트 세팅

기본 사항
- Gradle
- Java 17
- Spring Boot 3.1.1

0. 버전 설정

project : Gradle(Groovy)

Language : Java 17

• Java 20이 5/22에 나왔지만 나온지 한 달 된 버전을 쓰는 건 좀 위험할 것 같아서 17로 선택했다.
• 이전 프로젝트에서 Collection Factory Method를 많이 썼었는데, Java 17에서는 이 부분이 개선되었다고 해서 17로 결정하게 되었다
• Spring Boot 3.x 이상을 사용하기 위해서는 Java 17 이상을 사용해야 한다
• https://techblog.gccompany.co.kr/%EC%9A%B0%EB%A6%AC%ED%8C%80%EC%9D%B4-jdk-17%EC%9D%84-%EB%8F%84%EC%9E%85%ED%95%9C-%EC%9D%B4%EC%9C%A0-ced2b754cd7
• https://medium.com/sjk5766/spring-boot-%EB%B2%84%EC%A0%84%EC%97%90-%EB%94%B0%EB%A5%B8-java-%EB%B2%84%EC%A0%84-ff15c5ba7ecb

 

Spring Boot : 3.1.1

• 일단 SNAPSHOT 제외
• https://velog.io/@jmjmjmz732002/Springboot-Spring-Boot-3.0-%EB%B2%84%EC%A0%84-%EC%82%B4%ED%8E%B4%EB%B3%B4%EA%B8%B0
• https://github.com/spring-projects/spring-boot/releases/tag/v3.1.1
• 이번 프로젝트에서 WebSocket과 Redis를 쓸 것 같은데(사실 redis는 희망사항) 그것 관련 버그 fix가 있길래 사용했다.

 

Metadata

지금까지 몰랐는데 이것도 naming convention이 있더라고요...?

https://maven.apache.org/guides/mini/guide-naming-conventions.html#:~:text=artifactId%20is%20the%20name%20of,the%20jar%20as%20it's%20distributed.

Maven – Guide to Naming Conventions

팀 명에 dash 들어가는게 조금 별로인 것 같기도 하고ㅎㅎ...

 

 

1. Dependency 설정

처음에 아무것도 모르고 JPA랑 JDBC 같이 넣었다가 요즘은 JPA로 완전히 옮겨간다고 해서 그것만 넣기로 함

dependencies {
	implementation 'org.springframework.boot:spring-boot-starter-web'
	implementation 'org.springframework.boot:spring-boot-starter-data-jpa'

	// Security
	implementation 'org.springframework.boot:spring-boot-starter-security'
	implementation 'org.springframework.boot:spring-boot-starter-oauth2-client'

	// @Valid
	implementation 'org.springframework.boot:spring-boot-starter-validation'

	compileOnly 'org.projectlombok:lombok'

	// DB
	runtimeOnly 'com.mysql:mysql-connector-j'

	annotationProcessor 'org.projectlombok:lombok'
	testImplementation 'org.springframework.boot:spring-boot-starter-test'
	testImplementation 'org.springframework.security:spring-security-test'
}

 

 

application.yml 설정

SQL 관련 format과 parameter 값 표시하는 옵션을 추가했다

spring:
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://{HOST_NAME}:{PORT_NUM}/{DB_NAME}?serverTimezone=Asia/Seoul
    username: root
    password: {ROOT_PW}

  jpa:
    hibernate:
      ddl-auto: update
    generate-ddl: true
    properties:
      hibernate:
        show_sql: true         # hibernate가 DB에 날리는 모든 쿼리 표시
        format_sql: true       # sql format 설정
        use_sql_comments: true # 주석 표시
        highlight_sql: true    # ANSI SQL에 맞게 색 출력

logging:
  level:
    org:
      hibernate:
        type:
          descriptor:
            sql: trace # parameter 값을 표시

 

- connector 업데이트 관련 오류가 나서 새롭게 mysql-connector-java-8.0.30으로 깔았다

https://velog.io/@hans4257/jsp-MySQL-%EC%97%B0%EB%8F%99-%EC%98%A4%EB%A5%98java.lang.ClassNotFoundException-com.mysql.jdbc.Driver

 

2. Template 설정

PULL_REQUEST_TEMPLATE.md

### 작업 개요
<!--
  ex) 고양이가 야옹 소리를 내도록 수정
-->
### Jira
<!--
  ex) BAEMIN-1004
-->
### 작업 분류
- [ ] 버그 수정
- [ ] 신규 기능
- [ ] 프로젝트 구조 변경
<!--
  - [ ] 버그 수정
  - [x] 신규 기능
  - [ ] 프로젝트 구조 변경
-->
### 작업 상세 내용
<!--
  ex) 
  1. 네 발 짐승 클래스에 `크앙` 함수 추가
  2. 고양이 클래스에서 `크앙` 함수에 `미야아옹.wav` 재생시킴
-->
### 생각해볼 문제
<!--
  ex) 
  1. wav 파일을 매번 입력하기 귀찮겠다.
-->

 

Github Hook 추가

이건 아래 게시글에서 확인할 수 있다.

https://dev-minji.tistory.com/213

[Github Hook] Jira 티켓 번호 커밋 메시지 자동 추가하기

 

Base Branch develop으로 변경

이걸 안 해놓으면 맨날 PR할 때마다 develop으로 바꾸어야 하기 때문에 설정에서 바꿔줘야 함

 

3. 정적 분석 도구 및 convention tool 추가 

SonarCloud

sonarqube의 클라우드 버전으로 좀 더 간편하게 설치할 수 있다!

이전 프로젝트에서 쓰던 걸 그대로 들고왔다ㅎㅎ

https://zion830.tistory.com/79

GitHub 프로젝트와 SonarCloud 연결해보기

 

IntelliJ CheckStyle Plugin

이것도 지난 프로젝트 리팩토링하던 중 발견한 툴이다

아래 블로그를 참고해서 Naver Conding convention 다운 받고 그것 기반으로 checkstyle에 적용했다

https://bestinu.tistory.com/64

InteliJ 네이버 Java 코딩 컨벤션 적용하기 + Checkstyle

 

일단은 이것으로 1차 프로젝트 세팅은 끝!