[Spring Boot, DB] DB와 Spring Boot 연동

Spring Data JPA 첫 단추

서론

Spring Data JPA를 배우기에 앞서 알아야 할 내용들이 많다.

• JDBC
• ORM
• JPA
• Hibernate(JPA 구현체)
• Spring Framework 
• 트랜잭션의 이해 
• Spring Data JPA 구조와 주요 인터페이스

해당 내용들은 앞으로 하나씩 포스팅해가며 이해할 예정이다. 시작하기전 데이터베이스와 Spring Boot가 어떻게 연결되는지에 대해 알아보자. 사실 관련 내용 Dockerize를 통해 들은 이미 언급한 바 있다. https://1000sang-dev.tistory.com/72

[Docker] Dockerize #2

실습과 공부에 앞서 비슷한 내용을 작성해볼 예정이다. 👍 한번 더 복습하는 것도 나쁘지 않을 것 같다.

 

1️⃣ 로컬 내 Docker를 통해 데이터베이스 서버 구동 - PostgreSQL

• 아래 명령어를 통해 바로 구동이 가등하다 | 도커 내 포트는 5432이지만, 로컬 노출 포트는 54322

docker run --name postgresql-container \
-e POSTGRES_USER=asac \
-e POSTGRES_PASSWORD=**** \
-e POSTGRES_DB=example \
-p 54322:5432 -d postgres:15

• `docker ps` 명령어를 통해 컨테이너가 구동되고 있는지 확인이 가능하다.

• 아래 명령어를 통해 컨테이너 내 접속하여, 직접 데이터베이스 접속 및 쿼리 수행이 가능하다.

docker exec -it postgresql-container bash

• PostgresQL DBMS 접속: MySQl과 달리 접속 시 데이터베이스를 선택한다

psql -U asac -d example

• 데이터베이스 확인: `\l` 테이블확인: `\dt`

• 컨테이너 중지, 시작, 재시작

# PostgresQL Docker 컨테이너 중지
docker stop postgresql-container

# PostgresQL Docker 컨테이너 시작
docker start postgresql-container

# PostgresQL Docker 컨테이너 재시작
docker restart postgresql-container

2️⃣ Spring Boot에서 위 도커 컨테이너로 동작되는 데이터베이스에 접속

1. Gradle 설정 파일에 Driver와 JPA 2개의 디펜던시를 추가한다.

dependencies {
    runtimeOnly 'org.postgresql:postgresql'
    implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
		...
}

2. Spring Data JPA 사용응ㄹ 위한 Spring 설정 파일을 수정한다.

• `application.properties`

# ORM
spring.datasource.driver-class-name=org.postgresql.Driver
spring.jpa.database-platform=org.hibernate.dialect.PostgreSQLDialect
# PostgresQL - CREATE USER user PASSWORD '!@#' SUPERUSER;
spring.datasource.url=jdbc:postgresql://localhost:54322/example?useSSL=false
spring.datasource.username=asac
spring.datasource.password=****
# The SQL dialect makes Hibernate generate better SQL for the chosen database
spring.jpa.generate-ddl=true
spring.jpa.hibernate.ddl-auto=update
spring.jpa.show-sql=true

3. JPA로부터 데이터베이스에 쿼리 실행 시 예약어 사용 문제 해결을 위한 추가 설정

Entity 클래스 정의를 기반으로 데이터베이스 내 테이블을 생성하는 Auto DDL 이나 실제 DML 쿼리 수행 시 예약어(Reserved Words)가 포함되어있는 경우 Spring에서 에러 로그와 함께 문법 오류를 발생 시킨다.

 

해결방법:

• 매번 수행할 쿼리 내 존재하는 예약어에 대해 double-quote(`"`)로 감싸주어야한다.
• 매번 붙여주기 귀찮기때문에 JPA 설정으로 JPA가 생성하는 모든 쿼리에 double-quote(`"`) 적용

spring.jpa.properties.hibernate.globally_quoted_identifiers=true

4. Auto DDL 통해 개발자가 정의한 Entity 클래스가 정상적으로 테이블로 생성되는지 확인

• User 클래스

@Getter
@Entity
@AllArgsConstructor
@NoArgsConstructor(access = AccessLevel.PROTECTED)
@ToString
public class User {
    /**
     * JPA 통한 Database 사용 시 @GeneratedValue 전략에 대해 조금 상세히 알 필요가 있다.
     * - AUTO     : ID 생성 책임이 JPA 에게 있다 (JPA 는 hibernate_sequence 라는 sequence 테이블을 만들어 활용, nextval 호출)
     * - IDENTITY : ID 생성 책임을 Database 에게 위임한다. (PostgresQL 은 Primary Key 에 대해 SERIAL 로 정의 및 DB 자체적으로 Sequence 생성)
     * > MySQL 라면 AUTO_INCREMENT 사용할것이고,
     * > PostgresQL 이라면 SERIAL + Sequence 사용 (sequence name 형식은 {tablename}_{columnname}_seq), currval 호출)
     */
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    @Setter
    private Integer id;
    private String name;
    private Integer age;
    private String job;
    private String specialty;
    private LocalDateTime createdAt;
}

• Gradle 및 Spring 설정을 모두 마친 뒤 스프링 어플리케이션을 구동한 경우 Auto DDL이 동작하는 것을 확인할 수 있따.

• 위 로그를 통해 실제로 데이터베이스에 테이블이 잘 생성되었는지 확인이 가능하다.

• 실제 데이터베이스에도 테이블이 정상적으로 생성된 것을 확인할 수 있다.

---

ℹ️ 참고

[ASAC 6기 강의자료]