retrofit详细使用
来源:互联网 发布:java 数据库管理工具 编辑:程序博客网 时间:2024/06/05 05:43
Retrofit2.0 项目主页
Retrofit2.0 官方文档
简介
Retrofit是由Square公司出品的针对于Android和Java的类型安全的Http客户端,网络服务基于OkHttp 。
Retrofit2.0: 有史以来最大的改进
使用Retrofit2.0
下载 v2.0.0-beta2 JAR
Gradle :
compile 'com.squareup.retrofit:retrofit:2.0.0-beta2'
- 1
- 1
Maven :
<dependency> <groupId>com.squareup.retrofit</groupId> <artifactId>retrofit</artifactId> <version>2.0.0-beta2</version></dependency>
- 1
- 2
- 3
- 4
- 5
- 1
- 2
- 3
- 4
- 5
用法介绍
转换HTTP API为Java接口
public interface GitHubService { @GET("users/{user}/repos") Call<List<Repo>> listRepos(@Path("user") String user);}
- 1
- 2
- 3
- 4
- 1
- 2
- 3
- 4
使用类Retrofit
生成接口GitHubService
的实现
Retrofit retrofit = new Retrofit.Builder() .baseUrl("https://api.github.com/") .build();GitHubService service = retrofit.create(GitHubService.class);
- 1
- 2
- 3
- 4
- 5
- 1
- 2
- 3
- 4
- 5
之后就可以直接调用生成的GitHubServcie
实例去发送同步或异步的请求给Web服务器
Call<List<Repo>> repos = service.listRepos("octocat");
- 1
- 1
* baseUrl和注解中url连接的”/”最好写在baseUrl的后面,而不是注解中url的前面,否则可能会出现不可预知的错误。 *
API 声明
接口函数的注解和参数表明如何去处理请求
请求方法
每一个函数都必须有提供请求方式和相对URL的Http注解,Retrofit提供了5种内置的注解:GET
、POST
、PUT
、DELETE
和HEAD
,在注解中指定的资源的相对URL
@GET("users/list")
- 1
- 1
也可以在URL中指定查询参数
@GET("users/list?sort=desc")
- 1
- 1
URL处理
请求的URL可以在函数中使用替换块和参数进行动态更新,替换块是{ and }
包围的字母数字组成的字符串,相应的参数必须使用相同的字符串被@Path
进行注释
@GET("group/{id}/users")List<User> groupList(@Path("id") int groupId);
- 1
- 2
- 1
- 2
也可以添加查询参数
@GET("group/{id}/users")List<User> groupList(@Path("id") int groupId, @Query("sort") String sort);
- 1
- 2
- 1
- 2
复杂的查询参数可以使用Map
进行组合
@GET("group/{id}/users")List<User> groupList(@Path("id") int groupId, @QueryMap Map<String, String> options);
- 1
- 2
- 1
- 2
请求体
可以通过@Body
注解指定一个对象作为Http请求的请求体
@POST("users/new")Call<User> createUser(@Body User user);
- 1
- 2
- 1
- 2
该对象将会被Retroofit
实例指定的转换器转换,如果没有添加转换器,则只有RequestBody
可用。(转换器的添加在后面介绍)
FORM ENCODED 和 MULTIPART
函数也可以声明为发送form-encoded
和multipart
数据。
当函数有@FormUrlEncoded
注解的时候,将会发送form-encoded
数据,每个键-值对都要被含有名字的@Field
注解和提供值的对象所标注
@FormUrlEncoded@POST("user/edit")Call<User> updateUser(@Field("first_name") String first, @Field("last_name") String last);
- 1
- 2
- 3
- 1
- 2
- 3
当函数有@Multipart
注解的时候,将会发送multipart
数据,Parts都使用@Part
注解进行声明
@Multipart@PUT("user/photo")Call<User> updateUser(@Part("photo") RequestBody photo, @Part("description") RequestBody description);
- 1
- 2
- 3
- 1
- 2
- 3
Multipart parts要使用Retrofit的众多转换器之一或者实现RequestBody
来处理自己的序列化。
Header处理
可以使用@Headers
注解给函数设置静态的header
@Headers("Cache-Control: max-age=640000")@GET("widget/list")Call<List<Widget>> widgetList();
- 1
- 2
- 3
- 1
- 2
- 3
@Headers({ "Accept: application/vnd.github.v3.full+json", "User-Agent: Retrofit-Sample-App"})@GET("users/{username}")Call<User> getUser(@Path("username") String username);
- 1
- 2
- 3
- 4
- 5
- 6
- 1
- 2
- 3
- 4
- 5
- 6
需要注意的是:header不能被互相覆盖。所有具有相同名字的header将会被包含到请求中。
可以使用@Header
注解动态的更新一个请求的header。必须给@Header
提供相应的参数,如果参数的值为空header将会被忽略,否则就调用参数值的toString()
方法并使用返回结果
@GET("user")Call<User> getUser(@Header("Authorization") String authorization)
- 1
- 2
- 1
- 2
使用OkHttp拦截器可以指定需要的header给每一个Http请求
OkHttpClient client = new OkHttpClient();client.networkInterceptors().add(new Interceptor() { @Override public com.squareup.okhttp.Response intercept(Chain chain) throws IOException { com.squareup.okhttp.Response response = chain.proceed(chain.request()); // Do anything with response here return response; }});Retrofit retrofit = new Retrofit.Builder() .baseUrl(BASE_URL) ... .client(client) .build();
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
同步 VS 异步
每一个Call
实例可以同步(call.excute()
)或者异步(call.enquene(CallBack<?> callBack
))的被执行,每一个实例仅仅能够被使用一次,但是可以通过clone()
函数创建一个新的可用的实例。
也可以使用CallBack定义一个异步方法:
@GET("user/{id}/photo")void getUserPhoto(@Path("id") int id, Callback<Photo> cb);
- 1
- 2
- 1
- 2
在Android上,回调被执行在主线程;在JVM上,回调被执行在发送Http请求的线程。
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实例时传入转换器实例。
Retrofit retrofit = new Retrofit.Builder() .baseUrl(BASE_URL) .addCallAdapterFactory(RxJavaCallAdapterFactory.create()) // 使用RxJava作为回调适配器 .addConverterFactory(GsonConverterFactory.create()) // 使用Gson作为数据转换器 .build();
- 1
- 2
- 3
- 4
- 5
- 1
- 2
- 3
- 4
- 5
使用RxJava和Gson转换器需要添加依赖
// Retrofit适配RxJavacompile 'com.squareup.retrofit:adapter-rxjava:2.0.0-beta1'// Retrofit Gson数据转换器compile 'com.squareup.retrofit:converter-gson:2.0.0-beta1'
- 1
- 2
- 3
- 4
- 1
- 2
- 3
- 4
配合RxJava使用
在Rxjava下,你可以用Observable定义异步函数:
@GET("user/{id}/photo")Observable<Photo> getUserPhoto(@Path("id") int id);
- 1
- 2
- 1
- 2
现在你可以做很多事情,不光可以获取数据还可以改变数据。
Retrofit 支持Observable导致了将多个REST调用组合在一起变得简单了。例如,我们有一个调用去获取照片,第二个调用去获取原生数据,我们可以将结果一起打包。
Observable.zip( service.getUserPhoto(id), service.getPhotoMetadata(id), (photo, metadata) -> createPhotoWithData(photo, metadata)) .subscribe(photoWithData -> showPhoto(photoWithData));
- 1
- 2
- 3
- 4
- 5
- 1
- 2
- 3
- 4
- 5
通过RxJava + Retrofit可以让多个REST调用组合成一个变得更简单。
RxJava项目主页
RxAndroid项目主页
RxJava教程:
- 给 Android 开发者的 RxJava 详解
- 深入浅出RxJava(一:基础篇)
- 深入浅出RxJava(二:操作符)
- 深入浅出RxJava三–响应式的好处
- 深入浅出RxJava四-在Android中使用响应式编程
Retrofit代码混淆配置
-dontwarn retrofit.**-keep class retrofit.** { *; }-keepattributes Signature-keepattributes Exceptions
- 1
- 2
- 3
- 4
- 5
- 1
- 2
- 3
- 4
- 5
- retrofit详细使用
- 史上最详细的Retrofit 2.0 使用教程
- Retrofit的使用,及介绍,Retrofit中的各种方法的详细描述简单案例,三分钟学会Retrofit
- 详细的 Retrofit 2.0 使用教程(含实例讲解)
- Retrofit详细介绍
- 详细的retrofit
- Retrofit详细介绍
- Retrofit使用
- Retrofit使用
- Retrofit使用
- Retrofit使用
- Retrofit使用
- Retrofit使用
- Retrofit使用
- 【Retrofit 】Retrofit 基本使用教程
- 这是一份很详细的 Retrofit 2.0 使用教程(含实例讲解)
- 这是一份很详细的 Retrofit 2.0 使用教程(含实例讲解)
- 这是一份很详细的 Retrofit 2.0 使用教程(含实例讲解)
- 20170531练习赛比赛总结
- github常见操作和常见错误!错误提示:fatal: remote origin already exists.
- Android实现购物车(附demo)
- vi或vim查找替换
- 数据结构课程设计实战
- retrofit详细使用
- 比特币开发专题(区块链内核密钥、地址、钱包)
- 数据导出excel
- linux 重启命令
- 第一行代码第二版(郭霖著)笔记之第十二章(Material Design 实战)
- iis部署网站(asp.net或者wcf)出现HTTP 错误 404.17
- BZOJ 3667 Rabin-Miller算法
- centos7 安装java1.8
- printf函数调用的一般形式