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

相关文章

Spring IoC 容器的使用详解(最新整理)

《SpringIoC容器的使用详解(最新整理)》文章介绍了Spring框架中的应用分层思想与IoC容器原理,通过分层解耦业务逻辑、数据访问等模块,IoC容器利用@Component注解管理Bean... 目录1. 应用分层2. IoC 的介绍3. IoC 容器的使用3.1. bean 的存储3.2. 方法注

Python内置函数之classmethod函数使用详解

《Python内置函数之classmethod函数使用详解》:本文主要介绍Python内置函数之classmethod函数使用方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地... 目录1. 类方法定义与基本语法2. 类方法 vs 实例方法 vs 静态方法3. 核心特性与用法(1编程客

Java进程异常故障定位及排查过程

《Java进程异常故障定位及排查过程》:本文主要介绍Java进程异常故障定位及排查过程,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录一、故障发现与初步判断1. 监控系统告警2. 日志初步分析二、核心排查工具与步骤1. 进程状态检查2. CPU 飙升问题3. 内存

Linux中压缩、网络传输与系统监控工具的使用完整指南

《Linux中压缩、网络传输与系统监控工具的使用完整指南》在Linux系统管理中,压缩与传输工具是数据备份和远程协作的桥梁,而系统监控工具则是保障服务器稳定运行的眼睛,下面小编就来和大家详细介绍一下它... 目录引言一、压缩与解压:数据存储与传输的优化核心1. zip/unzip:通用压缩格式的便捷操作2.

使用Python实现可恢复式多线程下载器

《使用Python实现可恢复式多线程下载器》在数字时代,大文件下载已成为日常操作,本文将手把手教你用Python打造专业级下载器,实现断点续传,多线程加速,速度限制等功能,感兴趣的小伙伴可以了解下... 目录一、智能续传:从崩溃边缘抢救进度二、多线程加速:榨干网络带宽三、速度控制:做网络的好邻居四、终端交互

Python中注释使用方法举例详解

《Python中注释使用方法举例详解》在Python编程语言中注释是必不可少的一部分,它有助于提高代码的可读性和维护性,:本文主要介绍Python中注释使用方法的相关资料,需要的朋友可以参考下... 目录一、前言二、什么是注释?示例:三、单行注释语法:以 China编程# 开头,后面的内容为注释内容示例:示例:四

SpringBoot整合liteflow的详细过程

《SpringBoot整合liteflow的详细过程》:本文主要介绍SpringBoot整合liteflow的详细过程,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋...  liteflow 是什么? 能做什么?总之一句话:能帮你规范写代码逻辑 ,编排并解耦业务逻辑,代码

Java中调用数据库存储过程的示例代码

《Java中调用数据库存储过程的示例代码》本文介绍Java通过JDBC调用数据库存储过程的方法,涵盖参数类型、执行步骤及数据库差异,需注意异常处理与资源管理,以优化性能并实现复杂业务逻辑,感兴趣的朋友... 目录一、存储过程概述二、Java调用存储过程的基本javascript步骤三、Java调用存储过程示

Go语言数据库编程GORM 的基本使用详解

《Go语言数据库编程GORM的基本使用详解》GORM是Go语言流行的ORM框架,封装database/sql,支持自动迁移、关联、事务等,提供CRUD、条件查询、钩子函数、日志等功能,简化数据库操作... 目录一、安装与初始化1. 安装 GORM 及数据库驱动2. 建立数据库连接二、定义模型结构体三、自动迁

ModelMapper基本使用和常见场景示例详解

《ModelMapper基本使用和常见场景示例详解》ModelMapper是Java对象映射库,支持自动映射、自定义规则、集合转换及高级配置(如匹配策略、转换器),可集成SpringBoot,减少样板... 目录1. 添加依赖2. 基本用法示例:简单对象映射3. 自定义映射规则4. 集合映射5. 高级配置匹