[Project/4th] 2. 스프링 프로젝트 생성, 개발환경 구성

[프로젝트 일지] 4번째 프로젝트 - 1. 서버 설계하기

 

 

 

 

 

저저번주에 진행한 내용이지만 이제서야 기록하는 스프링 프로젝트 생성과 개발환경 구성 이야기!

 

 

 

 

로컬 개발 환경

---

OS : MAC OS(M2)

IDE : IntelliJ IDEA 2023.3.5 (Ultimate Edition) 

JDK : Amazon corretto 17.0.10

Server : Spring Boot 3.2.4

DB : MySQL 8.0.36

 

 

 

 

 

Spring Boot 프로젝트 생성 및 설정

---

백엔드 서버를 새로 구축하기 위해서 스프링 프로젝트를 생성했다.

 

24년 3월 기준, 현재 Spring Boot의 최신버전은 `3.3.0`이지만, SNAPSHOT 버전이 아닌 `3.2.4`로 생성을 했다.

Spring Boot 3 버전부터 Java 17이상을 써야 한다. Java 17 버전의 JDK를 알아보다가 `Amazon corretto 17.0.10`을 선택했다.

 

Oracle JDK는 프로덕션 환경에서 사용하려면 라이센스 문제가 발생할 수 있다고 해서 제외시켰다.

다른 무료 Open JDK로는 Azul zulu, Amazon corretto, Temurin이 있었다. 차이점을 알아봤으나 내가 아는 지식 수준으로는 별 차이가 없어보였고, AWS기반으로 서버를 운영할거라 Amazon corretto을 선택했다.

 

 

+ 내 컴퓨터에 새로 Amazon corretto aarch64을 다운받았어야 했다. 맥북 m1, m2의 애플 실리콘 칩이 aarch64 아키텍처라서 aarch64 버전을 다운받아야 했었다..

 

 

 

 

 

Dependency 추가

dependencies {
	implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
	implementation 'org.springframework.boot:spring-boot-starter-web'
	compileOnly 'org.projectlombok:lombok'
	developmentOnly 'org.springframework.boot:spring-boot-devtools'
	runtimeOnly 'com.h2database:h2'
	runtimeOnly 'com.mysql:mysql-connector-j'
	annotationProcessor 'org.projectlombok:lombok'
	testImplementation 'org.springframework.boot:spring-boot-starter-test'
}

 

• spring-boot-devtools : 서버 재시작 필요없이 편하게 개발하기 위해서 추가
• spring-boot-starter-web : spring mvc, 내장 톰캣 사용위한 스타터 추가
• mysql-connector-j : Mysql DB 연결을 위해 추가
• spring-boot-starter-data-jpa : DB와 매핑 위해 JPA 사용할 거라서 추가
• lombok : 어노테이션만으로 getter, 생성자 등 추가하기 위해 추가

 

 

 

 

 

application.yml 설정

spring:
  application:
    name: #서비스이름

  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:3306/#서비스이름#?useSSL=false&allowPublicKeyRetrieval=true&serverTimezone=Asia/Seoul&characterEncoding=UTF-8
    username: #계정명
    password: #비밀번호

  jpa:
    hibernate:
      ddl-auto: update
    properties:
      hibernate:
        show_sql: true
        format_sql: true

 

• datacource 연결
  • 일단 로컬 환경에서 개발할거라서 로컬 DB로 연결했다.
  • 중간에 `allowPublicKeyRetrieval=true` 이거 안적었더니 에러가 났었다. mysql 8.0 버전부터는 보안적인 이슈로 useSSL 옵션에 대한 추가적인 설정이 필요하다고 한다.
• jpa 옵션
  • ddl-auto : 개발하면서 자동으로 테이블과 칼럼을 추가하기 위해 설정했다. 운영 서버에서는 꺼야한다. 
  • show-sql, format-sql : 쿼리가 어떻게 날라가는지 보기 위해 추가했다.
• 추가로 Logging 설정해서 바인딩되는 쿼리 파라미터 출력하고 싶었는데, 3.X 버전에서는 기존 코드가 안먹는다...

 

 

 

DB 연결 테스트 완료

이후, 로컬에서 생성한 DB에 연결이 잘 되는지 테스트를 해줬다. 기본적인 설정이 끝났다.

 

 

 

 

 

테스트 Controller 만들기

---

서버가 제대로 실행이 되는지 상태를 확인하기 위해 테스트 컨트롤러를 생성해서 "hello"를 반환하는 API를 만들었다.

"localhost:8080/test/hello" 로 GET 요청을 보내면 "hello"와 함께 200 OK 상태 코드가 반환된다.

 

@RestController
@RequestMapping("/test")
public class TestController {
    @GetMapping("/hello")
    public ResponseEntity<?> test() {
        return new ResponseEntity<String>("hello", HttpStatus.OK);
    }
}

 

 

 

프론트에서도 연결 테스트 해본다고 요청을 보냈는데 응답이 잘 온다고 해줬다.