[Docker] Dockerize #2

Docker를 통한 Database 구동

---

Database: 사용하려는 DB의 Base Docker Image 기반에 추가 설정

목적: Docker를 통한 Database(MySql) 구동 ← docker 명령어 사용

• 데이터베이스 구동은 Dockerfile 통한 이미지 생성 없이, 베이스 이미지로 바로 구동한다.

1. MySQL 도커 구동

• 아래 명령어를 통해 바로 구동이 가능하다
  • 주의: 도커 내 포트는 3306이지만, 로컬 노출 포트는 33066

docker run --name mysql-container \
-e MYSQL_ROOT_PASSWORD=root \
-e MYSQL_USER=asac \
-e MYSQL_PASSWORD=1234 \
-e MYSQL_DATABASE=example \
-p 33066:3306 -d mysql:8

• 컨테이너가 잘 구동되었는지 확인하기 위해 구동 중인 컨테이너 조회 (모든 조회는 -a 옵션 사용)
  • 컨테이너를 구동시킬 때는 `docker start mysql-container`, 종료시킬 때는 `docker stop mysql-container`

docker ps

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

docker exec -it mysql-container bash

구동된 MySQL 도커 컨테이너 안에 접속해서 아래 명령어를 통해 데이터베이스 확인

• MySQL DBMS 접속
  • `-u`: 유저 아이디 명시
  • `-p`: 유저 비밀번호 직접 입력

mysql -u root -p

• 데이터베이스 확인

mysql> show databases;
+--------------------+
| Database           |
+--------------------+
| example            |
| information_schema |
| mysql              |
| performance_schema |
| sys                |
+--------------------+
5 rows in set (0.00 sec)

• 데이터 베이스 선택

use example;
Database changed

• 테이블 확인

show tables;
Empty set (0.02 sec)

• 컨테이너 중지, 시작 재시작 명령어

# MySQL Docker 컨테이너 중지
docker stop mysql-container

# MySQL Docker 컨테이너 시작
docker start mysql-container

# MySQL Docker 컨테이너 재시작
docker restart mysql-container

2. 도커로 동작시킨 MySQL에 DBeaver(DB Client)를 통한 접속

Public Key 이슈: DBeaver로 접근하든 로컬 Spring으로 접근하든 MySQL DB에 접속하려면 기본적으로 url, username, password 세 가지가 필요하다.

⚠️ 하지만 `MySQL 8.0` 버전부터 보안적인 이슈로 useSSL 옵션에 대한 추가적인 설정이 필요하다.

• DBeaver 접속 시 설정
  • allowPublicKeyRetrieval → True로 변경

3. Spring에서 데이터베이스 연결을 위한 추가 설정

먼저, 그림으로 ORM에 대한 설명과 Spring Data JPA와 JPA(Java ORm 표준) 차이에 대해 알아보자.

1단계 :JDBC 레벨(초록색)

• JDBC API: Java 애플리케이션이 데이터베이스에서 직접 쿼리를 수행할 수 있도록 해주는 표준 API이다. Spring의 가장 낮은 데이터 접근 계층이다.
• Query (Native Query): 데이터베이스 의존적인 쿼리를 직접 작성하여 실행한다.
• RowMapper: 쿼리 결과를 엔티티 객체로 매핑한다.
• DB: 실제 데이터베이스와 연결되어 있으며, 쿼리 실행 시 여기서 데이터를 가져오거나 저장한다.

2단계: ORM 레벨(파란색)

• ORM (Object-Relational Mapping): JPA를 사용해 객체와 관계형 데이터베이스 간의 매핑을 수행하는 계층이다.
• JPA API: 자바 객체를 데이터베이스에 매핑하고 CRUD 작업을 수행하는 API로, SQL 쿼리를 직접 작성하지 않아도 된다.
• JPQL(Java Persistence Query Language): 객체를 대상으로 하는 쿼리 언어로, 데이터베이스 독립적인 쿼리를 작성할 수 있다.
• Dialect: JPA가 데이터베이스에 접근할 때 사용하는 방언으로, 데이터베이스마다 다른 SQL 문법을 처리하도록 한다.
• Hibernate: JPA의 구현체로 가장 널리 사용되는 ORM 프레임워크

3단계: Spring Data JPA(빨간색)

• CRUD Repository: 기본적인 CRUD 작업을 지원하는 JPA 레파지토리 인터페이스.
• @Query와 @NamedQuery: Spring Data JPA에서 쿼리를 직접 작성할 수 있도록 하는 어노테이션
• QueryMethod: 메소드 이름을 통해 자동으로 쿼리를 생성(예: finyByid)
• CustomRepository와 QueryDSL: 고급 쿼리 작성을 위해 커스텀 레파지토리나 QueryDSL을 사용하여 복잡한 조건 처리 가능

Spring이 데이터베이스와 연동하여 JPA를 사용할 때 필요한 주요 설정을 세 가지로 나눠 설명

 

1. ORM(JPA) 설정: Spring이 데이터베이스와 상호작용하기 위해 설정하는 기본적인 ORM 및 JDBC 설정.

1. JDBC Driver:
   • 데이터베이스에 접속하기 위해 필요한 드라이버로, Java 애플리케이션이 특정 데이터베이스(MySQL, PostgreSQL 등)와 통신할 수 있도록 한다.
   • 예: MySQL을 사용하는 경우, mysql-connector-java 드라이버를 사용한다.
2. JPA:
   • 객체 조작(엔티티 조작)에 따른 데이터베이스 쿼리 변환을 담당한다.
   • Dialect 설정을 통해 JPA가 데이터베이스에 맞는 SQL 문법을 자동으로 생성할 수 있도록 한다.
   • 예: MySQL을 사용하는 경우, org.hibernate.dialect.MySQLDialect와 같은 설정을 지정한다.

2. Database 접속 ID/PW 설정: 데이터베이스에 접속하기 위한 URL, 사용자 ID, 비밀번호 설정이 필요하다.

1. Database URl:
   • 데이터베이스의 위치를 나타내는 URL.
   • 예: jdbc:mysql://localhost:3306/example_db
2. ID:
   • 데이터베이스에 접속할 수 있는 사용자 계정의 ID
3. PW:
   • 해당 사용자 계정의 비밀번호

3. JPA 사용 옵션 설정: JPA를 사용하면서 Spring이 데이터베이스와의 상호작용을 좀 더 쉽게 관리할 수 있도록 다양한 추가 옵션을 설정

1. 자동 테이블 생성 (DDL) 옵션:
   • JPA가 애플리케이션 시작 시 엔티티를 기준으로 데이터베이스 테이블을 자동 생성할지 여부를 결정.
   • 예: spring.jpa.hibernate.ddl-auto=create는 애플리케이션 시작 시 테이블을 새로 생성하라는 의미
   • 옵션 값: none, validate, update, create, create-drop
2. 쿼리 로그 옵션:
   • 쿼리 로그 옵션을 통해 쿼리 실행 내역을 로그로 확인할 수 있다.
   • 예: spring.jpa.show-sql=true로 설정하면 콘솔에 쿼리 로그가 출력된다.

앞서 MySQL 도커 구동의 경우

• application.properties 사용 시

# ORM
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.jpa.database-platform=org.hibernate.dialect.MySQLDialect

# PostgresQL - CREATE USER user PASSWORD '!@#' SUPERUSER;
spring.datasource.url=jdbc:mysql://localhost:33066/example?useSSL=false&allowPublicKeyRetrieval=true
spring.datasource.username=asac
spring.datasource.password=1234

# The SQL dialect makes Hibernate generate better SQL for the chosen database
spring.jpa.generate-ddl=true
spring.jpa.hibernate.ddl-auto=create
spring.jpa.show-sql=true

• application.yml 사용 시

spring:
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:33066/example?useSSL=false&allowPublicKeyRetrieval=true
    username: asac
    password: 1234
  jpa:
    generate-ddl: true
    hibernate:
      ddl-auto: create
    properties:
      hibernate:
        dialect: org.hibernate.dialect.MySQLDialect
    show-sql: true

로컬에서 Spring과 Database를 연결하는 방법 2개: 개별 / 동시 구동

로컬 및 Docker 구동 방식에 따른 조합으로 총 4가지 경우가 있으며, 모든 구동을 Docker Compoase로 묶어 한번에 실행할 수도 있다.

1. Spring과 Database 개별 구동

1. A-1. Spring Boot 로컬 구동 + B-1. Database 로컬 구동

• 둘 다 로컬에서 구동되는 가장 기본적이며 초보적인 방법
• 적합한 경우: 로컬에서 간단한 개발 및 디버깅을 할 때 사용

2. A-1. Spring Boot 로컬 구동 + B-2. Database Docker 구동

• Spring은 로컬에서, Database는 Docker에서 구동하는 방법
• 적합한 경우: 개발자가 로컬 환경을 유지하면서 데이터베이스만 Docker로 관리하고 싶을 때 사용한다. 데이터베이스 환경을 일관되게 유지하기 좋다.

3. A-2. Spring Boot Docker 구동 + B-1. Database 로컬 구동

• Spring Boot는 Docker에서 구동하고, Database는 로컬에서 구동하는 방법
• 적합한 경우: Spring 애플리케이션을 Docker 환경에서 테스트하면서, 로컬 데이터베이스에 접근하고 싶을 때 유용하다.

4. A-2 Spring Boot Docker 구동 + B-2. Database Docker 구동

• Spring Boot와 Database 모두 Docker에서 구동하는 방법. 배포 환경과 거의 유사한 구성
• 적합한 경우: 실제 배포 전, Docker 환경에서 전체 애플리케이션을 테스트하거나 실제 배표 환경으로 사용할 때.

이 중 방법 4는 배포 환경과 가장 유사하기 때문에, 배포 전에 최종 테스트를 위해 사용된다.

2. Spring과 Database 동시 구동 (Docker Compose)

Spring Boot와 Database를 모두 Docker로 구동할 경우, Docker Compose를 사용해 한번에 실행할 수 있다.

3. Spring Boot에서 Profiles를 사용한 Zone별 설정

Spring Boot는 `application.properties` 또는 `application.yml`파일을 Zone(로컬, 개발, 스테이징, 운영)에 맞게 설정하여 환경 별로 다르게 구동할 수 있다.

• Zone 구별에 대한 설명은 예전에 Git 브랜치 전략에 대해 포스팅한 글에 설명한 바 있다. → 해당 글을 참고하자.

https://1000sang-dev.tistory.com/30

Git & GitHub #6 - 실무에서의 Git 브랜치 전략 및 Zone 구별

 

주요 설정 파일

1. 공통 설정 파일(application.properties): 공통으로 사용될 JDBC 드라이버 설정 및 기본 ORM 설정
2. 로컬 환경 설정(application-local.properties):
   • 로컬 환경에서 개발 및 디버깅 용으로 사용하며, 로컬 데이터베이스나 Docker로 구동된 데이터베이스에 연결한다.
3. 개발 환경 설정(appljication-develop.properties):
   • 배포 전 개발 환경에서 사용하며, Docker Compose로 구동된 데이터베이스와 같은 개발용 인프라에 연결한다.
4. 운영 환경 설정(application-production.properties):
   • 실제 운영 환경에서 사용하며, AWS RDS와 같은 개별 데이터베이스 서버에 연결한다.

환경별 설정:

• application.properties

spring.application.name=[ appName ]

# ORM
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.jpa.database-platform=org.hibernate.dialect.MySQLDialect

• application-local.properties

# MySQL - Connection
spring.datasource.url=jdbc:mysql://localhost:33066/example?useSSL=false&allowPublicKeyRetrieval=true
spring.datasource.username=asac
spring.datasource.password=1234

# The SQL dialect makes Hibernate generate better SQL for the chosen database
spring.jpa.generate-ddl=true
spring.jpa.hibernate.ddl-auto=create
spring.jpa.show-sql=true

• application-develop.properties

# MySQL - Connection
spring.datasource.url=jdbc:mysql://mysql_host:3306/example?useSSL=false&allowPublicKeyRetrieval=true
spring.datasource.username=asac
spring.datasource.password=1234

# The SQL dialect makes Hibernate generate better SQL for the chosen database
spring.jpa.generate-ddl=true
spring.jpa.hibernate.ddl-auto=create
spring.jpa.show-sql=true

4. Docker와 Spring Boot Profile 설정

Dockerfile에서 Spring Boot의 Profile을 설정하여 특정 환경 설정을 적용할 수 있다. 이를 위해 Dockerfile에서 ARG와 ENV를 사용하여 프로파일을 전달한다.

FROM amazoncorretto:17-alpine

ARG JAR_FILE=build/libs/*.jar
COPY ${JAR_FILE} app.jar

ARG SPRING_PROFILE=local
ENV SPRING_PROFILE=$SPRING_PROFILE

ENTRYPOINT ["java", "-Dspring.profiles.active=${SPRING_PROFILE}", "-jar", "/app.jar"]

• 전달인자를 추가한 이 Dockerfile이 제대로 동작하는지 확인하기 위해서 도커 이미지 빌드를 해보면 된다.

docker build -t spring-jpa:6th .

docker run -p 1000:8080 -t spring-jpa:6th

 

 

docker run 명령어 전 빌드 과정에서 해당 오류가 발생하는 경우

"no main mainifest attribut, in /app.jar"

 

build.gradle 파일에 다음과 같은 설정을 추가한다.

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

5. Docker 네트워크 구성과 localhost의 의미

Docker 컨테이너 내부의 localhost는 컨테이너 자체를 가리키며, 호스트 머신의 localhost와는 다르다.

 

Docker 네트워크 모드

1. Bridge 네트워크 (기본):
   • Docker의 기본 네트워크 모드로, 여러 컨테이너가 같은 네트워크 안에서 서로 통신할 수 있다.
   • 하지만 호스트의 localhost에는 직접 접근할 수 없다.
2. Host 네트워크:
   • 컨테이너와 호스트가 동일한 네트워크를 사용하도록 설정하는 옵션
   • network_mode: "host"로 설정하면 컨테이너가 호스트의 localhost와 동일한 네트워크를 사용한다.

호스트 접근을 위한 설정

• 호스트 네트워크 모드가 어려운 경우: application-local.properties에서 localhost 대신 host.docker.internal을 사용한다.
• host.docker.internal: Docker 컨테이너가 호스트의 네트워크에 접근할 수 있도록 도와주는 설정

spring.datasource.url=jdbc:mysql://host.docker.internal:33066/example?useSSL=false&allowPublicKeyRetrieval=true

---

이번 포스팅에선 Docker에서 Database 구동, 도커로 구동시킨 database를 dbeaver(db client)로 접속, 각 Zone(환경) 별로 구분하여 설정하는 방법에 대해 알아보았다. 다음 포스팅은 이어서 Docker Compse를 이용하여 앞선 2개 도커 이미지를(Spring + DB) 결합하여 구동하는 과정을 발행할 예정이다. 

 

ℹ️ 참고

[ASAC 6기 강의자료]