Sugar-快速开发安卓项目，流行框架封装mvp + rxjava2 + retrofit2 + rxlifecycle2 + arouter...

时间 2019-11-09

标签 sugar 快速开发项目流行框架封装 mvp rxjava2 rxjava retrofit2 retrofit rxlifecycle2 rxlifecycle arouter 栏目 Android 繁體版

原文原文链接

🍯 Sugar

需求：新项目只需5分钟接入，以后直接开撸，不用关心网络、图片、模式、稳定等问题，支持mvp一个activity对应多个presenter。适用本身的才是最好的！java

更新日志

2019-09-06 更新 1.0.1.7 图片加载，ImageView扩展，fragment懒加载android
2019-06-24 更新 1.0.1.5 anko ui注解初始化+自定义ConverterFactorygit
2019-06-17 更新 kotlin-mvp temeplegithub
2019-06-14 更新 kotlin接入express
2019-06-05 更新游手好闲之使用MotionLayout实现高德地图bottomSheets效果apache
2019-05-31 更新 1.0.1.3升级到androidxjson
2019-05-29 最新，新鲜temeple出炉，请拉到最后看效果api
...缓存

`1.0.1.7`

主要新增，图片加载库图片加载，任意选择加载引擎打造统一的图片加载框架，融合Glide（4.x），Fresco,不侵入业务代码，一套API兼容两种加载库bash

@Override
    public AppSetting getAppSetting() {
        return getAppSettingBuilder()
                .isDebug(true)
                .build();
    }

    @Override
    public AppImageLoadSetting getImageLoadSetting() {
        return AppImageLoadSetting
                .builder()
                .imageLoaderConfig(getImageLoaderConfig())
                .isCrossFade(true)
                .errorholder(R.mipmap.ic_launcher_round)
                .placeholder(R.mipmap.ic_logo)
                .build();
    }
复制代码

`1.0.1.5`

主要新增anko支持,经过注解解耦使用AnkoUi,不须要手动初始化，直接使用ankoUi

顶部TYPE注解

@AnkoInject(ui = xxAnkoUi::class) 
复制代码

变量FIELD注解

@AnkoVariable
    internal var ui : xxAnkoUi? = null
复制代码

而后可直接使用ui这个变量，以下:

GankAnkoActivity

@AnkoInject(ui = GankActivityUi::class)
@Route(path = RouterPageContant.KT_ANKO)
@CreatePresenter(presenter = [GankPresenter::class])
class GankAnkoActivity : BaseAnkoActivity(), GankContract.IView {

    @PresenterVariable
    internal var mPresenter: GankPresenter? = null
    @AnkoVariable
    internal var ui : GankActivityUi? = null

    @SuppressLint("NewApi")
    override fun init(savedInstanceState: Bundle?) {
        setSupportActionBar(ui?.toolbar)
        supportActionBar?.setDisplayHomeAsUpEnabled(true)
        supportActionBar?.title = "KtGankActivity"
    }

    override fun loadData() {
        mPresenter?.getFuliDataRepository("20", "1")
    }

    override fun bindData(data: MutableList<GirlsData>?) {
        val jsonStr = JSON.toJSONString(data)
        ui?.textInfo?.text = jsonStr
    }
    override fun onOptionsItemSelected(item: MenuItem?): Boolean {
        when (item?.itemId) {
            android.R.id.home -> {
                finish()
                return true
            }
        }
        return super.onOptionsItemSelected(item)
    }

}
复制代码

GankAnkoFragment

@AnkoInject(ui = GankFragmentUi::class)
@CreatePresenter(presenter = [TestGankPresenter::class])
class GankAnkoFragment: BaseAnkoFragment(),  GankContract.IView {

    @PresenterVariable
    internal var mPresenter: TestGankPresenter? = null
    @AnkoVariable
    internal var ui : GankFragmentUi? = null

    override fun init(savedInstanceState: Bundle?) {

    }

    override fun initImmersionBar() {
        ImmersionBar.with(this)
                .transparentStatusBar()
                .fitsSystemWindows(true)
                .statusBarColor(R.color.colorPrimary)
                .statusBarDarkFont(true, 0.2f)
                .init()
    }



    override fun loadData() {
        mPresenter?.getFuliDataRepository("10", "1")
    }

    override fun bindData(data: MutableList<GirlsData>?) {
        val jsonStr = JSON.toJSONString(data)
        ui?.textInfo?.text = jsonStr
    }
}
复制代码

`1.0.1.4`

SugarHandleSubscriber 用于接口请求时候仅处理onNext(),由于在SugarRepository里面的customObservable(Observable observable)函数里面统一处理了错误异常抓取，通常状况下不须要再处理OnError固然能够重载函数的时候作处理

.doOnError(throwable -> {
                    LogUtils.i("doOnError------" + throwable);
                    if (mIView != null) {
                        mIView.showLoadFailed();
                    }
                    if (rxErrorHandler != null){
                       //统一异常抓取
                       rxErrorHandler.getHandlerFactory().handleError((Throwable) throwable);
                    }

                });
复制代码

使用SugarHandleSubscriber

java :

@Override
    public void getFuliDataRepository(String size, String index) {

        mModel.getFuliDataRepository(size, index)
                .subscribe(new SugarHandleSubscriber<List<GirlsData>>() {
                    @Override
                    public void onNext(List<GirlsData> girlsData) {
                        mView.bindData(girlsData);
                    }
                });
    }
复制代码

kotlin

mModel.getFuliDataRepository(size, index)
                .subscribe({
                    mView.bindData(it)
                })
复制代码

1.0.1.4版本以后 Presenter不支持在Activity/Fragment后写泛型，只支持注解

java:

@CreatePresenter(presenter = GankPresenter.class)
public class GankActivity extends BaseActivity implements GankContract.IView{
    @PresenterVariable
    GankPresenter mPresenter;
}
复制代码

kotlin

@CreatePresenter(presenter = [GankPresenter::class])
class KtGankActivity : BaseActivity(), GankContract.IView{
    @PresenterVariable
    internal var mPresenter: GankPresenter? = null
}
复制代码

实用到的库(排名不分前后)

Retrofit你懂的

ImmersionBar状态栏工具

ToastUtils 简单实用toast

RxErroHandler rxjava异常获取

RetrofitUrlManager retrofit动态绑定url

EasyMvp个简单强大且灵活的MVP框架

AndroidUtilCode 强大的工具库

RxLifecycle 为rxjava而生你懂的

Gloading 深度解耦Android App中全局加载中、加载失败及空数据视图

RxJava 不解释

RxAndroid 不解释

RxPermissions Android runtime permissions powered by RxJava2

Okhttp 不解释

Gson 不解释

Timber JakeWharton大神的日志打印工具

ARouter 阿里出的路由库

lottie

...以及忘了加上的

使用效果

图片有压缩,能够下载demo apk进行体验 demo-debug.apk

安装和依赖

3种选择

一、 git clone https://github.com/wobiancao/sugar.git
    implementation project(':sugarlibrary')
    
二、 implementation 'com.wobiancao:sugarlibrary:{version}'

三、 allprojects {
		repositories {
			...
			maven { url 'https://jitpack.io' }
		}
	}
implementation 'com.github.wobiancao:sugar:{version}'
复制代码

统一配置

建立DemoConfigure 继承于SugarConfigure 重载相关方法便可：

网络配置(Retrofit和okhttp3)Retrofit请求，rxbus等）
状态栏默认颜色ImmersionBar
toast样式ToastUtils你能够不用设置，有默认的
RxErroHandler rxjava异常获取
网络设置直接见代码便可，跟retrofit同样的配置,写了一些默认的拦截器可继承后使用也可本身写,host能够动态配置RetrofitUrlManager
解耦页面状态切换Gloading 你能够不用设置，有默认的
默认等待框BaseLoadingDialog你能够不用设置，有默认的
更多详见AppConfigureDelegate

public class DemoConfigure extends SugarConfigure {


    public DemoConfigure(Application application) {
        super(application);
    }

    @Override
    public ResponseErrorListener getErrorResponse() {
        return new ResponseErrorListener() {
            @Override
            public void handleResponseError(Context context, Throwable t) {
                LogUtils.i("捕获异常---" + t.getMessage());
                ToastUtils.show("发生异常---" + t.getMessage());
            }
        };
    }

    @Override
    public int getStatusColor() {
        return R.color.colorPrimary;
    }

    @Override
    public AppHttpSetting getHttpSetting() {
        return AppHttpSetting
                .builder()
                .with(mApplication)
                //设置初始的baseUrl host
                .setBaseUrl(Gank.HOST)
                //动态修改baseUrl 具体看https://github.com/JessYanCoding/RetrofitUrlManager
                .putDomain(Wan.DOMAN, Wan.HOST)
                //是否打印网络请求日志 默认否
                .setHttpLog(true)
                //百度Stetho便可 网络监测等 默认否
                .setHttpMoniter(true)
                //设置缓存时间 默认60s
                .setCacheMaxTime(65)
                //设置链接超时 默认20s
                .connectTimeout(20)
                //设置读取超时 默认20s
                .readTimeout(20)
                //设置写入超时 默认20s
                .writeTimeout(20)
                //请求header
                .addHeaderInterceptor(getHeader())
                //添加请求明文公共参数
                .addCustomHeaderInterceptor(getCustomHeader())
                //token过时等请求成功处理 通常不须要处理
//                .addExceptionInterceptor(getExceptionInterceptor())
                //其它拦截
//                .addInterceptor(xx)
//                .addNetworkInterceptor(xxx)
//                配置本身的缓存
//                .cache(xx)
                //甚至另外写一套本身的okhttp builder 也行
//                .setOkHttpBuilder(xxx)
                .build();
    }

    @Override
    public IToastStyle getToastStyle() {
        return new ToastStyle();
    }
}

复制代码

建立DemoApplication继承于 LibApplication < S extends SugarConfigure > 重写initConfigure()初始化配置便可,详见DemoApplication

public class DemoApplication extends LibApplication<DemoConfigure> {

    @Override
    protected void initConfigure() {
        mConfigure = new DemoConfigure(this);
    }

    @Override
    protected void init() {

    }

}

复制代码

网络请求统一配置

问题：咱们使用RetrofitUrlManager 解决了retorfit动态配置baseUrl的问题，可是每一个域名或者说每一个接口返回参数封装等的可能不统一（这种状况通常不会出如今公司项目）好比我这个app要展现Gank.io和WanAndroid的界面,这样就是两个网络请求封装，使用sugar能够快速解决此类问题；
使用以前先看源码SugarRepository

/**
 * @author wobiancao
 * @date 2019/5/20
 * desc :
 */
public class SugarRepository {
    /**
     * 0 没loading 1 dialog形式  2page形式
     */
    protected final static int LOADING_TYPE_NULL = 0;
    /**
     * 0 没loading 1 dialog形式  2page形式
     */
    protected final static int LOADING_TYPE_DIALOG = 1;
    /**
     * 0 没loading 1 dialog形式  2page形式
     */
    protected final static int LOADING_TYPE_PAGE = 2;
    protected BaseIView mIView;

    public SugarRepository(BaseIView IView) {
        mIView = IView;
    }

    protected Observable addObservable(Observable observable) {
        if (mIView == null) {
            return null;
        }
        return customObservable(observable);
    }

    protected Observable addObservable(Observable observable, int loadingType) {
        if (mIView == null) {
            return null;
        }
        return customObservable(observable)
                .doOnSubscribe(disposable -> {
                    if (loadingType > 0) {
                        if (loadingType == LOADING_TYPE_DIALOG) {
                            mIView.showDialogLoading();
                        } else {
                            mIView.showLoading();
                        }
                    }
                });
    }

    private Observable customObservable(Observable observable) {
        return observable
                .compose(mIView.getProvider().bindToLifecycle())
                .retryWhen(new RetryWithDelay(2, 2))
                .subscribeOn(Schedulers.io())
                .subscribeOn(AndroidSchedulers.mainThread())
                .observeOn(AndroidSchedulers.mainThread())
                .doFinally(() -> {
                    if (mIView != null) {
                        mIView.hideDialogLoading();
                    }
                })
                .doOnNext(o -> {
                    LogUtils.e("doOnNext------" + o);
                    if (mIView != null) {
                        mIView.showLoadSuccess();
                    }
                })
                .doOnError(throwable -> {
                    LogUtils.e("doOnError------" + throwable);
                    if (mIView != null) {
                        mIView.showLoadFailed();
                    }
                });
    }
}
复制代码

addObservable(Observable observable)不会使用任何loading效果， addObservable(Observable observable, int loadingType) loadingType : 0 没loading 、1 dialog形式、2 page形式
Repository首先有个契约类，RepositoryContract xxxModel为须要增长的一个域名接口，统一配置apiService、请求函数、相应的transformer

/**
* @author wobiancao
* @date 2019-05-21
* desc :
*/
public class RepositoryContract {

   /**
    * gank.io
    */
   public interface GankModel  {
       Gank getService();
       /**
        * Transformer 须要处理api返回值包装的加上便可
        * @param <T>
        * @return
        */
       <T> ObservableTransformer<GirlsResult<T>, T> gankTransformer();

       Observable<List<GirlsData>> getFuliDataRepository(String size, String index);
   }

   /**
    * wanandroid
    */
   public interface WanModel{
       Wan getService();
       /**
        * Transformer 须要处理api返回值包装的加上便可
        * @param <T>
        * @return
        */
       <T> ObservableTransformer<WanResult<T>, T> wanTransformer();


       Observable<WanData> getWanArticleList(String index);
   }
}
复制代码

使用，如GankRepository

/**
* @author wobiancao
* @date 2019/5/20
* desc :
*/
public class GankRepository extends SugarRepository implements RepositoryContract.GankModel {


   public GankRepository(BaseIView IView) {
       super(IView);
   }

   @Override
   public Gank getService() {
       return AppHttpClient.getInstance().initService(Gank.class);
   }


   @Override
   public <T> ObservableTransformer<GirlsResult<T>, T> gankTransformer() {

       return upstream -> upstream
               .flatMap((Function<GirlsResult<T>, ObservableSource<T>>) tGirlsResult -> {
                   if (tGirlsResult == null) {
                       return Observable.error(new HttpException("返回值为null"));
                   }
                   if (!tGirlsResult.error) {
                       return Observable.just(tGirlsResult.results);
                   } else {
                       return Observable.error(new HttpException("接口异常"));
                   }
               });

   }

   @Override
   public Observable<List<GirlsData>> getFuliDataRepository(String size, String index) {
       return addObservable(getService()
               .getFuliData(size, index)
               .compose(gankTransformer()), LOADING_TYPE_PAGE);
   }

}

复制代码

最后mvp建立（`以后会写相应的Template` ⬅️已写好）

以WanActivity举例
构成为 WanContract契约、WanPresenter 好了，完了，结束。

=。=假的，接下来看代码

WanContract

/**
 * @author wobiancao
 * @date 2019-05-21
 * desc :
 */
public class WanContract {
    public interface PView{

        void getWanArticleList(String index);
    }

    public interface IView extends BaseIView {
        /**
         * 绑定列表数据
         * @param data
         */
        void bindData(WanData data);
    }
}
复制代码

WanPresenter

/**
 * @author wobiancao
 * @date 2019-05-21
 * desc :
 */
public class WanPresenter extends BasePresenter<WanContract.IView, WanRepository> implements WanContract.PView {

    @Override
    protected void initRepository() {
        mModel = new WanRepository(mView);
    }

    @Override
    public void getWanArticleList(String index) {
        mModel.getWanArticleList(index)
                .subscribe(new ErrorHandleSubscriber<WanData>(rxErrorHandler) {
                    @Override
                    public void onNext(WanData wanData) {
                        mView.bindData(wanData);
                    }

                });
    }


}

复制代码

就是这么简单，最后就是在view层如何使用了，老规矩先看代码WanActivity

/**
 * @author wobiancao
 * @date 2019-05-21
 * desc :
 */
@CreatePresenter(presenter = WanPresenter.class)
public class WanActivity extends BaseActivity<WanPresenter> implements WanContract.IView {
    @PresenterVariable
    WanPresenter mPresenter;
    TextView mInfoView;
    Toolbar mToolbar;
    @Override
    protected int getContentView() {
        return R.layout.gank_activity_list;
    }

    @Override
    public void init(Bundle savedInstanceState) {
        mInfoView = findViewById(R.id.tv_info);
        mToolbar = findViewById(R.id.toolbar);
        setSupportActionBar(mToolbar);
        ActionBar actionBar = getSupportActionBar();
        if (actionBar != null) {
            actionBar.setDisplayHomeAsUpEnabled(true);
            actionBar.setTitle("WanAndroid");
        }
    }

    @Override
    public void loadData() {
        mPresenter.getWanArticleList("1");
    }

    @Override
    public void bindData(WanData data) {
        String jsonStr = new Gson().toJson(data);
        mInfoView.setText(jsonStr);
    }

    @Override
    public boolean onOptionsItemSelected(MenuItem item) {
        int id = item.getItemId();
        switch (id) {
            case android.R.id.home:
                finish();
                break;
        }
        return super.onOptionsItemSelected(item);
    }
}
复制代码

是的Presenter建立只须要注解便可，而且`支持多个presenter`

这里要万分感谢`EasyMvp一个简单强大且灵活的MVP框架`

首先，单个presenter

@CreatePresenter(presenter = WanPresenter.class)
public class WanActivity extends BaseActivity<WanPresenter> implements WanContract.IView 
复制代码

获取presenter变量两种方式

一、经过注解

@PresenterVariable
WanPresenter mPresenter;
复制代码

二、经过getPresenter()函数1.0.1.4以后不支持

xxActivity extends BaseActivity<xxPresenter>...

xxPresenter getPresenter()
复制代码

多个prenenter 就只有经过注解得到变量了

@CreatePresenter(presenter = {xxPresenter1.class, xxPresenter2.class})
xxActivity extends BaseActivity...

@PresenterVariable
xxPresenter1 mPresenter1;

@PresenterVariable
xxPresenter2 mPresenter2;
复制代码

`本库github地址 sugar 简单便捷快速开发Android项目，集合流行框架封装mvp + rxjava2 + retrofit2 + rxlifecycle2 + arouter...`

mvp Template完成

效果图

使用见图解

使用步骤：

下载源码目录在 Sugar/SugarMvpTemplate

把两个文件夹放入{Android Studio installation dir}\plugins\android\lib\templates\activities\路径下
重启Android studio便可使用

About me

License

Copyright 2019, wobiancao       
  
   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at 
 
       http://www.apache.org/licenses/LICENSE-2.0 

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
   
复制代码