关闭

Retrofit2.0使用

标签: AndroidRetrofit
6050人阅读 评论(1) 收藏 举报
分类:

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();



4
1
查看评论
发表评论
* 以上用户言论只代表其个人观点,不代表CSDN网站的观点或立场

Retrofit2.0使用详解

retrofit是由square公司开发的。square在github上发布了很多优秀的Android开源项目。例如:otto(事件总线),leakcanary(排查内存泄露),android-tim...
  • ljd2038
  • ljd2038
  • 2016-04-03 01:09
  • 51470

RxJava和Retrofit2.0的结合使用

RxJava和Retrofit2.0的结合使用如果还不了解Retrofit2.0,可以先看 Retrofit2.0的使用 如果对RxJava还不了解,可以先看 RxJava初体验 和 RxJava之...
  • EthanCo
  • EthanCo
  • 2015-12-20 23:40
  • 2217

这是一份很详细的 Retrofit 2.0 使用教程(含实例讲解)

前言 在Andrroid开发中,网络请求十分常用 而在Android网络请求库中,Retrofit是当下最热的一个网络请求库 今天,我将献上一份非常详细Retrofit v2.0的使用教程,希望你...
  • carson_ho
  • carson_ho
  • 2017-06-26 08:35
  • 29395

Retrofit 2.0使用详解的例子

  • 2015-11-06 17:12
  • 6.04MB
  • 下载

使用Retrofit2.0获取天气的Demo

  • 2015-12-20 23:28
  • 356KB
  • 下载

这是一份很详细的 Retrofit 2.0 使用教程(含实例讲解)

前言 在Andrroid开发中,网络请求十分常用而在Android网络请求库中,Retrofit是当下最热的一个网络请求库 今天,我将献上一份非常详细Retrofit v2.0的使用教...
  • qq944639839
  • qq944639839
  • 6天前 18:01
  • 62

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

Retrofit终于迎来了2.0版本,也修复了老版本的一些bug,这是修复日志,各位可以自己去看看,https://github.com/square/retrofit/blob/master/CHA...
  • ljx19900116
  • ljx19900116
  • 2016-03-03 16:19
  • 10054

Retrofit2.0使用详解

retrofit是由square公司开发的。square在github上发布了很多优秀的Android开源项目。例如:otto(事件总线),leakcanary(排查内存泄露),android-tim...
  • ljd2038
  • ljd2038
  • 2016-04-03 01:09
  • 51470

这是一份很详细的 Retrofit 2.0 使用教程(含实例讲解)

前言 在Andrroid开发中,网络请求十分常用而在Android网络请求库中,Retrofit是当下最热的一个网络请求库 今天,我将献上一份非常详细Retrofit v2.0的使...
  • kisty_yao
  • kisty_yao
  • 2017-07-26 14:26
  • 1244

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

概述Retrofit是由Square公司出品的针对于Android和Java的类型安全的Http客户端,网络服务基于OkHttp 。 变化如果之前使用过Retrofit1,会有一些变化, 比如创建方...
  • wbwjx
  • wbwjx
  • 2016-05-12 00:13
  • 18990
    个人资料
    • 访问:206170次
    • 积分:3134
    • 等级:
    • 排名:第12757名
    • 原创:68篇
    • 转载:10篇
    • 译文:0篇
    • 评论:227条
    多多支持
    博客专栏
    最新评论