Retrofit框架使用笔记

2024-06-13 05:38
文章标签 使用 笔记 框架 retrofit

本文主要是介绍Retrofit框架使用笔记,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

Retrofit使用

写个笔记以后回顾,嘿嘿….

Retrofit作用就是方便的把数据自动封装成JAVA对象,把REST API返回的数据转化成JAVA对象.

背景:Square公司框架之一,内置okhttp框架

开源框架地址:https://github.com/square/retrofit
英文文档官网:http://square.github.io/retrofit/ (英文好的童鞋可以直接看这个就OK,o(╯□╰)o);
相关框架:
RxJava:https://github.com/ReactiveX/RxJava
(注:使用方法先参考http://blog.csdn.net/lzyzsd/article/details/41833541 这个是翻译的文章还可以)
okhttp:https://github.com/square/okhttp
(注:后续文章介绍)


好的进入正题:

Retrofit框架是用来请求数据的所以说主要分为两部分:1.发送请求 2.接收数据

使用的三个步骤:

  1. 使用注解方式标注请求模板接口.
  2. RestAdapter实例化请求接口(接口当然不能直接被实例化,这里内部是反射实现的代理).
  3. 最后调用请求模板接口的方法获取数据.

下面贴上快速上手使用的代码:

//1.使用注解方式标注请求模板接口.
public interface GitHubService {@GET("/users/{user}/repos")//URL相对路径List<Repo> listRepos(@Path("user") String user);//Repo是JSON封装成的JAVA对象
}//2.RestAdapter实例化(使用了建造者模式)
RestAdapter restAdapter = new RestAdapter.Builder().setEndpoint("https://api.github.com")//URL域名.build();GitHubService service = restAdapter.create(GitHubService.class);//3.最后调用请求模板接口的方法.
List<Repo> repos = service.listRepos("octocat");//List<Repo>就是返回的已封装好的请求数据

注:上面使用了github API,直接返回的就是JSON数据,参考网站:

是不是感觉使用起来很简洁.结合RxAndroid使用效果更好.

下面说下详细使用:

一.请求部分:

这个框架的请求方式是采用的注解方式指明请求相对路径框架,然后参数指明具体内容
请求方法有:GET, POST, PUT, DELETE, and HEAD(GET,POST最常用)

URL操作

{}中的表示待定参数,路径中的参数使用@Path(“XXX”)

@GET("/group/{id}/users")
List<User> groupList(@Path("id") int groupId);

@Query用于查询参数如同”?”作用

@GET("/group/{id}/users")
List<User> groupList(@Path("id") int groupId, @Query("sort") String sort);

@QueryMap用于有多个查询参数

@GET("/group/{id}/users")
List<User> groupList(@Path("id") int groupId, @QueryMap Map<String, String> options);
请求体(主要是用于@POST方式)
@POST("/users/new")
void createUser(@Body User user, Callback<User> cb);//Callback参数下面讲解
表单提交

@FormUrlEncoded注明是表单提交
@Field注明表单中的键,方法的参数就是值了噻.

@FormUrlEncoded
@POST("/user/edit")
User updateUser(@Field("first_name") String first, @Field("last_name") String last);

下面部分不太常用可以跳过
多部分提交
@Multipart 多部分
@PUT(“XXX”) 提交相对路径

@Multipart
@PUT("/user/photo")
User updateUser(@Part("photo") TypedFile photo, @Part("description") TypedString description);
请求头

@Headers(“”)请求头设置

@Headers("Cache-Control: max-age=640000")
@GET("/widget/list")
List<Widget> widgetList();

注:所有头都不会覆盖,同名的会一并提交
若请求头要被添加到每一个请求,可以通过RequestInterceptor对象指定,如下:

RequestInterceptor requestInterceptor = new RequestInterceptor() {@Overridepublic void intercept(RequestFacade request) {request.addHeader("User-Agent", "Retrofit-Sample-App");}
};RestAdapter restAdapter = new RestAdapter.Builder().setEndpoint("https://api.github.com").setRequestInterceptor(requestInterceptor).build();

Retrofit支持RxAndroid(RxJava家族中一员),可以优化异步操作.后续文章介绍

二:接收数据部分

有两种方式处理数据的方式
方式一:操作框架已经转换好的数据
1. 返回值为封装好的数据
2. 无返回值,有Callback类型的回调参数
3. 返回RxAndroid Observable对象

@GET("/users/list")
List<User> userList();@GET("/users/list")
void userList(Callback<List<User>> cb);@GET("/users/list")
Observable<List<User>> userList();@GET("/users/list")
Response userList();
Callback使用说明
//List<GithubClient.Contributor>是请求返回的数据callback = new Callback<List<GithubClient.Contributor>>() {@Overridepublic void success(List<GithubClient.Contributor> contributors, Response response) {Logger.d(GithubActivity.this.getClass().getCanonicalName(), contributors.size());}@Overridepublic void failure(RetrofitError error) {Logger.d("Activity", error.getMessage());}};GithubClient.getContributors(callback);

方式二:直接操作原始HTTP 响应数据

@GET("/users/list")
Response userList();@GET("/users/list")
void userList(Callback<Response> cb);@GET("/users/list")
Observable<Response> userList();
RestAdapter配置

json转换器
Retrofit默认使用GSON转换JSON数据
若想自定义GSON转换器请参考:https://sites.google.com/site/gson/gson-user-guide GSON官方文档

示例:

Gson gson = new GsonBuilder().setFieldNamingPolicy(FieldNamingPolicy.LOWER_CASE_WITH_UNDERSCORES).registerTypeAdapter(Date.class, new DateTypeAdapter()).create();RestAdapter restAdapter = new RestAdapter.Builder().setEndpoint("https://api.github.com").setConverter(new GsonConverter(gson)).build();GitHubService service = restAdapter.create(GitHubService.class);

其实自定义个GSON转换器都不太常用,可能我们更加需要XML转换器
框架源码里面示例实现了个SimpleXML转换器:github地址
使用了Simple框架
替换转换器代码

RestAdapter restAdapter = new RestAdapter.Builder().setEndpoint("https://api.soundcloud.com").setConverter(new SimpleXMLConverter()).build();SoundCloudService service = restAdapter.create(SoundCloudService.class);

框架实现的转换器列表地址

自定义错误处理器
需要实现ErrorHandler接口.

class MyErrorHandler implements ErrorHandler {@Override public Throwable handleError(RetrofitError cause) {Response r = cause.getResponse();if (r != null && r.getStatus() == 401) {return new UnauthorizedException(cause);}return cause;}
}RestAdapter restAdapter = new RestAdapter.Builder().setEndpoint("https://api.github.com").setErrorHandler(new MyErrorHandler()).build();

注:被检测的错误,必须被声明在接口中,最好如同上面代码做的那样传递cause对象.

日志
为了更详细查看请求和响应,你可以直接在RestAdapter调用日志级别方法,四个等级
BASIC, FULL, HEADERS, and NONE.代码如下:

RestAdapter restAdapter = new RestAdapter.Builder().setLogLevel(RestAdapter.LogLevel.FULL).setEndpoint("https://api.github.com").build();

注:这当然是调试阶段使用,后面记得删了.

JAR下载:地址
Maven:

<dependency><groupId>com.squareup.retrofit</groupId><artifactId>retrofit</artifactId><version>(insert latest version)</version>
</dependency>

Gradle

compile 'com.squareup.retrofit:retrofit:(insert latest version)'

自动使用okhttp框架
maven

<dependency><groupId>com.squareup.okhttp</groupId><artifactId>okhttp</artifactId><version>2.0.0</version>
</dependency>

gradle

compile 'com.squareup.okhttp:okhttp-urlconnection:2.0.0'
compile 'com.squareup.okhttp:okhttp:2.0.0'

最后献上相关文章:

retrofit实现分析

这篇关于Retrofit框架使用笔记的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



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

相关文章

中文分词jieba库的使用与实景应用(一)

知识星球:https://articles.zsxq.com/id_fxvgc803qmr2.html 目录 一.定义: 精确模式(默认模式): 全模式: 搜索引擎模式: paddle 模式(基于深度学习的分词模式): 二 自定义词典 三.文本解析   调整词出现的频率 四. 关键词提取 A. 基于TF-IDF算法的关键词提取 B. 基于TextRank算法的关键词提取

使用SecondaryNameNode恢复NameNode的数据

1)需求: NameNode进程挂了并且存储的数据也丢失了,如何恢复NameNode 此种方式恢复的数据可能存在小部分数据的丢失。 2)故障模拟 (1)kill -9 NameNode进程 [lytfly@hadoop102 current]$ kill -9 19886 (2)删除NameNode存储的数据(/opt/module/hadoop-3.1.4/data/tmp/dfs/na

Hadoop数据压缩使用介绍

一、压缩原则 (1)运算密集型的Job,少用压缩 (2)IO密集型的Job,多用压缩 二、压缩算法比较 三、压缩位置选择 四、压缩参数配置 1)为了支持多种压缩/解压缩算法,Hadoop引入了编码/解码器 2)要在Hadoop中启用压缩,可以配置如下参数

Makefile简明使用教程

文章目录 规则makefile文件的基本语法:加在命令前的特殊符号:.PHONY伪目标: Makefilev1 直观写法v2 加上中间过程v3 伪目标v4 变量 make 选项-f-n-C Make 是一种流行的构建工具,常用于将源代码转换成可执行文件或者其他形式的输出文件(如库文件、文档等)。Make 可以自动化地执行编译、链接等一系列操作。 规则 makefile文件

使用opencv优化图片(画面变清晰)

文章目录 需求影响照片清晰度的因素 实现降噪测试代码 锐化空间锐化Unsharp Masking频率域锐化对比测试 对比度增强常用算法对比测试 需求 对图像进行优化,使其看起来更清晰,同时保持尺寸不变,通常涉及到图像处理技术如锐化、降噪、对比度增强等 影响照片清晰度的因素 影响照片清晰度的因素有很多,主要可以从以下几个方面来分析 1. 拍摄设备 相机传感器:相机传

pdfmake生成pdf的使用

实际项目中有时会有根据填写的表单数据或者其他格式的数据,将数据自动填充到pdf文件中根据固定模板生成pdf文件的需求 文章目录 利用pdfmake生成pdf文件1.下载安装pdfmake第三方包2.封装生成pdf文件的共用配置3.生成pdf文件的文件模板内容4.调用方法生成pdf 利用pdfmake生成pdf文件 1.下载安装pdfmake第三方包 npm i pdfma

零基础学习Redis(10) -- zset类型命令使用

zset是有序集合,内部除了存储元素外,还会存储一个score,存储在zset中的元素会按照score的大小升序排列,不同元素的score可以重复,score相同的元素会按照元素的字典序排列。 1. zset常用命令 1.1 zadd  zadd key [NX | XX] [GT | LT]   [CH] [INCR] score member [score member ...]

git使用的说明总结

Git使用说明 下载安装(下载地址) macOS: Git - Downloading macOS Windows: Git - Downloading Windows Linux/Unix: Git (git-scm.com) 创建新仓库 本地创建新仓库:创建新文件夹,进入文件夹目录,执行指令 git init ,用以创建新的git 克隆仓库 执行指令用以创建一个本地仓库的

【学习笔记】 陈强-机器学习-Python-Ch15 人工神经网络(1)sklearn

系列文章目录 监督学习:参数方法 【学习笔记】 陈强-机器学习-Python-Ch4 线性回归 【学习笔记】 陈强-机器学习-Python-Ch5 逻辑回归 【课后题练习】 陈强-机器学习-Python-Ch5 逻辑回归(SAheart.csv) 【学习笔记】 陈强-机器学习-Python-Ch6 多项逻辑回归 【学习笔记 及 课后题练习】 陈强-机器学习-Python-Ch7 判别分析 【学

系统架构师考试学习笔记第三篇——架构设计高级知识(20)通信系统架构设计理论与实践

本章知识考点:         第20课时主要学习通信系统架构设计的理论和工作中的实践。根据新版考试大纲,本课时知识点会涉及案例分析题(25分),而在历年考试中,案例题对该部分内容的考查并不多,虽在综合知识选择题目中经常考查,但分值也不高。本课时内容侧重于对知识点的记忆和理解,按照以往的出题规律,通信系统架构设计基础知识点多来源于教材内的基础网络设备、网络架构和教材外最新时事热点技术。本课时知识