关于 Dagger2+Mvp+rxjava+retroft2.0 的一点实践

1,238 阅读5分钟
原文链接: www.jianshu.com

前言


做这个项目的初衷是想练手,因为现在rxjava+retrofit框架相当火,而公司的同事正在用这个框架也觉得很方便,于是心痒难耐,决定学习这个框架。

介绍

Dagger2主要的作用就是依赖注入,我的理解就是当配置好Dagger的时候,不论哪里想用只要一个@Inject就OK了,非常方便。比如在全局配置好 Gson,Glide,联网框架等。(需要注意的是dagger2需要先写好Component和module 然后AS Rebuild 自动生成一个类,具体参考

DPY{E)V3NKUV~93KA5BXO6E.png


命名方法一般是你的Dagger+Component名字
例:DaggerApplicationComponent)
例子
App application();


SharedPreferences sharedPreferences();

Gson gson();

DataManager dataManager();

ApiService apiservice();


rxjava+retroft2.0这两个我是一起用的,因为retofit2中有接口支持rxjava,两者结合逻辑清晰,耦合性低,效率更高。
例:
return new Retrofit.Builder()
.baseUrl(zhihuUrl)
.client(okHttpClient)
.addConverterFactory(GsonConverterFactory.create())
.addCallAdapterFactory(RxJavaCallAdapterFactory.create())
.build();
其中.addCallAdapterFactory(RxJavaCallAdapterFactory.create())就是相关接口。

开始
由于自己也是新学这个框架,理论方便也不是很通透,就不提太多理论了。打算结合着项目把这个框架尽量解读出来,希望这个框架对大家以后的开发有所帮助。

一、配置gradle(添加依赖)

配置Dagger2

在主项目的build.gradle中添加
classpath 'com.neenbedankt.gradle.plugins:android-apt:1.8'
在Module的build.gradle中添加
compile 'com.google.dagger:dagger:2.6'
apt 'com.google.dagger:dagger-compiler:2.6'

配置RxJava+Retrofit2

//retrofit2
compile 'com.squareup.retrofit2:retrofit:2.1.0'
compile 'com.squareup.okhttp3:okhttp:3.4.1'
compile 'com.squareup.okhttp3:logging-interceptor:3.3.0'
compile 'com.squareup.retrofit2:converter-gson:2.0.0-beta3'
compile 'com.squareup.retrofit2:adapter-rxjava:2.0.1'
//rxjava
compile 'io.reactivex:rxjava:1.1.0'
compile 'io.reactivex:rxandroid:1.1.0'
compile 'com.tbruyelle.rxpermissions:rxpermissions:0.7.0@aar'
compile 'com.jakewharton.rxbinding:rxbinding:0.4.0'
compile 'com.jakewharton.rxbinding:rxbinding-support-v4:0.4.0'
compile 'com.jakewharton.rxbinding:rxbinding-appcompat-v7:0.4.0'
compile 'com.jakewharton.rxbinding:rxbinding-design:0.4.0'
compile 'com.jakewharton.rxbinding:rxbinding-recyclerview-v7:0.4.0'

其他

//Glide
compile 'com.github.bumptech.glide:glide:3.7.0'
//butterknife
compile 'com.jakewharton:butterknife:7.0.1'

配置到这里基本上就算完了,如果配置完还有什么错误,可以参考我的项目源码进行配置,万望海涵。(传送门:
github.com/xiaoluYi/Ya…

二、项目搭建。

我的工程目录
api:网络配置
data: javabean
injector: Dagger2(component、module、scope)
mvp: module、view、presenter
ui: activity、adapter、base(基类)、fragment
utils: 工具类(很多都没有用到)
widget: 空
APP: 全局App
Constants: 常量

首先App extends Application 在onCreat进行Dagger2初始化.


[{C$}S_6SQCK2]3PS}OR9KR.png


ApplicationComponent为连接器(component),连接module和将要注入的class.


(~W~ELV98R3%(3NUJ(UW)RT.png


三个Module,
ApplicationModule (全局App)
DataModule 提供一个SharedPreferences对象
ApiModule 网络连接

Module和Component关系
(Module类的上方应注解为@Module,Component类上方注解@Component),
每个module里边标注@Provides的方法,都会返回一个对应的实例,
例如:
ApplicationModule里边
@Provides
@Singleton
public App provideApplication() {
return mApplication;
}

返回了一个mApplication(类型为App),对应ApplicationComponent的 App application();

需要注意的是返回的实例上需要标注 @Provides(我理解的实例提供者)
DataModule 对应的 @Provides方法返回的是一个SharedPreferences实例。
ApiModule对应的 @Provides方法返回的是一个ApiService实例。
(@Provides标注的方法提供的实例 可在任意module的里边直接使用,参见ApiModule.class)

这样component和Modeule就配置完成了,返回App.class编译。
private static ApplicationComponent mApplicationComponent;
mApplicationComponent = DaggerApplicationComponent.builder().
applicationModule(new ApplicationModule(this))
.dataModule(new DataModule())
.apiModule(new ApiModule())
.build();

命名规则(Dagger+ApplicationComponent)

Build-------ReBuild Project;
全局的Dagger2配置完成。
使用方式,
@Inject
ApiService apiservice;(后边会继续讲解)

配置Retrofit2+Rxjava

配置主要是在刚才的ApiModule.class配置.
首先
@Provides
@Singleton
//这个类提供一个Retrofit 实例
Retrofit provideRetrofit(OkHttpClient okHttpClient) {
return new Retrofit.Builder()
//例如我是用的是知乎日报api( String zhihuUrl = "news-at.zhihu.com/api/4/";)
.baseUrl(zhihuUrl)
//联网方式okhttp3(需要一个okHttpClient实例)
.client(okHttpClient)
//Gson解析工厂(需要一个Gson解析工厂实例,这里用的是最简单的系统提供的,一般需 要重写GsonConverterFactory的子类来保证数据的安全性)
.addConverterFactory(GsonConverterFactory.create())
//重点:这一步是retrofit2与rxjava结合的重要步骤(retrofit2为rxjava提供的支持接口)
.addCallAdapterFactory(RxJavaCallAdapterFactory.create())
.build();
}

需要一个okHttpClient实例 @Provides
@Singleton
OkHttpClient provideOkHttpClient(@ForApplication Context context) {
OkHttpClient.Builder builder = new OkHttpClient.Builder()
.connectTimeout(15 1000L, TimeUnit.MILLISECONDS)//15
.readTimeout(20
1000L, TimeUnit.MILLISECONDS)//20
.writeTimeout(30 * 1000L, TimeUnit.MILLISECONDS)//15
.cache(new Cache(new File(CacheUtil.getHttpCacheDir(context), OKCLIENT_DISK_CACHE_NAME),
OKCLIENT_DISK_CACHE_SIZE)); //设置缓存目录和20M缓存
return builder.build();
}

这些配置好了以后Retrofit的实例配置完成,这样调用
@Provides
@Singleton
ApiService provideApiService(Retrofit retrofit) {
return retrofit.create(ApiService.class);
}
返回一个ApiService对应@Component ApplicationComponent 的
//retrofit2
ApiService apiservice();

这样就算简单的配置好了。使用的时候这样用(最简单的一种使用方式)
@Inject
ApiService apiService;

apiService.getData()
.subscribeOn(Schedulers.io())
.observeOn(AndroidSchedulers.mainThread())
.subscribe(new Subscriber<TitileBean>() {
@Override
public void onCompleted() {
//网络请求完成
}
@Override
public void onError(Throwable e) {
//网络请求失败
}
@Override
public void onNext(TitileBean titileBean) {
//网络请求成功
}
});
apiService.getData()方法是在ApiService.class(刚才配置过)
//get方式请求
@GET("themes")
Observable <TitileBean> getData();

三、基类avtivity的Dagger2配置

类名: ui.base.BaseAct
(通常情况下每个Activity会对应一个Component,那现在就为BaseAct创建一个ActivityComponent:
@ActivityScope
@Component(dependencies = ApplicationComponent.class, modules = ActivityModule.class)
public interface ActivityComponent {
void inject(GuiderActivity guiderActivity);
void inject(MainAct mainAct);
}

这里就把AppComponent中提供的一些对象依赖了过来,实现了全局共用。同时声明一个inject方法,参数是你要注入到的类。
public ActivityComponent getActivityComponent() {
if (mActivityComponent == null) {
mActivityComponent = DaggerActivityComponent.builder()
.applicationComponent(App.getApplicationComponent())
.activityModule(new ActivityModule(this))
.build();
}
return mActivityComponent;
}

关于MVP主要是几个基类的配置和相互关联,可以看我的ui.base里边的几个基类,看不懂的话直接拿来用也可以。

第一次写技术文章,由于自己才疏学浅,技术不扎实,万望海涵。

参考文章:

我的Dagger2学习历程:从一头雾水到恍然大悟(gold.xitu.io/post/587228…
Android 手把手教你使用Retrofit2:(www.jianshu.com/p/732169398…
项目借鉴知乎API:(github.com/izzyleung/Z…

一点想法:
当初只是简单的想学习一下rxjava+retofit2,后来就想着把dagger2也加进去,刚好公司大神对Mvp比较熟悉,就一起学习了。本文是在公司大神的参照下写的项目,期间看了掘金的许多技术文章、git的Dagger2 most star的许多项目,对这些无私的作者和大神表示感谢。但是由于基础较差一直理解不了dagger2,一度想过放弃,因为无法生成DaggerApplicationComponent这个编译的类,恼火了很久。现在把自己的一些经验给写出来,希望共勉。如果对该项目有什么不解,请留言,我有时间都会回复的(在我能力范围之内)。

如果我的项目对你有所帮助,请随手star,多谢。
传送门:github.com/xiaoluYi/Ya…