转：使用AndroidAPI最佳实践

原文来自于&＃xff1a;http://blog.jobbole.com/65170/

写在前面

现在&＃xff0c;Android应用程序中集成第三方API已十分流行。应用程序都有自己的网络操作和缓存处理机制&＃xff0c;但是大部分比较脆弱&＃xff0c;没有针对网络糟糕情况进行优化。感谢Square lnc 这家有创新精神的公司&＃xff0c;将信用卡商业交易带到手机上。现在有了一系列高质量开源库&＃xff0c;支持在Android应用程序中集成。

做什么&＃xff0c;如何做&＃xff1f;

现在&＃xff0c;我们要依次学习使用Retrofit、OKHttp和GSON&＃xff0c;简单快速的集成REST API。使用这个组合&＃xff0c;我们需要从Twitch.tv下载并解析一些数据。跟着下面的步骤可以在几分钟内&＃xff0c;不用写繁琐的模板代码&＃xff0c;完成大部分的REST API集成。

学习

Retrofit

Retrofit简化了从Web API下载数据&＃xff0c;解析成普通的Java对象&＃xff08;POJO&＃xff09;。例如&＃xff0c;要从Github 上下载用户仓库的信息&＃xff0c;你只需要编写下面的几行&＃xff1a;

另外&＃xff0c;你需要创建仓库信息类和数据类型。这些代码也可以自动生成&＃xff0c;下面会介绍如何自动生成。

整个过程很简单&＃xff0c;类似发送一次有参数的请求或发送POST或HEAD。如何连接不同类型的API&＃xff0c;请查看说明文当。

Retrofit的特性之一可以将处理逻辑添加到请求和响应中。你可以添加数据到http请求头部&＃xff0c;也可以拦截验证失败的响应重定向到登录界面。

OKHttp

OKHttp是Android版Http客户端。非常高效&＃xff0c;支持SPDY、连接池、GZIP和 HTTP 缓存。默认情况下&＃xff0c;OKHttp会自动处理常见的网络问题&＃xff0c;像二次连接、SSL的握手问题。如果你的应用程序中集成了OKHttp&＃xff0c;Retrofit默认会使用OKHttp处理其他网络层请求。

GSON

GSON是将JSON解析成POJO的Java库。GSON也可以将POJO解析成JSON。在Android中&＃xff0c;数据对象存储在SharePreference更加方便。

要使用GSON&＃xff0c;首先需要创建相应的POJO数据&＃xff0c;再用GSON解析为POJO对象。解析过程简单且非常高效。需要了解如何创建可以被GSON解析的POJO对象&＃xff0c;请查看说明文档。Retrofit使用GSON解析JSON数据。

开始Coding

添加库文件到工程

1. 下载Retrofit、OKHttp、GSON库文件。
2. 逐个添加jar文件到你的工程中。
3. 如果使用Android Studio&＃xff0c;可以使用gradle同步这个工程。

查找或者编写API

你可能已有一份API&＃xff0c;如果你还在寻找API目录&＃xff0c;我推荐ProgrammableWeb。在这个教程中&＃xff0c;我们会解析Twitch.Tv的数据流。请求格式请参考说明手册。Twicht.tv请求数据流的JSON格式&＃xff1a;
http://api.justin.tv/api/stream/list.json

展示输出

展示一些API返回的数据&＃xff0c;下面的示例是由于是一个GET请求&＃xff0c;只能在浏览器中运行&＃xff0c;返回数据如下&＃xff1a;

创建POJO

这部分很有趣&＃xff0c;用我们获取到的数据自动创建对应的POJO。使用jsonschema2pojo&＃xff0c;导入包名、类名和JSON数据&＃xff0c;保存为私有类型。示例中展示的构造器无法使用&＃xff0c;因为JSON数据的根元素是个数组&＃xff0c;不是对象。所以我只贴出了数组的第一个元素。展示相关的图片示例。

集成POJOs

将自动产生的POJOs粘贴到工程中就可以了。在我的示例工程中&＃xff0c;他们在models包中。

使用Retrofit下载&＃xff08;解析&＃xff09;API

创建REST Adapter

创建Adapter&＃xff0c;类似设置endPoint。

定义API接口

为需要连接的endPoint定义接口。下面示例中&＃xff0c;使用limit和offset&＃xff0c;这两个参数用来控制请求数据位置和大小。详细说明请参考API文档。

你可能会注意到&＃xff0c;我们期望返回的是一组JustinTvStreamData对象&＃xff0c;也就是我们刚才自动产生的POJO。关于如何定义这个接口的更多信息&＃xff0c;请参考Retrofit说明文档。

创建Twitch.tv 服务

现在我们已经建立了endPoint&＃xff0c;定义了需要的接口。下面需要创建Twitch.TV服务&＃xff0c;发送请求。

使用API

发送API请求十分简单&＃xff0c;只需要使用刚才创建的服务即可。

这里有一点需要注意&＃xff0c;Retrofit会在后台线程下载并解析API数据&＃xff0c;根据结果不同&＃xff08;成功或失败&＃xff09;发送到UI线程。Retrofit也支持在后台自动下载&＃xff08;这里没有显示&＃xff09;。

数据处理趣事

现在我们用POJO数据做一些有趣的事情。在这个Demo中&＃xff0c;展示了Twitch.Tv频道的图片和描述&＃xff0c;使用Picasso Library 下载缓存图片。

参考代码

示例代码下载。

原文链接&＃xff1a; meetme   翻译&＃xff1a; 伯乐在线 - imesong

译文链接&＃xff1a; http://blog.jobbole.com/65170/
[ 转载必须在正文中标注并保留原文链接、译文链接和译者等信息。]