Dagger2系列——实例解析

这篇文章会分享一下实际应用中的Dagger2如何使用,以及Dagger2通过apt插件如何给我们生成代码,以及生成的代码之间的关联。

下面说一下模拟的业务场景:

主界面MainActivity通过MainPresenter去请求一个接口,并返回数据。这里用的是MVP+Retrofit2+RxJava,如果不熟悉可以先不管,因为不会涉及太多,而这篇内容主要分享的是Dagger2。

如果mvp不清楚的可以借鉴 mvp google 写法;RxJava和Retrofit后期我也会分享出来(知道的略过),欢迎关注!!!

先看下关于Dagger部分的包目录结构:

首先我需要一个全局的网络请求对象IRetrofitRequest放在Application,并且是单例的。所以写了一个RetrofitModule提供IRetrofitRequest实例。

@Singleton
@Component(modules = {AppModule.class, RetrofitModule.class})
public interface AppComponent {
    IRetrofitRequest request();
    Context getContext();
}

其中request();方法返回的IRetrofitRequest对象需要上面代码块1:依赖的RetrofitModule类中进行实例化:如下代码

@Module
public class RetrofitModule {
    @Provides
    @Singleton
    public IRetrofitRequest getService() {
        OkHttpClient httpClient = new OkHttpClient.Builder()
                .connectTimeout(30, TimeUnit.SECONDS)//设置请求超时时间
                .retryOnConnectionFailure(true)//设置出现错误进行重新连接
                .build();
        Retrofit retrofit = new Retrofit.Builder()
                .baseUrl(UrlConst.URL)
                .addConverterFactory(GsonConverterFactory.create())
                .addCallAdapterFactory(RxJavaCallAdapterFactory.create())
                .client(httpClient)
                .build();
        return retrofit.create(IRetrofitRequest.class);
    }
}

代码块2:中提供的IRetrofitRequest 实例对象必须要用@Provides标注,该对象是单例的所以用@Singleton标注,这里为什么用这两个注解标注之后就能实现为AppComponent提供单例的实例,稍后会进行Dagger2生成的代码解析。

当然一个Component类可以依赖多个Module,如代码块1:中还依赖了AppModule,AppModule中提供了在Component方法名是getContext()的实例对象,如下代码:

@Module
public class AppModule {
    private Context context;
    public AppModule(Context context) {
        this.context = context;
    }
    @Provides
    public Context getContext() {
        return context;
    }
}

如代码块2和3所示,所有的被Component依赖的Module都必须用@Module注解标注。因为Dagger2需要这些标注通过apt插件自动生成代码。

在AppComponent中提供的IRetrofitRequest单例对象如何在Application中使用呢?

public class App extends Application {
    private static AppComponent appComponent;
    @Override
    public void onCreate() {
        super.onCreate();
        appComponent = DaggerAppComponent.builder()
                .appModule(new AppModule(getApplicationContext()))
                .retrofitModule(new RetrofitModule())
                .build();
    }
    public static AppComponent getComponent() {
        return appComponent;
    }
}

上面代码中的DaggerAppComponent是Dagger2帮我们自动生成的,只要编译一下就可以自动生成。

AppComponent需要初始化依赖的两个Module(AppModule和RetrofitModule),这里生成的DaggerAppComponent是通过构建者模式进行初始化的。

.appModule(new AppModule(getApplicationContext()))
.retrofitModule(new RetrofitModule())

最后创建的AppComponent就提供了IRetrofitRequest全局单例对象,整个app的网络访问都可以通过该对象进行调用。

AppComponent后期拓展:

一个全局的变量现在统一都可以放在AppComponent中进行管理,这个demo中有网络请求的一个单例接口对象,一个是全局的Context对象。后期肯定会有其他的都可以放在AppModule中进行实例化,或者单独再写一个Module依赖到AppComponent中。

在MainActivity中如何进行使用:

这里用的是mvp开发模式,所以需要一个Presenter:MainActivityPresenter,需要传递一个参数,用于操作MainActivity界面:MainActivityContract.View,而这个MainActivityPresenter谁来提供呢?当然是Component通过依赖的Module来提供,看看MainActivity的Component和Module。

@ActivityScope
@Component(dependencies = AppComponent.class, modules = {MainActivityModule.class})
public interface MainActivityComponent {
    void inject(MainActivity mainActivity);
}
@Module
public class MainActivityModule {
    private MainActivityContract.View view;
    public MainActivityModule(MainActivityContract.View view) {
        this.view = view;
    }
    @ActivityScope
    @Provides
    public MainActivityPresenter getMainActivityPresenter() {
        return new MainActivityPresenter(view);
    }
}

这里的代码块5和6,你会发现我们在MainActivityModule 里提供了MainActivityPresenter实例,但是在MainActivityComponent接口里并没有写上提供MainActivityPresenter的方法,另外还多了一个void inject(MainActivity mainactivity),这里跟AppComponent中的(代码块1)有区别是咋回事?等会解释。

再看MainActivity代码:

public class MainActivity extends BaseActivity implements MainActivityContract.View {
    @Inject
    MainActivityPresenter presenter;
    @Inject
    SecondActivityPresenter secondActivityPresenter;
    @Bind(R.id.textView)
    TextView textView;
    @Bind(R.id.textView2)
    TextView textView2;
    @Override
    public void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        ButterKnife.bind(this);
        presenter.start();
        secondActivityPresenter.set();
    }
    @Override
    public void providers() {//该方法是BaseActivity中onCreate()中调用的抽象方法
        DaggerMainActivityComponent.builder()
                .mainActivityModule(new MainActivityModule(this))
                .appComponent(App.getComponent())
                .build()
                .inject(this);
    }
    @OnClick({R.id.textView, R.id.textView2})
    public void onClick(View view) {
        switch (view.getId()) {
            case R.id.textView:
                startActivity(new Intent(this, SecondActivity.class));
                break;
            case R.id.textView2:
                break;
            default:
                break;
        }
    }
    @Override
    public void showSuccess() {
        T.show(this, "成功");
    }
    @Override
    public void showFailed() {
        T.show(this, "失败");
    }
}

先解释一下providers()方法:该方法是BaseActivity中onCreate()中调用的抽象方法。

@Inject
MainActivityPresenter presenter;

注意1:但是在整个MainActivity中却找不到初始化的过程,再看providers()方法中的代码,跟App中有区别的是,我这里并没有写成

MainActivityComponent mainActivityComponent = DaggerMainActivityComponent.builder()
                .mainActivityModule(new MainActivityModule(this))
                .appComponent(App.getComponent())
                .build();

注意2:还有的区别是多了一个

.inject(this);

原因:

1.因为在App中我并没有哪个对象的声明用了@Inject注解进行标注,而且App中的AppComponent实例对象需要给其他Activity或者类使用。

2.在该demo中的MainActivity,我们不需要其他地方用到MainActivityComponent对象,我们只是在MainActivity用到MainPresenter对象,我们可以不用通过MainActivityComponent中的某一个方法获得MainPresenter对象,我们在用@Inject标注MainActivityPresenter presenter的时候需要把在哪里声明的外部类(这里是MainActivity)注入到MainComponent中,就是上面(代码块5)说过的没有提供返回MainPresenter的方法却多了一个void inject(MainActivity mainactivity);这里的返回值是void的inject方法名可以是任意的,但是最好写成inject(官方写法)。

最后只要调用了providers()方法,我们的MainPresenter presenter对象就已经被初始化了,这个时候就可以通过presenter.start()去调用网络接口请求数据了;

只要我们配置了以上的Component,Module,编译之后Dagger2就会通过apt插件生成一系列代码。

那么一系列代码到底是怎样的?到底是怎样工作的呢?

先看下生成的代码目录结构:

可以看到生成的代码包名还是跟自己代码中的一样,生成的代码的类名也有一定的规则。

代码是根据什么注解生成的:

  • 用@Component注解标注的xxxComponent类会生成DaggerxxxComponent类
  • 用@Module注解标注的xxxModule中用@Provides注解标注的每个方法都会生成一个类,这个类是一个工厂模式,提供对象实例,比如:
@Module
public class AAModule{
    @ActivityScope
    @Providespublic 
    BB getBB() {
        return new BB();
    }
}

getBB()方法就会生成AAModule_GetBBFactory类。

  • 如果一个类的构造函数用了@Inject注解标注:例如:
public class CC{
    @Inject
    public CC() {
    }
}

就会生成CC_Factory类。

  • 如果一个类中有用@Inject注解标注对象声明他就会生成:比如demo中的MainActivity;
public class MainActivity extends BaseActivity implements MainActivityContract.View {   
     @Inject
     MainActivityPresenter presenter;
}

Dagger2就会自动生成MainActivity_MembersInjector。

代码之间的关联

分析图箭头的结尾是DaggerMainActivityComponent,也就是最后暴露给我们的就是DaggerMainActivityComponent这个类,其它帮助我们生成的代码都可以不用关心。

原文发布于微信公众号 - Android机动车(JsAndroidClub)

原文发表时间:2018-08-27

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏向治洪

Android Remote Views

听名字就可以看出,remote views是一种远程view,感觉有点像远程service,其实remote views是view的一个结构,他可以在其他的进程...

20670
来自专栏世界第一语言是java

Android全能开源项目xUtils3开发教程、简单封装

25040
来自专栏酷玩时刻

统一管理项目中的接口回调

无论是 Java Web 开发还是 Android 开发我们都避免不了异步处理业务的逻辑。有异步的出现一定就有异步结果(接口)的回调。你之前是不是有为每一个异步...

10240
来自专栏Android开发小工

在Android开发中怎样使用Application类

自己独立开发项目才发现以前对Application类并不是十分了解,现在开始直接搭建一个新项目的框架才重新踩过这个坑。

14350
来自专栏码农笔录

Android全能开源项目xUtils3开发教程、简单封装

19820
来自专栏Android相关

AAC---LiveData

LiveData是一个与Activity/Fragment生命周期相关(lifecycle-aware)的Observer类。而这种相关性(awareness ...

12720
来自专栏学海无涯

Android开发之Retrofit小试牛刀

感觉好久没有写Android的文章了,囧囧囧!因为Retrofit实在是太火了, 火得我一直跃跃欲试,但是由于种种原因吧,一直都没有用过。周末闲来无事,利用一个...

29690
来自专栏静默虚空的博客

NSIS 打包脚本基础

简介 NSIS(Nullsoft Scriptable Install System)是一个开源的 Windows 系统下安装程序制作程序。它提供了安装、卸载、...

56260
来自专栏Android机动车

Retrofit实现带进度下载

Retrofit是目前最主流的网络框架了,它对网络请求几近完美的封装,大大降低了我们开发者的研发难度,缩短了研发周期。最近项目中遇到了下载视频和图片文件的需求(...

14120
来自专栏漏斗社区

天空飘来五字:Android逆向smali

本期,我们将继续Android逆向动态分析之smali篇。内容包括smali语言介绍与动态调试。

14920

扫码关注云+社区

领取腾讯云代金券