Retrofit的网络框架介绍

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请求网络数据，大概可以分为以下几步

  • 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，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/的前提下

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

   @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?以post的 方式提交这样的 数据：num=10&page=1，我们可以写成 如下的 样子，注意post的时候必须使用@Field这种形式的注解，而不是使用@Query这种形式的注解，其他的 与get请求一样，这样只给出核心代码

```java
@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"
}

到此，这篇博客为止


讲解的确实到位：

参考地址：https://www.jianshu.com/p/82f8b58db53c

源码地址：https://github.com/gdutxiaoxu/RetrofitDemo.git

参考地址：https://blog.csdn.net/m0_37711172/article/details/79489409