Retrofit使用教程（一）- Retrofit入门详解

素颜马尾好姑娘i 2022-07-16 05:07 944阅读 0赞

# Retrofit使用教程（一）- Retrofit入门详解 #

--------------------

**[转载请注明博客地址：][Link 1][http://blog.csdn.net/gdutxiaoxu/article/details/52745491][Link 1]**

**[源码下载地址：][Link 2][https://github.com/gdutxiaoxu/RetrofitDemo.git][Link 2]**

**本人已经好久没有更新 博客了，这次更新博客打算写一下retrofit的使用教程系列的 博客，写作思路大概如下**

*  先从retrofit的基本使用讲起;
 *  接着将retrofit结合RxJava的使用;
 *  接着讲Retrofit的封装使用，（包括错误统一处理）;
 *  有时间和能力的话会尝试研究一下retrofit的 源码.

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

*  Retrofit简介
 *  Retrofit的简单使用例子
 *  Retrofit的get请求
 *  Retrofit的put请求（提交表单数据）
 *  如何为 retrofit添加header
 *  如何提交json数据

## Retrofit简介 ##

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

### 主要有一下几种请求方法 ###

<table> 
 <thead> 
  <tr> 
   <th>格式</th> 
   <th>含义</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>@GET</td> 
   <td>表示这是一个GET请求</td> 
  </tr> 
  <tr> 
   <td>@POST</td> 
   <td>表示这个一个POST请求</td> 
  </tr> 
  <tr> 
   <td>@PUT</td> 
   <td>表示这是一个PUT请求</td> 
  </tr> 
  <tr> 
   <td>@DELETE</td> 
   <td>表示这是一个DELETE请求</td> 
  </tr> 
  <tr> 
   <td>@HEAD</td> 
   <td>表示这是一个HEAD请求</td> 
  </tr> 
  <tr> 
   <td>@OPTIONS</td> 
   <td>表示这是一个OPTION请求</td> 
  </tr> 
  <tr> 
   <td>@PATCH</td> 
   <td>表示这是一个PAT请求</td> 
  </tr> 
 </tbody> 
</table>

### 各种请求注解的意思 ###

<table> 
 <thead> 
  <tr> 
   <th>格式</th> 
   <th>含义</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>@Headers</td> 
   <td>添加请求头</td> 
  </tr> 
  <tr> 
   <td>@Path</td> 
   <td>替换路径</td> 
  </tr> 
  <tr> 
   <td>@Query</td> 
   <td>替代参数值，通常是结合get请求的</td> 
  </tr> 
  <tr> 
   <td>@FormUrlEncoded</td> 
   <td>用表单数据提交</td> 
  </tr> 
  <tr> 
   <td>@Field</td> 
   <td>替换参数值，是结合post请求的</td> 
  </tr> 
  <tr> 
   <td>@Body</td> 
   <td>可以用来提交 Json 数据或者上传文件</td> 
  </tr> 
 </tbody> 
</table>

## Retrofit的简单使用例子 ##

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

*  1)添加依赖，这里以AndroidStudio为例：在build.grale添加如下依赖

compile 'com.squareup.retrofit2:retrofit:2.1.0'
    compile 'com.squareup.retrofit2:converter-gson:2.1.0'

*  2） 创建Retrofit对象

Retrofit retrofit = new Retrofit.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> news = mApi.getNews("1", "10");
    news.enqueue(new Callback<News>() {
        @Override
        public void onResponse(Call<News> call, Response<News> response) {
    
        }
    
        @Override
        public void onFailure(Call<News> call, Throwable t) {
    
        }
    });

public interface APi { 
    
        @Headers("apikey:81bf9da930c7f9825a3c3383f1d8d766")
        @GET("word/word")
        Call<News> getNews(@Query("num") String num,@Query("page")String page);
    }

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

--------------------

## Retrofit的get请求 ##

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

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

@Headers("apikey:81bf9da930c7f9825a3c3383f1d8d766")
        @GET("word/word")
        Call<News> getNews(@Query("num") String num,@Query("page")String page);

第二部，在代码里面请求

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

### 解释说明 ###

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

*  1）其中 @GET(“word/word”)会追加到baseUrl ：[http://apis.baidu.com/txapi/][http_apis.baidu.com_txapi]的后面，即变成：[http://apis.baidu.com/txapi/world/world][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]的后面，请求网址即变成:[http://apis.baidu.com/txapi/world/world?num=10&page=1][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")
        Call<News> getNews(@Query("num") String num,@Query("page")String page，@Query("type") String type);
 *  5)加入我们想要请求这样的网址[http://apis.baidu.com/txapi/tiyu/tiyu?num=10&page=1][http_apis.baidu.com_txapi_tiyu_tiyu_num_10_page_1]，,我们可以这样写
    
        @Headers({
             "apikey:81bf9da930c7f9825a3c3383f1d8d766" ,"Content-Type:application/json"})
        @GET("{type}/{type}")
        Call<News> tiYu(@Path("type") String type, @Query("num") String num,@Query("page")String page);
        String type="tiyu";
        Call<News> news = api.tiYu(type,number, page);

--------------------

## retrofit的post请求 ##

假如我们想要 请求这样的网址[http://apis.baidu.com/txapi/world/world][http_apis.baidu.com_txapi_world_world]?以post的 方式提交这样的 数据：num=10&page=1，我们可以写成 如下的 样子，注意post的时候必须使用@Field这种形式的注解，而不是使用@Query这种形式的注解，其他的 与get请求一样，这样只给出核心代码

@FormUrlEncoded
    @Headers({
       "apikey:81bf9da930c7f9825a3c3383f1d8d766" ,"Content-Type:application/json"})
    @POST("world/world")
    Call<News> postNews(@Field("num") String num, @Field("page")String page);

## 如何为retrofit添加请求头head ##

总共有以下几种方式

### 第一种方法 ###

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

okHttpClient.interceptors().add(new Interceptor() {  
        @Override
        public Response intercept(Interceptor.Chain chain) throws IOException {
            Request original = chain.request();
    
            // Request customization: add request headers
            Request.Builder requestBuilder = original.newBuilder()
                        .addHeader("header-key", "value1")
                        .addHeader("header-key", "value2");
    
            Request request = requestBuilder.build();
            return chain.proceed(request);
        }
    });

### 第二种方法 ###

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

okHttpClient.interceptors().add(new Interceptor() {  
        @Override
        public Response intercept(Interceptor.Chain chain) throws IOException {
            Request original = chain.request();
    
            // Request customization: add request headers
            Request.Builder requestBuilder = original.newBuilder()
                    .header("headerkey", "header-value"); // <-- this is the important line
    
            Request request = requestBuilder.build();
            return chain.proceed(request);
        }
    });

### 第三种方法 ###

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

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

--------------------

## 通过post提交json数据 ##

Post 提交JSON数据

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

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

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

*  接口定义：
    
        public interface TaskService {   
        @Headers({
             "Content-Type: application/json","Accept: application/json"})
        @POST("/tasks")
        Call<Task> createTask(@Body Task task);
        }
 *  传递实体需要有Model：
    
        public class Task {   
        private long id;
        private String text;
        
        public Task() {}
        public Task(long id, String text) {
            this.id = id;
            this.text = text;
        }
        }
 *  客户端调用：
    
        Task task = new Task(1, "my task title");  
        Call<Task> call = taskService.createTask(task);  
        call.enqueue(new Callback<Task>() {});
 *  这样，服务端得到的是JOSN数据：
    
        {
        "id": 1,
        "text": "my task title"
        }

到此，这篇博客为止

## 题外话： ##

其实retrofit在5月份实习的时候就接触了，之前为什么不写 博客了，因为网上的 使用教程很多，觉得没有必要。到后面学习的时候，发现retrofit的使用时 比较灵活的，并且使用方法也是相对较多的，于是，就写了retrofit这系列的使用博客。

**[转载请注明博客地址：][Link 1][http://blog.csdn.net/gdutxiaoxu/article/details/52745491][Link 1]**

**[源码下载地址：][Link 2][https://github.com/gdutxiaoxu/RetrofitDemo.git][Link 2]**

**[参考官网地址][Link 3][http://square.github.io/retrofit/][Link 3]**

最后的最后，卖一下广告，欢迎大家关注我的微信公众号，扫一扫下方二维码或搜索微信号 stormjun，即可关注。 目前专注于 Android 开发，主要分享 Android开发相关知识和一些相关的优秀文章，包括个人总结，职场经验等。  
![9fe4afa0gy1fky6yqvcbbj209k09k748.jpg][]

[Link 1]: http://blog.csdn.net/gdutxiaoxu/article/details/52745491
[Link 2]: https://github.com/gdutxiaoxu/RetrofitDemo.git
[http_apis.baidu.com_txapi_world_world_num_10_page_1]: http://apis.baidu.com/txapi/world/world?num=10&page=1
[http_apis.baidu.com_txapi]: http://apis.baidu.com/txapi/
[http_apis.baidu.com_txapi_world_world]: http://apis.baidu.com/txapi/world/world
[http_apis.baidu.com_txapi_tiyu_tiyu_num_10_page_1]: http://apis.baidu.com/txapi/tiyu/tiyu?num=10&page=1
[Link 3]: http://square.github.io/retrofit/
[9fe4afa0gy1fky6yqvcbbj209k09k748.jpg]: /images/20220716/aac8f280461f45e3a35fffb1dc00f86e.png