Android Retrofit2的详细使用

Retrofit2

1.Retrofit2概述

1,Retrofit框架是Square公司出品的目前非常流行的网络框架.
效率高，实现简单，运用注解和动态代理.
极大简化了网络请求的繁琐步骤，非常适合REST ful网络请求.
目前Retofit版本是2

2,Retrofit其实我们可以理解为OkHttp的加强版。
它也是一个网络加载框架。底层是使用OKHttp封装的。
准确来说,网络请求的工作本质上是OkHttp完成，而 Retrofit 仅负责网络请求接口的封装。
它的一个特点是包含了特别多注解，方便简化你的代码量。
并且还支持很多的开源库(著名例子：Retrofit + RxJava)

2.Retrofit2的好处

1，超级解耦
    解耦？解什么耦？
    我们在请求接口数据的时候，API接口定义和API接口使用总是相互影
响，什么传参、回调等，耦合在一块。有时候我们会考虑一下怎么封装我们的代
码让这两个东西不那么耦合，这个就是Retrofit的解耦目标，也是它的最大的特点。
2，可以配置不同HttpClient来实现网络请求，如OkHttp、HttpClient...
3，支持同步、异步和RxJava
4，可以配置不同的反序列化工具来解析数据，如json、xml...
5，请求速度快，使用非常方便灵活

3.Retrofit2配置

1，官网：http://square.github.io/retrofit/
2，依赖：
    implementation 'com.squareup.retrofit2:retrofit:2.5.0'
3，OkHttp库依赖
    由于Retrofit是基于OkHttp，所以还需要添加OkHttp库依赖
    implementation 'com.squareup.okhttp3:okhttp:3.12.0'
4，添加网络权限
    

4，Retrofit2的使用步骤

1，定义接口（封装URL地址和数据请求）
2，实例化Retrofit
3，通过Retrofit实例创建接口服务对象
4，接口服务对象调用接口中的方法，获取Call对象
5，Call对象执行请求（异步、同步请求）

Retrofit2发送GET、POST请求(异步、同步)

1.Retrofit2发送GET

//主机地址
String URL = "http://api.shujuzhihui.cn/api/news/";//必须以反斜杠结尾

//接口服务
public interface MyServer {
    
    //GET
    @GET("categories?appKey=908ca46881994ffaa6ca20b31755b675")
    Call getData1();

    @GET("categories?")
    Call getData2(@Query("appKey") String appkey);

    @GET("categories?")
    Call getData3(@QueryMap Map map);
}

//Get异步
private void initGetEnqueue() {

    //1.创建Retrofit对象
    Retrofit retrofit = new Retrofit.Builder()
            .baseUrl(MyServer.URL)
            .build();
    
    //2.获取MyServer接口服务对象
    MyServer myServer = retrofit.create(MyServer.class);
    
    //3.获取Call对象
    //方式一
    Call call1 = myServer.getData1();

    //方式二
    Call call2 = myServer.getData2("908ca46881994ffaa6ca20b31755b675");

    //方式三
    Map map = new HashMap<>();
    map.put("appKey","908ca46881994ffaa6ca20b31755b675");
    Call call = myServer.getData3(map);

    //4.Call对象执行请求
    call.enqueue(new Callback() {

        @Override
        public void onResponse(Call call,Response response) {

            try {
                String result = response.body().string();

                Log.e("retrofit", "onResponse: "+result);
                tv.setText(result);//默认直接回调主线程
            } catch (IOException e) {
                e.printStackTrace();
            }
        }

        @Override
        public void onFailure(Call call, Throwable t) {

            Log.e("retrofit", "onFailure: "+t.getMessage());
        }
    });
}


//GET同步
private void initGetExecute() {

    //1.创建Retrofit对象
    Retrofit retrofit = new Retrofit.Builder()
            .baseUrl(MyServer.URL)
            .build();

    //2.获取MyServer接口服务对象
    MyServer myServer = retrofit.create(MyServer.class);

    //3.获取Call对象
    final Call call = myServer.getData1();

    new Thread(){//子线程执行
        @Override
        public void run() {
            super.run();

            try {
                //4.Call对象执行请求
                Response response = call.execute();

                final String result = response.body().string();

                Log.e("retrofit", "onResponse: "+result);

                runOnUiThread(new Runnable() {
                    @Override
                    public void run() {
                        tv.setText(result);//默认直接回调主线程
                    }
                });
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
    }.start();

}

2.Retrofit2发送POST

String URL = "http://api.shujuzhihui.cn/api/news/";//必须以反斜杠结尾

public interface MyServer {
    
    //POST("categories?")    POST("categories")相同
    @POST("categories?")
    @FormUrlEncoded
    Call postData1(@Field("appKey") String appKey);

    @POST("categories")  
    @FormUrlEncoded
    Call postData2(@FieldMap Map map);
}

//POST异步
private void initPostEnqueue() {

    //1.创建Retrofit对象
    Retrofit retrofit = new Retrofit.Builder()
            .baseUrl(MyServer.URL)
            .build();

    //2.获取MyServer接口服务对象
    MyServer myServer = retrofit.create(MyServer.class);

    //3.获取Call对象
    //方式一
    Call call1 = myServer.postData1("908ca46881994ffaa6ca20b31755b675");

    //方式二
    Map map = new HashMap<>();
    map.put("appKey","908ca46881994ffaa6ca20b31755b675");
    Call call = myServer.postData2(map);

    //4.Call对象执行请求
    call.enqueue(new Callback() {
        @Override
        public void onResponse(Call call,Response response) {

            try {
                String result = response.body().string();

                Log.e("retrofit", "onResponse: "+result);
                tv.setText(result);//默认直接回调主线程
            } catch (IOException e) {
                e.printStackTrace();
            }
        }

        @Override
        public void onFailure(Call call, Throwable t) {

            Log.e("retrofit", "onFailure: "+t.getMessage());
        }
    });
}

Retrofit注解

注解代码       请求格式

请求方式：
    @GET           GET请求
    @POST          POST请求
    @DELETE        DELETE请求
    @HEAD          HEAD请求
    @OPTIONS       OPTIONS请求
    @PATCH         PATCH请求

请求头：
    @Headers("K:V") 添加请求头，作用于方法
    @Header("K")    添加请求头，参数添加头
    @FormUrlEncoded 用表单数据提交，搭配参数使用
    @Multipart      用文件上传提交   multipart/form-data

请求参数：
    @Query          替代参数值，通常是结合get请求的
    @QueryMap       替代参数值，通常是结合get请求的
    @Field          替换参数值，是结合post请求的
    @FieldMap       替换参数值，是结合post请求的

请求路径：
    @Path           替换路径
    @Url            路径拼接

请求体：
    @Body(RequestBody)  设置请求体，是结合post请求的

文件处理：
    @Part Multipart.Part
    @Part("key") RequestBody requestBody(单参)
    @PartMap Map requestBodyMap(多参)
    @Body RequestBody requestBody(自定义参数)

Retrofit2其他常用注解使用

String URL = "http://api.shujuzhihui.cn/api/news/";//必须以反斜杠结尾

public interface MyServer {
    
    //Path
    @GET("wages/{wageId}/detail") 
    CallgetImgData(@Path("wageId") String wageId);

    //Url
    @GET
    CallgetImgData(@Url String url);

    @GET
    CallgetImgData(@Url String url,@Query("appKey") String appkey);

    
    //Json
    @POST("categories")
    @Headers("Content-Type:application/json")
    Call getFormDataJson(@Body RequestBody requestBody);

    //Form
    @POST("categories")
    @Headers("Content-Type:application/x-www-form-urlencoded")
    Call getFormData1(@Body RequestBody requestBody);

    //复用URL
    @POST()
    @Headers("Content-Type:application/x-www-form-urlencoded")
    Call getFormData2(@Url String url,@Body RequestBody requestBody);

    //通用
    @POST()
    Call getFormData3(@Url String url, @Body RequestBody requestBody, @Header("Content-Type") String contentType);
}

//RequestBody参数拼接
private void initPostBody() {

    Retrofit.Builder builder = new Retrofit.Builder();
    Retrofit retrofit = builder.baseUrl(MyServer.URL)
            .build();

    MyServer myServer = retrofit.create(MyServer.class);

    //Json类型
    String json1 = "{\n" + "    \"appKey\": \"908ca46881994ffaa6ca20b31755b675\"\n" +  "}";
    RequestBody requestBody01 = RequestBody.create(MediaType.parse("application/json,charset-UTF-8"),json1);
    Call call01 = myServer.getFormDataJson(requestBody01);

    //String类型
    //有参形式
    RequestBody requestBody02 = RequestBody.create(MediaType.parse("application/x-www-form-urlencoded,charset-UTF-8"),"appKey=908ca46881994ffaa6ca20b31755b675");
    Call call02 = myServer.getFormData1(requestBody02);

    //无参形式
    RequestBody requestBody3 = RequestBody.create(MediaType.parse("application/x-www-form-urlencoded,charset-UTF-8"),"");
    Call call03 = myServer.getFormData1(requestBody3);

    //RequestBody （Form表单，键值对参数形式）
    //方式一(requestBody)
    FormBody requestBody = new FormBody.Builder()
            .add("appKey","908ca46881994ffaa6ca20b31755b675")
            .build();
    Call call1 = myServer.getFormData1(requestBody);

    //方式二(url+requestBody)
    FormBody requestBody = new FormBody.Builder()
            .add("appKey","908ca46881994ffaa6ca20b31755b675")
            .build();
    Call call2 = myServer.getFormData2("categories",requestBody);

    //方式三(url+requestBody+header)
    FormBody requestBody = new FormBody.Builder()
            .add("appKey","908ca46881994ffaa6ca20b31755b675")
            .build();
    Call call3 = myServer.getFormData3("categories",requestBody,"application/x-www-form-urlencoded");


    call3.enqueue(new Callback() {
        @Override
        public void onResponse(Call call, Response response) {

            try {
                String result = response.body().string();

                Log.e("retrofit", "onResponse: "+result);
                tv.setText(result);//默认直接回调主线程
            } catch (IOException e) {
                e.printStackTrace();
            }
        }

        @Override
        public void onFailure(Call call, Throwable t) {

            Log.e("retrofit", "onFailure: "+t.getMessage());
        }
    });
}