Spring Boot 3 + JPA를 활용한 Liquibase 실습하기 (4, final)

📖 실습 내용

 

1. Spring Boot 3 + Spring Data JPA 환경에서 Liquibase 환경을 설정한다.

2. Entity 파일을 생성한 뒤, 로컬 DB와 스키마 차이에 대한 ChangeLog 파일을 생성한다. (diff)

3. Liquibase를 통해 ChangeLog 파일을 기반으로 데이터베이스에 적용하고 로그를 확인한다.

4. profile 설정을 통해 개발 환경별로 적용한다.

 

📖 실습 4. profile 설정을 통해 개발 환경별로 적용해보기

이전 실습을 통해 changeLog 파일을 적용하고 DB에 관련 로그를 남긴 것을 확인했다. 

이번 실습에서는 Profile(dev, prod) 별로 다르게 설정을 적용하고 실행하는 방법에 대해 확인해 볼 것이다.

 

`dev 환경`에서는 엔티티 > 개발 DB로 마이그레이션 하도록 설정하고,

`prod 환경`에서는 개발DB > 운영 DB로 마이그레이션 하도록 설정한다.

1. pom.xml 설정하기

pom.xml에서 profile에 따라 다르게 설정 파일을 분리해야 한다. pom.xml 파일에 하단 코드를 추가한다.

dev의 경우는 엔티티에서 DB로 마이그레이션 하는 과정이므로 관련한 의존성이 추가되어 있고, prod는 DB 간 마이그레이션이므로 별도의 의존성을 추가하지 않는다.

 

    <profiles>
        <profile>
            <id>dev</id>
            <build>
                <plugins>
                    <plugin>
                        <groupId>org.liquibase</groupId>
                        <artifactId>liquibase-maven-plugin</artifactId>
                        <configuration>
                            <diffChangeLogFile>src/main/resources/db/changelog/diff/dev/${maven.build.timestamp}_changelog.xml</diffChangeLogFile>
                            <verbose>true</verbose>
                            <propertyFile>src/main/resources/liquibase-dev.properties</propertyFile>
                        </configuration>
                        <dependencies>
                            <dependency>
                                <groupId>org.liquibase.ext</groupId>
                                <artifactId>liquibase-hibernate6</artifactId>
                                <version>4.20.0</version>
                            </dependency>
                            <dependency>
                                <groupId>org.springframework.boot</groupId>
                                <artifactId>spring-boot-starter-data-jpa</artifactId>
                                <version>3.0.6</version>
                            </dependency>
                        </dependencies>
                    </plugin>
                </plugins>
            </build>
        </profile>
        <profile>
            <id>prod</id>
            <build>
                <plugins>
                    <plugin>
                        <groupId>org.liquibase</groupId>
                        <artifactId>liquibase-maven-plugin</artifactId>
                        <configuration>
                            <diffChangeLogFile>src/main/resources/db/changelog/diff/prod/${maven.build.timestamp}_changelog.xml</diffChangeLogFile>
                            <verbose>true</verbose>
                            <propertyFile>src/main/resources/liquibase-prod.properties</propertyFile>
                        </configuration>
                    </plugin>
                </plugins>
            </build>
        </profile>
    </profiles>

 

해당 설정에서 중요한 부분은 <diffChangeLogFile> 경로와 <propertyFile> 경로이다.

changeLog  파일이 생성되는 위치와 설정 파일이 있는 경로이므로 개발하는 프로젝트에 맞게 작성해준다.

2. properties 설정 파일 작성하기

dev, prod 환경마다 마이그레이션 하는 환경이 다르기 때문에 다르게 작성해주어야 한다.

liquibase-dev.properties

contexts=dev
logLevel=info
changeLogFile=src/main/resources/db/changelog/db.changelog-master.xml

referenceUrl=hibernate:spring:com.shibaholic.blogliquibase.model?dialect=org.hibernate.dialect.MariaDBDialect

url=jdbc:mariadb://localhost:3306/shibaholic
username=
password=
driver=org.mariadb.jdbc.Driver

liquibase-prod.properties

contexts=prod
logLevel=info
changeLogFile=src/main/resources/db/changelog/db.changelog-master.xml

referenceUrl=jdbc:mariadb://localhost:3306/shibaholic
referenceUsername=
referencePassword=
referenceDriver=org.mariadb.jdbc.Driver

url=jdbc:mariadb://localhost:3306/shibaholic2
username=
password=
driver=org.mariadb.jdbc.Driver

 

위에 작성된 설정파일을 보고 reference 접두가사 붙은 설정과 일반 설정은 어떤 차이가 있는 건지 궁금할 수 있다.

 

간단하게 일반 설정(url, username, password, driver)이 기준이라고 생각하면 된다. DB 차이 정보(changeLog)를 출력하는 diff 명령을 예시로 든다면, 다음과 같다.

 

diff = 일반 설정을 기준으로 reference 설정된 DB(혹은 엔티티)와 비교해서 없는 내용(스키마, 제약 등)을 추출한다.

 

그래서 일반 설정에 dev 에서는 개발 DB 연결 정보를 입력했고, prod 에서는 운영 DB 연결 정보를 입력했다.

3. db.changelog-master.xml 설정 파일 수정하기

master 설정 파일은 환경마다 별도의 마스터 파일을 두는 방법과 하나의 파일에서 context로 구분하는 방법이 있다.

필자는 하나의 파일에서 환경별로 context로 구분하는 방법을 사용했다.

(2번에서 설정파일을 살펴보면 각 설정 파일에 contexts= dev, prod가 작성된 것을 확인할 수 있다.)

 

<databaseChangeLog
        xmlns="http://www.liquibase.org/xml/ns/dbchangelog"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog
      http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-3.8.xsd" >

    <includeAll path="/db/changelog/diff/dev/" context="dev"></includeAll>
    <includeAll path="/db/changelog/diff/prod/" context="prod"></includeAll>

</databaseChangeLog>

 

context는 어떤 changeset을 실행할지 여부를 제어하는 ​​표현식이다.

4. 마이그레이션 하기

환경별로 설정이 잘 되었는지 확인해보기 위해 아래 4개의 명령어를 차례로 입력해본다.

update 명령어는 애플리케이션을 직접 실행해서 테스트해도 상관 없다. (profile 설정 필수)

 

1. mvn compile liquibase:diff -Pdev 

2. mvn compile liquibase:update -Pdev

3. mvn compile liquibase:diff -Pprod

4. mvn compile liquibase:update -Pprod

 

1,2는 엔티티에서 개발 DB로 마이그레이션 하는 과정이며,

3,4는 개발 DB에서 운영 DB로 마이그레이션 하는 과정이다.

 

데이터베이스에 접근해서 확인해보면 dev와 prod 환경에서 성공적으로 테이블이 생성되었고 제약조건이 추가된 것을 확인할 수 있다.

 

이것으로 liquibase 마이그레이션 실습 과정을 마무리 한다.

프로젝트에 유용하게 활용해보면 좋겠다.

 

REFERENCE

https://github.com/tsk902000/LiquibaseSpringboot