Android之retrofit初步使用

1.什么是retrofit?

retrofit是Square公司开源的适用于Android和java的网络请求库。retrofit简化了网络请求流程，自己内部对okhttp做了封装，2.x将1.x版本的部分不恰当职责都转移给OKhttp，这样的好处是职责清晰，retrofit做自己该做的事。简单来说，retrofit是与web服务器提供的接口进行通信(数据访问)

2.retrofit的优势：

retrofit相对于以前的HTTP请求方式，如HttpURLConnection和OKHttpClient有很大的优势，如对url构造和请求实体构造等，HttpURLConnection或OKHttpClient还需要手动拼接url，还需要手动对上传或者返回的数据流进行操作。如果要进行解析数据，还需要去引入一些解析框架如Gson，还要用异步控制的方案或者框架如AyncTask/handler/Rxjava,手动再与网络请求进行耦合。

retrofit在以下三个方面都比较有优势：

1.在构造HTTP请求时，只需要去构造接口的方法，框架会帮我们去实现这些方法，按规则去构造url,指定请求参数，可以直接用解析框架生成请求实体或解析结果，得到想要的异步请求的对象。

2.请求构造更加方便，同时和解析框架和异步请求框架解耦(通过Retrofit.addxxxFactory指定用不同的框架)，可以更加便捷的替换不同的解析框架或者异步框架。

3.性能上，因为retrofit是基于OKHttp的，所以继承了OKHttp的优秀性能，OKHttp使用Okio来大大简化数据的访问和存储，Okio是一个增强java.io和java.nio的库，所以retrofit性能和AsyncTask和Volley比还是很快.

下面以一个简单例子进行讲解：

现在通过get方式请求一个接口，接口返回json格式的数据。

1.首先先引入第三方依赖：

在build.gradle

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

2.根据返回的json格式编写实体类型(使用GsonFormat来转换)

public class IpModel {
    /**
     * code : 0
     * data : {"country":"内网IP","country_id":"-1","area":"","area_id":"-1","region":"","region_id":"-1","city":"内网IP","city_id":"local","county":"内网IP","county_id":"local","isp":"内网IP","isp_id":"local","ip":"192.168.1.3"}
     */

    private int code;
    private DataBean data;

    public int getCode() {
        return code;
    }

    public void setCode(int code) {
        this.code = code;
    }

    public DataBean getData() {
        return data;
    }

    public void setData(DataBean data) {
        this.data = data;
    }

    public static class DataBean {
        /**
         * country : 内网IP
         * country_id : -1
         * area :
         * area_id : -1
         * region :
         * region_id : -1
         * city : 内网IP
         * city_id : local
         * county : 内网IP
         * county_id : local
         * isp : 内网IP
         * isp_id : local
         * ip : 192.168.1.3
         */

        private String country;
        private String country_id;
        private String area;
        private String area_id;
        private String region;
        private String region_id;
        private String city;
        private String city_id;
        private String county;
        private String county_id;
        private String isp;
        private String isp_id;
        private String ip;

        public String getCountry() {
            return country;
        }

        public void setCountry(String country) {
            this.country = country;
        }

        public String getCountry_id() {
            return country_id;
        }

        public void setCountry_id(String country_id) {
            this.country_id = country_id;
        }

        public String getArea() {
            return area;
        }

        public void setArea(String area) {
            this.area = area;
        }

        public String getArea_id() {
            return area_id;
        }

        public void setArea_id(String area_id) {
            this.area_id = area_id;
        }

        public String getRegion() {
            return region;
        }

        public void setRegion(String region) {
            this.region = region;
        }

        public String getRegion_id() {
            return region_id;
        }

        public void setRegion_id(String region_id) {
            this.region_id = region_id;
        }

        public String getCity() {
            return city;
        }

        public void setCity(String city) {
            this.city = city;
        }

        public String getCity_id() {
            return city_id;
        }

        public void setCity_id(String city_id) {
            this.city_id = city_id;
        }

        public String getCounty() {
            return county;
        }

        public void setCounty(String county) {
            this.county = county;
        }

        public String getCounty_id() {
            return county_id;
        }

        public void setCounty_id(String county_id) {
            this.county_id = county_id;
        }

        public String getIsp() {
            return isp;
        }

        public void setIsp(String isp) {
            this.isp = isp;
        }

        public String getIsp_id() {
            return isp_id;
        }

        public void setIsp_id(String isp_id) {
            this.isp_id = isp_id;
        }

        public String getIp() {
            return ip;
        }

        public void setIp(String ip) {
            this.ip = ip;
        }
    }
}

3.编写请求网络接口

Retrofit提供的请求方式注解有几种，其中最常用的是@GET和@POST,看字面意思就是分别代表GET和POST请求，另外参数注解有@Query和@PATH，@Query是请求所带的键值对的设值，也就是网址链接后所带的参数。

public interface IpService {
    //必须要有这个Hearder，否则报错 java.lang.IllegalArgumentException: @Headers annotation is empty.

    /***
     * 请求头有什么用，请求头能反映给服务端以下信息
     * 1.请求类型 请求类型一般有GET和POST,这个信息在HTTP请求报文的第一行即请求中就可以得到
     * 2.请求地址 请求地址告诉服务端当前请求来自哪里
     * 3.请求参数 客户端和服务器的通信最终是要落实到具体数据的传递上来的，所以通过请求报文我们能够获得客户端传递的参数并对其进行处理，通常Get类型参数在请求行、而Post类型参数在消息体中。
     * 4.请求约束
         如果说1、2、3是通信核心要素，那么接下来这些我们可以称其为细节要素。如题主所言，在客户端发起请求以后，到底服务端该以什么样的形式来返回给客户端
     *
     *
     *
     *
     * @param ip
     * @return
     */
    @Headers({
            "Accept-Encoding: application/json",
            "User-Agent: MoonRetrofit"
    })
    @GET("getIpInfo.php")
    Call<IpModel> getIpMsg(@Query("ip")String ip);
}

@GET后面所带的是要访问的页面，@Query("ip")是键值对的key,String ip是键值对的value

4.创建retrofit对象

  String url = "http://ip.taobao.com/service/";
        Retrofit retrofit = new Retrofit.Builder()
                .baseUrl(url)
                //.addConverterFactory(ScalarsConverterFactory.create())//增加返回String类型的支持
                .addConverterFactory(GsonConverterFactory.create())
                .build();

baseUrl加上之前定义的@GET("getIpInfo.php")定义的参数就形成完整的请求地址，其中addConvertFactory是用于指定返回的数据类型，例如返回String类型和Gson类型。

5.创建接口文件

        IpService ipService = retrofit.create(IpService.class);
        Call<IpModel>call = ipService.getIpMsg(ip);

用retrofit创建之前定义的IpService接口对象，并调用该接口定义的getIpMsg获得Call对象

6.用Call请求网络并处理回调

 Call<IpModel>call = ipService.getIpMsg(ip);
        call.enqueue(new Callback<IpModel>() {
            @Override
            public void onResponse(Call<IpModel> call, Response<IpModel> response) {
                String country= response.body().getData().getCountry();
                Log.i("wangshu","country"+country);
                Toast.makeText(getApplicationContext(),country,Toast.LENGTH_SHORT).show();
            }

            @Override
            public void onFailure(Call<IpModel> call, Throwable t) {
                Log.i("wangshu","country");
            }
        });

上面是异步请求，回调的callbaxk是运行在主线程中的，得到的response后将数据的country字段用toast显示，如果同步请求就使用call.execute()。

这样最简单的使用retrofit使用get请求的方式请求数据就实现了

附上MainActivity的代码：

public class MainActivity extends Activity {
    private TextView text_click;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        text_click = (TextView)findViewById(R.id.text_click);
        text_click.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
               getIpInformation("192.168.1.3");
            }
        });
    }

    private void getIpInformation(String ip){
        String url = "http://ip.taobao.com/service/";
        Retrofit retrofit = new Retrofit.Builder()
                .baseUrl(url)
                //.addConverterFactory(ScalarsConverterFactory.create())//增加返回String类型的支持
                .addConverterFactory(GsonConverterFactory.create())
                .build();
        IpService ipService = retrofit.create(IpService.class);
        Call<IpModel>call = ipService.getIpMsg(ip);
        call.enqueue(new Callback<IpModel>() {
            @Override
            public void onResponse(Call<IpModel> call, Response<IpModel> response) {
                String country= response.body().getData().getCountry();
                Log.i("wangshu","country"+country);
                Toast.makeText(getApplicationContext(),country,Toast.LENGTH_SHORT).show();
            }

            @Override
            public void onFailure(Call<IpModel> call, Throwable t) {
                Log.i("failure","country");
            }
        });
    }
}

注意：retrofit常用的请求方法还有@POST，@PUT，@DELETE，@HEAD，@OPTIONS，@PATCH，@HTTP.

另外当发送GET请求时，需要设置GET的请求参数，retrofit注解提供两种方式进行配置，分别是@Query(一个键值对)和@QueryMao(多个键值对)，上面的例子是单个键值对的方式。多个键值对的方式如下：

Call<TestModel>  many(@QueryMap Map<String,String> params);

其他方式：

@Path

@Path用来替换路径

public interface testServices{

      @GET("ask/kj{uid}.html")

      Call<ResponseBody> getMessage(@Path("uid") String uid);

}

@Body

@Body和@POST注解一起使用，提供查询主体内容

public interface testServices{

   @POST("sd/ship/getsulest")

   Call<ResponseBody> getCarType(@Body userModel usermodel);

}

@Headers

public interface testService{

    @GET("sd/mountain/update")

    @Headers("Accept-Encoding:application/json")

    Call<ResponseBody> getUserType();

}

@Headres是用来添加头部信息，可以采用动态头部

public interface testService{

    @GET("sd/getSome")

    Call<ResponseBody> somepoint(@Header("Location") String location);

}

@Multipart

用来上传文件

public interface FileUpload{

    @Multipart

    @POST("upload")

     Call<ResponseBody> upload(@Part MultipartBody.Part file);

}