【开源项目12】Retrofit – Java(Android) 的REST 接口封装类库
Retrofit官网:http://square.github.io/retrofit/
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
接口的实现;
GitHubService service = restAdapter.create(GitHubService.class);
获取接口的实现后就可以调用接口函数来和服务器交互了;
List<Repo> repos = service.listRepos("octocat");
从上面的示例可以看出, Retrofit 使用注解来声明HTTP请求
- 支持 URL 参数替换和查询参数
- 返回结果转换为Java对象(返回结果可以为 JSON, protocol buffers)
- 支持 Multipart请求和文件上传
具体使用文档
函数和函数参数上的注解声明了请求方式
请求方式
每个函数都必须带有 HTTP 注解来表明请求方式和请求的URL路径。类库中有5个HTTP注解: GET
, POST
, PUT
, DELETE
, 和 HEAD。 注解中的参数为请求的相对URL路径。
@GET("/users/list")
在URL路径中也可以指定URL参数
@GET("/users/list?sort=desc")
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);
请求体(Request Body)
通过 @Body
注解可以声明一个对象作为请求体发送到服务器。
@POST("/users/new") void createUser(@Body User user, Callback<User> cb);
对象将被 RestAdapter
使用对应的转换器转换为字符串或者字节流提交到服务器。
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
来自己处理序列化。
异步 VS 同步
每个函数可以定义为异步或者同步。
具有返回值的函数为同步执行的。
@GET("/user/{id}/photo") Photo listUsers(@Path("id") int id);
而异步执行函数没有返回值并且要求函数最后一个参数为Callback对象
@GET("/user/{id}/photo") void listUsers(@Path("id") int id, Callback<Photo> cb);
在 Android 上,callback对象会在主(UI)线程中调用。而在普通Java应用中,callback在请求执行的线程中调用。
服务器结果转换为Java对象
使用RestAdapter的转换器把HTTP请求结果(默认为JSON)转换为Java对象,Java对象通过函数返回值或者Callback接口定义
@GET("/users/list") List<User> userList();@GET("/users/list") void userList(Callback<List<User>> cb);
如果要直接获取HTTP返回的对象,使用 Response
对象。
@GET("/users/list") Response userList();@GET("/users/list") void userList(Callback<Response> cb);
项目主页: http://square.github.io/retrofit/
参考项目: http://square.github.io/okhttp/
Android 示例项目: https://github.com/goodev/RetrofitDemo
转载于:https://www.cnblogs.com/dongdong230/p/4195375.html
【开源项目12】Retrofit – Java(Android) 的REST 接口封装类库相关推荐
- 阿里巴巴开源项目汇总-(JAVA)
来源:https://segmentfault.com/a/1190000017346799 1.分布式应用服务开发的一站式解决方案 Spring Cloud Alibaba Spring Cloud ...
- android 4k播放器开源项目,这15个Android开源库,只有经常逛Github的才知道!
哈喽,大家好,我是西哥! 又到了大家最喜欢了的环节--开源库推荐,前面为大家推荐了我收藏的一些非常酷的开源库,受到大家一致好评,还没看过的,请移步至: 本期又为大家带来了哪些有趣的库呢?本期为大家精选 ...
- 使用spring-loaded开源项目,实现java程序和web应用的热部署
2019独角兽企业重金招聘Python工程师标准>>> JDK1.5之后提供了java.lang.instrument.Instrumentation,即java agent机制能够 ...
- React Native开源项目-稀土掘金客户端(Android、iOS双适配)
@wangdicoder开发的基于React-Native实现的稀土掘金客户端,开源地址:https://github.com/wangdicoder/JueJinClient 欢迎大家star,fo ...
- 2021.12.9 java代码对接sap接口(soap协议、webservice)
2021.12.9 java对接sap接口(soap协议.webservice) 问题:对接sap接口,代码调试 执行: 1.soapui 软件测试是否能正确访问 未能正确访问,因为未在本地配置域名映 ...
- 流媒体方案,技术开源项目,包含Java调用FFMpeg(FFCH4J),推拉流服务器,nginx-http-flv-module,ckplayer,Flv.js,EasyPlayer.js集成
文章目录 streaming_media 介绍 ckplayer拉流播放 软件介绍 功能介绍 软件架构 安装教程 使用说明 EasyPlayer.js拉流播放 简介 功能说明 集成使用示例 普通集成 ...
- 推荐两个高仿抖音 GitHub 开源项目( iOS 和 Android)
人工智能(Artificial Intelligence),英文缩写为AI.它是研究.开发用于模拟.延伸和扩展人的智能的理论.方法.技术及应用系统的一门新的技术科学. 抖音短视频 App 火速爆红,没 ...
- java人工智能开源项目_用Java开源项目JOONE实现人工智能编程
很少有程序员不对这里或者那里所包含的人工智能编程所吸引,然而,许多对AI感兴趣的程序员很快就因其中包含的算法的复杂性而退却.在本文中,我们将讨论一个能大大简化这种复杂性的Java开源工程. Java面 ...
- 基于java斗地主_码云推荐开源项目丨 用 Java 写了一个控制台玩的斗地主
这是什么? 这是一场对抗地主的游戏 不同的是 它可以在命令行中进行 如何入门? Maven 打包 git clone https://github.com/ainilili/ratel.git cd ...
最新文章
- java 文件下载 【学习记录】
- 【时间序列】最完整的时间序列分析和预测(含实例及代码)
- ASP.NET Core之跨平台的实时性能监控
- 单值二叉树:如果二叉树每个节点都具有相同的值,那么该二叉树就是单值二叉树。 只有给定的树是单值二叉树时,才返回 true;否则返回 false。
- ORA-02266错误处理
- iPhone 13 Pro全新配色曝光:全新“磨砂黑”致敬经典
- visio绘图与processon绘图比较
- 简述计算机维修 维护的基本原则是什么,计算机硬件维护的四大原则
- PC网站接入微信登陆流程一:微信开放平台账号注册和开发者资质认证
- Django发送邮件(附代码)
- 计算机开机键盘屏幕无反应,电脑开机后键盘显示器无反应怎么解决
- 一种电池过放电保护电路
- Cisco 3850 Mgmt VRF Configuration
- easypoi 语法_请问英语如何学习语法?
- arduino电子时钟 简易版
- css 图片变大缩小,css3实现图片的变大变小
- 软件需求工程一些概念
- 用MATLAB AppDesigner开发了一款的高级日期时间计算器(Advanced Date Time Calculator)
- 【洛谷P5514】永夜的报应【模拟】
- fastreport 上一行_市、县人大常委会领导一行对公司环保工作进行督查