OkHttp Interceptor Multibindings with Dagger

도입

현재 사용하고 있는 앱의 구조를 살펴보면, 하위 프로젝트가 코어 모듈을 의존하고 있는 형태로, 흔히 말하는 Multi-Module projects이다. 물론, 코어 모듈은 현재 Artifactory 로 관리되어 버전 관리도 되고 있다.

이렇게 구성한 이유로는 1. 의외로 프로젝트마다 들어가는 중복 코드가 많고, 2. 프로젝트 특성에 종속되지 않는 코드여야 재활용이 가능하기 때문이다.

그런 이유로 Dagger 또한 코어 모듈과 하위 프로젝트에서 관리되는데, 코어 모듈에서는 Base~Module 만 가지고 있고, 하위 프로젝트에서 App~Module 와 Component 클래스를 가지고 있다.

문제는, Retrofit, OKHttpClient 등의 객체를 Base~Module, 즉 코어 모듈에서 관리하고 있는데 프로젝트마다 필요한 Interceptor 는 하위 프로젝트에서 들어간다는 점이다. 또, 이 Interceptor가 1개가 아닌 여러개가 될 수 있다.

이를 해결하기 위해 이 글에서는 Dagger 의 Multibindings 기능을 이용하여 Provide 된 Interceptor 등을 Set<Interceptor> 로 받아서 최종적으로 OKHttpClient를 만들 때 추가하려 한다.

언어는 평소대로 Kotlin, 사용부는 Java이다.

Multibindings란?

먼저, Multibindings에 대한 설명이 필요할 것 같다.

Multibindings 는 서로 다른 모듈에 객체가 바인딩되어 있어도 하나의 컬렉션으로서 객체에 바인딩할 수 있는 기능이다. Dagger에서는 이 컬렉션을 분석하여 개개인의 바인딩에 의존하지 않고 처리를 해준다.

종류는 두가지로, @IntoSet@IntoMap 가 있는데, 각각 이름과 같이 Set<T> 와 Map<Class<*>, Provider<T>> 를 제공한다.

이 중에서 오늘 사용할 것은 @IntoSet 이다.

제공될 Interceptor 제작

먼저, Dagger 에 Interceptor 를 제공할 Interceptor 를 만드는데, 예제로 할 주제가 명확하게 떠오르지 않아 원본을 바로 반환하는 기본 형태의 Interceptor 를 만든다.

class TestInterceptor : Interceptor {
    @Throws(IOException::class)
    override fun intercept(chain: Interceptor.Chain): Response? {
        val original = chain.request()
        val originalHttpUrl = original.url()
        val requestBuilder = original.newBuilder()
            .url(originalHttpUrl.newBuilder().build())

        return chain.proceed(requestBuilder.build())
    }
}

그 다음, 제작한 Interceptor 를 Module 에 제공한다.

@Module
public class AppInterceptorModule {

    @Provides
    @IntoSet
    public Interceptor provideTestInterceptor() {
        return new TestInterceptor();
    }
}

평소와 같이 Provide를 하되 @IntoSet 라는 어노테이션을 추가적으로 부착하면 된다. 만일 Multibinding 기능을 다른 기능에도 활용하고 싶으면 Qualifier 어노테이션을 부착하면 된다.

필요한 객체에 제공하기

@Provides
    fun provideClient(interceptors: Set<@JvmSuppressWildcards Interceptor>): OkHttpClient {
        val builder = OkHttpClient().newBuilder()
        builder.readTimeout(Config.timeout.toLong(), TimeUnit.MILLISECONDS)
        builder.connectTimeout(Config.connectTimeout.toLong(), TimeUnit.MILLISECONDS)
        if (interceptors.isNotEmpty()) {
            interceptors.forEach {
                builder.addInterceptor(it)
            }
        }
        return builder.build()
}

자세히 보면 파라미터에 interceptors: Set<Interceptor> 가 보이는데, 이 쪽으로 Multibindings 으로 구성된 컬렉션이 추가된다. Set이므로 비어있지 않으면 간단히 forEach 로 builder 에 Interceptor를 추가하면 된다.

여기서 @JvmSuppressWildcards 란 어노테이션이 있는데, 코틀린 컴파일러는 기본적으로 Set<Interceptor> 를 Set<? extends Interceptor> 로 변환한다. 이 때, 대거가 제공하는 컬렉션 객체는 Set<Interceptor> 이므로 Set<? extends Interceptor> 를 찾을 수 없다면서 오류가 나온다.

단, 해당 타입 파라미터가 final 이면 Wildcards 가 생성되지 않는데, Set<String> 가 그렇다.

이 때에는 @JvmSuppressWildcards 를 붙여 Set<? extends Interceptor> 가 아닌 Set<Interceptor> 로 구성되게 하면 된다.

생성된 코드 살펴보기

위 작업까지 마치고 빌드가 성공했을 경우, DaggerAppComponent에 관련 부분이 생성된 것을 확인할 수 있다.

먼저, setOfInterceptorProvider 라는 필드가 생성되는데, 이 곳이 Set<Interceptor> 를 보관하는 곳이다.

private Provider<Set<Interceptor>> setOfInterceptorProvider;

값을 할당하는 부분은 다음과 같다.

this.setOfInterceptorProvider =
        SetFactory.<Interceptor>builder(2, 0)
            .addProvider(provideTestInterceptorProvider)
            .addProvider((Provider) logInterceptorProvider)
            .build();

테스트에 사용된 프로젝트에서는 코어 모듈에 Interceptor 가 1개, 제작한 Interceptor 1개로 총 두 개가 선언되어있어 Set<Interceptor>를 생성하는 SetFactory.Builder 에 2가 기재되있는 것을 확인할 수 있다.

만들어진 setOfInterceptorProvider 를 사용하는 곳은 바로 밑에 나온다.

 this.provideClientProvider =
        BaseProvidesModule_ProvideClientFactory.create(
            builder.baseProvidesModule, setOfInterceptorProvider);

그리고 해당 BaseProvidesModule_ProvideClientFactory 에서 setOfInterceptorProvider 의 값을 얻어 바인딩을 진행한다.

public final class BaseProvidesModule_ProvideClientFactory implements Factory<OkHttpClient> {
    private final BaseProvidesModule module;
    private final Provider<Set<Interceptor>> interceptorsProvider;

    public BaseProvidesModule_ProvideClientFactory(BaseProvidesModule module, Provider<Set<Interceptor>> interceptorsProvider) {
        this.module = module;
        this.interceptorsProvider = interceptorsProvider;
    }

    public OkHttpClient get() {
        return provideInstance(this.module, this.interceptorsProvider);
    }

    public static OkHttpClient provideInstance(BaseProvidesModule module, Provider<Set<Interceptor>> interceptorsProvider) {
        return proxyProvideClient(module, (Set)interceptorsProvider.get());
    }

    public static BaseProvidesModule_ProvideClientFactory create(BaseProvidesModule module, Provider<Set<Interceptor>> interceptorsProvider) {
        return new BaseProvidesModule_ProvideClientFactory(module, interceptorsProvider);
    }

    public static OkHttpClient proxyProvideClient(BaseProvidesModule instance, Set<Interceptor> interceptors) {
        return (OkHttpClient)Preconditions.checkNotNull(instance.provideClient(interceptors), "Cannot return null from a non-@Nullable @Provides method");
    }
}

정리

Multibindings 기능은 코드를 생성하는 것에 기반을 두는 Dagger 나 Guice가 가지는 특별한 기능으로 여러 개의 비슷한 객체가 제공될 수 있는 경우에 좀 더 쉽게 처리할 수 있게 해준다.

특히, 코어 모듈과 하위 프로젝트를 따로 관리하는 입장으로서는 코어 모듈은 프로젝트 종속되지 않게 관리를, 하위 프로젝트에서는 프로젝트 특성을 띈 코드만 가지게 할 수 있다는 점이 이 Multibindings 를 한 층 더 특별히 만들어 주는 것 같다.