原文出处:http://blog.chengyunfeng.com/?p=491&utm_source=tuicool&utm_medium=referral
Retrofit 和Java领域的ORM概念类似, ORM把结构化数据转换为Java对象,而Retrofit 把REST API返回的数据转化为Java对象方便操作。同时还封装了网络代码的调用。
例如:
定义上面的一个REST API接口。 该接口定义了一个函数 listRepos , 该函数会通过HTTP GET请求去访问服务器的/users/{user}/repos路径并把返回的结果封装为List<Repo> Java对象返回。
其中URL路径中的{user}的值为listRepos 函数中的参数 user的取值。
然后通过 Retrofit对象来生成一个 GitHubService
接口的实现;
获取接口的实现后就可以调用接口函数来和服务器交互了;
从上面的示例可以看出, Retrofit 使用注解来声明HTTP请求
- 支持 URL 参数替换和查询参数
- 返回结果转换为Java对象(返回结果可以为 JSON, protocol buffers)
- 支持 Multipart请求和文件上传
具体使用文档
函数和函数参数上的注解声明了请求方式
请求方式
每个函数都必须带有 HTTP 注解来表明请求方式和请求的URL路径。类库中有5个HTTP注解: GET
, POST
, PUT
, DELETE
, 和 HEAD。 注解中的参数为请求的相对URL路径。
在URL路径中也可以指定URL参数
URL处理
请求的URL可以根据函数参数动态更新。一个可替换的区块为用{
和 }
包围的字符串,而函数参数必需用 @Path
注解表明,并且注解的参数为同样的字符串
还支持查询参数
请求体(Request Body)
通过 @Body
注解可以声明一个对象作为请求体发送到服务器。
对象将被 RestAdapter
使用对应的转换器转换为字符串或者字节流提交到服务器。
FORM ENCODED AND MULTIPART 表单和Multipart
函数也可以注解为发送表单数据和multipart 数据
使用 @FormUrlEncoded
注解来发送表单数据;使用 @Field
注解和参数来指定每个表单项的Key,value为参数的值。
使用 @Multipart
注解来发送multipart数据。使用 @Part
注解定义要发送的每个文件。
Multipart 中的Part使用 RestAdapter
的转换器来转换,也可以实现 TypedOutput
来自己处理序列化。
异步 VS 同步
每个函数可以定义为异步或者同步。
对于Retrofit1.x版本,具有返回值的函数为同步执行的。
而异步执行函数没有返回值并且要求函数最后一个参数为Callback对象
对于Retrofit2.0版本,同步与异步的接口定义都一样
call.enqueue(new Callback<List<User>>() { @Override public void onResponse(Call<List<User>> call, Response<List<User>> response) { List<User> list = response.body(); } @Override public void onFailure(Call<List<User>> call, Throwable t) { } });
Response<List<User>> response = call.execute();
在 Android 上,callback对象会在主(UI)线程中调用。而在普通Java应用中,callback在请求执行的线程中调用。
服务器结果转换为Java对象
使用RestAdapter的转换器把HTTP请求结果(默认为JSON)转换为Java对象,Java对象通过函数返回值或者Callback接口定义
如果要直接获取HTTP返回的对象,使用 Response
对象。
项目主页: http://square.github.io/retrofit/
参考项目:http://square.github.io/okhttp/
Android 示例项目: https://github.com/goodev/RetrofitDemo
Read more: http://blog.chengyunfeng.com/?p=491#ixzz4I2DZWqwu