Dagger2 之模块化划分

本篇是 Dagger2 系统学习的第三篇,注意:在看本篇内容的时候,希望你已经看过了前两篇内容,否则的确看不懂本篇文章在说些什么

好了,到此说明你已经看过前两篇文章了。

通过前两篇相信对 Dagger2 已经入门了,然后本篇目的学会和理解 Dagger2 模块化划分。


还是针对上一篇的代码的瓦基础上进行修改。

学习过前两篇的同学应该清楚,有一个 ApiServer 类是实现云端存储数据的,因此需要用到网络的功能。代码写了出来:

public class ApiServer {

    OkHttpClient mOkHttpClient;

    @Inject
    public ApiServer(OkHttpClient okHttpClient){
        Log.e("Howard","ApiServer--->start");
        this.mOkHttpClient = okHttpClient;
    }

    /**
     * 往服务端保存用户信息
     */
    public void register() {
        Log.e("Howard","ApiServer--->register");
        RequestBody body = RequestBody.create(MediaType.parse("JSON"),"");
        Request request = new Request.Builder()
                .url("https://xiaozhuanlan.com/dagger")
                .post(body)
                .build();
        mOkHttpClient.newCall(request).enqueue(new Callback() {
            @Override
            public void onFailure(Call call, IOException e) {

            }

            @Override
            public void onResponse(Call call, Response response) throws IOException {

            }
        });
    }

}

这里使用到了 OkHttpClient 这个实例,是通过 ApiServer 构造方法传过来的。构造方法传入了参数,因此,对于 UserModule 的代码需要做以下修改:

    @Provides
    public ApiServer provideApiServer(OkHttpClient okHttpClient){
        Log.e("Howard","provideApiServer--->start");
        return new ApiServer(okHttpClient);
    }

这个 OkhttpClient 在哪里提供呢?

按照上一篇的讲解,应该需要在 UserModule 里面提供如下代码:

    @Provides
    public OkHttpClient provideOkhttpClient(){
        return new OkHttpClient().newBuilder().build();
    }

这样在功能上想的确没有任何问题。但是,这里在开发角度考虑是存在问题:
在安卓项目开发中,访问网络的地方超级多,当每一次访问网络的时候,就会调用 provideOkhttpClient 这个方法,然后实例化。显然,是非常的消耗性能的。而且,可能多个 Module 都需要进行网络操作使用 Okhttp,在每个 Module 中又都需要去创建对应的方法,显然比较繁琐,维护成本也比较高。所以这里又是有问题的。

因此,最好把 Okhttp 相关的放在一个单独的 Module 里面,如下:
创建一个 HttpModule 类:

@Module
public class HttpModule {

    @Provides
    public OkHttpClient provideOkhttpClient(){
        return new OkHttpClient().newBuilder().build();
    }
    
}

这里专门针对 Http 写了一个 Module,并加上了 @Module 注解,然后通过 provideOkhttpClient 方法获取 OkhttpClient 实例。

这样做有什么好处呢?先看看怎么使用吧:

目的肯定是希望 UserModule 能够拿到 HttpModule 那边提供的 OkhttpClient 实例嘛。
常见一下两种方式:

  • 方式一:
    在 UserModule 的注解旁边通过 includes 方式。
@Module(includes = HttpModule.class)

然后在 Activity 端的代码:

        DaggerUserComponet.builder().userModule(new UserModule(getApplicationContext()))
                .httpModule(new HttpModule())
                .build().inject(this);
  • 方式二
    在 UserComponet 的注解里面加入多个 Module(上一篇也讲过了,可以添加多个 Module )
@Component(modules = {UserModule.class,HttpModule.class})

那么这样有什么好处呢?相信有点很明显了,这样做只需要通过注解引入的方式就可以拿到 OkHttpClient 实例了,不需要每个与网络有关的Module里面都去提供最初的 provideOkhttpClient 方法,提高了代码的可维护性。后面讲解 SingLenton 的时候更能体现 Dagger2 单例的优点。

通过本文学习,主要理解模块化划分的原因和好处。下一篇主要讲解限定符 @Qualifier

你可能感兴趣的:(Dagger2 之模块化划分)