Retrofit2.0使用

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

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


1.设置

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

(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> groupList(@Path("id") int groupId);

也可以添加查询参数

@GET("group/{id}/users")

Call> groupList(@Path("id") int groupId, @Query("sort") String sort);

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

@GET("group/{id}/users")

Call> groupList(@Path("id") int groupId, @QueryMap Map options);

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

@POST("users/new")

Call createUser(@Body User user);

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

@FormUrlEncoded

@POST("user/edit")

Call getUser(@Field("name") String name, @Field("password") String password);

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

@FormUrlEncoded

@POST("user/edit")

Call getUser(@FieldMap Map map);

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

@Multipart

@POST("/user/edit")

Call upload(@Part("image\"; filename=\"文件名.jpg") RequestBody file);

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

@Multipart

@POST("/user/edit")

Call upload(@PartMap Map 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 getUser(@Path("username") String username);

}

MyApiEndpointInterface apiService = retrofit.create(MyApiEndpointInterface.class);

异步请求这个API

String username = "sarahjean";

Call call = apiService.getUser(username);

call.enqueue(new Callback() {

@Override

public void onResponse(Response 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 call = apiService.getUser(username);

User user = call.execute();

3.注意

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

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

response = call.execute();

// This will throw IllegalStateException:

response = call.execute();

Call> call2 = call.clone();

// This will not throw:

response = call2.execute();

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

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

call.enqueue(...);

// or...

call.execute();

// later...

call.cancel();


最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,142评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,298评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,068评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,081评论 1 291
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,099评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,071评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,990评论 3 417
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,832评论 0 273
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,274评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,488评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,649评论 1 347
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,378评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,979评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,625评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,796评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,643评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,545评论 2 352

推荐阅读更多精彩内容