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的使用与深入学习(上)

注意:以下分析都是基于Retrofit2 转载请注明出处:http://blog.csdn.net/evan_man 简单介绍     Retrofit发送网络请求通过okHttp,okhttp的诸多...

Retrofit用法详解

一、 简介Retrofit是Square公司开发的一款针对Android网络请求的框架,Retrofit2底层基于OkHttp实现的,OkHttp现在已经得到Google官方认可,大量的app都采用O...

精选:深入理解 Docker 内部原理及网络配置

网络绝对是任何系统的核心,对于容器而言也是如此。Docker 作为目前最火的轻量级容器技术,有很多令人称道的功能,如 Docker 的镜像管理。然而,Docker的网络一直以来都比较薄弱,所以我们有必要深入了解Docker的网络知识,以满足更高的网络需求。

Retrofit2.0使用详解

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

Retrofit2.0使用详解

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

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

Retrofit终于迎来了2.0版本,也修复了老版本的一些bug,这是修复日志,各位可以自己去看看,[https://github.com/square/retrofit/blob/master/CH...

Retrofit2.0 ,OkHttp3完美同步持久Cookie实现免登录(二)

通过对Retrofit2.0的基础入门和案例实践,掌握了怎么样使用Retrofit访问网络,加入自定义header,包括加入SSL证书,基本的调试基础,但是正常的开发中会涉及cookie同步问题,可以...

Retrofit2.0使用

前几天学习了Retrofit相关知识,网络请求这块一般很抵触去学,但是又像是一个宝箱诱惑着你去探索尝试,于是,看了官方两篇基础教程,先简单实现一下访问豆瓣或者知乎网站的数据,并将其用Listview或...

Retrofit2.0使用

首先是我参考的文章: ● Retrofit 2.0:有史以来最大的改进 ● 使用Retrofit请求API数据 ● Retrofit2.0使用详解 ● Retrofit 2.0使用详解,配合OkHt...

Retrofit2.0的使用

Retrofit简单使用 定义接口 为Retrofit添加返回值支持 为Retrofit添加转化器支持

Retrofit2.0使用

随着Google对HttpClient 摒弃,和Volley的逐渐没落,OkHttp开始异军突起,而Retrofit则对okHttp进行了强制依赖。Retrofit是由Square公司出品的针对于An...
返回顶部
收藏助手
不良信息举报
您举报文章:深度学习:神经网络中的前向传播和反向传播算法推导
举报原因:
原因补充:

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