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

📖 실습 내용

 

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

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

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

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

 

📖 실습 2. 로컬 DB와 Entity 간의 스키마 차이 ChangeLog 만들기

이전 실습에서는 프로젝트에 기본적인 Liquibase를 완료했다.

 

이번 실습에서는 프로젝트에 Spring Data JPA 기반의 간단한 엔티티를 생성하고, DB와 스키마 차이에 대한 ChangeLog 파일을 만들 것이다.

1. 데이터베이스 설정

application.properties에 데이터베이스 설정 정보를 추가한다.

기존 프로젝트에 데이터 베이스 설정이 되어있는 경우는 1번을 생략하면 된다.

 

spring.datasource.driver-class-name=org.mariadb.jdbc.Driver
spring.datasource.url=jdbc:mariadb://localhost:{db_port}/{database_name}
spring.datasource.username={user_name}
spring.datasource.password={password}

spring.jpa.hibernate.ddl-auto=none
spring.jpa.properties.hibernate.format_sql=true
spring.jpa.show-sql=true

 

{user_name} = 데이터베이스 id 정보 입력

{password} = 데이터베이스 비밀번호 입력

{db_port} = 데이터베이스 포트 번호

{database_name} = 데이터베이스 이름

 

⛔️ ddl-auto 옵션은 none으로 설정하자.

 

liquibase는 ddl-auto를 통해 update 또는 create 하는 정보에 대해서는 알지 못한다. 따라서 liquibase를 활용해서 제대로 된 DB Migration 이력 관리를 의도하고 있다면, JPA가 지원하는 ddl-auto 기능은 사용하지 않는 것이 좋다. 

2. 엔티티 생성/변경

간단한 엔티티를 생성 또는 변경한다. 기존 프로젝트에 엔티티가 있는 경우에는 2번을 생략하면 된다.

 

@Entity
@Getter
@Table(name = "shiba_holic")
public class ShibaHolic {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    @Column(unique = true, length = 200, nullable = false)
    private String name;

    @Column(nullable = false)
    private Integer age;
}

 

예제를 보여주기 위해 간단한 엔티티를 생성했다. 또한, 제약 사항과 옵션들을 추가하였다.

3. diff 명령어 사용하여 changeLog 파일 만들기

- cmd에서 프로젝트 위치에 가거나 인텔리제이 터미널을 활용해서 프로젝트 경로로 이동한다.

- mvn liquibase:diff 명령어를 입력한다.

 

명령어를 입력하면 상단 이미지처럼 터미널의 Liquibase 실행 화면이 나오며, 설정 및 진행 관련 정보 등을 출력한다.

4. changeLog.xml 파일 내용 확인하기

 

설정을 동일하게 했다면 해당 이미지처럼 resoures/db/changelog/diff 디렉터리에 변경된 내용이 작성된 날짜_changelog.xml 파일이 생성되었을 것이다.

 

결과물을 확인해 보자.

 

<?xml version="1.1" encoding="UTF-8" standalone="no"?>
<databaseChangeLog xmlns="http://www.liquibase.org/xml/ns/dbchangelog" xmlns:ext="http://www.liquibase.org/xml/ns/dbchangelog-ext" xmlns:pro="http://www.liquibase.org/xml/ns/pro" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog-ext http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-ext.xsd http://www.liquibase.org/xml/ns/pro http://www.liquibase.org/xml/ns/pro/liquibase-pro-latest.xsd http://www.liquibase.org/xml/ns/dbchangelog http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-latest.xsd">
    <changeSet author="MHK (generated)" id="1684573329477-1">
        <createTable tableName="shiba_holic">
            <column autoIncrement="true" name="id" type="BIGINT">
                <constraints nullable="false" primaryKey="true" primaryKeyName="shiba_holicPK"/>
            </column>
            <column name="age" type="INT">
                <constraints nullable="false"/>
            </column>
            <column name="name" type="VARCHAR(200)">
                <constraints nullable="false"/>
            </column>
        </createTable>
    </changeSet>
    <changeSet author="MHK (generated)" id="1684573329477-2">
        <addUniqueConstraint columnNames="name" constraintName="UC_SHIBA_HOLICNAME_COL" tableName="shiba_holic"/>
    </changeSet>
</databaseChangeLog>

 

내용을 살펴보면 다음과 같은 정보를 파악할 수 있다.

 

1. shiba_holic 테이블 생성(createTable)

2. column 3개 생성(column)

3. 각 column에 설정한 nullable = false(constraints), length= 200(VARCHAR(200)) 등의 제약 조건과 옵션

4. name에 유니크 제약 조건 추가 (addUniqueConstraint)

 

즉, 엔티티 파일에 설정한 내용이 고스란히 liquibase 형식에 맞게 추가되어 있다.

 

이것으로 ChangeLog 파일 생성하기까지 끝이 났다.

 

3편에서는 생성한 ChangeLog 파일을 데이터베이스에 적용해서 실제 테이블을 생성하고, 변경 이력을 추가하는 내용을 공유하겠다.

 

REFERENCE

https://docs.liquibase.com/commands/inspection/diff.html

diff

https://docs.liquibase.com/commands/inspection/diff-changelog.html

diff-changelog