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

📖 실습 내용

 

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

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

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

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

 

📖 실습 3. ChangeLog 파일을 적용하고 로그 확인하기

이전 실습들을 통해 프로젝트에 Liquibase 설정과 로컬 DB와 엔티티 간의 스키마 차이에 대한 정보를 담고 있는 ChangeLog 파일을 생성했다. 

 

이번 실습에서는 ChangeLog 파일을 적용하여 DB 스키마를 변경하고 관련 로그를 확인해 볼 것이다.

1. ChangeLog.xml 적용하기

changelog.xml을 적용하는 방법은 2가지다.

 

첫 번째는 터미널 입력이다. 터미널에서 직접 mvn 명령어를 입력해서 update 하는 방식이다.

프로젝트가 있는 위치에서 mvn liquibase:update 명령어를 입력해 보자.

 

이미지와 같이 artifact 목록 내용이 잔뜩 출력되고, Build가 성공하게 된다.

 

두 번째는 애플리케이션 실행이다. 프로젝트 설정 파일(properties)에 설정된 change-master.xml 파일을 읽어 들여서 include 정보를 바탕으로 changelog 파일을 적용한다.

 

우리는 이전에 application.properties 파일에 spring.liquibase.change-log를 설정했었다.

해당 파일에 있는 정보를 바탕으로 추가된 내역이 있으면, update를 수행한다.

 

애플리케이션을 실행하고 로그를 살펴보자.

로그 내용 중 liquibase를 필터링해서 찾아보면 changelog 파일을 읽은 뒤, 적용하는 것을 알 수 있다.

2. 적용 확인하기

데이터 베이스를 확인하여 의도한 대로 테이블과 제약 사항이 추가 됐는지와 이력이 남았는지 확인해 본다.

예상대로 테이블이 잘 추가되었고, 3개의 필드와 크기(200), Unique, NotNull 등의 제약 사항이 잘 적용된 것을 확인할 수 있다.

 

databasechangelog라는 Liquibase에서 생성한 테이블을 확인하면 상단 이미지와 같이 변경 이력이 추가된 것을 확인할 수 있다.

 

해당 테이블 각 필드의 설명은 다음과 같다.

 

열	설명
ID	changeset의 id
AUTHOR	changeset의 author
FILENAME	changeset 파일 경로 changeLog가 Liquibase 에 전달된 방식에 따라 절대 경로 또는 상대 경로가 될 수 있다. 논리적 파일 경로 속성은 changelog 또는 개별 changeset에서 사용할 수 있다.
DATEEXECUTED	실행된 날짜/시간. 롤백 순서를 결정하기 위해 ORDEREXECUTED와 함께 사용된다.
ORDEREXECUTED	changeset이 실행된 순서. 순서가 올바른지 확인하기 위해 DATEEXECUTED와 함께 사용된다. 값은 개별 업데이트 실행에서만 증가를 보장하며, 0에서 다시 시작하는 경우가 있다.
EXECTYPE	changeset이 실행된 방법. 종류는 EXECUTED, FAILED, SKIPPED, RERAN, MARK_RAN 등이 있다.
MD5SUM	changelog의 checksum. 각 실행에서 changelog 파일 의 changeset에 예기치 않은 변경이 없는지 확인한다.
DESCRIPTION	changeset에 대해 자동으로 생성되는 간단한 설명
COMMENTS	changeset의 주석
TAG	tag에 해당하는 changeset을 추적하는 경우 사용
LIQUIBASE	Liquibase 버전
CONTEXTS	changeset을 실행하는 데 사용되는 컨텍스트
LABELS	changeset을 실행하는 데 사용되는 레이블
DEPLOYMENT_ID	함께 배포된 changeset의 동일한 고유 식별자

변경 로그에 있는 것과 데이터베이스에 대해 실제로 실행된 것 사이의 변경 사항을 감지하기 위해 Liquibase는 databasechangelog 테이블에 각 변경 집합 항목과 함께 체크섬(checksum)을 저장한다.

 

만약 changeset이 실행된 이후 수정된 경우(xml을 임의로 조작하는 경우 등), Liquibase가 중지되고 오류가 발생한다.

해당 문제를 해결할 수 있는 방법에 대해서는 REFERENCE에 포스팅을 추가해 놓았으니 참고하기 바란다.

 

이것으로 changelog 적용하기 및 로그 이력 확인하기가 끝이 났다.

4편에서는 profile을 사용해서 각 환경(dev, prod) 별로 liquibase를 적용하는 방법에 대해 알아본다.

REFERENCE

https://docs.liquibase.com/tools-integrations/maven/commands/maven-update.html

Maven update

https://docs.liquibase.com/concepts/tracking-tables/databasechangelog-table.html

DATABASECHANGELOG table

https://gettingstartedstage.liquibase.com/concepts/changelogs/changeset-checksums.html

Changeset Checksums

https://www.liquibase.com/blog/what-affects-changeset-checksums

All About Changeset Checksums