retrofit把你的HTTP API改造成java接口。

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

Retrofit类实现了GithubService接口。

Retrofit retrofit = new Retrofit.Builder()
.baseUrl("https://api.github.com")
.build(); GitHubService service = retrofit.create(GitHubService.class);

这样就实现并创建了一个GithubService实例。

这个实例每次调用create方法都会创建一个同步或异步的远程网络服务。

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

使用注解来描述这个HTTP请求:

支持URL参数与数组参数。

支持request body添加Object参数(比如JSON,protocol buffers)

支持Multipart requeset body与文件上传。

注意:这一部分还在2.0 AIPs 后不断拓展。

声明

接口方法的注释与参数表明了该请求应如何处理。

请求方式

每一个请求都必须有描述请求方式及请求地址的HTTP注释。

@GET("users/list")

你也可以在URL中添加参数。

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

URL处理

请求可以通过在url中使用置换块实现动态更新参数。置换块是使用被{}包裹的含有字母、数字的字符串。相应的参数必须通过@Path注释 参数名与之前的字符串相同。

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

数组参数也可以被这样添加。

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

复杂的数组参数可以通过Map组合实现。

@GET("group/{id}/users")
Call<List<User>> groupList(@Path("id") int groupId, @QueryMap Map<String, String> options);

REQUEST BODY

一个object对象可以通过 @Body 注释 来被指定为 request body。

@POST("users/new")
Call<User> createUser(@Body User user);

这个object将会被Retrofit实例指定的的转换器所转换。如果Retrofit实例没有添加转换器,就只能使用 RequestBody。

FORM ENCODED AND MULTIPART

方法也可声明发送 form-encoded 和 multipart data。

当在方法中出现@FormUrlEncoded时会发送form-encoded data。每一个键值对通过 @Field 注释来提供name与object的值。

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

Multipart 部分使用Retrofit的一个转换器或者通过实现RequestBody去实现他们自己的序列化。

HEADER MANIPULATION

你可以通过使用@Headers注释为一个方法设置统一的headers

@Headers("Cache-Control: max-age=640000")
@GET("widget/list")
Call<List<Widget>> widgetList();
@Headers({
"Accept: application/vnd.github.v3.full+json",
"User-Agent: Retrofit-Sample-App"
})
@GET("users/{username}")
Call<User> getUser(@Path("username") String username);

注意headers都不会进行覆盖。相同名字的headers都会包含在请求中。

一个请求的Header 可以通过使用@Header注释来实现动态更新。必须为@Header注释提供对应的参数。如果参数值为null,这个header将会被忽略。反之,将会使用参数的toString方法的输出作为参数的值。

@GET("user")
Call<User> getUser(@Header("Authorization") String authorization)


使用 OkHttp interceptor为每一个请求添加相同的headers。

同步与异步

每一个请求的实例都可以同步或异步执行。每一个实例都只能被执行一次,但是可以通过执行clone()方法创建一个新的可使用的实例。

在Android里,回调将会主线程中执行。在jvm,回调将在执行http请求的线程中被执行。

Retrofit 是一个通过你的API接口转变成可调用对象的类。默认的,retrofit将会给你一个稳健的默认实现但也允许你进行定制。

转换器

默认的,Retrofit只能反序列化HTTP bodies到OkHttp's ResponseBody类型中并且他只能接受其 RequestBody 类型通过 @Body。

添加转换器可以让它支持其他类型。有六种支持库。

  • Gsoncom.squareup.retrofit2:converter-gson
  • Jacksoncom.squareup.retrofit2:converter-jackson
  • Moshicom.squareup.retrofit2:converter-moshi
  • Protobufcom.squareup.retrofit2:converter-protobuf
  • Wirecom.squareup.retrofit2:converter-wire
  • Simple XMLcom.squareup.retrofit2:converter-simplexml
  • Scalars (primitives, boxed, and String): com.squareup.retrofit2:converter-scalars

这里有一个使用 GsonConvertreFactory 类去生成一个使用Gson进行反序列化的GitHubService实现类的例子。

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

自定义转换器

如果你需要与一个Retrofit不支持且使用content-format的API通信(如 YAML,txt,自定义格式)或者你希望同一个不同的库来实现已存在的格式,又可以简单的创建你自己的转换器。创建一个继承与 Converter.Factory的类并在创建适配器是将其实例传入。

初步阅读完毕,我要开始进行实践了。

原文地址点这里

Retrofit学习笔记01的更多相关文章

  1. 软件测试之loadrunner学习笔记-01事务

    loadrunner学习笔记-01事务<转载至网络> 事务又称为Transaction,事务是一个点为了衡量某个action的性能,需要在开始和结束位置插入一个范围,定义这样一个事务. 作 ...

  2. C++ GUI Qt4学习笔记01

    C++ GUI Qt4学习笔记01   qtc++signalmakefile文档平台 这一章介绍了如何把基本的C++只是与Qt所提供的功能组合起来创建一些简单的图形用户界面应用程序. 引入两个重要概 ...

  3. SaToken学习笔记-01

    SaToken学习笔记-01 SaToken版本为1.18 如果有排版方面的错误,请查看:传送门 springboot集成 根据官网步骤maven导入依赖 <dependency> < ...

  4. Redis:学习笔记-01

    Redis:学习笔记-01 该部分内容,参考了 bilibili 上讲解 Redis 中,观看数最多的课程 Redis最新超详细版教程通俗易懂,来自 UP主 遇见狂神说 1. Redis入门 2.1 ...

  5. PHP 学习笔记 01

    例子: 为什么要学PHP 主观原因: 前段时间在学校处理了毕业的一些事情,回到上海后开始了找工作的旅程.意向工作是WPF开发或者ASP.NET 作为后端的WEB开发. 陆陆续续一直在面试,其中有一家公 ...

  6. vue.js 2.0 官方文档学习笔记 —— 01. vue 介绍

    这是我的vue.js 2.0的学习笔记,采取了将官方文档中的代码集中到一个文件的形式.目的是保存下来,方便自己查阅. !官方文档:https://cn.vuejs.org/v2/guide/ 01. ...

  7. xml基础学习笔记01

    注意:刚刚看了网上对于XML中的标签,节点和元素?到底应该怎么表述?起初我也有这个疑惑,现在我的想法是:下面出现node的应称作节点,节点对象.element应称作元素,毕竟这更符合英文的本意.至于标 ...

  8. Ext.Net学习笔记01:在ASP.NET WebForm中使用Ext.Net

    Ext.Net是一个对ExtJS进行封装了的.net控件库,可以在ASP.NET WebForm和MVC中使用.从今天开始记录我的学习笔记,这是第一篇,今天学习了如何在WebForm中使用Ext.Ne ...

  9. FPGA-VHDL课堂学习笔记*01

    FPGA-VHDL课堂学习笔记 记录说明:本文档主要记录大学期间,老师FPGA授课课堂笔记. 代码语言:VHDL 编程软件:MAX+plus II FPGA硬件:FLE-843 03月05日  理论课 ...

随机推荐

  1. http_load

    wget http://acme.com/software/http_load/http_load-12mar2006.tar.gz

  2. hibernate3 所需的jar包

  3. java中的foreach循环

    foreach语句是java5的新特征之一,在遍历数组.集合方面,foreach为开发人员提供了极大的方便. foreach语句是for语句的特殊简化版本,但是foreach语句并不能完全取代for语 ...

  4. http 301和302的区别

    1.什么是301转向?什么是301重定向? 301转向(或叫301重定向,301跳转)是当用户或搜索引擎向网站服务器发出浏览请求时,服务器返回的HTTP数据流中头信息(header)中的状态码的一种, ...

  5. 2.4G/5G频段WLAN的模式、带宽、协商速率

    2.4G频段 5G频段

  6. AmazeUI定制

    定制流程 下载 Amaze UI 源码:从 GitHub 选择版本,点击 Source code (zip) 下载并解压(定制只适用于 Amaze UI 2.x): 下载安装 Node.js: 全局安 ...

  7. POJ 题目3280 Cheapest Palindrome(区间DP)

    Cheapest Palindrome Time Limit: 2000MS   Memory Limit: 65536K Total Submissions: 7148   Accepted: 34 ...

  8. Android 中dp和px

    dp是虚拟像素,在不同的像素密度的设备上会自动适配,比如: 在320x480分辨率,像素密度为160,1dp=1px 在480x800分辨率,像素密度为240,1dp=1.5px 计算公式: 1dp* ...

  9. Android -- 关闭AsyncTask(异步任务)

    前面说了如何操作AsyncTask,这篇我们来说一下如何关闭AsyncTask. 有人就问了:为什么要关闭AsyncTask呢?很简单,AsyncTask 是在后台执行耗时操作(获取数据),当你离开当 ...

  10. 我们的html

    http://files.cnblogs.com/files/eeroom/mac-Bootstrap.rar http://files.cnblogs.com/files/eeroom/CSharp ...