[关闭]
@xujun94 2016-10-07T14:19:06.000000Z 字数 5823 阅读 2903

Retrofit使用教程(一)- Retrofit入门详解


转载请注明博客地址:http://blog.csdn.net/gdutxiaoxu/article/details/52745491

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

本人已经好久没有更新 博客了,这次更新博客打算写一下retrofit的使用教程系列的 博客,写作思路大概如下
- 先从retrofit的基本使用讲起;
- 接着将retrofit结合RxJava的使用;
- 接着讲Retrofit的封装使用,(包括错误统一处理);
- 有时间和能力的话会尝试研究一下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添加如下依赖

  1. compile 'com.squareup.retrofit2:retrofit:2.1.0'
  2. compile 'com.squareup.retrofit2:converter-gson:2.1.0'
  1. Retrofit retrofit = new Retrofit.Builder()
  2. //使用自定义的mGsonConverterFactory
  3. .addConverterFactory(GsonConverterFactory.create())
  4. .baseUrl("http://apis.baidu.com/txapi/")
  5. .build();
  6. mApi = retrofit.create(APi.class);
  1. mApi = retrofit.create(APi.class);
  2. Call<News> news = mApi.getNews("1", "10");
  3. news.enqueue(new Callback<News>() {
  4. @Override
  5. public void onResponse(Call<News> call, Response<News> response) {
  6. }
  7. @Override
  8. public void onFailure(Call<News> call, Throwable t) {
  9. }
  10. });
  1. public interface APi {
  2. @Headers("apikey:81bf9da930c7f9825a3c3383f1d8d766")
  3. @GET("word/word")
  4. Call<News> getNews(@Query("num") String num,@Query("page")String page);
  5. }

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


Retrofit的get请求

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

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

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

第二部,在代码里面请求

  1. //创建retrofit对象
  2. Retrofit retrofit = new Retrofit.Builder()
  3. //使用自定义的mGsonConverterFactory
  4. .addConverterFactory(GsonConverterFactory.create())
  5. .baseUrl("http://apis.baidu.com/txapi/")
  6. .build();
  7. // 实例化我们的mApi对象
  8. mApi = retrofit.create(APi.class);
  9. // 调用我们的响应的方法
  10. Call<News> news = mApi.getNews(number, page);
  11. news.enqueue(new Callback<News>() {
  12. @Override
  13. public void onResponse(Call<News> call, Response<News> response) {
  14. News body = response.body();
  15. Logger.i("onResponse: ="+body.toString());
  16. }
  17. @Override
  18. public void onFailure(Call<News> call, Throwable t) {
  19. Logger.i("onResponse: ="+t.getMessage());
  20. }
  21. });

解释说明

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


retrofit的post请求

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

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

如何为retrofit添加请求头head

总共有以下几种方式

第一种方法

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

  1. okHttpClient.interceptors().add(new Interceptor() {
  2. @Override
  3. public Response intercept(Interceptor.Chain chain) throws IOException {
  4. Request original = chain.request();
  5. // Request customization: add request headers
  6. Request.Builder requestBuilder = original.newBuilder()
  7. .addHeader("header-key", "value1")
  8. .addHeader("header-key", "value2");
  9. Request request = requestBuilder.build();
  10. return chain.proceed(request);
  11. }
  12. });

第二种方法

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

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

第三种方法

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

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

通过post提交json数据

Post 提交JSON数据

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

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

  1. {
  2. "id": 1,
  3. "text": "my task title"
  4. }

到此,这篇博客为止

题外话:

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

转载请注明博客地址:http://blog.csdn.net/gdutxiaoxu/article/details/52745491

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

参考官网地址http://square.github.io/retrofit/

添加新批注
在作者公开此批注前,只有你和作者可见。
回复批注