Retrofit2.0使用详解
2016-05-10 23:11
573 查看
Retrofit2.0 项目主页
Retrofit2.0 官方文档
Retrofit2.0: 有史以来最大的改进
转换HTTP API为Java接口
之后就可以直接调用生成的
也可以在URL中指定查询参数
URL处理
请求的URL可以在函数中使用替换块和参数进行动态更新,替换块是
复杂的查询参数可以使用
可以通过
该对象将会被
函数也可以声明为发送
当函数有
Multipart parts要使用Retrofit的众多转换器之一或者实现
可以使用
每一个
也可以使用CallBack定义一个异步方法:
添加转换器可以支持其他的类型,为了方便的适应流行的序列化库,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
在Rxjava下,你可以用Observable定义异步函数:
现在你可以做很多事情,不光可以获取数据还可以改变数据。
Retrofit 支持Observable导致了将多个REST调用组合在一起变得简单了。例如,我们有一个调用去获取照片,第二个调用去获取原生数据,我们可以将结果一起打包。
RxJava项目主页
RxAndroid项目主页
深入浅出RxJava(一:基础篇)
深入浅出RxJava(二:操作符)
深入浅出RxJava三–响应式的好处
深入浅出RxJava四-在Android中使用响应式编程
原文链接:http://blog.csdn.net/u014165119/article/details/49280779
参考链接:http://www.2cto.com/kf/201603/494601.html (Retrofit+RxJava使用以及自定义Retrofit转换器使用)
Retrofit2.0 官方文档
简介
Retrofit是由Square公司出品的针对于Android和Java的类型安全的Http客户端,网络服务基于OkHttp 。Retrofit2.0: 有史以来最大的改进
使用Retrofit2.0
下载 v2.0.0-beta2 JARGradle
compile 'com.squareup.retrofit:retrofit:2.0.0-beta2'
Maven :
<dependency> <groupId>com.squareup.retrofit</groupId> <artifactId>retrofit</artifactId> <version>2.0.0-beta2</version> </dependency>用法介绍
转换HTTP API为Java接口
public interface GitHubService { @GET("users/{user}/repos") Call<List<Repo>> listRepos(@Path("user") String user); }使用类
Retrofit生成接口
GitHubService的实现
Retrofit retrofit = new Retrofit.Builder() .baseUrl("https://api.github.com/") .build(); GitHubService service = retrofit.create(GitHubService.class);
之后就可以直接调用生成的
GitHubServcie实例去发送同步或异步的请求给Web服务器
Call<List<Repo>> repos = service.listRepos("octocat");* baseUrl和注解中url连接的”/”最好写在baseUrl的后面,而不是注解中url的前面,否则可能会出现不可预知的错误。 *
API 声明
接口函数的注解和参数表明如何去处理请求请求方法
每一个函数都必须有提供请求方式和相对URL的Http注解,Retrofit提供了5种内置的注解:GET、
POST、
PUT、
DELETE和
HEAD,在注解中指定的资源的相对URL
@GET("users/list")
也可以在URL中指定查询参数
@GET("users/list?sort=desc")
URL处理
请求的URL可以在函数中使用替换块和参数进行动态更新,替换块是
{ and }包围的字母数字组成的字符串,相应的参数必须使用相同的字符串被
@Path进行注释
@GET("group/{id}/users") List<User> groupList(@Path("id") int groupId);也可以添加查询参数
@GET("group/{id}/users") List<User> groupList(@Path("id") int groupId, @Query("sort") String sort);
复杂的查询参数可以使用
Map进行组合
@GET("group/{id}/users") List<User> groupList(@Path("id") int groupId, @QueryMap Map<String, String> options);请求体
可以通过
@Body注解指定一个对象作为Http请求的请求体
@POST("users/new") Call<User> createUser(@Body User user);
该对象将会被
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);当函数有
@Multipart注解的时候,将会发送
multipart数据,Parts都使用
@Part注解进行声明
@Multipart @PUT("user/photo") Call<User> updateUser(@Part("photo") RequestBody photo, @Part("description") RequestBody description);
Multipart parts要使用Retrofit的众多转换器之一或者实现
RequestBody来处理自己的序列化。
Header处理
可以使用@Headers注解给函数设置静态的header
@Headers("Cache-Control: max-age=640000") @GET("widget/list") Call<List<Widget>> widgetList();
@Headers({ "Accept: application/vnd.github.v3.full+json", "User-Agent: Retrofit-Sample-App" }) @GET("users/{username}") Call<User> getUser(@Path("username") String username);需要注意的是:header不能被互相覆盖。所有具有相同名字的header将会被包含到请求中。
可以使用
@Header注解动态的更新一个请求的header。必须给
@Header提供相应的参数,如果参数的值为空header将会被忽略,否则就调用参数值的
toString()方法并使用返回结果
@GET("user") Call<User> getUser(@Header("Authorization") String authorization)使用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();同步 VS 异步
每一个
Call实例可以同步(
call.excute())或者异步(
call.enquene(CallBack<?> callBack))的被执行,每一个实例仅仅能够被使用一次,但是可以通过
clone()函数创建一个新的可用的实例。
也可以使用CallBack定义一个异步方法:
@GET("user/{id}/photo") void getUserPhoto(@Path("id") int id, Callback<Photo> cb);在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();使用RxJava和Gson转换器需要添加依赖
// Retrofit适配RxJava compile 'com.squareup.retrofit:adapter-rxjava:2.0.0-beta1' // Retrofit Gson数据转换器 compile 'com.squareup.retrofit:converter-gson:2.0.0-beta1'配合RxJava使用
在Rxjava下,你可以用Observable定义异步函数:
@GET("user/{id}/photo") Observable<Photo> getUserPhoto(@Path("id") int id);
现在你可以做很多事情,不光可以获取数据还可以改变数据。
Retrofit 支持Observable导致了将多个REST调用组合在一起变得简单了。例如,我们有一个调用去获取照片,第二个调用去获取原生数据,我们可以将结果一起打包。
Observable.zip( service.getUserPhoto(id), service.getPhotoMetadata(id), (photo, metadata) -> createPhotoWithData(photo, metadata)) .subscribe(photoWithData -> showPhoto(photoWithData));通过RxJava + Retrofit可以让多个REST调用组合成一个变得更简单。
RxJava项目主页
RxAndroid项目主页
RxJava教程:
给 Android 开发者的 RxJava 详解深入浅出RxJava(一:基础篇)
深入浅出RxJava(二:操作符)
深入浅出RxJava三–响应式的好处
深入浅出RxJava四-在Android中使用响应式编程
Retrofit代码混淆配置
-dontwarn retrofit.** -keep class retrofit.** { *; } -keepattributes Signature -keepattributes Exceptions
原文链接:http://blog.csdn.net/u014165119/article/details/49280779
参考链接:http://www.2cto.com/kf/201603/494601.html (Retrofit+RxJava使用以及自定义Retrofit转换器使用)
相关文章推荐
- Retrofit2.0结合RxAndroid实现二次封装
- Retrofit Rxjava 实现图片下载、保存并展示
- Retrofit 2.0 (v2.0.0-beta4)
- Retrofit2.0+ .Net MVC4(WebApi) 上传多张图片
- 初识Retrofit
- Retrofit2.0初识
- Retrofit2.0的学习以及Rxjava与Retrofit2的结合使用
- retrofit 如何post json给服务端
- Retrofit2.0的简单使用 (包含Gson)
- Retrofit2.0 简单使用总结
- Retrofit 2.0源码分析
- Retrofit网络请求框架,简介
- 从零开始搭建一个主流项目框架(三)—RxJava2.0+Retrofit2.0+OkHttp
- Retrofit2.0入门学习
- 关于Retrofit2.0源码的学习和理解
- RESTful API 设计
- Android使用Retrofit2.0技术仿微信发说说
- Java中double类型精度丢失问题
- Swift 第一天
- android:descendantFocusability用法简析-ListView与Button、RadioButton焦点冲突问题