史上最适合新手的Dagger2教程(三)模型与单例

Dagger2系列教程目录:

史上最适合新手的Dagger2教程(一)基本注入

史上最适合新手的Dagger2教程(二)对象注入

史上最适合新手的Dagger2教程(三)模型与单例

 史上最适合新手的Dagger2教程(四)带参注入

史上最适合新手的Dagger2教程(五)命名、限定与延时加载

上节课的代码中,我们遇到一个问题:使用@Inject注入每次都会new一个无参的新对象。

而在需要使用某一对象,或是单例的情况下,这个注入方式显然是不可取的。

本节课就来讲解Dagger2如何以单例模式注入对象。

我们拿大名鼎鼎的OkHttp3为例,它的构建方法是这样的:

OkHttpClient okHttpClient = new OkHttpClient();

记得添加网络权限:

扫描二维码关注公众号,回复: 2476829 查看本文章
<uses-permission android:name="android.permission.INTERNET"/>

用过OKHttp的都知道,这个实例在整个APP运行过程中只要使用一个,多了会造成严重的性能损耗和大量的GC。

然而,OkHttp的代码不是自己写的,不能直接修改其源码,因此肯定没办法像以往的注入方式一样直接在构建方法上使用@Inject。

这个时候,就轮到模型(@Module)闪亮登场了~

1.建立模型(@Module)

模型(@Module)的作用就是在不修改对象源代码的情况下,将其装入注入器(@Component)。

我们现在就为OkHttp创建一个模型,使用@Module注解将它标记起来:

@Module
public class OkHttpModule {
}

2.创建提供者(@Provides)

Provides,顾名思义——提供者,他用于给Dagger2标记提供参数以及对象的方法

我们在上述模型中,创建一个提供对象的方法,并用@Provides标记起来:

@Module
public class OkHttpModule {
    @Provides
    public OkHttpClient okHttpClientProvider() {
        return new OkHttpClient();
    }
}

3.单例标记(@Singleton)

因为OkHttp的实例需要用到单例模式,这里就轮到@Singleton登场了,

Singleton,翻译过来就是独身的,这个注释是用来标记使用单例模式的提供者(Provides)以及注入器(Component)

@Module
public class OkHttpModule {

    @Singleton//单例标记

    @Provides
    public OkHttpClient okHttpClientProvider() {
        return new OkHttpClient();
    }
}

4.创建单例模型注入器(@Component)

这个注解是不是很熟悉~如果还不熟悉的话,请回顾第一节课!

这里的注入器和第一节的不同,需要指定它的提供者模型(modules = OkHttpModule.class),并标记他是一个单例注入器(@Singleton):

@Singleton//注意:写在Component的上面
@Component(modules = OkHttpModule.class)
public interface OkHttpComponent {

    void inject(MainActivity mainActivity);
}

5.构建项目,生成注入器

Make一下Project,喝口冰阔落。

6.使用模型注入器

不带参数的对象,注入器使用起来是一模一样的,都是DaggerXXXComponent.create().inject(this);

public class MainActivity extends AppCompatActivity {
    @Inject
    OkHttpClient okHttpClient;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        final TextView tv = findViewById(R.id.tv);

        //注入对象
        DaggerOkHttpComponent.create().inject(this);

        /**
            以下为OkHttp使用,与Dagger2无关
        */
        Request request = new Request.Builder().url("https://www.baidu.com/s?wd=世界上最帅的人").build();
        okHttpClient.newCall(request).enqueue(new Callback() {
            @Override
            public void onFailure(Call call, IOException e) {
                runOnUiThread(new Runnable() {
                    @Override
                    public void run() {
                        tv.setText("查无此人");
                    }
                });
            }

            @Override
            public void onResponse(Call call, final Response response) throws IOException {
                runOnUiThread(new Runnable() {
                    @Override
                    public void run() {
                        try {
                            tv.setText(response.body().string());
                        } catch (IOException e) {
                            e.printStackTrace();
                        }
                    }
                });
            }
        });

    }
}

这样一来,就以Dagger2的方式创建了单例OkHttpClient。

那么话说回来,如果不需要单例模式怎么办呢?

如果不需要单例模式,去掉注入器和提供者上的@Singleton注释就好了~

7.踏坑

有些同学就要问了,那在注入的时候,直接注入Activity岂不是复用性更高吗~

@Singleton
@Component(modules = OkHttpModule.class)
public interface OkHttpComponent {
    //这里直接注入Activity
    void inject(Activity activity);
}

那我们现在就开始以这种方式踏坑~

啥玩意儿啊,我明明@Inject了啊,所有代码都准确无误啊!

告诉你,崩溃的原因是:Dagger2是强类型注入的。

我们来看下当你使用Activity注入时,Dagger2生成的代码:

public final class DaggerOkHttpComponent implements OkHttpComponent {
    
    ......

  @Override
  public void inject(Activity activity) {}

看到没,inject方法是空的!空的!空的!

而使用MainActivity注入时:

public final class DaggerOkHttpComponent implements OkHttpComponent {

    ......

  @Override
  public void inject(MainActivity mainActivity) {
    injectMainActivity(mainActivity);
  }

这个时候才有代码。

我不知道这个是目前Dagger2的Bug,还是作者为了让你“优雅的编程”,故意这样设计的,

总而言之,在写注入器的时候,一定要按强类型进行注入!【毕竟帮不帮你注入是Dagger2说了算

那么关于Dagger2单例模式注入就到这里。

下节课我们讲解Dagger2如何注入一个带参数的对象

猜你喜欢

转载自blog.csdn.net/u014653815/article/details/81214499