[java] Guice와 JPA의 통합

17 Nov 2023

java

개요

Guice는 Java 어플리케이션의 의존성 주입(Dependency Injection)을 쉽게 구현할 수 있도록 해주는 프레임워크입니다. JPA(Java Persistence API)는 Java 어플리케이션에서 데이터베이스와의 상호작용을 쉽게 할 수 있도록 지원하는 API입니다. 본 글에서는 Guice와 JPA를 함께 사용하여 의존성 주입과 데이터베이스 연동을 효과적으로 구현하는 방법에 대해 알아보겠습니다.

Guice 설정

먼저 Guice의 의존성을 프로젝트에 추가해야 합니다. Maven을 사용하는 경우, pom.xml에 다음과 같이 Guice의 의존성을 추가합니다:

<dependency>
    <groupId>com.google.inject</groupId>
    <artifactId>guice</artifactId>
    <version>4.2.3</version>
</dependency>

다음으로, Guice의 AbstractModule 클래스를 확장한 클래스를 작성하여 Guice 설정을 진행합니다. 이 클래스에서는 필요한 의존성들을 바인딩(Binding)하여 Guice에 등록해야 합니다. 예를 들어, JPA의 EntityManager를 사용하기 위해서는 EntityManagerFactory를 Guice에 등록해야 합니다.

public class AppModule extends AbstractModule {
    @Override
    protected void configure() {
        bind(EntityManagerFactory.class).toProvider(EntityManagerFactoryProvider.class).in(Singleton.class);
        bind(EntityManager.class).toProvider(EntityManagerProvider.class).in(RequestScoped.class);
    }
}

위 예시에서는 EntityManagerFactory와 EntityManager를 Guice에 등록하고 있습니다. EntityManagerFactoryProvider와 EntityManagerProvider는 Guice의 Provider 인터페이스를 구현하여 EntityManagerFactory와 EntityManager를 제공합니다.

JPA와의 통합

Guice 설정이 완료되면, JPA를 통해 데이터베이스와의 상호작용을 시작할 수 있습니다. JPA를 사용하여 데이터베이스에 접근하려면, persistence.xml 파일을 작성하고, 이를 바탕으로 EntityManagerFactory를 생성해야 합니다.

public class EntityManagerFactoryProvider implements Provider<EntityManagerFactory> {
    private static final String PERSISTENCE_UNIT_NAME = "persistenceUnit";

    @Override
    public EntityManagerFactory get() {
        return Persistence.createEntityManagerFactory(PERSISTENCE_UNIT_NAME);
    }
}

위 예시에서는 persistenceUnit이라는 이름의 Persistence Unit을 사용하고 있습니다. 해당 이름은 persistence.xml 파일에서 정의한 이름과 동일해야 합니다.

EntityManagerFactoryProvider를 작성하였다면, 이제 JPA의 EntityManager를 사용하는 클래스에서 Guice로부터 EntityManager를 의존성 주입받아 사용할 수 있습니다.

public class UserRepository {
    @Inject
    private EntityManager entityManager;

    public User findById(int id) {
        return entityManager.find(User.class, id);
    }

    // ... other methods
}

위 예시에서는 UserRepository 클래스에서 EntityManager를 Guice로부터 주입받아 findById 메소드에서 사용하고 있습니다.

마무리

이제 Guice와 JPA를 함께 사용하여 Java 어플리케이션에서 의존성 주입과 데이터베이스 연동을 효과적으로 구현하는 방법을 알아보았습니다. Guice의 설정 클래스에 JPA의 EntityManagerFactory와 EntityManager를 바인딩하여 의존성을 해결한 뒤, JPA를 사용하는 클래스에서 필요한 의존성을 Guice로부터 주입받아 사용하면 됩니다. 이를 통해 코드의 유지 보수성과 재사용성을 높일 수 있습니다.

개요

Guice 설정

JPA와의 통합

마무리

참고 자료