Retro是一个类型安全的REST客户端，它可以直接解析JSON数据变成JAVA对象，甚至支持回调操作，处理不同的结果，本文将以IP地址API数据解析为例，讲解如何使用Retrofit
本文适用于2.0以下的版本，目前1.9还是主流，此文章将渐渐成为历史
将要使用的网站
文章目录
JSON数据如何转成JAVA
Retrofit同步获取方法
Retrofit异步回调方法
JSON数据如何转成JAVA
打开了刚刚引用的API查询网页，那个网页给了一串JSON数据的示例
{"code":0,"data":{"ip":"210.75.225.254","country":"\u4e2d\u56fd","area":"\u534e\u5317",
"region":"\u5317\u4eac\u5e02","city":"\u5317\u4eac\u5e02","county":"","isp":"\u7535\u4fe1",
"country_id":"86","area_id":"100000","region_id":"110000","city_id":"110000",
"county_id":"-1","isp_id":"100017"}}
根据数据的大意，我们可以考虑构建一个JavaIP类
publicclassIP{privateintcode;privateData data;}
这个类中的Date类是十分麻烦的，所以我们考虑用工具直接生成
粘贴JSON代码进去，在右边的Source Type选择JSON，Anotation Style选择Gson，其他的选择自行摸索，我的配置如图
Retrofit
注意服务器发送的区分大小写与带下划线的数据可能无法识别，导致返回为NULL，所以一定要勾选上Gson这个Anotation，这个勾选后，你的POJO数据，以及Gson的jar包都可以完全混淆，是一种超级偷懒的写法。
点击下方的Jar，就会生成源码包，你可以直接扔到工程中或者改名为zip手动折腾，注意代码的有些注解(Annotation)可能在AS中无法通过编译,删除即可
HTTP GET简介
请求指定的页面信息，并返回实体主体，我们可以在http链接中加入path,key-value等参数，从而得到具体的对象。
我们回到API网站，它告诉了我们它的API是通过HTTP GET方法获取的，何为GET？简单的说，就是在请求的url中加入key-value参数，发送给服务器，这里的key是ip，value是你要查询的地址，比如202.202.33.33
http://ip.taobao.com/service/getIpInfo.php?ip=202.202.33.33
服务器根据你的GET请求，返回如下的JSON数据
{"code":0, "data":{ "country":"中国", "country_id":"CN", "area":"西南", "area_id":"500000", "region":"重庆市", "region_id":"500000", "city":"重庆市", "city_id":"500000", "county":"", "county_id":"-1", "isp":"教育网", "isp_id":"100027", "ip":"202.202.33.33"}}
接下来我们如何使用Retrofit获取并解析数据呢，现在开始正式的使用
Retrofit同步获取方法
这里的同步获取方法是指以只获得JAVA对象为目标，而不更新UI线程中的数据，异步是指获取到数据后立刻回调，更新UI线程中的界面，我们先讲简单的同步,建议跟着官方Wiki一起看
打开Android Studio，新建一个工程，添加网络权限，Bulid.gradle添加如下依赖
//自行更新后面的版本号compile'com.squareup.retrofit:retrofit:1.7.1' compile'com.squareup.okhttp:okhttp-urlconnection:2.0.0' compile'com.squareup.okhttp:okhttp:2.0.0'
修改UI界面，里面放上一个EditText,一个Button,一些Textview，用于输入和显示UI数据，这步略
写IP工具类，用于封装获取获取IP，这里的命名IPUtils比较吐槽，各位先忽视
publicclassIPUtils{//eg : http://ip.taobao.com/service/getIpInfo.php?ip=202.202.32.202staticfinalString ENDPOINT ="http://ip.taobao.com/service";publicinterfaceTaobaoIPService{@GET("/getIpInfo.php")IPgetIp(@Query("ip")String ip); }staticRestAdapter restAdapter =newRestAdapter.Builder() .setEndpoint(ENDPOINT)//是否Debug.setLogLevel(RestAdapter.LogLevel.FULL) .build();staticpublicTaobaoIPService taobaoIPService = restAdapter.create(TaobaoIPService.class); }
这个IPUtils首先建立了一个接口TaobaoIPService，接着又创建了一个restAdapter，最后用restAdapter实例化接口，我们要获取IP的时候，直接调用taobaoIPService中的getIp方法了，至于为什么我要写这个接口？官网上有详细的讲解
现在只需要在Activity中调用getIp即可
IP ip = IPUtils.taobaoIPService.getIp("202.202.33.33");
就可以获得所有的IP数据了，注意这个任务是网络任务，所以不要忘记给程序加入网络权限，并且让这个getIp在非UI线程中使用（比如最简单的AsyncTask），之后如何使用IP数据就简单了，操作第二步的UI组件即可
Retrofit异步回调方法
Retrofit的异步回调是指在获取到数据后，立刻进行UI的更新，你不需要自己另外写AsyncTask，代码看上去简洁，如果配合Dagger(一个Android注解框架，本文不讨论)的使用就更加美了
建立一个工具类
publicclassIPUtils{//eg : http://ip.taobao.com/service/getIpInfo.php?ip=202.202.32.202staticfinalString ENDPOINT ="http://ip.taobao.com/service";publicinterfaceTaobaoIPService{@GET("/getIpInfo.php")voidgetIp(@Query("ip")String ip, Callback callback); }staticRestAdapter restAdapter =newRestAdapter.Builder() .setEndpoint(ENDPOINT) .setLogLevel(RestAdapter.LogLevel.FULL) .build();publicstaticTaobaoIPService taobaoIPService = restAdapter.create(TaobaoIPService.class); }
从代码中可以看出TaobaoIPService中的方法getIp没有返回值了，反而多了一个Callback，官方 Wiki是这么说的
On Android, callbacks will be executed on the main thread.
在我们结束了数据获取后，无论是否成功，都将启动回调，回调将在主线程(UI线程)执行。
在Activity的使用
submitButton.setOnClickListener(newView.OnClickListener() {@OverridepublicvoidonClick(View view){ String query = editText.getText().toString();if(!query.isEmpty()) {//该组件能够自动启动Http线程，然后在回调中用main线程修改UI//详情可以看“SYNCHRONOUS VS. ASYNCHRONOUS VS. OBSERVABLE”IPUtils.taobaoIPService.getIp(query,newCallback() {@Overridepublicvoidsuccess(IP ip, Response response){ textView_code.setText(String.valueOf(ip.getCode())); textView_ip.setText(ip.getData().getIp()); textView_country.setText(ip.getData().getCountry()); textView_area.setText(ip.getData().getArea()); textView_region.setText(ip.getData().getRegion()); textView_city.setText(ip.getData().getCity()); textView_isp.setText(ip.getData().getIsp()); }@Overridepublicvoidfailure(RetrofitError error){ showToast("failure:"+ error.getKind()); } }); } } });
我们可以看出Callback重写了2个方法，一个是成功，一个是失败。在成功(success)中，我们利用回调的数据，直接进行UI的更新
这里注意可能出现的内存泄露，如果你是执行耗时任务，当你退出activity后，回调后可能会出现空指针异常。
对错误以及异常的处理
可以看到，在刚刚的代码中，我们仅仅输出了错误的种类，没有个性化的输出，作为客户端我们应该如何处理不同的错误异常呢？我们先列举用户出错的情况，常见的错误种类如下
publicenumKind {/** An {@link IOException} occurred while communicating to
the server. */NETWORK,/** An exception was thrown while (de)serializing a body. */CONVERSION,/** A non-200 HTTP status code was received from the server. */HTTP,/**
* An internal error occurred while attempting to execute a
request. It is best practice to
* re-throw this exception so your application crashes.
*/UNEXPECTED }
NETWORK：用户没有联网，这个简单，你可以发一个Toast，或者在提交数据前检查网络连接
CONVERSION：用户输入错误的数据，比如1234,导致服务器返回错误的数据,使客户度无法解析(CONVERSION)
{"code":1,"data":"invaild ip."}
对于这个错误(CONVERSION)，我们可以在本地用正则表达式在提交数据前对数据进行简单的验证,当然如果服务器真的传来了，也没什么，你同样只用发一个Toast，提示“重新填写请求”即可
HTTP：处理这个错误，需要服务端与客户端写好技术文档，或者使用Mock模拟所有的错误，一般一个好的服务器是不会出现这个错误的，真的出现了话，特例处理，比如常见的500,404错误
UNEXPECTED：暂时没见过
最后，我们写出的failure应该是这样的，健壮高效
@Overridepublicvoidfailure(RetrofitError error){switch(error.getKind()) {caseNETWORK: showToast("网络错误");break;caseCONVERSION: showToast("重新输入");break;caseHTTP://这里可以用Mockito模拟showToast("错误代码:"+ String.valueOf(error.getResponse().getStatus()) +"错误原因:"+ error.getResponse().getReason());break;caseUNEXPECTED: showToast("未知错误");//TODO:写入日志break; } showToast("failure:"+ error.getKind());}
在用界面看来，用户得到了有效的错误消息，可以与开发作者沟通反馈。
PS1：POST操作
我目前有个开源的项目，图片上传用的就是Retrofit2.0的POST上传，有兴趣去看看吧。
PS2: Retrofit2.0
我在stackoverflow回答的关于Retrofit2.0的相关问题
使用RxJava与Retrofit2.0使用的实例：Retrofit 2.0 RxJava Sample
JW大神的文章
http://wuxiaolong.me/2016/01/15/retrofit/
后记
本文全完，谢谢观看！本博客持续更新与搬运国外大神的文章，有兴趣的话不妨点一个收藏，另外我还维护着一个材料设计的专题，欢迎收藏。
89145aa6a54e：@火枪辉耀了我也是最近在学习这个 缓存今天看的 你可以看下这篇文章http://www.jcodecraeer.com/a/anzhuokaifa/androidkaifa/2016/0115/3873.html
网友评论