Retrofit的介绍与使用

一、介绍

Retrofit其实我们可以理解为OkHttp的加强版，是一个网络加载框架。底层是使用OKHttp。它的一个特点是包含了特别多注解，方便使用。支持很多的开源库(著名例子：Retrofit + RxJava)。

二、使用步骤

使用 Retrofit 的步骤共有7个：
1：添加Retrofit库的依赖
2：创建 接收服务器返回数据的Bean类
3：定义用于描述网络请求的接口
4：创建 Retrofit 实例
5：创建网络请求实现第三步网络接口的实例。
6：发送网络请求（异步 / 同步）
7：处理服务器返回的数据

步骤详细介绍:
步骤1：
导包：
implementation ‘com.squareup.retrofit2:retrofit:2.2.0’
implementation ‘com.squareup.retrofit2:converter-gson:2.2.0’
添加网络权限：
步骤2：创建 接收服务器返回数据的Bean类:
步骤3：定义网络请求的接口.例如下图:
public interface IPostInterface {

@FormUrlEncoded//表示表单形式键值对的参数.
@POST(“splash/splashList”)
Call getDataByPostRequest(@Field(“platform”) String platform, @Field(“appVersion”) String appVersion, @Field(“osType”) String osType);

@POST(“login.php”)
Call login(@Body LogBean logBean);//body 注解它会把实例给转成json字符串.
}

步骤4：创建 Retrofit 实例:
Retrofit retrofit = new Retrofit.Builder()
.baseUrl(“http://fanyi.youdao.com/”) //设置网络请求的Url地址
.addConverterFactory(GsonConverterFactory.create()) // 设置Gson数据解析器,将字符串转换成Bean类
.build();

步骤5：通过Retrofit创建用于网络请求的接口实例。
DataInterface IDataInterface = retrofit.create(DataInterface.class);
步骤6：发送网络请求。
Call< DataInfo > call = IDataInterface. getDataInfo ();//调用接口返回Call.
//发送网络请求(异步)
call.enqueue(new Callback< DataInfo >() {
//请求成功时回调
@Override
public void onResponse(Call call, Response< DataInfo > response) {
//请求处理,输出结果
response.body().show();
}
//请求失败时候的回调
@Override
public void onFailure(Call< DataInfo > call, Throwable throwable) {
System.out.println(“连接失败”);
}
});
步骤7：处理返回数据
通过response类的 body（）对返回的数据进行处理
//发送网络请求(异步)
call.enqueue(new Callback< DataInfo >() {
//请求成功时回调
@Override
public void onResponse(Call< DataInfo > call, Response< DataInfo > response) {
// 对返回数据进行处理
response.body().show();
}

    //请求失败时候的回调
    @Override
    public void onFailure(Call< DataInfo > call, Throwable throwable) {
        System.out.println("连接失败");
    }
});

// 发送网络请求（同步）
Response< DataInfo > response = call.execute();
// 对返回数据进行处理
response.body().show();

public interface DataInterface {

//公共地址 http://www.moviebase.cn/uread/app/
// values splash/splashList
// 参数: platform=2&appVersion=1.7.0&osType=2
@POST(“splash/splashList”)
Call getDataInfo(@QueryMap ArrayMap<String,String> map);

/**
@GET Get请求
@POST Psot 请求
@QueryMap 请求的参数 ArrayMap<Key,Value>
@Query() 请求参数 int String
@Path() 拼接的地址
*/
@POST(“splash/{url}”)
Call getDataInfo(@Path(“url”) String list);

@Streaming
@GET
Call retrofitDownloadFile(@Url String fileUrl);
}

Retrofit将Http请求抽象成 Java接口：
Java 接口中的注解说明.
注解类型：
1，网络请求方法：
@GET
@POST
@PUT
@DELETE
@PATH
@HEAD
@OPTIONS
@HTTP

2,标记类
@FormUrlEncoded
@MultiPart
@Streaming

3,网络请求参数
@Header
@Headers
@URL
@Body
@Path
@Filed
@FiledMap
@Part
@PartMap
@Query
@QueryMap
@Path 路径当中某一部分是可变的，可以使用占位符
@QueryMap 键值对
@Query(“xxx”) 查询参数的设置

注释占位符的好处：解耦解析接口和网络请求，如果返回的结果相似，那么可以通过向方法中传递参数，来改变网址。

POST请求体的方式向服务器传入json字符串 @Body
有两种requestBody，一个是FormBody（表单的提交），一个是MultipartBody（文件的提交），前者以表单的方式传递

简单的键值对。

三、代码示例

1.GET请求

//GET接口
package day01.bw.com.retrofitinterface;

import android.net.Uri;

import java.net.URL;
import java.util.Map;

import day01.bw.com.bean.FoodBean;
import retrofit2.Call;
import retrofit2.http.GET;
import retrofit2.http.Path;
import retrofit2.http.Query;
import retrofit2.http.QueryMap;
import retrofit2.http.Url;

public interface MyGetByNetData {
    //http://www.qubaobei.com/ios/cf/dish_list.php?stage_id=1&limit=20&page=1
    @GET("ios/cf/{path}")
    Call<FoodBean> getData(@Path("path")String path,
                           @Query("stage_id")String stage_id,
                           @Query("limit")String limit,
                           @Query("page")String page);


    @GET("ios/cf/{path}")
    Call<FoodBean> getDataByMap(@Path("path")String path, @QueryMap Map<String,String> map);

    @GET
    Call<FoodBean> getDataByUrl(@Url String url);


}

//Activity类
package day01.bw.com.retrofitdemo;

import android.support.v7.app.AppCompatActivity;
import android.os.Bundle;
import android.util.Log;

import java.util.HashMap;
import java.util.Map;

import day01.bw.com.bean.FoodBean;
import day01.bw.com.retrofitinterface.MyGetByNetData;
import retrofit2.Call;
import retrofit2.Callback;
import retrofit2.Response;
import retrofit2.Retrofit;
import retrofit2.converter.gson.GsonConverterFactory;

public class GetUrlActivity extends AppCompatActivity {

    private String baseUrl = "http://www.qubaobei.com/";
    private String url = "http://www.qubaobei.com/ios/cf/dish_list.php?stage_id=1&limit=20&page=1";

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_get_url);
        initRetrofit();
        initRetrofitMap();
        initRetrofitUrl();

    }

    private void initRetrofitUrl() {
        new Retrofit.Builder()
                .baseUrl(baseUrl)
                .addConverterFactory(GsonConverterFactory.create())
                .build()
                .create(MyGetByNetData.class)
                .getDataByUrl(url).enqueue(new Callback<FoodBean>() {
            @Override
            public void onResponse(Call<FoodBean> call, Response<FoodBean> response) {
                Log.e("###Url","请求成功");
                Log.e("###Urldata",response.body().toString());
            }

            @Override
            public void onFailure(Call<FoodBean> call, Throwable t) {
                Log.e("###Url","请求失败");
            }
        });
    }

    private void initRetrofitMap() {
        Map<String,String> map = new HashMap<>();
        map.put("stage_id","1");
        map.put("limit","20");
        map.put("page","1");
        Call<FoodBean> call = new Retrofit.Builder()
                .baseUrl(baseUrl)
                .addConverterFactory(GsonConverterFactory.create())
                .build()
                .create(MyGetByNetData.class)
                .getDataByMap("dish_list.php", map);
        call.enqueue(new Callback<FoodBean>() {
            @Override
            public void onResponse(Call<FoodBean> call, Response<FoodBean> response) {
                Log.e("###Map","请求成功");
                Log.e("###Mapdata",response.body().toString());
            }

            @Override
            public void onFailure(Call<FoodBean> call, Throwable t) {
                Log.e("###Map","请求失败");
            }
        });
    }

    private void initRetrofit() {
        //获取构建者
        Retrofit.Builder builder = new Retrofit.Builder();
        //传入baseUrl
        builder.baseUrl(baseUrl);
        //给获取的字符串转换成JavaBean
        builder.addConverterFactory(GsonConverterFactory.create());
        Retrofit retrofit = builder.build();
        MyGetByNetData myGetByNetData = retrofit.create(MyGetByNetData.class);
        Call<FoodBean> call = myGetByNetData.getData("dish_list.php", "1", "20", "1");
        call.enqueue(new Callback<FoodBean>() {
            @Override
            public void onResponse(Call<FoodBean> call, Response<FoodBean> response) {
                Log.e("###","请求成功");
                Log.e("###data",response.body().toString());
            }

            @Override
            public void onFailure(Call<FoodBean> call, Throwable t) {
                Log.e("###","请求失败");
            }
        });
    }
}

2.Post代码

//Post接口
package day01.bw.com.retrofitinterface;

import java.util.Map;

import day01.bw.com.bean.BodyBean;
import day01.bw.com.bean.FoodBean;
import retrofit2.Call;
import retrofit2.http.Body;
import retrofit2.http.Field;
import retrofit2.http.FieldMap;
import retrofit2.http.FormUrlEncoded;
import retrofit2.http.GET;
import retrofit2.http.POST;
import retrofit2.http.Path;
import retrofit2.http.Url;

public interface MyPostByNetData {
    //http://www.qubaobei.com/ios/cf/dish_list.php?stage_id=1&limit=20&page=1
    @FormUrlEncoded
    @POST("ios/cf/{path}")
    Call<FoodBean> getData(@Path("path") String path,
                           @Field("stage_id") String stage_id,
                           @Field("limit") String limit,
                           @Field("page") String page);

    @POST("ios/cf/{path}")
    Call<FoodBean> getDataByBody(@Path("path") String path, @Body BodyBean bodyBean);

    @POST
    Call<FoodBean> getDataByUrl(@Url String url);


}

//Activity类
package day01.bw.com.retrofitdemo;

import android.support.v7.app.AppCompatActivity;
import android.os.Bundle;
import android.util.Log;

import java.util.HashMap;
import java.util.Map;

import day01.bw.com.bean.BodyBean;
import day01.bw.com.bean.FoodBean;
import day01.bw.com.retrofitinterface.MyPostByNetData;
import retrofit2.Call;
import retrofit2.Callback;
import retrofit2.Response;
import retrofit2.Retrofit;
import retrofit2.converter.gson.GsonConverterFactory;

public class PostUrlActivity extends AppCompatActivity {

    private String baseUrl = "http://www.qubaobei.com/";
    private String url = "http://www.qubaobei.com/ios/cf/dish_list.php?stage_id=1&limit=20&page=1";
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_post_url);
//        initRetrofit();
//        initRetrofitBody();
        initRetrofitUrl();
    }

    private void initRetrofitUrl() {
        new Retrofit.Builder()
                .baseUrl(baseUrl)
                .addConverterFactory(GsonConverterFactory.create())
                .build()
                .create(MyPostByNetData.class)
                .getDataByUrl(url).enqueue(new Callback<FoodBean>() {
            @Override
            public void onResponse(Call<FoodBean> call, Response<FoodBean> response) {
                Log.e("###","请求成功");
                Log.e("###Urldata",response.body().toString());
            }

            @Override
            public void onFailure(Call<FoodBean> call, Throwable t) {
                Log.e("###","请求失败");
            }
        });
    }

    private void initRetrofitBody() {
        BodyBean bodyBean = new BodyBean();
        bodyBean.setStage_id("1");
        bodyBean.setLimit("20");
        bodyBean.setPage("1");
        new Retrofit.Builder()
                .baseUrl(baseUrl)
                .addConverterFactory(GsonConverterFactory.create())
                .build()
                .create(MyPostByNetData.class)
                .getDataByBody("dish_list.php",bodyBean).enqueue(new Callback<FoodBean>() {
            @Override
            public void onResponse(Call<FoodBean> call, Response<FoodBean> response) {
                Log.e("###Body","请求成功");
                Log.e("###Bodydata",response.body().toString());
            }

            @Override
            public void onFailure(Call<FoodBean> call, Throwable t) {
                Log.e("###Body","请求失败");
            }
        });
    }

    private void initRetrofit() {
        new Retrofit.Builder()
                .baseUrl(baseUrl)
                .addConverterFactory(GsonConverterFactory.create())
                .build()
                .create(MyPostByNetData.class)
                .getData("dish_list.php","1","20","1").enqueue(new Callback<FoodBean>() {
            @Override
            public void onResponse(Call<FoodBean> call, Response<FoodBean> response) {
                Log.e("###","请求成功");
                Log.e("###data",response.body().toString());
            }

            @Override
            public void onFailure(Call<FoodBean> call, Throwable t) {
                Log.e("###","请求失败");
            }
        });
    }
}