Retrofit2.0使用总结及注意事项
来源:互联网 发布:高仿香港身份证淘宝 编辑:程序博客网 时间:2024/06/11 04:26
概述
随着Google对HttpClient 摒弃,和Volley的逐渐没落,OkHttp开始异军突起,而Retrofit则对okHttp进行了强制依赖。
Retrofit是由Square公司出品的针对于Android和Java的类型安全的Http客户端,
如果看源码会发现其实质上就是对okHttp的封装,使用面向接口的方式进行网络请求,利用动态生成的代理类封装了网络接口请求的底层,
其将请求返回javaBean,对网络认证 REST API进行了很好对支持此,使用Retrofit将会极大的提高我们应用的网络体验。
REST
既然是RESTful架构,那么我们就来看一下什么是REST吧。
REST(REpresentational State Transfer)是一组架构约束条件和原则。
RESTful架构都满足以下规则:
(1)每一个URI代表一种资源;
(2)客户端和服务器之间,传递这种资源的某种表现层;
(3)客户端通过四个HTTP动词,对服务器端资源进行操作,实现”表现层状态转化”。
更多关于REST的介绍:什么是REST - GitHub讲解的非常详细
2.0与1.9使用比较
如果之前使用过Retrofit1,会发现2.0后的API会有一些变化,
比如创建方式,拦截器,错误处理,转换器等,如下我们列举以下他们使用起来具体的区别有哪些。
(1) 在Retrofit1中使用的是RestAdapter,而Retrofit2中使用的Retrofit实例,之前的setEndpoint变为了baseUrl。
(2) Retrofit1中使用setRequestInterceptor设置拦截器,对http请求进行相应等处理。
(3) Retrofit2通过OKHttp的拦截器拦截http请求进行监控,重写或重试等,包括日志打印等。
(4) converter,Retrofit1中的setConverter,换以addConverterFactory,用于支持Gson转换。
Retrofit1体验不好的地方:
(1) Retrofit1不能同时操作response返回数据(比如说返回的 Header 部分或者 URL)
和序列化后的数据(JAVABEAN)
,
(2) Retrofit1中同步和异步执行同一个方法需要分别定义接口。
(3) Retrofit1对正在进行的网络任务无法取消。
参考:官方CHANGELOG.md
更新到Retrofit2的一些技巧
1.9使用配置:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
2.0使用配置
引入依赖
- 1
- 2
- 3
- 4
- 5
- 1
- 2
- 3
- 4
- 5
OkHttp配置
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
其中 level 为 BASIC / HEADERS / BODY,BODY等同于1.9中的FULL
retryOnConnectionFailure:错误重联
addInterceptor:设置应用拦截器,可用于设置公共参数,头信息,日志拦截等
addNetworkInterceptor:网络拦截器,可以用于重试或重写,对应与1.9中的setRequestInterceptor。
参考:Interceptors
中文翻译:Okhttp-wiki 之 Interceptors 拦截器
Retrofit配置
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 1
- 2
- 3
- 4
- 5
- 6
- 7
其中baseUrl相当于1.9中的setEndPoint,
addCallAdapterFactory提供RxJava支持,如果没有提供响应的支持(RxJava,Call),则会跑出异常。
addConverterFactory提供Gson支持,可以添加多种序列化Factory,但是GsonConverterFactory必须放在最后,否则会抛出异常。
参考:用 Retrofit 2 简化 HTTP 请求
2.0使用介绍
注意:retrofit2.0后:BaseUrl要以/结尾;@GET 等请求不要以/开头;@Url: 可以定义完整url,不要以 / 开头。
关于URL拼接注意事项:Retrofit 2.0:有史以来最大的改进
基本用法:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
retrofit注解:
方法注解,包含@GET、@POST、@PUT、@DELETE、@PATH、@HEAD、@OPTIONS、@HTTP。
标记注解,包含@FormUrlEncoded、@Multipart、@Streaming。
参数注解,包含@Query,@QueryMap、@Body、@Field,@FieldMap、@Part,@PartMap。
其他注解,@Path、@Header,@Headers、@Url
几个特殊的注解
@HTTP:可以替代其他方法的任意一种
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 1
- 2
- 3
- 4
- 5
- 6
- 7
@Url:使用全路径复写baseUrl,适用于非统一baseUrl的场景。
- 1
- 2
- 1
- 2
@Streaming:用于下载大文件
- 1
- 2
- 3
- 1
- 2
- 3
- 1
- 2
- 3
- 1
- 2
- 3
常用注解
@Path:URL占位符,用于替换和动态更新,相应的参数必须使用相同的字符串被@Path进行注释
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
@Query,@QueryMap:查询参数,用于GET查询,需要注意的是@QueryMap可以约定是否需要encode
- 1
- 2
- 3
- 1
- 2
- 3
- 1
- 1
@Body:用于POST请求体,将实例对象根据转换方式转换为对应的json字符串参数,
这个转化方式是GsonConverterFactory定义的。
- 1
- 2
- 1
- 2
@Field,@FieldMap:Post方式传递简单的键值对,
需要添加@FormUrlEncoded表示表单提交
Content-Type:application/x-www-form-urlencoded
- 1
- 2
- 3
- 1
- 2
- 3
@Part,@PartMap:用于POST文件上传
其中@Part MultipartBody.Part代表文件,@Part(“key”) RequestBody代表参数
需要添加@Multipart表示支持文件上传的表单,Content-Type: multipart/form-data
- 1
- 2
- 3
- 4
- 1
- 2
- 3
- 4
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
参考: Retrofit2 完全解析 探索与okhttp之间的关系
Retrofit 2 — How to Upload Files to Server
@Header:header处理,不能被互相覆盖,用于修饰参数,
- 1
- 2
- 3
- 1
- 2
- 3
等同于 :
- 1
- 2
- 3
- 4
- 1
- 2
- 3
- 4
@Headers 用于修饰方法,用于设置多个Header值:
- 1
- 2
- 3
- 4
- 5
- 6
- 1
- 2
- 3
- 4
- 5
- 6
自定义Converter
retrofit默认情况下支持的converts有Gson,Jackson,Moshi…
要自定义Converter<F, T>
,需要先看一下GsonConverterFactory的实现,
GsonConverterFactory实现了内部类Converter.Factory。
其中GsonConverterFactory中的主要两个方法,主要用于解析request和response的,
在Factory中还有一个方法stringConverter,用于String的转换。
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
GsonRequestBodyConverter实现了Converter<F, T>
接口,
主要实现了转化的方法
- 1
- 1
StringConverterFactory实现源码
自定义Interceptor
Retrofit 2.0 底层依赖于okHttp,所以需要使用okHttp的Interceptors 来对所有请求进行拦截。
我们可以通过自定义Interceptor来实现很多操作,打印日志,缓存,重试等等。
要实现自己的拦截器需要有以下步骤
(1) 需要实现Interceptor接口,并复写intercept(Chain chain)方法,返回response
(2) Request 和 Response的Builder中有header,addHeader,headers方法,需要注意的是使用header有重复的将会被覆盖,而addHeader则不会。
标准的 Interceptor写法
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
缓存策略
设置缓存就需要用到OkHttp的interceptors,缓存的设置需要靠请求和响应头。
如果想要弄清楚缓存机制,则需要了解一下HTTP语义,其中控制缓存的就是Cache-Control
字段
参考:Retrofit2.0+okhttp3缓存机制以及遇到的问题
How Retrofit with OKHttp use cache data when offline
使用Retrofit和Okhttp实现网络缓存。无网读缓存,有网根据过期时间重新请求
一般情况下我们需要达到的缓存效果是这样的:
- 没有网或者网络较差的时候要使用缓存(统一设置)
- 有网络的时候,要保证不同的需求,实时性数据不用缓存,一般请求需要缓存(单个请求的header来实现)。
OkHttp3中有一个Cache类是用来定义缓存的,此类详细介绍了几种缓存策略,具体可看此类源码。
noCache :不使用缓存,全部走网络
noStore : 不使用缓存,也不存储缓存
onlyIfCached : 只使用缓存
maxAge :设置最大失效时间,失效则不使用
maxStale :设置最大失效时间,失效则不使用
minFresh :设置最小有效时间,失效则不使用
FORCE_NETWORK : 强制走网络
FORCE_CACHE :强制走缓存
配置目录
这个是缓存文件的存放位置,okhttp默认是没有缓存,且没有缓存目录的。
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
其中获取cacahe目录,我们一般采取的策略就是应用卸载,即删除。一般就使用如下两个目录:
- data/$packageName/cache:Context.getCacheDir()
- /storage/sdcard0/Andorid/data/$packageName/cache:Context.getExternalCacheDir()
且当sd卡空间小于data可用空间时,使用data目录。
最后来一张图看懂Android内存结构,参考:Android文件存储使用参考 - liaohuqiu
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
缓存第一种类型
配置单个请求的@Headers,设置此请求的缓存策略,不影响其他请求的缓存策略,不设置则没有缓存。
- 1
- 2
- 3
- 4
- 1
- 2
- 3
- 4
缓存第二种类型
有网和没网都先读缓存,统一缓存策略,降低服务器压力。
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
此中方式的缓存Interceptor实现:ForceCachedInterceptor.java
缓存第三种类型
结合前两种,离线读取本地缓存,在线获取最新数据(读取单个请求的请求头,亦可统一设置)。
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
此中方式的缓存Interceptor实现:OfflineCacheControlInterceptor.java
错误处理
在请求网络的时候,我们不止会得到HttpException,还有我们和服务器约定的errorCode和errorMessage,为了统一处理,我们可以
预处理以下上面两个字段,定义BaseModel,在ConverterFactory中进行处理,
可参照:
- Retrofit+RxJava实战日志(3)-网络异常处理
- retrofit-2-simple-error-handling
网络状态监听
一般在没有网络的时候使用缓存数据,有网络的时候及时重试获取最新数据,其中获取是否有网络,我们采用广播的形式:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 1
- 2
- 3
- 4
- 5
- 6
- 7
HttpNetUtil实时获取网络连接状态,关键代码
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
在需要监听网络的界面或者base(需要判断当前activity是否在栈顶)实现Networkreceiver。
Retrofit封装
全局单利的OkHttpClient:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
全局单利的Retrofit.Builder,这里返回builder是为了方便我们设置baseUrl的,我们可以动态创建多个api接口,当然也可以用@Url注解
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
Retrofit2+RxJava 使用Demo:Retrofit2Demo
参考:
Articles tagged in: Retrofit
官方文档
Retrofit2 完全解析 探索与okhttp之间的关系
Retrofit 2.0 + OkHttp 3.0 配置
更新到Retrofit2的一些技巧
Effective OkHttp
Okhttp-wiki 之 Interceptors 拦截器
Retrofit2.0+okhttp3缓存机制以及遇到的问题
How Retrofit with OKHttp use cache data when offline
使用Retrofit和Okhttp实现网络缓存。无网读缓存,有网根据过期时间重新请求
用 Retrofit 2 简化 HTTP 请求
Retrofit请求参数注解字段说明
Android文件存储使用参考 - liaohuqiu
Retrofit+RxJava实战日志(3)-网络异常处理
retrofit-2-simple-error-handling
- 顶
- 0
- 踩
- 0
- 上一篇Android网络请求使用Retrofit+OkHttp,如何获取请求参数 ?
- 下一篇Retrofit 动态参数(非固定参数、非必须参数)(Get、Post请求)
我的同类文章
- •Android Base64字符串转换成图片2017-04-13
- •ConstraintLayout (约束布局)属性详情2017-03-16
- •RecyclerView的Item点击事件实现总结2016-12-21
- •Retrofit 动态参数(非固定参数、非必须参数)(Get、Post请求)2016-12-20
- •MVVM Light Toolkit使用指南2016-12-13
- •android activity启动的时候隐藏软键盘2017-04-11
- •Android-MVVM架构-Data Binding的使用2016-12-26
- •Retrofit2.0 公共参数(固定参数)2016-12-20
- •Android网络请求使用Retrofit+OkHttp,如何获取请求参数 ?2016-12-20
- •玩转Android之MVVM开发模式实战,炫酷的DataBinding!2016-12-13
- Retrofit2.0使用总结及注意事项
- Retrofit2.0使用总结及注意事项
- Retrofit2.0使用总结及注意事项
- Retrofit2.0使用总结及注意事项
- Retrofit2.0使用总结及注意事项
- Retrofit2.0使用总结
- Retrofit2.0使用总结
- Retrofit2.0使用总结
- Retrofit2.0使用总结
- Retrofit2.0使用总结
- Retrofit2.0的使用总结
- Retrofit2.0简单使用总结
- Retrofit2.0 简单使用总结
- Retrofit2.0的使用及原理解析
- Retrofit2使用总结
- Service总结及使用注意事项
- retrofit2、RxJava简单使用总结
- Retrofit2 的使用以及总结
- c++中输出小数格式控制(c++中怎么控制浮点型小数点后输出的位数)
- ubuntu live555测试
- pb实现增删改查
- 洛谷 2068_统计和_树状数组
- PowerShell 初探
- Retrofit2.0使用总结及注意事项
- T
- C++流的基础知识
- onActivityResult,startActivityForResult,setResult用法解决从后一个activity带参数跳转到前一个activity且不走前activity的onCre
- 面试技巧总结~
- c语言 根据字符串生成QR二维码 libqrencode库的使用
- hashmap源码学习整理
- jQuery.extend 函数使用详解
- java中自定义对象排序(TreeSet)