Retrofit2.0基本应用初探

最新推荐文章于 2021-11-23 21:14:26 发布
最新推荐文章于 2021-11-23 21:14:26 发布
阅读量1.5k 收藏
点赞数
分类专栏： Android基础 文章标签： android
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_24448923/article/details/53102541
版权

本文主要是讲解了Retrofit的使用以下几方面的介绍
使用get方式，@Path 注解来构建完整的URL
.使用get方式，@Query，@Querymap 注解来构建完整的URL
使用post 方式 ，@Field ，@Fieldmap 注解来构建完整的URL。

Retrofit是什么？
Retrofit就是一个Http请求库，和其它Http库最大区别在于通过大范围使用注解简化Http请求。目前Retrofit 2.0底层是依赖OkHttp实现的，也就是说Retrofit本质上就是对OkHttp的更进一步封装。
Retrofit简单示例使用
要想使用retrofit，首先需要添加以下相关的依赖：

    compile 'com.squareup.retrofit2:retrofit:2.1.0'
    compile 'com.squareup.retrofit2:converter-gson:2.0.2'
    compile 'com.google.code.gson:gson:2.6.1'
    compile 'com.squareup.okhttp3:okhttp:3.2.0'

我们请求的URL地址为：https://api.github.com/repos/square/retrofit/contributors 这是一个restful url格式的请求,而retrofit非常适合于这种请求

创建API接口
在retrofit中通过一个Java接口作为http请求的api接口。

public interface ApiService {
    @GET("repos/{owner}/{repo}/contributors")
    Call<List<ResponseBody>> getInfo(@Path("owner") String owner, @Path("repo") String repo);
}

创建retrofit实例
　　在这里baseUrl是在创建retrofit实力的时候定义的，我们也可以在API接口中定义完整的url。在这里建议在创建baseUrl中以”/”结尾，在API中不以”/”开头和结尾。

Retrofit retrofit=new Retrofit.Builder()
                .baseUrl("https://api.github.com/")
                .addConverterFactory(GsonConverterFactory.create())
                .build();

创建retrofit实例，我们通过addConverterFactory指定一个factory来对响应反序列化,因为笔者一直用Gson来解析数据，所以在本篇一开始我就把为retrofit添加gson转换器的依赖给添加进来了·就是：

compile ‘com.squareup.retrofit2:converter-gson:2.0.2’
compile ‘com.google.code.gson:gson:2.6.1’

当然除了gson以外，还提供了以下的选择：

Gson: com.squareup.retrofit2:converter-gson
Jackson: com.squareup.retrofit2:converter-jackson
Moshi: com.squareup.retrofit2:converter-moshi
Protobuf: com.squareup.retrofit2:converter-protobuf
Wire: com.squareup.retrofit2:converter-wire
Simple XML: com.squareup.retrofit2:converter-simplexml
Scalars (primitives, boxed, and String): com.squareup.retrofit2:converter-scalar

现在API接口跟retrofit实例都创建好了·我们就试着去调用，当然在我们创建API接口之前我们需要根据服务器返回的数据类型创建一个Java类ResponseBody，用来保存接收到的数据。

 private String login;
    private int id;

    public String getLogin() {
        return login;
    }

    public void setLogin(String login) {
        this.login = login;
    }

    public int getId() {
        return id;
    }

    public void setId(int id) {
        this.id = id;
    }

这个接口返回的数据字段很多·为了简单点·我就选了login跟id这2个字段.

调用API接口

在调用API接口请求后，获得一个json字符串，通过Gson进行解析，获得login以及id。

ApiService service=retrofit.create(ApiService.class);

        Call<List<ResponseBody>> call =service.getInfo("square","retrofit");
        call.enqueue(new Callback<List<ResponseBody>>() {
            @Override
            public void onResponse(Call<List<ResponseBody>> call, Response<List<ResponseBody>> response) {
                textView.setText(response.body().get(1).getLogin());
            }

            @Override
            public void onFailure(Call<List<ResponseBody>> call, Throwable t) {

            }
        });
    }

通过调用创建的API接口，请求的数据显示在TextView上，说明了这次请求成功。
总结：
使用get方式，@Path 注解来构建完整的URL,首先请求的URL是具有restful风格的url比如上面例子的url=”https://api.github.com/repos/square/retrofit/contributors”,然后在创建API接口的时候我们是用注解的方式来区别get或post请求,比如上面的例子@GET(“repos/{owner}/{repo}/contributors”),对于{owner}与{repo} 我们可以这么理解，我们可以理解为他只是一个占位符，然后我们通过getInfo(@Path(“owner”) String owner, @Path(“repo”) String repo)方法请求的时候所填的值给替换上去，这样我们就构成了如上的完整的url.

对于大多数开发公司来说后台给的url不是具有restful风格的，比如像这种url=http://apis.juhe.cn/mobile/get?phone=13429667914&key=46066e52ff348681e2e3b22669c0cd89 我们改怎么处理呢·看以下示例

使用get方式，@Query 注解来构建完整的URL

首先我们通过这个url给的数据写一个java实体类给来存储数据

public class Info {
        private String resultcode;
        private String reason;
        private ResultBean result;
        private int error_code;
        public String getResultcode() {
            return resultcode;
        }
        public void setResultcode(String resultcode) {
            this.resultcode = resultcode;
        }
        public String getReason() {
            return reason;
        }
        public void setReason(String reason) {
            this.reason = reason;
        }
        public ResultBean getResult() {
            return result;
        }
        public void setResult(ResultBean result) {
            this.result = result;
        }
        public int getError_code() {
            return error_code;
        }
        public void setError_code(int error_code) {
            this.error_code = error_code;
        }
        public static class ResultBean {
            private String province;
            private String city;
            private String areacode;
            private String zip;
            private String company;
            private String card;
            public String getProvince() {
                return province;
            }
            public void setProvince(String province) {
                this.province = province;
            }
            public String getCity() {
                return city;
            }
            public void setCity(String city) {
                this.city = city;
            }

            public String getAreacode() {
                return areacode;
            }
            public void setAreacode(String areacode) {
                this.areacode = areacode;
            }
            public String getZip() {
                return zip;
            }
            public void setZip(String zip) {
                this.zip = zip;
            }
            public String getCompany() {
                return company;
            }
            public void setCompany(String company) {
                this.company = company;
            }
            public String getCard() {
                return card;
            }
            public void setCard(String card) {
                this.card = card;
            }
        }
}

然后我们创建API接口

public interface ApiService {
    @GET("mobile/get")
    Call<Info> getInfo1(@Query("phone") String phone,@Query("key") String key);

API接口创建好了·我们创建retrofit的实例如下：

Retrofit retrofit = new Retrofit.Builder()
                .baseUrl("http://apis.juhe.cn/")
                .addConverterFactory(GsonConverterFactory.create())
                .build();

接口跟实例都创建好了·我们调用获取数据然后显示在TextView上

 ApiService service = retrofit.create(ApiService.class);

        Call<Info> call = service.getInfo1("15201339282", "46066e52ff348681e2e3b22669c0cd89");
        call.enqueue(new Callback<Info>() {
            @Override
            public void onResponse(Call<Info> call, Response<Info> response) {
                textView.setText(response.body().getResult().getCity());
            }

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

            }
        });
    }

经过运行项目我们的TextView上显示了城市名称，这样我们的请求成功

上面是使用get方式，@Query 注解来构建完整的URL，我们还可以用，@Querymap注解来构建完整的url如下：

API接口

public interface ApiService {
    @GET("mobile/get")
    Call<Info> getInfo2(@QueryMap Map<String,String> map);
    }

跟上面用@Query注解构建url不同的是·这里在getInfo2方法中传的参数是一个 Map集合
创建retrofit实例跟上面的例子一样的·这里就不贴出来了·然后调用如下：

 Map<String, String> map = new HashMap<>();
        map.put("phone", "13762529061");
        map.put("key", "46066e52ff348681e2e3b22669c0cd89");
        Retrofit retrofit = new Retrofit.Builder()
                .baseUrl("http://apis.juhe.cn/")
                .addConverterFactory(GsonConverterFactory.create())
                .build();
        ApiService service = retrofit.create(ApiService.class);
        Call<Info> call = service.getInfo2(map);
        call.enqueue(new Callback<Info>() {
            @Override
            public void onResponse(Call<Info> call, Response<Info> response) {
                Log.d("TAG", response.body().getResultcode());
                textView.setText(response.body().getResult().getCity());
            }

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

            }
        });
    }

如上构建完整的url是：url=http://apis.juhe.cn/mobile/get?phone=13762569061&key=46066e52ff348681e2e3b22669c0cd89

如上url我们还可以使用post 方式 ，@Field ，@Fieldmap 注解来构建完整的URL。
API接口

public interface ApiService {
    @FormUrlEncoded
    @POST("mobile/get")
    Call<Info> getInfo3(@Field("phone") String phone , @Field("key") String key)}

创建retrofit实例跟调用

  Retrofit retrofit = new Retrofit.Builder()
                .baseUrl("http://apis.juhe.cn/")
                .addConverterFactory(GsonConverterFactory.create())
                .build();
        ApiService service = retrofit.create(ApiService.class);
        Call<Info> call = service.getInfo3("13762569061", "46066e52ff348681e2e3b22669c0cd89");
        call.enqueue(new Callback<Info>() {
            @Override
            public void onResponse(Call<Info> call, Response<Info> response) {
                textView.setText(response.body().getResult().getCity());
            }

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

            }
        });

显示的结果跟上面的例子是一样的只是使用get跟post的方法的区别,至于使用@Fieldmap 注解来构建url 也就是在getInfo()方法中传入的的参数是一个map集合，参照@Querymap注解来构建完整url的例子。

写了这么多大家看到的请求方式都是异步请求call.enqueue()，当然需要同步请求的话可以使用时call.execute()执行一个同步请求.这里代码就不贴出来了，相信执行很简单的.

clone的使用
当我们想利用call的实例多次请求的时候，我们发现会报这样的错误:

 Process: com.example.john.retrofit2, PID: 16999
                                                                            java.lang.IllegalStateException: Already executed.
                                                                                at retrofit2.OkHttpCall.enqueue(OkHttpCall.java:78)
                                                                                at retrofit2.ExecutorCallAdapterFactory$ExecutorCallbackCall.enqueue(ExecutorCallAdapterFactory.java:60)
                                                                                at com.example.john.retrofit2.MainActivity.getDataFromService3(MainActivity.java:130)
                                                                                at com.example.john.retrofit2.MainActivity$7.onClick(MainActivity.java:179)

因为在这里无论是同步操作还是异步操作每一个call对象实例只能被执行一次，不然的话就会抛出以上的异常.如果我们真有需求要执行多次·那么retrofit提供了一个clone给我们，表面意思是克隆.我们该这样子做:

Call<Info> callClone= call.clone();
        callClone.enqueue(new Callback<Info>() {}
或者
Call<Info> callClone= call.clone();
        callClone.execute();

也就是克隆一个实例执行同步或者异步请求.

到此使用Retrofit最基本的用法的使用已经完结，需要更深入的了解Retrofit的使用可以移至http://blog.csdn.net/lmj623565791/article/details/51304204

本篇博客demo地址：https://github.com/MrXiaoChao/Retrofit2 欢迎围观

Bright.Luo
关注
专栏目录
Retrofit2.0 Demo
04-23
本项目"Retrofit2.0 Demo"是一个实际应用示例，结合了Okhttp作为网络底层库，Gson作为数据解析库，为开发者提供了一套完整的网络请求解决方案。 首先，我们要理解Retrofit2.0的核心概念。Retrofit通过注解方式定义...
java.lang.IllegalStateException: Already executed.
qq_34900897的博客
10-11 4268
这里出错是retrofit请求的时候报错，并且不知道怎么出现的。也是困扰了好久，百度上是没法找到的，万事找stackoverflow.com就好了，里面基本上有答案。 call.execute().body(); 上面是报错的地方，执行到这里就报错了硬是头痛啊。为啥回报这个错误呢，是因为这个方法在retrofit2.0之后，该请求只能调用一次，如果再次调用就会报： java.lang.Il...
源码之 Retrofit
qq_39438055的博客
11-23 755
文章目录1、使用1.1 创建 Service 接口1.2 使用2、分析2.1 Retrofit 对象的创建爱你 沿着使用追溯源码 Retrofit 的使用过程为：创建 Service 接口，创建 Retrofit 对象，创建实现了 Service 接口的代理对象，调用代理对象的请求方法，发起同步/异步请求并获取回调 1、使用 1.1 创建 Service 接口 public interface ApiService { @GET("users/{user}/repos") Call&lt
Retrofit源码详解
u010939317的专栏
04-14 223
一.Retrifit代码详解 1.使用方式 Retrofit retrofit = new Retrofit.Builder(). baseUrl("https://www.wanandroid.com/"). addConverterFactory(GsonConverterFactory.create()). build(); //1动态代理生成代理接口代理实例 WanAndroidApi wanAndroidApi=retrofit.create(WanAndroidApi.class); //2
Retrofit 自定义GsonConverterFactory 解析异常
K_Hello的博客
08-01 4986
在用自定义GsonConverterFactory 中解析数据出现异常 retrofit2.ExecutorCallAdapterFactory$ExecutorCallbackCall@5c86aee==java.lang.IllegalStateException: closed===closed``` 完整如下： java.lang.IllegalStateException: c...
JavaSE基础 第七章 方法
日天家的猫
08-05 262
第七章 方法 目录第七章 方法1.方法的定义2.方法的调用3.JVM的内存结构4.栈数据结构5.方法执行过程中的内存变化6.方法重载7.方法递归 1.方法的定义 格式： [修饰符列表] 返回值类型 方法名(形式参数列表){ 方法体; } 注意点： 修饰符是分选的，不是不选项 返回值类型是java中合法的数据类型，无返回值为void，有返回值时，必须有return 值; return;或 return 值;执行后，挡墙方法结束 方法名见名知意，小驼峰式 形参列表中的参数为局部变量，可以没有 publ
retrofit2.0+mvp 登录 demo
10-25
本篇将深入探讨基于`Retrofit2.0`和`MVP`架构的登录Demo，旨在为初学者提供一个清晰的理解和实践指南。`Retrofit`是一款优秀的网络请求库，它使得Android开发者能够方便地进行网络交互，而`MVP`（Model-View-...
RxJava整合Retrofit2.0网络框架
12-07
本文将深入探讨如何将RxJava与Retrofit2.0整合，以实现高效、灵活的网络请求，特别是在处理城市天气查询这类实时性较强的需求时。 首先，Retrofit是由Square公司开发的一款Android和Java的网络请求库，它通过注解的...
Android使用Retrofit2.0技术仿微信发说说
08-31
本篇文章主要探讨如何利用Retrofit2.0技术来仿照微信实现发送带有图片的说说功能，包括拍照、从图库选择图片以及上传多张图片。 首先，要集成Retrofit2.0到Android项目中，你需要在build.gradle文件中添加依赖项，...
详解Retrofit2.0 公共参数（固定参数）
08-27
Retrofit2.0 公共参数（固定参数） 在本篇文章中，我们将详细介绍Retrofit2.0中的公共参数（固定参数），包括什么是公共参数，如何在Retrofit2.0中实现公共参数，以及Interceptor的使用等。 什么是公共参数（固定...
Retrofit2使用CallAdapterFactory的错误处理
BoBoMEe
07-27 4121
## 概述 在使用Retrofit1的时候有一个类叫`ErrorHandler`,可以方便的定义自己的异常处理，但是在`Retrofit2`中是没有这个类的，详情见讨论：[How do we create ErrorHandler in retrofit 2.0? #1102](https://github.com/square/retrofit/issues/1102)
Retrofit(十) DefaultCallAdapterFactory & CallbackExecutor
zjuter的专栏
04-25 841
DefaultCallAdapterFactory , 是默认的CallAdapter。做了两件事情。 以OKHttp的方式执行Call， 也就是没有转换。 public @Nullable CallAdapter<?, ?> get( Type returnType, Annotation[] annotations, Retrofit retrofit) { if (getRawType(returnType) != Call.class) { .
处理Retrofit MalformedJsonException报错
技术小黑屋
03-10 663
使用Retrofit配合GsonConverter，我们能很好地将网络响应内容转换成对应的对象。比如像下面这样。 Retrofit网络接口方法 1 2 3 4 5 6 7 public interface DroidNetwork { @GET("/content/test.json") Call<DroidResponse> jsonData(); ...
Retrofit源码学习笔记（2）-CallAdapter解析
zzg080643的博客
01-11 1274
Retrofit允许各种第三方库来对返回的HTTP call进行操作。因此这就要求Retrofit给出一套机制来使得API 请求和现有的第三库进行无缝的链接。这个机制就是CallAdapter，它可以将返回的 http call进行处理，从而适应不同的操作。
我就简单理解一下Retrofit及其CallAdapter.Factory
Kelly
06-05 6286
前言 用了Retrofit这么久 ，感觉Retrofit的架构设计牛逼，是学习设计思想和设计模式的不二典范。但今天不是来详细分析这个框架的原理，主要简单了解下Retrofit的CallAdapter.Factory及怎么通过CallAdapter.Factory兼容OkHttp和RxJava。 OkHttpClient.Builder httpClient = new ...
Android解决bug的思路：追本溯源
程晨的博客
06-15 1215
Android开发中经常会遇到各种异常，如果在开发阶段还好，直接在log控制平台上捕获。万一要是遇到线上的问题，有的还真不好处理。不过呢，现在有好多第三方平台来供我们捕获线上的bug，比如友盟等。友盟的错误统计功能使用起来也非常方便，使用官方文档，相信大家都会集成。这个错误统计功能也非常强大，可以实时统计线上的各种bug，出现这种问题的机型，问题时间，APP版本号，次数等等，还有最重要的log日志了
Retrofit源码解析：RxJavaCallAdapterFactory
gengqiquan的博客
10-11 9974
上篇博客Retrofit源码解析我们讲到了retrofit所采用的注解方法会交由ServiceMethod的callAdapter 去进行层层解析，然后交由OkHttpCall 去执行具体的请求 并且这个callAdapter 是可以设置的使用rxjava的用户一般会设置RxJavaCallAdapterFactory.create())而如果用户如果不设置的话，retrofit会默认创建一个。创建
Retrofit的使用与深入学习（下）
evan_man的专栏
05-05 7573
注意：以下分析都是基于Retrofit2 转载请注明出处：http://blog.csdn.net/evan_man/article/details/51320408     本节是《Retrofit的使用与深入学习》的进阶版本，着重讲解一下Retrofit中的Converter.Factory和CallAdapter.Factory两个对象。正式介绍之前，首先回顾一下这两个抽
Retrofit2.0 公共参数详解与Interceptor应用
本文主要讲解了如何在Retrofit2.0中处理公共参数（固定参数），尤其是在那些需要对所有网络请求统一添加固定参数的情况下。Retrofit2.0原版中没有直接提供设置公共参数的方法，但可以通过实现RequestInterceptor接口...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值