Retrofit2.0使用过程中所踩到的坑

2024-08-31 15:32

本文主要是介绍Retrofit2.0使用过程中所踩到的坑,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

Retrofit2.0使用过程中所踩到的坑

转载请注明出处
作者:AboutJoke ( http://blog.csdn.net/u013200308 )
原文链接:http://blog.csdn.net/u013200308/article/details/52562722


简介

http://square.github.io/retrofit/ 官网

Retrofit2.0是Square公司的开源项目之一,Square还有众多的开源项目,推荐大家可以去GitHub上关注和学习。笔者对于Retrofit2.0也还处在学习过程中,更多的深层次的理解和认识推荐大家去鸿洋大神的博客学习。本篇博客主要介绍一下使用过程中所出现的一些问题,方便各位同学们去学习使用。


Retrofit的使用

Maven

<dependency><groupId>com.squareup.retrofit2</groupId><artifactId>retrofit</artifactId><version>2.1.0</version>
</dependency>

Gradle

compile ‘com.squareup.retrofit2:retrofit:2.1.0’


简单使用

retrofit的使用需要先定义一个接口对象来作为http请求的对象,我们先以官网的示例来做一个学习。
此处请求的接口地址是https://api.github.com/repos/square/retrofit/contributors

1.创建请求API接口
public interface ApiDemo {/***1.这里的url不可以用 / 来开头*2.这里{owner}起到的是占位的作用,即表示将被我们定义的owner代替*3.如我们所传递的参数是按照一定的顺序拼接在url后面则可以将占位省略掉*/@GET("repos/{owner}/{repo}/contributors")Call<String> simpleGet(@Path("owner") String owner,@Path("repo") String repo);}
2.实现Retrofit对象
        /***注意:这里所传递的url必须以 / 结尾*/Retrofit retrofit=new Retrofit.Builder().baseUrl("https://api.github.com/").addConverterFactory(ScalarsConverterFactory.create()).build();
3.调用http请求接口
ApiDemo apiDemo = retrofit.create(ApiDemo.class);Call<String> simpleGet = apiDemo.simpleGet("square", "retrofit");simpleGet.enqueue(new Callback<String>() {@Overridepublic void onResponse(Call<String> call, Response<String> response) {L.json(TAG,response.body().toString());}@Overridepublic void onFailure(Call<String> call, Throwable t) {L.e(t.toString());}});
4.结果

这里写图片描述

这样我们就完成了一次简单的get请求,但这个简单的请求也包含着一些坑,其中之一关于url的拼接已经在注释中说明。那么我是如何将获取到的json以string输出的呢?关键就在于 “addConverterFactory(ScalarsConverterFactory.create())”这句代码,添加了这个转换工厂后,就可以将我们获取的数据原样输出,从而方便去筛选需要的信息。“addConverterFactory”为我们提供了7种可以选择的格式:

  • 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-scalars

当然你想要使用哪种格式就需要去添加相应的依赖,如果上述的类型无法满足你的需求,你也可以去自定义,具体的就不在这里说了。


封装使用

可能很多人看了上面的使用过程后都会觉得很麻烦,不像其他的网络请求库,传入请求地址和参数后就可以使用,所以我们需要对retrofit做一定的封装来更加的方便我们的使用。

1.对Retrofit做封装
public class BaseRetrofit {private static String baseUrl = "https://api.github.com/";private static Retrofit stringRetrofit = new Retrofit.Builder().baseUrl(baseUrl).addConverterFactory(ScalarsConverterFactory.create()).addConverterFactory(GsonConverterFactory.create()).build();public static ApiDemo getService() {ApiDemo apiService = stringRetrofit.create(ApiDemo.class);return apiService;}
}
2.对CallBack做封装

这里对CallBack做封装的原因是,我们在使用过程中或多或少都会遇到网络请求失败的问题,比如404、超时等等。但是Retrofit并没有给我们提供一个很好的方式去操作,在源码的注释里也写到

An HTTP response may still indicate an application-level failure such as a 404 or 500.

这样就导致404的失败响应也出现在了“onResponse”方法中,而不是“onFailure”,而且如果不对返回的数据做处理的话可能会直接导致应用的崩溃。有些同学会说这些都是需要后台和服务器去处理的,于我们关系不大。诚然,在公司开发中会有人去处理相应的问题,但如果没有就需要我们自己去处理了。下面,我贴出我对应需求的代码,大家可以去按照自己的需求做更多的操作。

public abstract class MyCallBack<T extends BaseCallModel> implements Callback<T> {@Overridepublic void onResponse(Call<T> call, Response<T> response) {if (response.raw().code() == 200) {//200是服务器有合理响应String code = response.body().dec.getCode();if (code!=null) {if (code.equals("000000")) {onSuccess(response);} else {onFail(response.body().dec.getMsg());}}} else {//失败响应//这里可以按照自己的需求对返回的数据做一定的处理String s = response.errorBody().byteStream().toString();onFailure(call, new RuntimeException(s));}}@Overridepublic void onFailure(Call<T> call, Throwable t) {//网络问题走该回调//根据自己的需求可以去定义多种的错误方式,响应多种的操作if (t instanceof SocketTimeoutException) {//} else if (t instanceof ConnectException) {//} else if (t instanceof RuntimeException) {onError(t.getMessage());}}protected abstract void onError(String message);protected abstract void onSuccess(Response<T> response);protected abstract void onFail(String message);
}
3.具体的使用
APIService service = BaseRetrofit.getService();//这块的BaseCallModel是对返回数据的类型做了一定封装,大家可以按照自己的需求去实现Call<BaseCallModel<CashBean>> cashList = service.cashList("1", user_token, 1);cashList.enqueue(new MyCallBack<BaseCallModel<CashBean>>() {@Overrideprotected void onError(String message) {// 错误的响应}@Overridepublic void onSuccess(Response<BaseCallModel<CashBean>> response) {// 成功获取到数据}@Overridepublic void onFail(String message) {// 数据请求失败}});

从这里的代码已经可以看出和最开始的使用方式相比简洁了很多,而且经过我们的封装,使用起来也更加的便利。


图片上传

请求接口定义

    @Multipart@POST("user/avatar")//u_avatar为请求接口参数Call<String> upLoadIcon(@Part MultipartBody.Part u_avatar, @Part("u_id")RequestBody u_id, @Part("u_token") RequestBody u_token);

具体使用

File file = new File(Environment.getExternalStorageDirectory() + icon_url);RequestBody photoRequestBody = RequestBody.create(MediaType.parse("image/png/jpeg/jpg"), file);MultipartBody.Part u_avatar = MultipartBody.Part.createFormData("u_avatar", icon_name, photoRequestBody);APIService service = BaseRetrofit.getService();Call<String> Call = service.upLoadIc(u_avatar, RequestBody.create(null, user_id), RequestBody.create(null, user_token));

其他

  1. POST请求记得添加“@FormUrlEncoded”注解;
  2. 同步请求“execute()”记得在子线程中去使用;
  3. 无论同步还是异步每个call对象只能被执行一次,可通过“clone()”去创建一个相同的实例;Call<String> clone = simpleGet.clone();
  4. 不要忘记添加网络请求权限;

以后如果遇到其他的问题,我也会在此篇博文中进行更新。

这篇关于Retrofit2.0使用过程中所踩到的坑的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1124298

相关文章

SpringBoot线程池配置使用示例详解

《SpringBoot线程池配置使用示例详解》SpringBoot集成@Async注解,支持线程池参数配置(核心数、队列容量、拒绝策略等)及生命周期管理,结合监控与任务装饰器,提升异步处理效率与系统... 目录一、核心特性二、添加依赖三、参数详解四、配置线程池五、应用实践代码说明拒绝策略(Rejected

C++ Log4cpp跨平台日志库的使用小结

《C++Log4cpp跨平台日志库的使用小结》Log4cpp是c++类库,本文详细介绍了C++日志库log4cpp的使用方法,及设置日志输出格式和优先级,具有一定的参考价值,感兴趣的可以了解一下... 目录一、介绍1. log4cpp的日志方式2.设置日志输出的格式3. 设置日志的输出优先级二、Window

Ubuntu如何分配​​未使用的空间

《Ubuntu如何分配​​未使用的空间》Ubuntu磁盘空间不足,实际未分配空间8.2G因LVM卷组名称格式差异(双破折号误写)导致无法扩展,确认正确卷组名后,使用lvextend和resize2fs... 目录1:原因2:操作3:报错5:解决问题:确认卷组名称​6:再次操作7:验证扩展是否成功8:问题已解

Qt使用QSqlDatabase连接MySQL实现增删改查功能

《Qt使用QSqlDatabase连接MySQL实现增删改查功能》这篇文章主要为大家详细介绍了Qt如何使用QSqlDatabase连接MySQL实现增删改查功能,文中的示例代码讲解详细,感兴趣的小伙伴... 目录一、创建数据表二、连接mysql数据库三、封装成一个完整的轻量级 ORM 风格类3.1 表结构

使用Docker构建Python Flask程序的详细教程

《使用Docker构建PythonFlask程序的详细教程》在当今的软件开发领域,容器化技术正变得越来越流行,而Docker无疑是其中的佼佼者,本文我们就来聊聊如何使用Docker构建一个简单的Py... 目录引言一、准备工作二、创建 Flask 应用程序三、创建 dockerfile四、构建 Docker

Python使用vllm处理多模态数据的预处理技巧

《Python使用vllm处理多模态数据的预处理技巧》本文深入探讨了在Python环境下使用vLLM处理多模态数据的预处理技巧,我们将从基础概念出发,详细讲解文本、图像、音频等多模态数据的预处理方法,... 目录1. 背景介绍1.1 目的和范围1.2 预期读者1.3 文档结构概述1.4 术语表1.4.1 核

Python使用pip工具实现包自动更新的多种方法

《Python使用pip工具实现包自动更新的多种方法》本文深入探讨了使用Python的pip工具实现包自动更新的各种方法和技术,我们将从基础概念开始,逐步介绍手动更新方法、自动化脚本编写、结合CI/C... 目录1. 背景介绍1.1 目的和范围1.2 预期读者1.3 文档结构概述1.4 术语表1.4.1 核

Conda与Python venv虚拟环境的区别与使用方法详解

《Conda与Pythonvenv虚拟环境的区别与使用方法详解》随着Python社区的成长,虚拟环境的概念和技术也在不断发展,:本文主要介绍Conda与Pythonvenv虚拟环境的区别与使用... 目录前言一、Conda 与 python venv 的核心区别1. Conda 的特点2. Python v

Spring Boot中WebSocket常用使用方法详解

《SpringBoot中WebSocket常用使用方法详解》本文从WebSocket的基础概念出发,详细介绍了SpringBoot集成WebSocket的步骤,并重点讲解了常用的使用方法,包括简单消... 目录一、WebSocket基础概念1.1 什么是WebSocket1.2 WebSocket与HTTP

C#中Guid类使用小结

《C#中Guid类使用小结》本文主要介绍了C#中Guid类用于生成和操作128位的唯一标识符,用于数据库主键及分布式系统,支持通过NewGuid、Parse等方法生成,感兴趣的可以了解一下... 目录前言一、什么是 Guid二、生成 Guid1. 使用 Guid.NewGuid() 方法2. 从字符串创建