Retrofit初识

Retrofit

Retrofit是一套RESTful架构的Android(Java)客户端实现,基于注解,提供JSON to POJO(Plain Ordinary Java Object,简单Java对象),POJO to JSON,网络请求(POST,GET,PUT,DELETE等)封装。

相关资料:

RESTful百度百科

RESTful API设计

Retrofit 原理

Retrofit 简单使用

Retrofit Github工程地址

Retrofit 和Java领域的ORM概念类似, ORM把结构化数据转换为Java对象,而Retrofit 把REST API返回的数据转化为Java对象方便操作。同时还封装了网络代码的调用。

例如:

public interface GitHubService {
    @GET("/users/{user}/repos")
    List<Repo> listRepos(@Path("user") String user);
}

定义上面的一个REST API接口。 该接口定义了一个函数 listRepos ,该函数会通过HTTP GET请求去访问服务器的 /users/{user}/repos 路径并把返回的结果封装为 List<Repo> Java对象返回。

其中URL路径中的 {user} 的值为 listRepos 函数中的参数 user 的取值。

然后通过 RestAdapter 类来生成一个 GitHubService 接口的实现;

RestAdapter restAdapter = new RestAdapter.Builder()
    .setEndpoint("https://api.github.com")
    .build();
GitHubService service = restAdapter.create(GitHubService.class);

获取接口的实现后就可以调用接口函数来和服务器交互了;

List<Repo> repos = service.listRepos("octocat");

从上面的示例可以看出, Retrofit 使用注解来声明HTTP请求

  • 支持 URL 参数替换和查询参数
  • 返回结果转换为Java对象(返回结果可以为JSON, protocol buffers)
  • 支持 Multipart请求和文件上传

具体使用文档

函数和函数参数上的注解声明了请求方式

1、请求方式

每个函数都必须带有 HTTP 注解来表明请求方式和请求的URL路径。类库中有5个HTTP注解: GET , POST , PUT , DELETE 和 HEAD 。注解中的参数为请求的 相对URL路径 。

@GET("/users/list")

在URL路径中也可以指定URL参数

@GET("/users/list?sort=desc")

2、URL处理

请求的URL可以根据函数参数动态更新。一个可替换的区块为用 { 和 } 包围的字符串,而函数参数必需用 @Path 注解标明,并且 注解的参数为 同样的字符串

@GET("/group/{id}/users") //注意 字符串id
List<User> groupList(@Path("id") int groupId); //注意 Path注解的参数要和前面的字符串一样 id

还支持查询参数

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

3、请求体(Request Body)

通过 @Body 注解可以声明一个对象作为请求体发送到服务器。

@POST("/users/new")
void createUser(@Body User user, Callback<User> cb);

对象将被 RestAdapter 使用对应的转换器转换为字符串或者字节流提交到服务器。

4、FORM ENCODED AND MULTIPART 表单和Multipart

函数也可以注解为发送表单数据和multipart 数据

使用 @FormUrlEncoded 注解来发送表单数据;使用 @Field 注解和参数来指定每个表单项的Key,value为参数的值。

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

使用 @Multipart 注解来发送 multipart 数据。使用 @Part 注解定义要发送的每个文件。

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

Multipart 中的Part使用 RestAdapter 的转换器来转换,也可以实现TypedOutput 来自己处理序列化。

5、异步 VS 同步

每个函数可以定义为异步或者同步。

5.1、具有返回值的函数为同步执行的

@GET("/user/{id}/photo")
Photo listUsers(@Path("id") int id);

5.2、异步执行函数没有返回值并且要求函数最后一个参数为Callback对象

@GET("/user/{id}/photo")
void listUsers(@Path("id") int id, Callback<Photo> cb);
  • 在 Android 上,callback对象会在主(UI)线程中调用。
  • 在普通Java应用中,callback在请求执行的线程中调用。

6、服务器结果转换为Java对象

使用RestAdapter的转换器把HTTP请求结果(默认为JSON)转换为Java对象,Java对象通过函数返回值或者Callback接口指定

// 通过返回值指定要转换的Java的对象的类型
@GET("/users/list")
List<User> userList();
// 通过Callback的泛型参数来制定要转换的Java对象的类型
@GET("/users/list")
void userList(Callback<List<User>> cb);

7、如果要直接获取HTTP返回的对象,使用Response对象。

// 通过返回值的方式指定
@GET("/users/list")
Response userList();
// 通过Callback的泛型参数指定
@GET("/users/list")
void userList(Callback<Response> cb);

8、Retrofit涉及的重要知识点

  • 动态代理
  • 注解
  • Handler + MessageQueue + Thread + Looper机制
  • OKHttp请求网络
  • GSON用来转换Java POJO和解析JSON
时间: 2024-10-12 08:05:38

Retrofit初识的相关文章

Android 初识Retrofit

什么是 Retrofit ? Retrofit 是一套 RESTful 架构的 Android(Java) 客户端实现,基于注解,提供 JSON to POJO(Plain Ordinary Java Object ,简单 Java 对象),POJO to JSON,网络请求(POST,GET, PUT,DELETE 等)封装. 既然只是一个网络请求封装库,现在已经有了那么多的大家已经耳熟能详的网络请求封装库了,为什么还要介绍它呢,原因在于 Retrofit 是一套注解形的网络请求封装库,让我们

Android网络框架OkHttp之get请求(源码初识)

概括 OkHttp现在很火呀.于是上个星期就一直在学习OkHttp框架,虽然说起来已经有点晚上手了,貌似是2013年就推出了.但是现在它版本更加稳定了呀.这不,说着说着,OkHttp3.3版本在这几天又发布了.以下以OkHttp3.2版本为准,没办法,上个星期看的时候还是以3.2为最新版本的.首先,我们要先了解一些背景,OkHttp这个框架是有Square公司推出的,进入官网.如果想看API,点击进入API.大概了解了OkHttp之后,我们应该知道OkHttp是一个网络框架,想想以前在开发中,网

学会Retrofit+OkHttp+RxAndroid三剑客的使用,让自己紧跟Android潮流的步伐

转载请标明出处: http://blog.csdn.net/iamzgx/article/details/51607387 概括 在上一篇博客android网络框架OkHttp之get请求(源码初识) 讲解了OkHttp的简单使用和OkHttp源码的分析,主要讲解的还是理论上的知识,还是没有去实践下,那么这篇博客里面就来实践下.在上一篇博客里面说到了OkHttp类似HttpUrlConnection.按这样说的话,我们在项目中肯定还是要封装一层.如果嫌封装麻烦的话,也可以拿来主义,比如使用鸿洋大

Android之Http通信——1.初识Http协议

Android之Http通信--1.初识Http协议 引言: 今天是六一儿童节,先在这里给各位超龄儿童说声节日快乐哈~( ╯□╰ ),小猪也象征性地给群里的小朋友们派了红包-嗯,忙碌的五月最终过去了,做毕设,写论文,拍毕业照,答辩,辞职.各种各样的事,也算忙完了,好吧.小猪如今又在一家新的公司上班了.第三间公司了.你们肯定会认为小猪三心二意是吧,毕竟才差点儿相同毕业就换了那么多家公司,然后可能问我."小猪你什么时候跳第四间公司",哈哈,应该不会了哈,怎么说呢,事实上我还是非常专一的,毕

【腾讯Bugly干货】深入浅出 Retrofit,这么牛逼的框架你们还不来看看?

Android 开发中,从原生的 HttpUrlConnection 到经典的 Apache 的 HttpClient,再到对前面这些网络基础框架的封装,比如 Volley.Async Http Client,Http 相关开源框架的选择还是很多的,其中由著名的 Square 公司开源的 Retrofit 更是以其简易的接口配置.强大的扩展支持.优雅的代码结构受到大家的追捧.也正是由于 Square 家的框架一如既往的简洁优雅,所以我一直在想,Square 公司是不是只招处女座的程序员? 1.初

Android Retrofit 实现(图文上传)文字(参数)和多张图片一起上传

背景 在有心课堂<自己动手写HTTP框架>课程中有下列课程: 自拍要发朋友圈如何实现 http://stay4it.com/course/4/learn#lesson/208 通过自己写的HTTP框架实现将图片和文字等内容在一个接口中提交到服务器.无论哪种网络框架,都要遵守HTTP协议.下面我们简单了解下HTTP协议. HTTP协议 其中HTTP协议版本有两种:HTTP1.0/HTTP1.1 可以这样区别: HTTP1.0对于每个连接都的建立一次连接一次只能传送一个请求和响应,请求就会关闭,H

初识Python,望君多多关照

在学习Python之前,我们接触过数据结构和网页制作.前者让我们学习如何把C语言运用的更加整齐规范,而后者让我们亲身学习如何运用所学,制作一个静态网页.通过这些课程的学习,让我对C语言产生了比较大的压力,以至于对编程.对这学期的Python课程都有一种如临大敌的感觉. 但是真的学习了这门课程,体会了编码过程中的一些固定运用方法和套路之后,也许过程中对这门课程隐隐约约产生了一点点朦胧的感觉,仿佛他也并没有想象中的那么困难,起码现在的学习让我认为,他可能没有C语言那么繁琐和麻烦.当然,以一个初学者的

初识数组排序!!!!

<!doctype html> <html lang="en"> <head> <meta charset="UTF-8"> <title>初识数组排序</title> <!--调试成功--> <style type="text/css"> *{ padding:0; margin: 0; } li,ul{ list-style: none; } #p

初识操作系统和linux

初识操作系统和linux 1.计算机系统由硬件系统和软件系统两大部分组成:是一种能接收和存储信息,并按照存储在其内部的程序对海量数据进行自动.高速地处理,然后把处理结果输出的现代化智能电子设备. 2.世界上第一台计算机是1946年诞生在美国宾州大学. 3.冯·诺依曼体系结构:1946年数学家冯·诺依曼于提出计算机硬件系统由运算器.控制器.存储器.输入设备.输出设备.摩根定律:当价格不变时,集成电路上可容纳的元器件的数目,约每隔18-24个月便会增加一倍,性能也将提升一倍.现在计算机技术进本很难遵