[java] Flyway를 사용하여 Java 애플리케이션의 데이터베이스 초기 덤프 생성하기

29 Nov 2023

java

Flyway는 데이터베이스 스키마 버전 관리 도구로서, 애플리케이션의 데이터베이스 마이그레이션을 관리할 수 있습니다. 이번 포스트에서는 Flyway를 사용하여 Java 애플리케이션의 데이터베이스 초기 덤프를 생성하는 방법을 알아보겠습니다.

Flyway를 사용하기 위해서는 먼저 의존성을 프로젝트에 추가해야 합니다. Maven을 사용한다면 pom.xml 파일에 다음 의존성을 추가합니다:

<dependency>
    <groupId>org.flywaydb</groupId>
    <artifactId>flyway-core</artifactId>
    <version>7.0.3</version>
</dependency>

Gradle을 사용한다면 build.gradle 파일에 다음 의존성을 추가합니다:

dependencies {
    implementation 'org.flywaydb:flyway-core:7.0.3'
}

의존성을 추가한 후에는 Flyway 구성을 위한 설정 파일을 생성해야 합니다. 보통 flyway.conf 또는 flyway.properties라는 이름으로 파일을 생성하고, 해당 파일에 데이터베이스 연결 정보를 작성합니다. 다음은 flyway.conf 파일의 예입니다:

flyway.url=jdbc:mysql://localhost:3306/mydatabase
flyway.user=myuser
flyway.password=mypassword

위 설정 파일에서는 MySQL 데이터베이스에 접속하기 위한 URL, 사용자 이름, 비밀번호를 설정하고 있습니다. 이를 프로젝트의 리소스 디렉토리 (일반적으로 src/main/resources)에 저장합니다.

이제 Flyway를 사용하여 데이터베이스 초기 덤프를 생성하는 코드를 작성해보겠습니다. 먼저, Flyway 객체를 생성하고 설정 파일의 경로를 지정합니다:

Flyway flyway = Flyway.configure()
        .locations("classpath:db/migration")
        .load();

위 코드에서 locations 메서드를 사용하여 마이그레이션 스크립트 파일이 저장된 위치를 지정해줍니다. 대부분의 경우, 클래스패스의 db/migration 폴더를 사용하며, 이 폴더에 .sql 확장자를 가진 마이그레이션 스크립트 파일들을 저장합니다.

마지막으로, Flyway 객체의 migrate 메서드를 호출하여 데이터베이스 마이그레이션을 실행합니다:

flyway.migrate();

위 코드에서 migrate 메서드는 데이터베이스 스키마의 현재 버전과 마이그레이션 스크립트들의 버전을 비교하여 변경된 스키마를 적용합니다.

이제 Java 애플리케이션을 실행하면 Flyway가 설정 파일을 읽어와서 데이터베이스 초기 덤프를 생성할 것입니다. Flyway는 이미 존재하는 마이그레이션 스크립트를 실행하지 않으므로, 애플리케이션을 여러 번 실행해도 데이터베이스 스키마에 대한 일관성을 유지할 수 있습니다.

Flyway를 사용하여 Java 애플리케이션의 데이터베이스 초기 덤프를 생성하는 방법에 대해 알아보았습니다. Flyway를 사용하면 데이터베이스 마이그레이션 관리를 편리하게 할 수 있으며, 애플리케이션의 스키마 변화를 체계적으로 관리할 수 있습니다.

참고 자료

Flyway 공식 문서: https://flywaydb.org/documentation/
Maven 중앙 저장소: https://mvnrepository.com/artifact/org.flywaydb/flyway-core/7.0.3

주의: 위 예제 코드는 간략한 예시이며, 실제 프로젝트에서는 예외 처리와 같은 추가 작업이 필요할 수 있습니다.