Retrofit

最新推荐文章于 2022-07-05 21:38:11 发布

luoj_616

最新推荐文章于 2022-07-05 21:38:11 发布

阅读量151

点赞数

分类专栏： android-第三方框架

本文链接：https://blog.csdn.net/luoj_616/article/details/79655567

版权

android-第三方框架专栏收录该内容

11 篇文章 0 订阅

订阅专栏

描述

准确来说，Retrofit 是一个 RESTful 的 HTTP 网络请求框架的封装。
原因：网络请求的工作本质上是 OkHttp 完成，而 Retrofit 仅负责网络请求接口的封装

本质过程

App应用程序通过 Retrofit 请求网络，实际上是使用 Retrofit 接口层封装请求参数、Header、Url 等信息，之后由 OkHttp 完成后续的请求操作
在服务端返回数据之后，OkHttp 将原始的结果交给 Retrofit，Retrofit根据用户的需求对结果进行解析

使用介绍

使用 Retrofit 的步骤共有7个：

步骤1：添加Retrofit库的依赖
步骤2：创建接收服务器返回数据的类
步骤3：创建用于描述网络请求的接口
步骤4：创建 Retrofit 实例
步骤5：创建网络请求接口实例并配置网络请求参数
步骤6：发送网络请求（异步 / 同步）

步骤1：添加Retrofit库的依赖

添加依赖
在modul的build文件下的dependencies中添加

compile 'com.squareup.retrofit2:retrofit:2.0.2'
compile 'com.squareup.retrofit2:converter-gson:2.0.2'

添加权限

由于是网络请求，需要在manifest中添加网络请求的权限

<uses-permission android:name="android.permission.INTERNET"/>

步骤2：创建接收服务器返回数据的类

java bean对象

步骤3：创建用于描述网络请求的接口

Retrofit将 Http请求抽象成 Java接口：采用注解描述网络请求参数和配置网络请求参数

用动态代理动态将该接口的注解“翻译”成一个 Http 请求，最后再执行 Http 请求
注：接口中的每个方法的参数都需要使用注解标注，否则会报错

GetRequest_Interface.interface

public interface GetRequest_Interface {

    @GET("openapi.do?keyfrom=Yanzhikai&key=2032414398&type=data&doctype=json&version=1.1&q=car")
    Call<Translation>  getCall();
    // @GET注解的作用:采用Get方法发送网络请求
 
    // getCall() = 接收网络请求数据的方法
    // 其中返回类型为Call<*>，*是接收数据的类（即上面定义的Translation类）
    // 如果想直接获得Responsebody中的内容，可以定义网络请求返回值为Call<ResponseBody>
}

注解类型

GET

样式1（一个简单的get请求）

http://102.10.10.132/api/News

    @GET("News")
    Call<NewsBean> getItem();

样式2（URL中有参数）

http://102.10.10.132/api/News/1
http://102.10.10.132/api/News/{资讯id}

    @GET("News/{newsId}")
    Call<NewsBean> getItem(@Path("newsId") String newsId);

样式3（参数在URL问号之后）

http://102.10.10.132/api/News?newsId=1
http://102.10.10.132/api/News?newsId={资讯id}

    @GET("News")
    Call<NewsBean> getItem(@Query("newsId") String newsId);

样式4（多个参数在URL问号之后，且个数不确定）

http://102.10.10.132/api/News?newsId=1&type=类型1...
http://102.10.10.132/api/News?newsId={资讯id}&type={类型}...

    @GET("News")
    Call<NewsBean> getItem(@QueryMap Map<String, String> map);

POST

样式1（需要补全URL，post的数据只有一条reason）

http://102.10.10.132/api/Comments/1
http://102.10.10.132/api/Comments/{newsId}

    @FormUrlEncoded
    @POST("Comments/{newsId}")
    Call<Comment> reportComment(
        @Path("newsId") String commentId,
        @Field("reason") String reason);

样式2（需要补全URL，问号后加入access_token，post的数据只有一条reason）

http://102.10.10.132/api/Comments/1?access_token=1234123
http://102.10.10.132/api/Comments/{newsId}?access_token={access_token}

    @FormUrlEncoded
    @POST("Comments/{newsId}")
    Call<Comment> reportComment(
        @Path("newsId") String commentId,
        @Query("access_token") String access_token,
        @Field("reason") String reason);

样式3（需要补全URL，问号后加入access_token，post一个body（对象））

http://102.10.10.132/api/Comments/1?access_token=1234123
http://102.10.10.132/api/Comments/{newsId}?access_token={access_token}

    @POST("Comments/{newsId}")
    Call<Comment> reportComment(
        @Path("newsId") String commentId,
        @Query("access_token") String access_token,
        @Body CommentBean bean);

DELETE

样式1（需要补全URL）

http://102.10.10.132/api/Comments/1
http://102.10.10.132/api/Comments/{commentId}

    @DELETE("Comments/{commentId}")
    Call<ResponseBody> deleteNewsCommentFromAccount(
        @Path("commentId") String commentId);

样式2（需要补全URL，问号后加入access_token）

http://102.10.10.132/api/Comments/1?access_token=1234123
http://102.10.10.132/api/Comments/{commentId}?access_token={access_token}

    @DELETE("Comments/{commentId}")
    Call<ResponseBody> deleteNewsCommentFromAccount(
        @Path("commentId") String commentId，
        @Query("access_token") String access_token);

样式3（带有body）

http://102.10.10.132/api/Comments

@HTTP(method = "DELETE",path = "Comments",hasBody = true)
Call<ResponseBody> deleteCommont(
            @Body CommentBody body
    );

CommentBody：需要提交的内容，与Post中的Body相同

PUT

http://102.10.10.132/api/Accounts/1
http://102.10.10.132/api/Accounts/{accountId}

    @PUT("Accounts/{accountId}")
    Call<ExtrasBean> updateExtras(
        @Path("accountId") String accountId,
        @Query("access_token") String access_token,
        @Body ExtrasBean bean);

header @Header & @Headers

作用：添加请求头 &添加不固定的请求头
具体使用如下：

// @Header
@GET("user")
Call<User> getUser(@Header("Authorization") String authorization)

// @Headers
@Headers("Authorization: authorization")
@GET("user")
Call<User> getUser()

// 以上的效果是一致的。
// 区别在于使用场景和使用方式
// 1. 使用场景：@Header用于添加不固定的请求头，@Headers用于添加固定的请求头
// 2. 使用方式：@Header作用于方法的参数；@Headers作用于方法

总结

@Path：所有在网址中的参数（URL的问号前面），如：
http://102.10.10.132/api/Accounts/{accountId}
@Query：URL问号后面的参数，如：
http://102.10.10.132/api/Comments?access_token={access_token}
@QueryMap：相当于多个@Query
@Field：用于POST请求，提交单个数据
@Body：相当于多个@Field，以对象的形式提交
Tips

Tips1
使用@Field时记得添加@FormUrlEncoded
Tips2
若需要重新定义接口地址，可以使用@Url，将地址以参数的形式传入即可。如

    @GET
    Call<List<Activity>> getActivityList(
            @Url String url,
            @QueryMap Map<String, String> map);

    Call<List<Activity>> call = service.getActivityList(
                "http://115.159.198.162:3001/api/ActivitySubjects", map);

步骤4：创建 Retrofit 实例

 Retrofit retrofit = new Retrofit.Builder()
                .baseUrl("http://fanyi.youdao.com/") // 设置网络请求的Url地址
                .addConverterFactory(GsonConverterFactory.create()) // 设置数据解析器
                .addCallAdapterFactory(RxJavaCallAdapterFactory.create()) // 支持RxJava平台
                .build();

a. 关于数据解析器（Converter）

Retrofit支持多种数据解析方式
使用时需要在Gradle添加依赖

数据解析器	Gradle依赖
Gson	com.squareup.retrofit2:converter-gson:2.0.2
Jackson	com.squareup.retrofit2:converter-jackson:2.0.2
Simple XML	com.squareup.retrofit2:converter-simplexml:2.0.2
Protobuf	com.squareup.retrofit2:converter-protobuf:2.0.2
Moshi	com.squareup.retrofit2:converter-moshi:2.0.2
Wire	com.squareup.retrofit2:converter-wire:2.0.2
Scalars	com.squareup.retrofit2:converter-scalars:2.0.2 解析String类型数据

b. 关于网络请求适配器（CallAdapter）

Retrofit支持多种网络请求适配器方式：guava、Java8和rxjava

使用时如使用的是 Android 默认的 CallAdapter，则不需要添加网络请求适配器的依赖，否则则需要按照需求进行添加
Retrofit 提供的 CallAdapter

使用时需要在Gradle添加依赖：

网络请求适配器	Gradle依赖
guava	com.squareup.retrofit2:adapter-guava:2.0.2
Java8	com.squareup.retrofit2:adapter-java8:2.0.2
rxjava	com.squareup.retrofit2:adapter-rxjava:2.0.2

步骤5：创建网络请求接口实例

        // 创建 网络请求接口 的实例
        GetRequest_Interface request = retrofit.create(GetRequest_Interface.class);

        //对 发送请求 进行封装
        Call<Reception> call = request.getCall();

步骤6：发送网络请求（异步 / 同步）

封装了数据转换、线程切换的操作

//发送网络请求(异步)
        call.enqueue(new Callback<Translation>() {
            //请求成功时回调
            @Override
            public void onResponse(Call<Translation> call, Response<Translation> response) {
                //请求处理,输出结果
                response.body().show();
            }

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

// 发送网络请求（同步）
Response<Reception> response = call.execute();

一、使用自定义Log拦截器

1、创建自定义Log拦截器类

class LoggingInterceptor implements Interceptor {
    @Override
    public Response intercept(Chain chain) throws IOException {
        //这个chain里面包含了request和response，所以你要什么都可以从这里拿
        Request request = chain.request();
        long t1 = System.nanoTime();//请求发起的时间

        String method = request.method();
        if ("POST".equals(method)) {
            StringBuilder sb = new StringBuilder();
            if (request.body() instanceof FormBody) {
                FormBody body = (FormBody) request.body();
                for (int i = 0; i < body.size(); i++) {
                    sb.append(body.encodedName(i) + "=" + body.encodedValue(i) + ",");
                }
                sb.delete(sb.length() - 1, sb.length());
                Log.d("CSDN_LQR",String.format("发送请求 %s on %s %n%s %nRequestParams:{%s}",
                        request.url(), chain.connection(), request.headers(), sb.toString()));
            }
        } else {
            Log.d("CSDN_LQR",String.format("发送请求 %s on %s%n%s",
                    request.url(), chain.connection(), request.headers()));
        }
        Response response = chain.proceed(request);
        long t2 = System.nanoTime();//收到响应的时间
        //这里不能直接使用response.body().string()的方式输出日志
        //因为response.body().string()之后，response中的流会被关闭，程序会报错，我们需要创建出一
        //个新的response给应用层处理
        ResponseBody responseBody = response.peekBody(1024 * 1024);
        Log.d("CSDN_LQR",
                String.format("接收响应: [%s] %n返回json:【%s】 %.1fms %n%s",
                        response.request().url(),
                        responseBody.string(),
                        (t2 - t1) / 1e6d,
                        response.headers()
                ));
        return response;
    }
}

2、使用Log拦截器

OkHttpClient.Builder builder = new OkHttpClient.Builder();
if (BuildConfig.DEBUG) {
    builder.addInterceptor(new LoggingInterceptor());//使用自定义的Log拦截器
}

OkHttpClient client = builder.build();
mRetrofit = new Retrofit.Builder()
        ...
        .client(client)
        .build();

二、使用okhttp官方Log拦截器

1、引入依赖

compile 'com.squareup.okhttp3:logging-interceptor:3.3.1'

2、使用Log拦截器

OkHttpClient.Builder builder = new OkHttpClient.Builder();
if (BuildConfig.DEBUG) {
    // Log信息拦截器
    HttpLoggingInterceptor loggingInterceptor = new HttpLoggingInterceptor();
    loggingInterceptor.setLevel(HttpLoggingInterceptor.Level.BODY);//这里可以选择拦截级别

    //设置 Debug Log 模式
    builder.addInterceptor(loggingInterceptor);
}

OkHttpClient client = builder.build();
mRetrofit = new Retrofit.Builder()
        ...
        .client(client)
        .build();

使用上述两种Log拦截器设置方式中的任意一种之后，当使用debug模式运行项目时，在控制台中就会打印出每次客户端发出的请求和收到的响应内容

三、使用拦截器添加header

    public  OkHttpClient genericClient() {
             OkHttpClient httpClient = new OkHttpClient.Builder()
                      .addInterceptor(headerIntercepter)
if (BuildConfig.DEBUG) {
    builder.addInterceptor(new LoggingInterceptor());//使用自定义的Log拦截器
}
                     .build();

           return httpClient;

           }


Interceptor headerIntercepter=new Interceptor() {
                     @Override
                     public okhttp3.Response intercept(Chain chain) throws IOException {

                                    Request requestLog = chain.request().newBuilder()
                                            .headers(initHead())

                                 /*    .addHeader("Content-Type", "application/x-www-form-urlencoded; charset=UTF-8")
                                       .addHeader("Accept-Encoding", "gzip, deflate")
                                                 .addHeader("Connection","keepalive")
                                           .addHeader("Cookie", "add cookies here")*/
                                                .build();
                         okhttp3.Response response = chain.proceed(requestLog);
                                         return response;
                                    }
                    };

 public Headers initHead(){
        Headers.Builder builder =new Headers.Builder()
                .add("User-Agent", getUserAgent())
                .add("Udid", "dc:09:4c:d6:f9:63")//Udid=dc:09:4c:d6:f9:63
             
        return builder.build();
    }

   private static String getUserAgent() {
        String userAgent = "我们是不 4.2.4 (HUAWEI TAG-AL00;android 5.1;zh)";
        //有中文需要转义
        StringBuffer sb = new StringBuffer();
        for (int i = 0, length = userAgent.length(); i < length; i++) {
            char c = userAgent.charAt(i);
            if (c <= '\u001f' || c >= '\u007f') {
                sb.append(String.format("\\u%04x", (int) c));
            } else {
                sb.append(c);
            }
        }
        return sb.toString();
    }

参考：

https://www.jianshu.com/p/7687365aa946

https://www.jianshu.com/p/a3e162261ab6

https://www.jianshu.com/p/73216939806a

https://blog.csdn.net/yuzhiqiang_1993/article/details/90168515

http://gank.io/post/56e80c2c677659311bed9841

luoj_616

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
Retrofit

描述准确来说，Retrofit 是一个 RESTful 的 HTTP 网络请求框架的封装。原因：网络请求的工作本质上是 OkHttp 完成，而 Retrofit 仅负责网络请求接口的封装本质过程App应用程序通过 Retrofit 请求网络，实际上是使用 Retrofit 接口层封装请求参数、Header、Url 等信息，之后由 OkHttp 完成后续的请求操作在服务端返回...
复制链接

扫一扫