Retrofit2.0使用

原创 2015年11月20日 13:44:33

Retrofit项目Github主页:点击打开链接

Retrofit项目官方文档   :点击打开链接


首先是我参考的文章:

● Retrofit 2.0:有史以来最大的改进

● 使用Retrofit请求API数据

● Retrofit2.0使用详解

● Retrofit 2.0使用详解,配合OkHttp、Gson,Android最强网络请求框架

● 用Retrofit 2 简化 HTTP 请求

这里感谢以上的作者对于 Retrofit使用的讲解,对我的帮助很大。

那么我根据自己的使用情况做一下汇总:因为也是第一次使用,没有接触过2.0之前的版本,所以不介绍与旧版区别。


1.设置


(1)权限:首先确保在AndroidManifest.xml中请求了网络权限 :


<uses-permission android:name="android.permission.INTERNET" />


(2)Studio用户,在app/build.gradle文件中添加如下代码:

dependencies {
    compile 'com.squareup.retrofit:retrofit:2.0.0-beta2'
    compile 'com.squareup.okhttp:okhttp:2.5.0'
    compile 'com.squareup.okio:okio:1.6.0'
}

Eclipse的用户,可以下载最新的jar:我将整理的jar包已上传:点击打开链接
注意:1.Retrofit必须使用okhttp请求了,如果项目中没有okhttp的依赖的话,肯定会出错 。
           2.okhttp内部依赖okio所以也要添加。


2.使用


(1)创建Retrofit实例

public static final String BASE_URL = "http://api.myservice.com";
Retrofit retrofit = new Retrofit.Builder()
    .baseUrl(BASE_URL)
    .build();

如果你想接收json 结果并解析成DAO,你必须把Gson Converter 作为一个独立的依赖添加进来。

compile 'com.google.code.gson:gson:2.4'
compile 'com.squareup.retrofit:converter-gson:2.0.0-beta2'

这里是Square提供的官方Converter modules列表。选择一个最满足你需求的。


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


你也可以通过实现Converter.Factoty接口来创建一个自定义的converter。


然后使用addConverterFactory把它添加进来:

public static final String BASE_URL = "http://api.myservice.com";
Retrofit retrofit = new Retrofit.Builder()
    .baseUrl(BASE_URL)
    .addConverterFactory(GsonConverterFactory.create())
    .build();

(2)定义Endpoints,实现了转换HTTP API为Java接口


Retrofit提供了5种内置的注解:GET、POST、PUT、DELETE和HEAD,在注解中指定的资源的相对URL

@GET("users/list")

也可以在URL中指定查询参数

@GET("users/list?sort=desc")

请求的URL可以在函数中使用替换块和参数进行动态更新,替换块是{ and }包围的字母数字组成的字符串,相应的参数必须使用相同的字符串被@Path进行注释

@GET("group/{id}/users")
Call<List<User>> groupList(@Path("id") int groupId);

也可以添加查询参数

@GET("group/{id}/users")
Call<List<User>> groupList(@Path("id") int groupId, @Query("sort") String sort);

复杂的查询参数可以使用Map进行组合

@GET("group/{id}/users")
Call<List<User>> groupList(@Path("id") int groupId, @QueryMap Map<String, String> options);

可以通过@Body注解指定一个对象作为Http请求的请求体

@POST("users/new")
Call<User> createUser(@Body User user);

使用@FormUrlEncoded发送表单数据,使用@Field注解和参数来指定每个表单项的Key,Value为参数的值。

@FormUrlEncoded
@POST("user/edit")
Call<User> getUser(@Field("name") String name, @Field("password") String password);


使用@FormUrlEncoded发送表单数据时,表单项过多时可以使用Map进行组合

@FormUrlEncoded
@POST("user/edit")
Call<User> getUser(@FieldMap Map<String, String> map);

使用@Multipart可以进行文件上传,使用@Part指定文件路径及类型

@Multipart
@POST("/user/edit")
Call<User> upload(@Part("image\"; filename=\"文件名.jpg") RequestBody file);

使用@MapPart可以方便批量上传

@Multipart
@POST("/user/edit")
Call<User> upload(@PartMap Map<String, RequestBody> params);
RequestBody fileBody = RequestBody.create(MediaType.parse("image/png"), imgFile);
map.put("image\"; filename=\""+imgFile.getName()+"", fileBody);

(3)Accessing the API

public interface MyApiEndpointInterface {
    // Request method and URL specified in the annotation
    // Callback for the parsed response is the last parameter
    @GET("/users/{username}")
    Call<User> getUser(@Path("username") String username);
}
MyApiEndpointInterface apiService = retrofit.create(MyApiEndpointInterface.class);


异步请求这个API

String username = "sarahjean";
Call<User> call = apiService.getUser(username);
call.enqueue(new Callback<User>() {
    @Override
    public void onResponse(Response<User> response) {
        int statusCode = response.code();
        User user = response.body();  
    }
    @Override
    public void onFailure(Throwable t) {
        // Log error here since request failed
    }
});

同步请求

String username = "sarahjean"; 


Call<User> call = apiService.getUser(username);


User user = call.execute();


3.注意


(1)我们在同步方法使用时可以直接调用execute方法,但是这个方法只能调用一次。解决办法:需要用clone方法生成一个新的之后在调用execute方法

Call<List<Contributor>> call = gitHubService.repoContributors("square", "retrofit");
response = call.execute();
// This will throw IllegalStateException:
response = call.execute();
Call<List<Contributor>> call2 = call.clone();
// This will not throw:
response = call2.execute();


(2)当我们执行的同步或异步加入队列后,可以随时使用cancel方法取消请求:

Call<List<Contributor>> call = gitHubService.repoContributors("square", "retrofit");

call.enqueue(...);
// or...
call.execute();

// later...
call.cancel();



版权声明:本文为博主原创文章,未经博主允许不得转载。http://blog.csdn.net/qq_17766199

相关文章推荐

Retrofit掉坑记录(一)

随着项目的深入,Retrofit会深入学习,本系列应该当入坑先驱了,不说了,都是累1.@QueryMap AND @FieldMap 错用将会导致HTTP 414错误 首先借用HTTP 414的某百...

Retrofit2.0使用详解

Retrofit2.0 项目主页 Retrofit2.0 官方文档简介Retrofit是由Square公司出品的针对于Android和Java的类型安全的Http客户端,网络服务基于OkHttp 。...

retrofit post请求多文件,partMap用法

1. APIService 定义注解 @Multipart @POST("cyxx/Feedback/add.do") Observable getFeedbackResult( ...

Retrofit2.0使用总结及注意事项

概述Retrofit是由Square公司出品的针对于Android和Java的类型安全的Http客户端,网络服务基于OkHttp 。 变化如果之前使用过Retrofit1,会有一些变化, 比如创建方...
  • wbwjx
  • wbwjx
  • 2016年05月12日 00:13
  • 17109

Android Retrofit 框架上传多张图片解决方案

方案: 解决的方法是:使用Retrofit的MulipartTypedOutput 接口声明如下,注意此时不要再使用@FormUrlEncoded 和 @Multipart 注解了 @POST(PAT...

RxJava分析

RxJava功能: 主要是实现异步操作的库,别的定语都在异步操作定义之上; RxJava优势: 简洁,可读性强,后期维护方面;代码逻辑清晰,主线程与非主线程切换方便,能满足响应式需求   RxJa...

优雅的处理Android崩溃(二)

写在前面上一篇博客中已经介绍了怎么通过UncaughtExceptionHandler接口实现全局异常的抓取,以及崩溃日志的保存。不太清楚这些操作的可以看我上一篇博客:优雅的处理Android崩溃(一...

Retrofit 2.0使用详解的例子

  • 2015年11月06日 17:12
  • 6.04MB
  • 下载

使用Retrofit2.0获取天气的Demo

  • 2015年12月20日 23:28
  • 356KB
  • 下载

Retrofit2.0中注解使用套路

之前有讲过Retrofit2.0的简单使用和解析。最近在做Retrofit替换之前使用的AsyncHttpClient,在替换的过程中遇到一些之前忽视的小细节。自己感觉知道这几点在开发中灵活使用Ret...
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:Retrofit2.0使用
举报原因:
原因补充:

(最多只允许输入30个字)