Android框架式编程之Retrofit
一、Retrofit 简介
Retrofit 官网地址: https://github.com/square/retrofit
Retrofit(即Retrofit,目前最新版本为2.6.0版本),是目前非常流行的网络请求框架,底层是基于okHttp实现的。准确来说Retrofit是对okHttp的进一步封装,它功能强大,支持同步和异步,支持多种数据的解析方式(默认为Gson),支持RxJava。
Retrofit 最大的优势就是简洁易用,它通过注解配置网络请求的参数,采用大量的设计模式来简化我们的使用。而且它的拓展性也做的相当的好,Retrofit 的功能模块高度封装,高内聚低耦合,我们可以自定义自己想要的组件,比如说我们可以自己选择解析工具而不用默认的Gson。除此之外,Retrofit 还有诸如性能好,处理速度快,代码简化等优势。
二、Retrofit 注解
使用 Retrofit 前我们不得不提一下注解,正是这些注解极大的方便了我们的代码编写及逻辑流程的控制。
1. 请求方法注解
- @GET:GET请求
- @POST:POST请求
- @DELETE:DELETE请求
- @HEAD:HEAD请求
- @OPTIONS:OPTIONS请求
- @PATCH:PATCH请求
2. 请求参数
- @Headers:添加请求头
- @Path:替换路径
- @Query:替代参数值,通常是结合get请求的
- @FormUrlEncoded:用表单数据提交
- @Field:替换参数值,是结合post请求的
二、Retrofit 使用
Retrofit代码实现步骤如下:
1)创建Retrofit 实例。
2)定义接口,使用注解的形式封装请求地址和请求参数
3)通过Retrofit实例,获取一个接口服务对象
4)通过接口服务对象调用接口中的方法,获取call对象
5)Call对象执行请求(异步请求、同步请求)
0. 准备工作
由于Retrofit是基于OkHttp,所以还需要添加OkHttp库依赖,需要在build.grale添加如下依赖:
dependencies {
// Okhttp库
compile 'com.squareup.okhttp3:okhttp:3.10.0'
// Retrofit库
compile 'com.squareup.retrofit2:retrofit:2.6.0'
}
添加网络权限
<uses-permission android:name="android.permission.INTERNET"/>
创建接收服务器返回数据的类:
public class Blog {
// 根据返回数据的格式和数据解析方式(Json、XML等)定义
...
}
1. 创建Retrofit实例
创建Retrofit实例时需要通过 Retrofit.Builder
,并调用baseUrl
方法设置URL。
Retrofit retrofit = new Retrofit.Builder()
.baseUrl("http://localhost:4567/")
.build();
注意:Retrofit 的 baseUlr 必须以 /(斜线) 结束,不然会抛出一个IllegalArgumentException。
2. 定义接口
定义请求接口的方式示例如下:
public interface BlogService {
@GET("blog/{id}")
Call<ResponseBody> getBlog(@Path("id") int id);
}
注意这里的 interface
不是class
,所以我们是无法直接调用该方法,我们需要用Retrofit创建一个BlogService
的代理对象。
BlogService service = retrofit.create(BlogService.class);
拿到代理对象之后,就可以调用了。
3. 接口调用
调用方式的示例如下:
Call<ResponseBody> call = service.getBlog();
// 通过call对象执行网络请求(同步请求execute,异步请求enqueue)
call.enqueue(new Callback<ResponseBody>() {
@Override
public void onResponse(Call<ResponseBody> call, Response<ResponseBody> response) {
try {
System.out.println(response.body().string());
} catch (IOException e) {
e.printStackTrace();
}
} @Override
public void onFailure(Call<ResponseBody> call, Throwable t) {
t.printStackTrace();
}
});
至此,使用Retrofit 就能够进行基本的网络请求了,如果需要更深层的使用,可以参考一下资料进行使用,后续我们在对这些高级的使用方法进行一一整理。
三、Retrofit 添加header参数
添加Header有以下几种方式:
1. 使用注解的方式
添加一个Header参数
public interface UserService {
@Headers("Cache-Control: max-age=640000")
@GET("/tasks")
Call<List<Task>> getTasks();
}
添加多个Header参数
public interface UserService {
@Headers({
"Accept: application/vnd.yourapi.v1.full+json",
"User-Agent: Your-App-Name"
})
@GET("/tasks/{task_id}")
Call<Task> getTask(@Path("task_id") long taskId);
}
2. 使用代码的方式,则需要使用拦截器:
OkHttpClient.Builder httpClient = new OkHttpClient.Builder();
httpClient.addInterceptor(new Interceptor() {
@Override
public Response intercept(Interceptor.Chain chain) throws IOException {
Request original = chain.request();
Request request = original.newBuilder().header("User-Agent", "Your-App-Name")
.header("Accept", "application/vnd.yourapi.v1.full+json")
.method(original.method(), original.body()).build();
return chain.proceed(request);
}
} OkHttpClient client = httpClient.build();
Retrofit retrofit = new Retrofit.Builder().baseUrl(API_BASE_URL)
.addConverterFactory(GsonConverterFactory.create()).client(client).build();
3. 使用注解的方式,但是Header参数每次提交的都不同,也就是动态的Header:
public interface UserService {
@GET("/tasks")
Call<List<Task>> getTasks(@Header("Content-Range") String contentRange);
}
4. 使用注解Map方式,也就是将多个Header参数进行封装:
@GET("/search")
Call<ResponseBody> list(@HeaderMap Map<String, String> headers);
四、Retrofit 提交数据方式
1. Retrofit实现Form提交
Form表单提交,后台服务器是以 键值对 的形式来接受参数的,所以Retrofit也很聪明,把接口参数通过Map的形式来提交。使用@FieldMap,@POST注解。
/**
* 登录
* post
* 表单提交
*
* @param map
* @return
*/
@FormUrlEncoded
@POST("login")
Flowable<BaseDto<LoginDto>> login(@FieldMap Map<String, String> map);
2. Retrofit实现Json提交
Json提交就是可以把对象直接转换成Json字符串,提交到后台服务器。所以我们直接传递整个对象即可。Retrofit会帮我们把对象转换成Json,然后传递给后台服务器。使用@Body ,@POST注解。
/**
* 签到详情
*
* @param vo
* @return
*/
@POST("sign/getDate")
Flowable<BaseDto<SignDetailDto>> signGetDate(@Body SignDetailVo vo);
参考资料:
1. 博文:https://www.jianshu.com/p/308f3c54abdd
2. 实例代码:https://github.com/ikidou/Retrofit2Demo/tree/master/client/src/main/java/com/github/ikidou
Android框架式编程之Retrofit的更多相关文章
- Android框架式编程之Android Architecture Components
1. 当前Android开发面临的问题 Android开发不同于传统的桌面程序开发,桌面程序一般都有唯一的快捷方式入口,并且常作为单进程存在:而一个典型的Android应用通常由多个应用组件构成,包括 ...
- Android框架式编程之BufferKnife
配置 compile 'com.jakewharton:butterknife:(insert latest version)' annotationProcessor 'com.jakewharto ...
- Android框架式编程之RxJava(一):HelloWorld
Hello World 源码: import android.graphics.Bitmap; import android.graphics.BitmapFactory; import androi ...
- Android框架式编程之Room
Room是Google官方出品的ORM(Object-relational mapping) 框架.当前我们也知道当前还有很多的ORM框架,例如GreenDao.OrmLite.Litepal等.目前 ...
- Android框架式编程之Lifecycle
Lifecycle官方文档地址:https://developer.android.com/topic/libraries/architecture/lifecycle. 一.为什么要使用Lifecy ...
- Android框架式编程之EasyPermissions
EasyPermission库是一个谷歌官方提供的简化基本的系统权限逻辑的库,可用于在Android M或者更高版本上. 官方项目地址:https://github.com/googlesamples ...
- Android框架式编程之LiveData
一.LiveData 介绍 LiveData是 Google 推荐的 Android 架构组件之一,是一个基于观察者模式的数据容器,但与一般的被观察者不同的是,它是有生命周期感知功能,解决了Andro ...
- Android框架式编程之EventBus
一.EventBus 简介 EventBus是一种用于Android的事件发布-订阅总线,由GreenRobot开发,Gihub地址是:EventBus. 它简化了应用程序内各个组件之间进行通信的复杂 ...
- Android框架式编程之MVP架构
MVP(Model-View-Presenter)模式.是将APP的结构分为三层:View - Presenter - Model. View 1. 提供UI交互 2. 在presenter的控制下修 ...
随机推荐
- Android 通知的基本用法
一.概念 通知(Notification)是 Android 系统中比较有特色的一个功能,当某个应用程序希望像用户发送一些提示消息的时候,然而此时应用程序并不在前台运行,此时就可以借助通知来实现.发出 ...
- Xcode 10 Error: Multiple commands produce
目录 Xcode 9.4.1运行react-native 可以,但是在Xcode 10运行报错,报错信息如下: 解决方法 1. 选择 File > Project Settings (或者 Fi ...
- [TimLinux] Python 模块
1. 概念 模块是最高级别的程序组织单元,它将程序文件和数据封装起来以便重用.实际上,模块往往对应Python文件,每一个文件都是一个模块,并且模块导入其他模块之后就可以使用导入模块定义的变量,模块和 ...
- css Backgroud-clip (文字颜色渐变)
首先来瞄一下background-clip,这个属性是干嘛的? 顾名思义,背景裁剪... 按照我自己的理解就是背景的显示区域 此处粘上MDN的示例链接(嫌麻烦的,后面我也贴上截图)https:// ...
- Python 3 对象关系映射(ORM)
ORM 对象关系映射 Object Relational Mapping 表 ---> 类 字段 ---> 属性 记录 ---> 对象 # mysql_client.py impor ...
- Day 06 流程控制和爬虫基础2
目录 if 判断 单分支结构 双分支结构 多分支结构 for循环 for循环的基本用法 for循环嵌套 break continue 爬虫基础2 爬取豆瓣TOP250 爬取豆瓣数据接口(异步数据) 爬 ...
- CSS中的变量使用,var()语法
参考博客:https://blog.csdn.net/qq_34206361/article/details/53690414
- 自建CA证书搭建https服务器
由于CA收费,所以可以自建CA,通过将CA导入浏览器实现https的效果,曾经12306购票就需要自行导入网站证书. 关于https 2015年阿里巴巴将旗下淘宝.天猫(包括移动客户端)全站启用HTT ...
- Vue大纲
Vue框架 Vue ---- vue的基本使用 文本/事件/属性指令 补充: js面向对象 js函数 Vue ---- 表单指令 条件指令 循环指令 分隔符 过滤器 计算属性 监听属性 Vue --- ...
- java8-从Lamda到方法引用和构造引用
一方法引用概述 经过前面2章Lamda原理引入和Lamda解析,基本就会熟练使用Lamda表达式,这次我们更深入点.来了解一下方法引用. 方法引用是特定Lamda表达式的一种简写,其思路就是能替换La ...