Docker와 springboot,mysql Docker Compose로 올려서 사용하기

🔎 Springboot 프로젝트 설정

도커 환경에서 DB를 사용하는 애플리케이션 구동을 목표로 하므로 최대한 간단하게 프로젝트를 구성해볼께요.

springboot 프로젝트는 사용자에게 글을 입력받으면 DB에 저장하고 목록을 확인할 수 있는 아주 간단한 구조입니다.

---

🔎 springboot 설정파일 (application.yml)

datasource의 url 부분에서 호스트 부분 설정을 잘 해주셔야 합니다.

현재 호스트가 db-mysql로 되어 있는데 이 호스트명은 앞으로 도커환경에서 mysql이 구동되는 컨테이너의 이름입니다.

spring:
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://db-mysql:3306/mydb?useSSL=false
    username: user
    password: user
  jpa:
    hibernate:
      ddl-auto: create
    properties:
      hibernate:
        format_sql: true
        dialect: org.hibernate.dialect.MySQL5InnoDBDialect

---

🔎 도커 이미지 빌드를 위한 Dockerfile 작성

FROM openjdk:11

COPY ./build/libs/docker-compose-test-0.0.1-SNAPSHOT.jar app.jar

ENV TZ=Asia/Seoul

CMD ["java", "-jar", "/app.jar"]

• FROM: 베이스 이미지 빌드하고자 하는 이미지의 기본 골격이 되는 이미지입니다.
• ARG: 일종의 변수선언이라고 이해해도 될 것 같습니다. 패키징된 jar 파일을 저장합니다.
• COPY: 실행가능한 패키징된 파일(jar)을 컨테이너 내부로 복사합니다.
• ENTRYPOINT: 이미지 빌드시 실행되는 명령어입니다. 로컬에서 jar파일을 구동하는 것과 동일한 명령어를 넣어주면 됩니다.

---

🔎 springboot 프로젝트 패키징

현재 프로젝트는 gradle을 사용하고 있기 때문에 gradle명령어를 사용합니다.

gradlew clean build --exclude-task test이거 꼭 넣어주세요..
yml에서 도커에서 구동될 mysql의 컨테이너명을 넣어주는데 이 부분 때문에 패키징 시 테스트에 실패하는 것 같습니다..

위 명령어를 실행하면 프로젝트 디렉토리에 target이 생성되고 그 안에 jar 파일이 생성될 것 입니다.

이 때 생성되는 jar 파일을 도커 컨테이너 안으로 복사해줘서 컨테이너가 실행시킬 수 있도록 하는 것 입니다.

---

🔎 도커 네트워크 생성

도커 환경에서 여러 컨테이너를 동일한 환경에서 연동시키기 위해서 네트워크 설정이 필요합니다.

여기서는 MySQL 과 springboot app이 동일한 네트워크에서 구동되도록 해주어야 합니다.

일단 네트워크부터 하나 생성해줍니다.
$ docker network create springboot-mysql-net

생성된 네트워크는 아래 명령어로 확인 가능합니다.
$ docker network ls

---

🔎 도커 환경에서 MySQL 구동

도커 허브에서 mysql 이미지 가져오기
$ docker pull mysql:5.7

mysql 구동
--name: 컨테이너명 설정
-p: 포트매핑
--network: 네트워크 설정
-e: 환경변수 설정
-d: 백그라운드로 컨테이너 실행

docker run --name db-mysql -p 3306:3306 --network springboot-mysql-net -e MYSQL_ROOT_PASSWORD=root -e MYSQL_DATABASE=mydb -e MYSQL_USER=user -e MYSQL_PASSWORD=user -d mysql:5.7

---

🔎 도커 환경에서 springboot app 구동

Dockerfile을 이용한 이미지 빌드
$ docker build -t springboot-mysql:1.0

빌드된 이미지로 컨테이너 구동

$ docker run -p 8080:8080 --name springboot-mysql --network springboot-mysql-net -d springboot-mysql:1.0 

---

🌡 테스트

두 개 컨테이너 모두 백그라운드로 잘 실행되고 있습니다.

요청 및 DB 테스트

 

요청 한대로 잘 뜨네요 ! 

 

🌡 2번째  Docker Compose 를 이용해서 한번에 띄우기 테스트

 

 Docker-compose.yml 작성

이전에 Docker-compose 없이 멀티컨테이너를 구동했던 설정을 그대로 Docker-compose에 적용할 것 입니다.

version: "3.7"

services:
  db-mysql:
    image: mysql:5.7
    environment:
      MYSQL_DATABASE: mydb
      MYSQL_USER: user
      MYSQL_PASSWORD: user
      MYSQL_ALLOW_EMPTY_PASSWORD: "yes"
    ports:
      - 3306:3306
    networks:
      - springboot-mysql-net
  test-app:
    image: kimminwoo1234/simple-spring-boot:11
    ports:
      - 8080:8080
    depends_on:
      - db-mysql
    networks:
      - springboot-mysql-net

networks:
  springboot-mysql-net:
         driver: bridge

Docker-compose는 services 밑에 여러 컨테이너들을 가질 수 있습니다. 여기서 생성되는 컨테이너들은 기본적으로 같은 네트워크에서 구동되게 됩니다.(default network)
하지만 이전에 했던 예제와 아예 동일하게 하기 위해 네트워크도 설정해주었습니다.

하나씩 자세히 볼께요.

db-mysql
mysql 을 컨테이너로 구동시키기 위한 설정입니다.

• image: 도커허브에서 가져올 이미지 (docker pull mysql:5.7 동일)
• environment: mysql 구동시 필요한 환경변수 설정
  (사용할 db이름, 접속할 user이름, password)
• ports: 포트매핑 (로컬의 포트에서 접근할 포트와 컨테이너 내부의 포트와 맞춤)
• networks: 컨테이너가 구동될 네트워크 설정

test-app
springboot 를 컨테이너로 구동시키기 위한 설정입니다.

• port: 이전과 동일
• depend_on: db-mysql 컨테이너에 의존한다는 의미인데 여기서 의존은 반드시 db-mysql컨테이너가 구동된 후에 test-app 컨테이너를 구동시키겠다는 의미입니다.
• networks: 이전과 동일

networks
이전 예제와 동일하게 네트워크를 구성하였습니다.

🔎 컨테이너 구동

docker-compose up or docker-compose up -d

서버가 정상적으로 구동되어 로컬에서 접근이 가능합니다.
또한 ps 명령어로 구동중인 컨테이너를 보면 mysql과 springboot 두 개 컨테이너가 구동되는 것을 확인할 수 있습니다.

컨테이너 중지
docker-compose down

🔎 테스트결과 잘 되네요!

 

 

🌡 3번째  Docker Compose 및 불륨 마운트를 이용해서 한번에 띄우기 테스트

 

springboot와 MySQL을 도커 컨테이너 환경에서 구동까지는 성공했습니다. 근데 컨테이너가 내려가는 순간 DB의 데이터가 모두 초기화 되어 버립니다.

컨테이너 구동 중에 DB에 쌓이는 데이터는 컨테이너 내부에 쌓일 뿐 로컬 파일시스템은 모르는 일 입니다.

mysql이 구동되는 컨테이너의 데이터를 로컬 파일시스템과 연결해주어야 합니다.

docker는 이러한 문제를 해결하기 위해 여러 기능을 제공하지만 찾아본 결과 volume을 가장 많이 쓰고 권장하는 것 같아 volume을 사용해보겠습니다.

 

Docker-compose.yml 작성

version: "3.7"

services:
  db-mysql:
    image: mysql:5.7
    environment:
      MYSQL_DATABASE: mydb
      MYSQL_USER: user
      MYSQL_PASSWORD: user
      MYSQL_ALLOW_EMPTY_PASSWORD: "yes"
    ports:
      - 3306:3306
    volumes:
      - ./db:/var/lib/mysql
    command: ['--character-set-server=utf8mb4', '--collation-server=utf8mb4_unicode_ci']
    networks:
      - springboot-mysql-net
  test-app:
    image: kimminwoo1234/simple-spring-boot:11
    ports:
      - 8080:8080
    depends_on:
      - db-mysql
    networks:
      - springboot-mysql-net

networks:
  springboot-mysql-net:
         driver: bridge

db-mysql 부분의 volumes만 추가로 설정합니다.

:를 기준으로 앞쪽이 로컬 파일시스템의 경로이고 뒤쪽이 컨테이너 내부의 경로입니다.

설정해준 컨테이너의 경로를 지정한 로컬 경로로 마운트 시키는 것 입니다.

docker-compose up 으로 실행하면 프로젝트의 루트경로에 db 폴더가 생길 것 입니다.

---

🧐 ....

아직 도커에 대한 이해가 부족해서 볼륨을 추가하고도 영속화가 되지 않는 현상을 겪었습니다.

혹시 같은 현상을 겪는 분이 있을까봐 적용방법도 함께 써볼께요.

일단 테스트를 위해 application.yml의 JPA 옵션인 ddl-auto는 create에서 update 혹은 none으로 해주세요.

그리고 변경된 사항을 적용하기 위해 다시 프로젝트를 패키징합니다.
gradlew clean build --exclude-task test

이제 이미지 재빌드와 함께 컨테이너를 구동합니다.
docker-compose up --build

---

 

docker compose 를 이용해서 db 와 springboot jpa를 이용하고 블룸 마운트를 이용해서

컨테이너가 내려가는 순간 DB의 데이터가 모두 초기화 되어 버리는 문제를 해결하였습니다.

db라는 폴더에 컨테이너의 db정보를 담아주었습니다.