安卓框架主要内容及使用注意事项

一，适配方案—— SmallestWith解决方案

github地址：https://github.com/ladingwu/dimens_sw

Tips:大部分手机的宽度dp值集中在320-450之间，大部分1080P的手机应该都是360dp，390dp,411dp。

使用说明：

DimenTypes文件中写入你希望适配的sw尺寸，默认的这些尺寸能够覆盖几乎所有手机适配需求

DimenGenerator文件中填写设计稿的尺寸(DESIGN_WIDTH是设计稿宽度，DESIGN_HEIGHT是设计稿高度)

执行lib module中的DimenGenerator.main()方法，当前地址下会生成相应的适配文件,把相应的文件连带文件夹拷贝到正在开发的项目中

二，开发模式—— MVVM

github地址：https://github.com/goldze/MVVMHabit

快速上手，使用方法：

1，Activity

[if !supportLists]1，[endif]继承BaseViewModel

新建你的ViewModel继承BaseViewModel

public class LoginViewModel extends BaseViewModel {

public LoginViewModel(@NonNull Application application) {

super(application);

}

....

}

BaseViewModel与BaseActivity通过LiveData来处理常用UI逻辑，即可在ViewModel中使用父类的showDialog()、startActivity()等方法。在这个LoginViewModel中就可以尽情的写你的逻辑了！

BaseFragment的使用和BaseActivity一样

2,用你的layout文件关联你新建的ViewModel

type="com.goldze.mvvmhabit.ui.login.LoginViewModel"

name="viewModel"

.....

3，用你的Activity继承BaseActivity

public class LoginActivity extends BaseActivity {

//ActivityLoginBinding类是databinding框架自定生成的,对activity_login.xml

@Override

public int initContentView(Bundle savedInstanceState) {

return R.layout.activity_login;

@Override

public int initVariableId() {

return BR.viewModel;

}

@Override

public LoginViewModel initViewModel() {

//View持有ViewModel的引用，如果没有特殊业务处理，这个方法可以不重写

return ViewModelProviders.of(this).get(LoginViewModel.class);

}

initContentView() 返回界面layout的idinitVariableId() 返回变量的id，对应activity_login中name="viewModel"，就像一个控件的id，可以使用R.id.xxx，这里的BR跟R文件一样，由系统生成，使用BR.xxx找到这个ViewModel的id。

选择性重写initViewModel()方法，返回ViewModel对象

@Overridepublic LoginViewModel initViewModel() {

//View持有ViewModel的引用，如果没有特殊业务处理，这个方法可以不重写

return ViewModelProviders.of(this).get(LoginViewModel.class);

}

注意：不重写initViewModel()，默认会创建LoginActivity中第二个泛型约束的LoginViewModel，如果没有指定第二个泛型，则会创建BaseViewModel

三，数据绑定

1，传统绑定

在你的ViewModel中定义

//用户名的绑定public ObservableField<String> userName = new ObservableField<>("");

在用户名EditText标签中绑定

android:text="@={viewModel.userName}"

注意： @符号后面需要加=号才能达到双向绑定效果；userName需要是public的，不然viewModel无法找到它。

点击事件绑定：

在你的ViewModel中定义

//登录按钮的点击事件public View.OnClickListener loginOnClick = new View.OnClickListener() {

@Override

public void onClick(View v) {

}

};

在登录按钮标签中绑定

android:onClick="@{viewModel.loginOnClick}"

用户的点击事件直接被回调到ViewModel层了，更好的维护了业务逻辑

这就是强大的databinding框架双向绑定的特性，不用再给控件定义id，setText()，setOnClickListener()。

但是，光有这些，完全满足不了我们复杂业务的需求啊！MVVMHabit闪亮登场：它有一套自定义的绑定规则，可以满足大部分的场景需求，请继续往下看。

在你的ViewModel中定义

//登录按钮的点击事件public BindingCommand loginOnClickCommand = new BindingCommand(new BindingAction() {

@Override

public void call() {

}

});

在activity_login中定义命名空间

xmlns:binding="http://schemas.android.com/apk/res-auto"

在登录按钮标签中绑定

binding:onClickCommand="@{viewModel.loginOnClickCommand}"

这和原本传统的绑定不是一样吗？不，这其实是有差别的。使用这种形式的绑定，在原本事件绑定的基础之上，带有防重复点击的功能，1秒内多次点击也只会执行一次操作。如果不需要防重复点击，可以加入这条属性：

binding:isThrottleFirst="@{Boolean.TRUE}"

2，自定义Imagview图片加载

在ViewModel中定义

public String imgUrl = "http://img0.imgtn.bdimg.com/it/u=2183314203,562241301&fm=26&gp=0.jpg";

在ImageView标签中

binding:url="@{viewModel.imgUrl}"

url是图片路径，这样绑定后，这个ImageView就会去显示这张图片，不限网络图片还是本地图片。

如果需要给一个默认加载中的图片，可以加这一句

binding:placeholderRes="@{R.mipmap.ic_launcher_round}"

注意：

R文件需要在data标签中导入使用，如：

[if !supportLists]2，[endif]Rcycclerview绑定

在ViewModel中定义：

//给RecyclerView添加itemspublic final ObservableList observableList = new ObservableArrayList<>();//给RecyclerView添加ItemBindingpublic final ItemBinding itemBinding = ItemBinding.of(BR.viewModel, R.layout.item_network);

ObservableList<>和ItemBinding<>的泛型是Item布局所对应的ItemViewModel

在xml中绑定：

<android.support.v7.widget.RecyclerView

android:layout_width="match_parent"

android:layout_height="match_parent"

binding:itemBinding="@{viewModel.itemBinding}"

binding:items="@{viewModel.observableList}"

binding:layoutManager="@{LayoutManagers.linear()}"

binding:lineManager="@{LineManagers.horizontal()}" />

layoutManager控制是线性(包含水平和垂直)排列还是网格排列，lineManager是设置分割线

网格布局的写法：binding:layoutManager="@{LayoutManagers.grid(3)}水平布局的写法：binding:layoutManager="@{LayoutManagers.linear(LinearLayoutManager.HORIZONTAL,Boolean.FALSE)}"

注意：

使用到相关类，则需要导入该类才能使用，和导入Java类相似

这样绑定后，在ViewModel中调用ObservableList的add()方法，添加一个ItemViewModel，界面上就会实时绘制出一个Item。在Item对应的ViewModel中，同样可以以绑定的形式完成逻辑。可以在请求到数据后，循环添加observableList.add(new NetWorkItemViewModel(NetWorkViewModel.this, entity));

注意： 在以前的版本中，ItemViewModel是继承BaseViewModel，传入Context，新版本3.x中可继承ItemViewModel，传入当前页面的ViewModel

更多RecyclerView、ListView、ViewPager等绑定方式，请参考

https://github.com/evant/binding-collection-adapter

四，网络请求

Retrofit+Okhttp+RxJava

1，构建Retrofit时加入：

Retrofit retrofit = new Retrofit.Builder()

.addConverterFactory(GsonConverterFactory.create())

.addCallAdapterFactory(RxJavaCallAdapterFactory.create())

.build();

2，网络拦截器

1，LoggingInterceptor： 全局拦截请求信息，格式化打印Request、Response，可以清晰的看到与后台接口对接的数据

LoggingInterceptor mLoggingInterceptor = new LoggingInterceptor

.Builder()//构建者模式

.loggable(true) //是否开启日志打印

.setLevel(Level.BODY) //打印的等级

.log(Platform.INFO) // 打印类型

.request("Request") // request的Tag

.response("Response")// Response的Tag

.addHeader("version", BuildConfig.VERSION_NAME)//打印版本 .build()

构建okhttp时加入：

OkHttpClient okHttpClient = new OkHttpClient.Builder()

.addInterceptor(mLoggingInterceptor)

.build();,

2，CacheInterceptor： 缓存拦截器，当没有网络连接的时候自动读取缓存中的数据，缓存存放时间默认为3天。创建缓存对象

//缓存时间int CACHE_TIMEOUT = 10 * 1024 * 1024//缓存存放的文件File httpCacheDirectory = new File(mContext.getCacheDir(), "goldze_cache");//缓存对象Cache cache = new Cache(httpCacheDirectory, CACHE_TIMEOUT);

构建okhttp时加入

OkHttpClient okHttpClient = new OkHttpClient.Builder()

.cache(cache)

.addInterceptor(new CacheInterceptor(mContext))

.build();

3，Cookie管理 MVVMHabit提供两种CookieStore：PersistentCookieStore (SharedPreferences管理)和MemoryCookieStore (内存管理)，可以根据自己的业务需求，在构建okhttp时加入相应的cookieJar

OkHttpClient okHttpClient = new OkHttpClient.Builder()

.cookieJar(new CookieJarImpl(new PersistentCookieStore(mContext)))

.build();

或者

OkHttpClient okHttpClient = new OkHttpClient.Builder()

.cookieJar(new CookieJarImpl(new MemoryCookieStore()))

.build();

4，绑定生命周期

请求在ViewModel层。默认在BaseActivity中注入了LifecycleProvider对象到ViewModel，用于绑定请求的生命周期，View与请求共存亡。

RetrofitClient.getInstance().create(DemoApiService.class)

.demoGet()

.compose(RxUtils.bindToLifecycle(getLifecycleProvider())) // 请求与View周期同步

.compose(RxUtils.schedulersTransformer()) // 线程调度

.compose(RxUtils.exceptionTransformer()) // 网络错误的异常转换

.subscribe(new ConsumerDemoEntity>>() {

        @Override

        public void accept(BaseResponse<DemoEntity> response) throws Exception {



        }

    }, new Consumer<ResponseThrowable>() {

        @Override

        public void accept(ResponseThrowable throwable) throws Exception {



        }

    });

注意：由于BaseActivity/BaseFragment都实现了LifecycleProvider接口，并且默认注入到ViewModel中，所以在调用请求方法时可以直接调用getLifecycleProvider()拿到生命周期接口。如果你没有使用mvvmabit 里面的BaseActivity或BaseFragment，使用自己定义的Base，那么需要让你自己的Activity继承RxAppCompatActivity、Fragment继承RxFragment才能用RxUtils.bindToLifecycle(lifecycle)方法。

六，网络异常处理

在使用Retrofit请求时，加入组合操作符.compose(RxUtils.exceptionTransformer())，当发生网络异常时，回调onError(ResponseThrowable)方法，可以拿到异常的code和message，做相应处理。

mvvmhabit中自定义了一个ExceptionHandle，已为你完成了大部分网络异常的判断，也可自行根据项目的具体需求调整逻辑。

注意： 这里的网络异常code，并非是与服务端协议约定的code。网络异常可以分为两部分，一部分是协议异常，即出现code = 404、500等，属于HttpException，另一部分为请求异常，即出现：连接超时、解析错误、证书验证失等。而与服务端约定的code规则，它不属于网络异常，它是属于一种业务异常。在请求中可以使用RxJava的filter(过滤器)，也可以自定义BaseSubscriber统一处理网络请求的业务逻辑异常。由于每个公司的业务协议不一样，所以具体需要你自己来处理该类异常。

7，辅助功能

1，事件总线

RxBus

使用方法：在ViewModel中重写registerRxBus()方法来注册RxBus，重写removeRxBus()方法来移除RxBus

//订阅者private Disposable mSubscription;//注册RxBus@Overridepublic void registerRxBus() {

    super.registerRxBus();

    mSubscription = RxBus.getDefault().toObservable(String.class)

        .subscribe(new Consumer<String>() {

            @Override

            public void accept(String s) throws Exception {

            }

        });

    //将订阅者加入管理站

    RxSubscriptions.add(mSubscription);

}

//移除RxBus@Overridepublic void removeRxBus() {

    super.removeRxBus();

    //将订阅者从管理站中移除

    RxSubscriptions.remove(mSubscription);

}

在需要执行回调的地方发送

RxBus.getDefault().post(object);

Messenger

使用方法：Messenger是一个轻量级全局的消息通信工具，在我们的复杂业务中，难免会出现一些交叉的业务，比如ViewModel与ViewModel之间需要有数据交换，这时候可以轻松地使用Messenger发送一个实体或一个空消息，将事件从一个ViewModel回调到另一个ViewModel中。

定义一个静态String类型的字符串token：

public static final String TOKEN_LOGINVIEWMODEL_REFRESH = "token_loginviewmodel_refresh";

在ViewModel中注册消息监听：

//注册一个空消息监听 //参数1：接受人（上下文）//参数2：定义的token//参数3：执行的回调监听Messenger.getDefault().register(this, LoginViewModel.TOKEN_LOGINVIEWMODEL_REFRESH, new BindingAction() {

    @Override

    public void call() {

    }

});

//注册一个带数据回调的消息监听 //参数1：接受人（上下文）//参数2：定义的token//参数3：实体的泛型约束//参数4：执行的回调监听Messenger.getDefault().register(this, LoginViewModel.TOKEN_LOGINVIEWMODEL_REFRESH, String.class, new Consumer<String>() {

    @Override

    public void accept(String s) throws Exception {

    }

});

在需要回调的地方使用token发送消息：

//发送一个空消息//参数1：定义的tokenMessenger.getDefault().sendNoMsg(LoginViewModel.TOKEN_LOGINVIEWMODEL_REFRESH);

//发送一个带数据回调消息//参数1：回调的实体//参数2：定义的tokenMessenger.getDefault().send("refresh",LoginViewModel.TOKEN_LOGINVIEWMODEL_REFRESH);

注意：

oken最好不要重名，不然可能就会出现逻辑上的bug，为了更好的维护和清晰逻辑，建议以aa_bb_cc的格式来定义token。aa：TOKEN，bb：ViewModel的类名，cc：动作名（功能名）。

为了避免大量使用Messenger，建议只在ViewModel与ViewModel之间使用，View与ViewModel之间采用ObservableField去监听UI上的逻辑，可在继承了Base的Activity或Fragment中重写initViewObservable()方法来初始化UI的监听

八，文件下载

用Retrofit+Okhttp+RxJava+RxBus实现一行代码监听带进度的文件下载。

String loadUrl = "你的文件下载路径";String destFileDir = context.getCacheDir().getPath(); //文件存放的路径String destFileName = System.currentTimeMillis() + ".apk";//文件存放的名称DownLoadManager.getInstance().load(loadUrl, new ProgressCallBack<ResponseBody>(destFileDir, destFileName) {

    @Override

    public void onStart() {

        //RxJava的onStart()

    }

    @Override

    public void onCompleted() {

        //RxJava的onCompleted()

    }

    @Override

    public void onSuccess(ResponseBody responseBody) {

        //下载成功的回调

    }

    @Override

    public void progress(final long progress, final long total) {

        //下载中的回调 progress：当前进度，total：文件总大小

    }

    @Override

    public void onError(Throwable e) {

        //下载错误回调

    }

});

在ProgressResponseBody中使用了RxBus，发送下载进度信息到ProgressCallBack中，继承ProgressCallBack就可以监听到下载状态。回调方法全部执行在主线程，方便UI的更新

九，ContainerActivity

使用方法：

在ViewModel中调用BaseViewModel的方法开一个Fragment：

startContainerActivity(你的Fragment类名.class.getCanonicalName())

在ViewModel中调用BaseViewModel的方法，携带一个序列化实体打开一个Fragment

Bundle mBundle = new Bundle();

mBundle.putParcelable("entity", entity);

startContainerActivity(你的Fragment类名.class.getCanonicalName(), mBundle);

在你的Fragment中取出实体

Bundle mBundle = getArguments();if (mBundle != null) {

    entity = mBundle.getParcelable("entity");

}

十，6.0权限申请

使用方法：

//请求打开相机权限RxPermissions rxPermissions = new RxPermissions((Activity) context);

rxPermissions.request(Manifest.permission.CAMERA)

    .subscribe(new Consumer() {

        @Override

        public void accept(Boolean aBoolean) throws Exception {

            if (aBoolean) {

                ToastUtils.showShort("权限已经打开，直接跳入相机");

            } else {

                ToastUtils.showShort("权限被拒绝");

            }

        }

    });

更多了解https://github.com/tbruyelle/RxPermissions

十一，图片压缩

使用方法：

RxJava的方式压缩单张图片，得到一个压缩后的图片文件对象

String filePath = "mnt/sdcard/1.png";ImageUtils.compressWithRx(filePath, new Consumer() {

    @Override

    public void accept(File file) throws Exception {

        //将文件放入RequestBody

RxJava的方式压缩多张图片，按集合顺序每压缩成功一张，都将在onNext方法中得到一个压缩后的图片文件对象

List<String> filePaths = new ArrayList<>();

filePaths.add("mnt/sdcard/1.png");

filePaths.add("mnt/sdcard/2.png");ImageUtils.compressWithRx(filePaths, new Subscriber() {

    @Override

    public void onCompleted() {

    }

    @Override

    public void onError(Throwable e) {

    }

    @Override

    public void onNext(File file) {

    }

});

十二，其他辅助类

ToastUtils： 吐司工具类

MaterialDialogUtils： Material风格对话框工具类

SPUtils： SharedPreferences工具类

SDCardUtils： SD卡相关工具类

ConvertUtils： 转换相关工具类

StringUtils： 字符串相关工具类

RegexUtils： 正则相关工具类

KLog： 日志打印，含json格式打印

十三，编译错误解决方法

使用databinding其实有个缺点，就是会遇到一些编译错误，而AS不能很好的定位到错误的位置，这对于刚开始使用databinding的开发者来说是一个比较郁闷的事。那么我在此把我自己在开发中遇到的各种编译问题的解决方法分享给大家，希望这对你会有所帮助。

1，绑定错误

绑定错误是一个很常见的错误，基本都会犯。比如TextView的 android:text="" ，本来要绑定的是一个String类型，结果你不小心，可能绑了一个Boolean上去，或者变量名写错了，这时候编辑器不会报红错，而是在点编译运行的时候，在AS的Messages中会出现错误提示

解决方法：把错误提示拉到最下面(上面的提示找不到BR类这个不要管它)，看最后一个错误，这里会提示是哪个xml出了错，并且会定位到行数，按照提示找到对应位置，即可解决该编译错误的问题。

注意： 行数要+1，意思是上面报出第33行错误，实际是第34行错误，AS定位的不准确 (这可能是它的一个bug)

2，导包错误

在xml中需要导入ViewModel或者一些业务相关的类，假如在xml中导错了类，那一行则会报红，但是res/layout却没有错误提示，有一种场景，非常特殊，不容易找出错误位置。就是你写了一个xml，导入了一个类，比如XXXUtils，后来因为业务需求，把那个XXXUtils删了，这时候res/layout下不会出现任何错误，而你在编译运行的时候，才会出现错误日志。苦逼的是，不会像上面那样提示哪一个xml文件，哪一行出错了，最后一个错误只是一大片的报错报告。如下图：,

解决方法：同样找到最后一个错误提示，找到Cannot resolve type for xxx这一句(xxx是类名)，然后使用全局搜索 (Ctrl+H) ，搜索哪个xml引用了这个类，跟踪点击进去，在xml就会出现一个红错，看到错误你就会明白了，这样就可解决该编译错误的问题。

3，build错误

构建多module工程时，如出现【4.1.1、绑定错误】，且你能确定这个绑定是没有问题的，经过修改后出现下图错误：

解决方法：这种是databinding比较大的坑，清理、重构和删build都不起作用，网上很难找到方法。经过试验，解决办法是手动创建异常中提到的文件夹，或者拷贝上一个没有报错的版本中对应的文件夹，可以解决这个异常

4，自动生成类错误

有时候在写完xml时，databinding没有自动生成对应的Binding类及属性。比如新建了一个activity_login.xml，按照databinding的写法加入 后，理论上会自动对应生成ActivityLoginBinding.java类和variable的属性，可能是as对databding的支持还不够吧，有时候偏偏就不生成，导致BR.xxx报红等一些莫名的错误。

解决方法：其实确保自己的写法没有问题，是可以直接运行的，报红不一定是你写的有问题，也有可能是编译器抽风了。或者使用下面的办法第一招：Build->Clean Project；第二招：Build->Rebuild Project；第三招：重启大法。

十四，组件化：https://github.com/goldze/MVVMHabitComponent

安卓框架搭建最终解决方案连载中……

一，适配方案—— SmallestWith解决方案

二，开发模式—— MVVM

1，Activity

2,用你的layout文件关联你新建的ViewModel

3，用你的Activity继承BaseActivity

三，数据绑定

1，传统绑定

2，自定义Imagview图片加载

四，网络请求

1，构建Retrofit时加入：

2，网络拦截器

六，网络异常处理

7，辅助功能

1，事件总线

八，文件下载

九，ContainerActivity

十，6.0权限申请

十一，图片压缩

十二，其他辅助类

十三，编译错误解决方法

1，绑定错误

2，导包错误

3，build错误

4，自动生成类错误

十四，组件化：https://github.com/goldze/MVVMHabitComponent

你可能感兴趣的:(安卓框架搭建最终解决方案连载中……)