Retrofit全攻略——基础篇
实际开发过程中一般都会选择一些网络框架提升开发效率。随着Google对HttpClient 摒弃和Volley框架的逐渐没落。OkHttp開始异军突起。而Retrofit则对OkHttp进行了强制依赖,能够简单理解Retroifit在OKHttp基础上进一步完好。
Retrofit是由Square公司出品的针对于Android和Java的类型安全的Httpclient,眼下推出了2.0+的版本号。
Retrofit框架项目地址:https://github.com/square/retrofit。
Retrofit官方文档地址: http://square.github.io/retrofit/
使用Retrofit
接下来我们来学习下怎样使用Retrofit。
首先须要在app/build.gradle加入依赖。
dependencies {
//...
//retrofit
compile 'com.squareup.retrofit2:retrofit:2.1.0'
//假设用到gson解析 须要加入以下的依赖
compile 'com.squareup.retrofit2:converter-gson:2.1.0'
}
我们以查号码归属地接口为例 https://www.juhe.cn/docs/api/id/11
Retrofit不能直接使用,须要进行初始化,在这里创建NetWork.java
public class NetWork {
private static Retrofit retrofit;
/**返回Retrofit*/
public static Retrofit getRetrofit(){
if(retrofit==null){
Retrofit.Builder builder = new Retrofit.Builder();//创建Retrfit构建器
retrofit = builder.baseUrl("http://apis.juhe.cn/") //指定网络请求的baseUrl
.addConverterFactory(GsonConverterFactory.create())//返回的数据通过Gson解析
.build();
}
return retrofit;
}
}
Retrofit须要之地baseUrl。往往一个项目中有很多接口。接口都使用同样的server地址,这时候能够把接口地址同样的部分抽取到baseUrl中。Retrofit扩展性极好。能够指定返回的数据通过Gson解析,前提你须要保证项目中有Gson框架和com.squareup.retrofit2:converter-gson:2.1.0的依赖。
除了通过Gson解析还能够使用其他的方式解析,须要的依赖也不同。有例如以下几种:
- Gson: com.squareup.retrofit:converter-gson
- Jackson: com.squareup.retrofit:converter-jackson
- Moshi: com.squareup.retrofit:converter-moshi
- Protobuf: com.squareup.retrofit:converter-protobuf
- Wire: com.squareup.retrofit:converter-wire
- Simple XML: com.squareup.retrofit:converter-simplexml
Retrofit须要把Http的请求接口封装到一个接口文件里。
public interface NetInterface {
//获取号码归属地,返回来类型是Bean, 须要两个參数分别为phone何key
@GET("mobile/get")
Call<Bean> getAddress(@Query("phone") String phone, @Query("key") String key);
}
当中Bean是依据请求的结果创建的对象.
方法前加入@GET注解表示当前请求是Get方式请求,链接的地址是baseUrl+”mobile/get”。baseUrl在初始化Retrofit的时候指定了,拼到一起就是 http://apis.juhe.cn/mobile/get。
对于 Retrofit 2.0中新的URL定义方式,这里是我的建议:
- baseUrl: 总是以 /结尾
- url: 不要以 / 开头
由于假设不是这样的方式,拼装后的结果和你期望的是不一样的,详情參考官方文档。
除了Get请求还有以下几种请求方式
- @POST 表明这是post请求
- @PUT 表明这是put请求
- @DELETE 表明这是delete请求
- @PATCH 表明这是一个patch请求。该请求是对put请求的补充。用于更新局部资源
- @HEAD 表明这是一个head请求
- @OPTIONS 表明这是一个option请求
- @HTTP 通用注解,能够替换以上全部的注解。其拥有三个属性:method。path,hasBody
最后的HTTP通用注解写法比較特殊。请求能够取代之前的请求。以下的写法和之前的@GET效果是一样的。
/**
* method 表示请的方法,不区分大写和小写
* path表示路径
* hasBody表示是否有请求体
*/
@HTTP(method = "get",path = "mobile/get",hasBody = false)
Call<Bean> getAddress(@Query("phone") String phone, @Query("key") String key);
@Quert表示查询參数。用于GET查询,注解里的字符串是參数的key值,參数会自己主动拼装到Url后面。
除了上面的注解。再给大家介绍几种不同的注解。
经常使用的注解
@Url:使用全路径复写baseUrl,适用于非统一baseUrl的场景。演示样例代码:
@GET Call<ResponseBody> XXX(@Url String url);
@Streaming:用于下载大文件。演示样例代码:
@Streaming @GET Call<ResponseBody> downloadFileWithDynamicUrlAsync(@Url String fileUrl);
//获取数据的代码
ResponseBody body = response.body();
long fileSize = body.contentLength();
InputStream inputStream = body.byteStream();
@Path:URL占位符,用于替换和动态更新,相应的參数必须使用同样的字符串被@Path进行凝视
//实际请求地址会给句groupId的值发生变化--> http://baseurl/group/groupId/users
@GET("group/{id}/users") Call<List<User>> groupList(@Path("id") int groupId);
@QueryMap:查询參数,和@Query相似。差别就是后面须要Map集合參数。演示样例代码:
Call<List<News>> getNews((@QueryMap(encoded=true) Map<String, String> options);
@Body:用于POST请求体。将实例对象依据转换方式转换为相应的json字符串參数。这个转化方式是GsonConverterFactory定义的。 演示样例代码:
@POST("add")
Call<List<User>> addUser(@Body User user);
@Field,@FieldMap:Post方式传递简单的键值对,须要加入@FormUrlEncoded表示表单提交
@FormUrlEncoded @POST("user/edit") Call<User> updateUser(@Field("first_name") String first, @Field("last_name") String last);
@Part,@PartMap:用于POST文件上传,当中@Part MultipartBody.Part代表文件,@Part(“key”) RequestBody代表參数,须要加入@Multipart表示支持文件上传的表单。
@Multipart
@POST("upload")
Call<ResponseBody> upload(@Part("description") RequestBody description,
@Part MultipartBody.Part file);
完毕请求实例
了解了Retrofit,我们用Retrofit请求完毕请求。Retrofit使用起来比較省事,核心代码例如以下所看到的:
//初始化Retrofit,载入接口
NetInterface netInterface = NetWork.getRetrofit().create(NetInterface.class);
//请求接口
netInterface.getAddress(editText.getText().toString(),"你的app key")
.enqueue(new Callback<Bean>() {
@Override
public void onResponse(Call<Bean> call, Response<Bean> response) {
//请求成功
Bean bean = response.body();
//...
}
@Override
public void onFailure(Call<Bean> call, Throwable t) {
//请求失败
}
});
Retrofit会自己主动在子线程中进行网络请求。请求结束切换到主线程中。并且内部使用了线程池。对网络请求的缓存控制的也很到位,网络响应速度也是很快的,使用起来很的爽!
RxJava和Retrofit结合
RxJava很强大。就连Retrofit都要抱下他的大腿,Retrofit也能够用RxJava方式进行网络请求。仅仅须要对上面的代码进行改造就可以。
首先加入框架依赖。
dependencies {
//...
compile 'io.reactivex:rxandroid:1.2.1'
compile 'io.reactivex:rxjava:1.1.6'
compile 'com.google.code.gson:gson:2.8.0'
compile 'com.squareup.retrofit2:retrofit:2.1.0'
//假设用到gson解析 须要加入以下的依赖
compile 'com.squareup.retrofit2:converter-gson:2.1.0'
//Retrofit使用RxJava须要的依赖
compile 'com.squareup.retrofit2:adapter-rxjava:2.1.0'
}
改动Retrofit初始化的代码:
public class NetWork {
private static Retrofit retrofit;
/**返回Retrofit*/
public static Retrofit getRetrofit(){
if(retrofit==null){
//创建Retrfit构建器
Retrofit.Builder builder = new Retrofit.Builder();
//指定网络请求的baseUrl
retrofit = builder.baseUrl("http://apis.juhe.cn/")
//返回的数据通过Gson解析
.addConverterFactory(GsonConverterFactory.create())
//使用RxJava模式
.addCallAdapterFactory(RxJavaCallAdapterFactory.create())
.build();
}
return retrofit;
}
}
上面代码我们通过,加入代码addCallAdapterFactory(RxJavaCallAdapterFactory.create())
就变成了使用RxJava模式。
接口也须要改动,把方法的返回值类型由Call改成了RxJava中的Observable。
public interface NetInterface {
//获取号码归属地,返回来类型是Bean, 须要两个參数分别为phone何key
@GET("mobile/get")
Observable<Bean> getAddress(@Query("phone") String phone, @Query("key") String key);
}
接下来改动终于网络请求的代码,能够改成RxJava方式了。
NetInterface netInterface = NetWork.getRetrofit().create(NetInterface.class);
//RxJava方式
netInterface.getAddress(editText.getText().toString(),"你的app key")
.subscribeOn(Schedulers.io())//设置网络请求在子线程中
.observeOn(AndroidSchedulers.mainThread())// 回调在主线程中
.subscribe(new Action1<Bean>() {
@Override
public void call(Bean bean) {
//请求成功
}
}, new Action1<Throwable>() {
@Override
public void call(Throwable throwable) {
//请求失败
}
});
总结
这是Retrofit基础篇, 后面有时间再继续深入研究
很多其他精彩请关注微信公众账号likeDev
Retrofit全攻略——基础篇的更多相关文章
- Retrofit全攻略——进阶篇
最近事比较多,距离上次写文章已经过去了一个月了.上一篇文章Retrofit全攻略——基础篇 介绍了Retrofit的基础用法,这篇文章介绍点进阶的用法. 打印网络日志 在开发阶段,为了方便调试,我们需 ...
- vscode 开发项目, Prettier ESLint的配置全攻略(基础篇)
我们在做项目尤其是多人合作开发的时候经常会因为不同的开发规范和代码风格导致出现冲突, 为了能统一代码风格和规范我们需要使用到prettier和eslint,接下来就一vscode编辑器为例详细讲解下: ...
- BOOST 线程完全攻略 - 基础篇
http://blog.csdn.net/iamnieo/article/details/2908621 2008-09-10 12:48 9202人阅读 评论(3) 收藏 举报 thread多线程l ...
- 【C/C++】BOOST 线程完全攻略 - 基础篇
C++多线程开发是一个复杂的事情,mfc下提供了CWinThread类,和AfxBeginThread等等函数,但是在使用中会遇到很多麻烦事情,例如线程之间参数传递的问题,我们一般都是把参数new一个 ...
- 打造一个高逼格的android开源项目——小白全攻略 (转)
转自:打造一个高逼格的android开源项目 小引子 在平时的开发过程中,我们经常会查阅很多的资料,最常参考的是 github 的开源项目.通常在项目的主页面能看到项目的简介和基本使用,并且时不时能看 ...
- VS2013全攻略(安装,技巧,快捷键,插件)!
工欲善其事,必先利其器.VS2013全攻略(安装,技巧,快捷键,插件)! 之前一篇<c++的性能, c#的产能?!鱼和熊掌可以兼得,.NET NATIVE初窥>承蒙大家喜爱和编辑推荐,在此 ...
- CSS Grid网格布局全攻略
CSS Grid网格布局全攻略 所有奇技淫巧都只在方寸之间. 几乎从我们踏入前端开发这个领域开始,就不停地接触不同的布局技术.从常见的浮动到表格布局,再到如今大行其道的flex布局,css布局技术一直 ...
- Android屏幕适配全攻略(最权威的官方适配指导)屏幕尺寸 屏幕分辨率 屏幕像素密度 dpdipdpisppx mdpihdpixdpixxdpi
Android屏幕适配全攻略(最权威的官方适配指导)原创赵凯强 发布于2015-05-19 11:34:17 阅读数 153734 收藏展开 转载请注明出处:http://blog.csdn.net/ ...
- 【C#代码实战】群蚁算法理论与实践全攻略——旅行商等路径优化问题的新方法
若干年前读研的时候,学院有一个教授,专门做群蚁算法的,很厉害,偶尔了解了一点点.感觉也是生物智能的一个体现,和遗传算法.神经网络有异曲同工之妙.只不过当时没有实际需求学习,所以没去研究.最近有一个这样 ...
随机推荐
- 1.flume概述
我们的web服务器等等每天会产生大量的日志,我们要把这些日志收集起来,移动到hadoop平台上进行分析. 那么如何移动这些数据呢?一种方法是通过shell cp到hadoop集群上,然后通过hdfs ...
- 内部网络出口防火墙导致TCP类扫描异常
测试过程中确认,由于内部网络出口防火墙存在连接数等策略限制,会导致TCP类扫描出现异常,表现为大量误报. Nessus.nmap.synscan均存在此现象.
- python 文件路径操作方法(转)
Python编程语言在实际使用中可以帮助我们轻松的实现一些特殊的功能需求.在这里我们将会为大家详细介绍一下有关Python文件路径的相关操作技巧,从而方便我们在实际开发中获得一些帮助. Python文 ...
- [thinkPHP] buildSql可以查看tp CURD操作对应的SQL
$goods = M('Goods')->where($map)->buildSql(); echo $goods;
- 【我要学python】愣头青之初安装就打了一记耳光
pycharm安装好后创建项目出现interpreter field is empty,导致pycharm无法使用. 这是因为python没有安装好,重新自定义安装一次即可 下载地址:https:// ...
- AMQ学习笔记 - 03. 消息的接收方式
概述 消息有两种接收方式:同步接收和异步接收. 同步接收:主线程阻塞式等待下一个消息的到来,可以设置timeout,超时则返回null. 异步接收:主线程设置MessageListener,然后继续做 ...
- [JSOI2008]Star War
星球之间互相直接或间接地连接帝国开始使用死星有计划地摧毁反抗军占领的星球给出星球间隧道的连通情况,已经帝国打击的顺序要求以尽量快的速度求出每一次打击之后反抗军占据的星球的联通快的个数(若两个星球,直接 ...
- rngd.service 启动失败的处理
[root@localhost ~]# systemctl --failed UNIT LOAD ACTIVE SUB DESCRIPTION ● mdmonitor.service loaded f ...
- Java 反射调用的一种优化
写一些Java框架的时候,经常需要通过反射get或者set某个bean的field,比较普通的做法是获取field后调用java.lang.reflect.Field.get(Object),但每次都 ...
- POP3、IMAP、SMTP邮件协议的理解
一个热爱技术的菜鸟...用点滴的积累铸就明日的达人 CSDN博客链接: http://blog.csdn.net/my_confesser 正文 今天入职配置OutLook的时候,看到公司的 ...