Android开发相关——Retrofit+RxJava+OkHttp(下)使用
2017-07-21 17:45
507 查看
先扯两句
好了,上一篇闲扯过后,算是将我为什么会把Retrofit说出来了吧(虽然好像什么都没说),当然还有其他框架,作为一个懒人,我这里就不加以阐述了,还是进入整体,开始进入我们的使用的部分。还是先上我的Git库,然后开始正文。
MyBaseApplication (https://github.com/BanShouWeng/MyBaseApplication)
正文
这么快进正文还真不太适应,那就先感谢一波吧:感谢依然范特稀西的Retrofit + RxJava + OkHttp 让网络请求变的简单-基础篇帮了个大忙;
感谢依然范特稀西的Retrofit + RxJava + OkHttp 让网络请求变的简单-封装篇帮了个大忙;
感谢tough1985的RxJava 与 Retrofit 结合的最佳实践帮了个大忙
感谢张鸿洋的Retrofit2 完全解析 探索与okhttp之间的关系帮了个大忙
Retrofit官网
感谢扔物线的 给 Android 开发者的 RxJava 详解帮了个大忙
感谢了这么多,其实大家如果把上面这些都看过了,一定会比我使用的好,而我这里也只是说一下自己的所得罢了,欢迎大家一起分享,指点。
正文的正文
按照我的理解,其实看起来用的东西不少,可是真的用起来,还是不那么费力的,我们就从基础开始,一步一步进行吧(因为参考了上述的文章,所以也就使用了豆瓣Top250的接口)。1、导包
既然想要使用,那么第一步自然就是需要将包导入进来,导包的方法可以参见我之前的博客[android开发相关——ButterKnife以及Android ButterKnife Zelezny]](http://blog.csdn.net/u010513377/article/details/75022649),与导入ButterKnife的方法相同,需要导入的包如下:
//retrofit compile 'com.squareup.retrofit2:retrofit:2.3.0' //rxjava compile 'io.reactivex.rxjava2:rxjava:2.1.1' //rxandroid compile 'io.reactivex.rxjava2:rxandroid:2.0.1' //配合Rxjava 使用 compile 'com.squareup.retrofit2:adapter-rxjava2:2.3.0' //转换器 将结果通过gson将json串转换为model compile 'com.squareup.retrofit2:converter-gson:2.3.0' //GSON库 compile 'com.google.code.gson:gson:2.8.1'
其中,gson库,我前期测试了,可以不添加不过也算是常用库,即便这部分没有用到,但是后续的部分也或多或少会使用到,所以也添加了进来。
转换器部分,这里使用的就是gson,不过实际上retrofit2提供的转换器远远不止gson一种:
上图也仅仅只是其中一部分而已,不过在我们开发中,基本的掌握gson即可,这里也就使用gson举例了。
2、基础使用(GET)
至于方法,大家看了如果看了上面的博客也就知道了,我也就不多卖关子,直接将代码贴出来了
//请求接口 public interface MovieService { @GET("top250") Call<ResponseBody> getTopMovie(@Query("start") int start, @Query("count") int count); } //进行网络请求 private void getMovie() { String baseUrl = "https://api.douban.com/v2/movie/"; Retrofit retrofit = new Retrofit.Builder() .baseUrl(baseUrl) .addConverterFactory(GsonConverterFactory.create()) .build(); MovieService movieService = retrofit.create(MovieService.class); Call<ResponseBody> call = movieService.getTopMovie(0, 2); call.enqueue(new Callback<ResponseBody>() { @Override public void onResponse(Call<ResponseBody> call, Response<ResponseBody> response) { try { Log.i("response", response.body().string()); } catch (IOException e) { e.printStackTrace(); } } @Override public void onFailure(Call<ResponseBody> call, Throwable t) { } }); }
关于接口的解释,我也就直接引用了:
说明:定义了一个方法getTopMovie,使用get请求方式,加上@GET 标签,标签后面是这个接口的 尾址top250,完整的地址应该是 baseUrl+尾址,参数 使用@Query标签,如果参数多的话可以用@QueryMap标签,接收一个Map
而方法调用,我是将其暂时放在了所需要请求网络的Activity中(下一篇封装部分再做处理),其中Retrofit的创建就不用说了,传入的参数共有两个:
baseUrl,也就是上面引用部分中完整的地址的组成部分之一,也就是说尾址是在接口中赋值,而baseUrl是在调用的方法中赋值,是分开的,而在正常的工程中,baseUrl也就是不变的部分,而尾址则是由于访问功能不同而随之改变的部分。例如我们访问搜狗搜索的时候,可以看到地址为:“https://www.sogou.com/”,而当我们搜索资料的时候,可以看到地址变成了:
“https://www.sogou.com/web?query=半寿翁&ie=utf8&_ast=1500538240&_asf=null&w=01029901&p=40040100&dp=1&cid=&s_from=result_up&sut=1976&sst0=1500538301206&lkt=0%2C0%2C0&sugsuv=005D6320652C48B859337925D211D527&sugtime=1500538301206”
这其中“https://www.sogou.com/”就可以理解为baseUrl
4000
,而“web”则是尾址,而“?”后面的部分,则是我们要传递的参数,也就是上面MovieService接口的抽象方法中,“@Query”后面的部分,参数与参数之间使用“&”区分开。而这里的baseUrl就是“https://api.douban.com/v2/movie/”
addConverterFactory:按照字面理解就可以——添加转换工厂,也就是我们前面导入的gson转换器(或者大家想要使用的其他转换器)
其后就是我们前面创建的接口MovieService的实例化,再就是创建Call方法,然后是Call的异步中得到返回的参数,而异步访问的结果自然是两个,也就是两个回调方法,成功/失败。
当然,这些都不重要,按部就班就可以,我要说的部分是在Call方法的所携带的泛型,因为我们前面使用了gson将json串转换为model,那么这里自然就需要两个元素,json和我们将要转换成什么样model模板。
而这个泛型就是一个模板,我们可以将想要其转换的bean传入其中(bean不理解的可以参见我的博客《一个Android工程的从零开始》-1前期准备),至于bean如何能更方便的创建出来,请参见我的另一篇博客Android开发相关——Log日志输出显示不完整以及GsonFormat。
我的代码中使用的bean对象是OkHttp中提供的类,算是一个万能对象,不过一般不使用它,而是使用我们针对每一个接口调用专门创建的bean对象,这里使用它主要还是为了获取json串,也就是response.body().string()方法。
3、基础使用(POST)
前面说的内容是GET,这里说的是POST,新手的话可以放心,基础使用到这就结束了,没有第三种了,至于GET与POST之间有什么区别,请看链接浅谈HTTP中Get与Post的区别。
关于我使用的时候发现的问题,那就是之前的项目中,使用GET时,出现过一次问题,那就是使用GET传递中文字符的时候,服务器接受到的却是乱码,但是使用POST却没问题,网上查的解决方法链接如下Android编程向服务器发送请求时出现中文乱码问题的解决方法,不过我还没有尝试过,如果遇到相同问题的可以尝试一下。
好了,关于GET和POST相关的内容就先到这里,下面还是进入到正题。
//请求接口 public interface IpService { @FormUrlEncoded @POST("getIpInfo.php") // 1.4.通过@Field来指定key,后面跟上value // Observable<ResponseBody> postIP(@Field("ip") String ip); Call<ResponseBody> postIP(@Field("ip") String ip); } //网络请求 private void postIp() { String baseUrl = "http://192.168.31.242:8080/springmvc_users/user/"; Retrofit retrofit = new Retrofit.Builder() .baseUrl(baseUrl) .addConverterFactory(GsonConverterFactory.create()) .addCallAdapterFactory(RxJava2CallAdapterFactory.create()) .build(); IpService ipService = retrofit.create(IpService.class); Call<ResponseBody> call = ipService.postIP("202.202.32.202"); call.enqueue(new Callback<ResponseBody>() { @Override public void onResponse(Call<ResponseBody> call, Response<ResponseBody> response) { try { LogUtil.info("response", response.body().string()); } catch (IOException e) { e.printStackTrace(); } } @Override public void onFailure(Call<ResponseBody> call, Throwable t) { } }); }
从上面代码可以看出,实际上POST与GET的代码基本大同小异,不过若说细节上的差别,就是我在Service中添加了一个@FormUrlEncoded,至于为什么添加它,官网中是这么说的
Form-encoded data is sent when @FormUrlEncoded is present on the method. Each key-value pair is annotated with @Field containing the name and the object providing the value
以我粗浅的英文水平翻译过来就是“当@FormUrlEncoded这个方法被调用是将发送被按照键值对格式编码的数据,其中键是@Field后包含的名字,而值是提供来的数据”
Call<ResponseBody> postIP(@Field("ip") String ip);
所以这段代码中,@Field(“ip”)引号中的ip就是键,而后面String类型的ip就是值。
4、集成RxJava
上面的基础使用部分已经结束了,不过目测没有使用到RxJava,不过既然题目中已经说明有它了,那怎么也不能不带人家玩不是,下面就把RxJava集成进来。
至于为什么使用RxJava,它好在哪,大家只能在前面感谢的第六篇文章中自行寻找答案了。
由于GET与POST集成方法相差不多,这里就使用GET举例,POST的大家自行替换一下即可。
//请求接口 public interface Movie2Service { @GET("top250") Observable<ResponseBody> getTop250(@Query("start") int start, @Query("count")int count); } //进行网络请求 private void getMovie2() { String baseUrl = "https://api.douban.com/v2/movie/"; Retrofit retrofit = new Retrofit.Builder() .baseUrl(baseUrl) .addConverterFactory(GsonConverterFactory.create()) .addCallAdapterFactory(RxJava2CallAdapterFactory.create()) .build(); Movie2Service movieService = retrofit.create(Movie2Service.class); movieService.getTopMovie(10, 10) .subscribeOn(Schedulers.io()) .observeOn(AndroidSchedulers.mainThread()) .subscribe(new Observer<ResponseBody>() { @Override public void onSubscribe(@NonNull Disposable d) { } @Override public void onNext(@NonNull ResponseBody responseBody) { try { String responseString = responseBody.string(); Log.i("responseString", responseString); LogUtil.info("response", responseString); } catch (IOException e) { e.printStackTrace(); } } @Override public void onError(@NonNull Throwable e) { } @Override public void onComplete() { } }); }
可以看到,其实只不过是将Call换成了Observable而已,而回调方法从简单的成功/失败,变成了当前的四个,其功能,我们可以看一下源码:
public interface Observer<T> { /** * Provides the Observer with the means of cancelling (disposing) the * connection (channel) with the Observable in both * synchronous (from within {@link #onNext(Object)}) and asynchronous manner. * @param d the Disposable instance whose {@link Disposable#dispose()} can * be called anytime to cancel the connection * @since 2.0 */ void onSubscribe(@NonNull Disposable d); /** * Provides the Observer with a new item to observe. * <p> * The {@link Observable} may call this method 0 or more times. * <p> * The {@code Observable} will not call this method again after it calls either {@link #onComplete} or * {@link #onError}. * * @param t * the item emitted by the Observable */ void onNext(@NonNull T t); /** * Notifies the Observer that the {@link Observable} has experienced an error condition. * <p> * If the {@link Observable} calls this method, it will not thereafter call {@link #onNext} or * {@link #onComplete}. * * @param e * the exception encountered by the Observable */ void onError(@NonNull Throwable e); /** * Notifies the Observer that the {@link Observable} has finished sending push-based notifications. * <p> * The {@link Observable} will not call this method if it calls {@link #onError}. */ void onComplete(); }
每个方法都对应有注释,后两个就不用看了,分别是失败以及完成,其前两个的功能则是onSubscribe以及onNext,onSubscribe的作用,是负责与观察者(Observer)断开链接的,而onNext则是为观察者提供一个新的item来观察,翻译成现行标准普通话就是,网络请求完毕的数据回调方法。
所以需要注意的是,这里的网络请求结束的回调是onNext,而不是onComplete,onComplete是成功发送了消息后更新观察者的,具体功能在网络访问部分用不上,这里大家只要记住onNext就可以了。
至此,关于三者的配合使用也就算完成了,不过很显然,从篇幅上看就能知道,这只是最简单的应用,Retrofit中还包括文件的上传下载等,还有一些其他的注意点,作为一个小菜鸟,实在难以在短短的时间内融会贯通,再通过本篇博客展示出来,所以这里强烈建议有求知欲的战友们看一下张鸿洋的Retrofit2 完全解析 探索与okhttp之间的关系。
附录
《一个Android工程的从零开始》- 目录相关文章推荐
- Android开发相关——Retrofit+RxJava+OkHttp(上)闲扯
- 初学者--Android Retrofit+RxJava+OkHttp使用post请求
- Android开发常见错误(3):使用retrofit+rxjava更新UI出现卡顿
- Android开发之Retrofit+RxJava的使用
- 如何优雅的使用Retrofit、Rxjava、Butterknife、Material开发一款MVP模式的新闻+天气预报+妹子的Android app
- Android开发之Retrofit+RxJava的使用
- Android Retrofit 2.0(二)使用教程OkHttp3 + Gson + RxJava
- Android中的Retrofit+OkHttp+RxJava缓存架构使用
- Android网络开发框架Retrofit(四:扩展篇,Retrofit+RxJava)
- Android开发使用TelephonyManager获得手机相关信息
- 菜鸟阶段,使用Android开发工具eclipse编辑器中的相关快捷键
- 实现PHP服务器+Android客户端(Retrofit+RxJava)第五天学一学ndk开发吧
- Android开发之OkHttp的使用
- Rxjava+Retrofit结合使用时的开发技巧
- RxJava入门指南及其在Android开发中的使用示例
- Android-使用Mockito、Robolectric和RxJava及Retrofit进行单元测试
- Android开发okhttp,retrofit,android-async-http,volley?
- Android使用eclipse开发导入源码包相关问题
- Android app开发中Retrofit框架的初步上手使用
- Android ReactiveX 使用RxJava开发