Retrofit使用方法
官网:http://square.github.io/retrofit/
首先需要添加访问网络的权限。
<uses-permission android:name="android.permission.INTERNET"/>
去官网添加最新依赖
compile 'com.squareup.retrofit2:retrofit:2.0.1'
创建API接口
在retrofit中通过一个Java接口作为http请求的api接口。注:GET括号里面的是相对路径。Path括号里面的是对应Get括号的参数
创建retrofit实例
在这里baseUrl是在创建retrofit实力的时候定义的,我们也可以在API接口中定义完整的url。在这里建议在创建baseUrl中以”/”结尾,在API中不以”/”开头和结尾。
构建根url
GitHubService service = retrofit .create (GitHubService .class ) ;
之后就可以直接调用生成的GitHubServcie
实例去发送同步或异步的请求给Web服务器
API 声明
接口函数的注解和参数表明如何去处理请求
请求方法
每一个函数都必须有提供请求方式和相对URL的Http注解,Retrofit提供了5种内置的注解:GET
、POST
、PUT
、DELETE
和HEAD
,在注解中指定的资源的相对URL
- 1
- 1
也可以在URL中指定查询参数
URL处理
请求的URL可以在函数中使用替换块和参数进行动态更新,替换块是{ and }
包围的字母数字组成的字符串,相应的参数必须使用相同的字符串被@Path
进行注释
- 1
- 2
- 1
- 2
也可以添加查询参数
- 1
- 2
- 1
- 2
复杂的查询参数可以使用Map
进行组合
请求体
可以通过@Body
注解指定一个对象作为Http请求的请求体
- 1
- 2
- 1
- 2
该对象将会被Retroofit
实例指定的转换器转换,如果没有添加转换器,则只有RequestBody
可用。(转换器的添加在后面介绍)
FORM ENCODED 和 MULTIPART
函数也可以声明为发送form-encoded
和multipart
数据。
当函数有@FormUrlEncoded
注解的时候,将会发送form-encoded
数据,每个键-值对都要被含有名字的@Field
注解和提供值的对象所标注
- 1
- 2
- 3
- 1
- 2
- 3
当函数有@Multipart
注解的时候,将会发送multipart
数据,Parts都使用@Part
注解进行声明
- 1
- 2
- 3
- 1
- 2
- 3
Multipart parts要使用Retrofit的众多转换器之一或者实现RequestBody
来处理自己的序列化。
Header处理
可以使用@Headers
注解给函数设置静态的header
- 1
- 2
- 3
- 1
- 2
- 3
- 1
- 2
- 3
- 4
- 5
- 6
- 1
- 2
- 3
- 4
- 5
- 6
需要注意的是:header不能被互相覆盖。所有具有相同名字的header将会被包含到请求中。
可以使用@Header
注解动态的更新一个请求的header。必须给@Header
提供相应的参数,如果参数的值为空header将会被忽略,否则就调用参数值的toString()
方法并使用返回结果
Header处理
可以使用@Headers
注解给函数设置静态的header
- 1
- 2
- 3
- 1
- 2
- 3
- 1
- 2
- 3
- 4
- 5
- 6
- 1
- 2
- 3
- 4
- 5
- 6
需要注意的是:header不能被互相覆盖。所有具有相同名字的header将会被包含到请求中。
可以使用@Header
注解动态的更新一个请求的header。必须给@Header
提供相应的参数,如果参数的值为空header将会被忽略,否则就调用参数值的toString()
方法并使用返回结果
Retrofit 配置
Retrofit
是通过API接口转换成的可调用的对象,默认有一些合理的配置,这些配置也可以进行定制。
转换器
默认情况下,Retrofit只能够反序列化Http体为OkHttp的ResponseBody
类型,并且只能够接受ResponseBody
类型的参数作为@body
。
添加转换器可以支持其他的类型,为了方便的适应流行的序列化库,Retrofit提供了六个兄弟模块:
- 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不支持开箱即用的内容格式(如YAML、txt、自定义格式)和API进行通信,或者想要使用不同的库实现已经存在的格式,你可以很方便的创建自己的转换器。创建方式:新建一个类继承Converter.Factory类,并在构建Retrofit实例时传入转换器实例。
- 1
- 2
- 3
- 4
- 5
- 1
- 2
- 3
- 4
- 5
使用RxJava和Gson转换器需要添加依赖
配合RxJava使用
在Rxjava下,你可以用Observable定义异步函数:
- 1
- 2
- 1
- 2
现在你可以做很多事情,不光可以获取数据还可以改变数据。
Retrofit 支持Observable导致了将多个REST调用组合在一起变得简单了。例如,我们有一个调用去获取照片,第二个调用去获取原生数据,我们可以将结果一起打包。
- 1
- 2
- 3
- 4
- 5
- 1
- 2
- 3
- 4
- 5
通过RxJava + Retrofit可以让多个REST调用组合成一个变得更简单。