Retrofit↙↙↙

写文章

↓↓↓↓1)添加依赖,↓↓↓↓这里以AndroidStudio为例:在build.grale添加如下依赖↙↙↙↙

compile'com.squareup.retrofit2:retrofit:2.0.0-beta4'

compile'com.squareup.retrofit2:converter-gson:2.0.0-beta4'

先从retrofit的基本使用讲起;

接着将retrofit结合RxJava的使用;

接着讲Retrofit的封装使用,(包括错误统一处理);

有时间和能力的话会尝试研究一下retrofit的 源码.

本篇博客主要讲解以下问题

Retrofit简介

Retrofit的简单使用例子

Retrofit的get请求

Retrofit的put请求(提交表单数据)

如何为 retrofit添加header

如何提交json数据

Retrofit简介

Retrofit是square开源的网络请求库,底层是使用OKHttp封装的,网络请求速度很快.

主要有一下几种请求方法

格式含义

@GET表示这是一个GET请求

@POST表示这个一个POST请求

@PUT表示这是一个PUT请求

@DELETE表示这是一个DELETE请求

@HEAD表示这是一个HEAD请求

@OPTIONS表示这是一个OPTION请求

@PATCH表示这是一个PAT请求

各种请求注解的意思

格式含义

@Headers添加请求头

@Path替换路径

@Query替代参数值,通常是结合get请求的

@FormUrlEncoded用表单数据提交

@Field替换参数值,是结合post请求的

Retrofit的简单使用例子

要使用retrofit请求网络数据,大概可以分为以下几步

2) 创建Retrofit对象

Retrofit retrofit =newRetrofit.Builder()//使用自定义的mGsonConverterFactory.addConverterFactory(GsonConverterFactory.create())        .baseUrl("http://apis.baidu.com/txapi/")        .build();mApi = retrofit.create(APi.class);

3)发起网络请求

mApi = retrofit.create(APi.class);Call news = mApi.getNews("1","10");news.enqueue(newCallback() {@OverridepublicvoidonResponse(Call call, Response response){    }@OverridepublicvoidonFailure(Call call, Throwable t){    }});

publicinterfaceAPi{@Headers("apikey:81bf9da930c7f9825a3c3383f1d8d766")@GET("word/word")CallgetNews(@Query("num")String num,@Query("page")String page);}

到此一个简单的使用retrofit的网络请求就完成了。接下来我们来了解retrofit的各种请求方式。

Retrofit的get请求

加入我们想请求这样的网址:http://apis.baidu.com/txapi/world/world?num=10&page=1,header为"apikey:81bf9da930c7f9825a3c3383f1d8d766",我们可以这样请求:

第一步,在interface Api中 增加如下方法

@Headers("apikey:81bf9da930c7f9825a3c3383f1d8d766")@GET("word/word")CallgetNews(@Query("num")String num,@Query("page")String page);

第二部,在代码里面请求

//创建retrofit对象Retrofit retrofit =newRetrofit.Builder()//使用自定义的mGsonConverterFactory.addConverterFactory(GsonConverterFactory.create())        .baseUrl("http://apis.baidu.com/txapi/")        .build();// 实例化我们的mApi对象mApi = retrofit.create(APi.class);// 调用我们的响应的方法Call news = mApi.getNews(number, page);news.enqueue(newCallback() {@OverridepublicvoidonResponse(Call call, Response response){        News body = response.body();        Logger.i("onResponse:  ="+body.toString());    }@OverridepublicvoidonFailure(Call call, Throwable t){        Logger.i("onResponse:  ="+t.getMessage());    }});

解释说明

假设BaseUrl是http://apis.baidu.com/txapi/的前提下

1)其中 @GET("word/word")会追加到baseUrl :http://apis.baidu.com/txapi/的后面,即变成:http://apis.baidu.com/txapi/world/world

2)@Query("num") String num,@Query("page")String page;分别对应键值的名称与值。会追加到http://apis.baidu.com/txapi/world/world的后面,请求网址即变成:http://apis.baidu.com/txapi/world/world?num=10&page=1

3)  @Headers("apikey:81bf9da930c7f9825a3c3383f1d8d766")是 在基础之上为 其添加响应头

4)如果想继续增加参数,只需要在方法参数追加这样的形式就OK了:

,@Query("page")String page

@Headers("apikey:81bf9da930c7f9825a3c3383f1d8d766")@GET("word/word")CallgetNews(@Query("num")String num,@Query("page")String page,@Query("type")String type);

5)加入我们想要请求这样的网址http://apis.baidu.com/txapi/tiyu/tiyu?num=10&page=1,,我们可以这样写

@Headers({"apikey:81bf9da930c7f9825a3c3383f1d8d766","Content-Type:application/json"})@GET("{type}/{type}")CalltiYu(@Path("type")String type, @Query("num")String num,@Query("page")String page);  String type="tiyu";  Call news = api.tiYu(type,number, page);  ```  ---## retrofit的post请求假如我们想要 请求这样的网址http://apis.baidu.com/txapi/world/world?以post的 方式提交这样的 数据:num=10&page=1,我们可以写成 如下的 样子,注意post的时候必须使用@Field这种形式的注解,而不是使用@Query这种形式的注解,其他的 与get请求一样,这样只给出核心代码```java@FormUrlEncoded@Headers({"apikey:81bf9da930c7f9825a3c3383f1d8d766","Content-Type:application/json"})@POST("world/world")CallpostNews(@Field("num")String num, @Field("page")String page);

如何为retrofit添加请求头head

总共有以下几种方式

第一种方法

在OKHttpClient interceptors里面进行处理,这样添加的headKey不会覆盖掉 前面的 headKey

okHttpClient.interceptors().add(newInterceptor() {@OverridepublicResponseintercept(Interceptor.Chain chain)throwsIOException{        Request original = chain.request();// Request customization: add request headersRequest.Builder requestBuilder = original.newBuilder()                    .addHeader("header-key","value1")                    .addHeader("header-key","value2");        Request request = requestBuilder.build();returnchain.proceed(request);    }});

第二种方法

同样在在OKHttpClient interceptors里面进行处理,这样添加的headKey会覆盖掉 前面的 headKey

okHttpClient.interceptors().add(newInterceptor() {@OverridepublicResponseintercept(Interceptor.Chain chain)throwsIOException{        Request original = chain.request();// Request customization: add request headersRequest.Builder requestBuilder = original.newBuilder()                .header("headerkey","header-value");// <-- this is the important lineRequest request = requestBuilder.build();returnchain.proceed(request);    }});

第三种方法

利用 retrofit自带的注解,比如我们想要添加这样的请求头:"apikey:81bf9da930c7f9825a3c3383f1d8d766" ,"Content-Type:application/json";则可以写成如下的 样式

@Headers({"apikey:81bf9da930c7f9825a3c3383f1d8d766","Content-Type:application/json"})@GET("world/world")CallgetNews(@Query("num")String num,@Query("page")String page);

通过post提交json数据

Post 提交JSON数据

有时提交的数据量比较大时,用键值对的方式提交参数不太方便,Retrofit可以通过@Body注释,直接传递一个对象给请求主体,Retrofit通过JSON转化器,把对象映射成JSON数据。

假设我们需要提交的数据为

{"id":1,"text":"my task title"}

接口定义:

publicinterfaceTaskService{@Headers({"Content-Type: application/json","Accept:  application/json"})@POST("/tasks")CallcreateTask(@Body Task task);}

传递实体需要有Model:

publicclassTask{privatelongid;privateString text;publicTask(){}publicTask(longid, String text){this.id = id;this.text = text;  }}

客户端调用:

Task task =newTask(1,"my task title");  Call call = taskService.createTask(task);  call.enqueue(newCallback() {});

这样,服务端得到的是JOSN数据:

{"id":1,"text":"my task title"}

到此,这篇博客为止

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

推荐阅读更多精彩内容

  • 原来公司用的是OKGO来加载网络,现在全部替换为Retrofit了,用起来挺不适应的,现在我负责的模块代码中网络数...
    SHERLOCKvv阅读 131,498评论 27 219
  • 简介 刚接触Retrofit的时候,就写了一篇简单的使用介绍:Retrofit 2.0基本使用方法,算是对Retr...
    Whyn阅读 2,779评论 4 24
  • 一、简介 Retrofit是Square公司开发的一款针对Android网络请求的框架,Retrofit2底层基于...
    Devil不加V阅读 508评论 0 0
  • 石头,就是那块石头 猿人手中磨过 石头,还是那块石头 在米芾手里把玩 现在,到了我的手里 摩挲中 伤感的泪滴下来了...
    雪番阅读 315评论 0 1
  • 从前,马云说:银行不改变,我们就改变银行。这话听起来有点狂。但马云的这句豪言壮语,在“余额宝”的横空出世下,一切都...
    违心人_9ab2阅读 582评论 0 0