[java] Google Guice를 사용하여 DB 마이그레이션 처리하기

20 Nov 2023

java

많은 애플리케이션에서 데이터베이스 마이그레이션은 중요한 작업입니다. 데이터베이스 스키마를 수정하거나 데이터를 이동하는 등의 변경 작업은 신중하게 처리해야 합니다. 이러한 작업을 자동화하고 관리하기 위해 Google Guice를 사용할 수 있습니다.

Google Guice란?

Google Guice는 Java용 경량 의존성 주입(Dependency Injection) 프레임워크입니다. 의존성 주입은 애플리케이션의 클래스간 의존성을 외부에서 제공하여 결합도를 낮추고 유연성을 높이는 디자인 패턴입니다. Guice는 이를 쉽게 구현하고 관리할 수 있도록 도와줍니다.

DB 마이그레이션을 위한 Guice 모듈 작성하기

먼저, DB 마이그레이션을 위한 Guice 모듈을 작성해야 합니다. 아래는 간단한 예시입니다.

public class MigrationModule extends AbstractModule {
    @Override
    protected void configure() {
        bind(MigrationRunner.class).asEagerSingleton();
    }
}

위 예시에서 MigrationRunner 클래스는 실제 DB 마이그레이션 작업을 처리하는 클래스입니다. asEagerSingleton 메서드를 사용하여 싱글톤으로 관리될 수 있도록 설정합니다.

MigrationRunner 클래스 작성하기

다음으로, DB 마이그레이션 작업을 처리하는 MigrationRunner 클래스를 작성해야 합니다. 이 클래스는 Guice에서 의존성 주입을 받아와 실제 마이그레이션 작업을 수행합니다.

public class MigrationRunner {
    private final DataSource dataSource;

    @Inject
    public MigrationRunner(DataSource dataSource) {
        this.dataSource = dataSource;
    }

    public void runMigrations() {
        // DB 마이그레이션 작업 수행
        // ...
    }
}

위 예시에서 DataSource는 Guice에서 의존성 주입을 받을 데이터베이스 연결 객체입니다. @Inject 어노테이션을 사용하여 의존성을 주입받습니다.

애플리케이션에서 Guice 모듈 등록하기

마지막으로, 애플리케이션의 엔트리 포인트에서 Guice 모듈을 등록하고 마이그레이션 작업을 실행해야 합니다.

public class MainApplication {
    public static void main(String[] args) {
        Injector injector = Guice.createInjector(new MigrationModule());
        MigrationRunner migrationRunner = injector.getInstance(MigrationRunner.class);
        migrationRunner.runMigrations();
    }
}

Guice.createInjector() 메서드를 사용하여 Guice 인젝터를 생성하고, MigrationModule을 등록합니다. 그런 다음, 인젝터를 사용하여 MigrationRunner 인스턴스를 가져와 runMigrations() 메서드를 호출합니다.

마무리

이제 Google Guice를 사용하여 DB 마이그레이션 작업을 처리하는 방법을 살펴보았습니다. Guice를 사용하면 의존성 주입을 통해 애플리케이션의 클래스들을 유연하게 관리할 수 있으며, DB 마이그레이션과 같은 작업도 쉽게 자동화할 수 있습니다. Guice의 다양한 기능을 활용하여 애플리케이션을 더욱 강력하게 개발할 수 있습니다.

참고 문서: