DevRing

介绍

DevRing是一个提供了常用模块的安卓基础开发库。
主要包括 网络请求、图片加载、数据库、事件总线、缓存、权限管理、工具类 模块。

其中，网络请求使用Retrofit+RxJava实现，图片加载使用Glide实现（可替换），数据库使用GreenDao实现（可替换），事件总线使用EventBus实现（可替换），权限管理使用RxPermission实现。

Demo采用MVP+Dagger2进行开发，对以上提及的框架不熟悉的建议先学习了解，底部也有相关的博客链接。

使用

详细使用说明请点这里

1.添加依赖

在项目module下的gradle中添加以下依赖：

compile 'com.ljy.ring:devring:1.0.5'

由于数据库、图片加载、事件总线模块支持替换其默认实现的框架，所以库中对GreenDao，Glide，EventBus的依赖是使用compileOnly（仅在编译时依赖），这么做是为了避免被替换的框架依然参与打包，从而增加了apk大小。
也就是说，对于这三个模块，当你需要使用相关框架时，还需添加其依赖。

如果要使用Devring库的图片加载模块（默认Glide），那么需要添加Glide依赖

compile 'com.github.bumptech.glide:glide:4.4.0'

如果要使用Devring库的数据库模块（默认GreenDao），那么需要添加GreenDao依赖

//Project下的build.gradle文件中加入
classpath 'org.greenrobot:greendao-gradle-plugin:3.2.0'

//Module下的build.gradle文件中加入
apply plugin: 'org.greenrobot.greendao'
compile 'org.greenrobot:greendao:3.2.0'

如果要使用Devring库的事件总线模块（默认EventBus），那么需要添加EventBus依赖

compile 'org.greenrobot:eventbus:3.0.0'

2.初始化、配置、构建

在Application的onCreate中进行初始化、配置、构建。
务必按顺序执行这三步。

//1.初始化
DevRing.init(this);


//2.根据你的需求进行相关模块的全局配置

//配置网络请求模块，如BaseUrl,连接超时时长，Log，全局Header，缓存，失败重试等
DevRing.configureHttp().setXXX()...

//配置图片加载模块，如替换实现框架，加载中图片，加载失败图片，开启过渡效果，缓存等
DevRing.configureImage().setXXX()...

//配置事件总线模块，如替换实现框架，EventBus的index加速
DevRing.configureBus().setXXX()...

//配置数据库模块、替换实现框架
DevRing.configureDB(dbManager);  

//配置缓存模块，如磁盘缓存的地址、大小等
DevRing.configureCache().setXXX()...

//配置其他模块，如是否显示RingLog，是否启用崩溃日志等
DevRing.configureOther().setXXX()...


//3.构建
DevRing.create();

3.开始调用

通过DevRing.xxxManager()得到相关模块的管理者，然后进行具体操作。

//网络请求模块：
//普通请求、上传请求、下载请求、监听上传下载进度、生命周期控制等。
DevRing.httpManager().xxx();

//图片加载模块:
//各类型图片的加载，可设置加载要求（圆形、圆角、模糊、灰白），下载图片，获取Bitmap等
DevRing.imageManager().xxx();

//事件总线模块：
//订阅、解除订阅，发送普通事件，发送粘性事件
DevRing.busManager().xxx();

//数据库模块：
//对key值对应的数据表进行增删改查等
DevRing.tableManager(key).xxx();

//缓存模块：
//提供内存缓存，磁盘缓存，SharedPreference缓存
DevRing.cacheManager().xxxCache().xxx();

//其他模块：权限管理、Activity栈管理
DevRing.permissionManager().xxx();
DevRing.activityStackManager().xxx();

...

4.LifeCycleCallback

提供了ActivityLifeCallback 和 FragmentLifeCallback，以实现基类的功能。
只需Activity实现IBaseActivity接口即可完成相关的基类操作。
只需Fragment实现IBaseFragment接口即可完成相关的基类操作。
具体请查看关于基类的那些事以及项目代码

5.工具类

提供了部分常用的工具类：
ColorBar（设置导航栏/状态栏颜色），FileUtil（文件操作工具类），RingLog（可定位的Log打印），RingToast（吐司工具类），ImageUitl（图片工具类），NetworkUtil（网络状态工具类）等。

6.注意事项

DevRing库中AndroidManifest已添加了网络权限，所以主项目不必重复添加。
DevRing库中已添加了Dagger2，Retrofit2，RxJava2，RxAndroid2，RxLifeCycle2，RxPermission2的依赖，所以主项目不必重复添加。
配置参数为File时，请自行确保对传入的file具有可读写权限，如果没有需先进行权限申请。
部分框架需忽略混淆，具体的混淆配置请参考Demo中app下的proguard-rules.pro文件。