写文章

↓↓↓↓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"}

到此，这篇博客为止