Android网络开源库Retrofit(一)简单介绍

前言

当前的网络开源库有许多&＃xff0c;如volley&＃xff0c;okhttp&＃xff0c;retrofit等&＃xff0c;这三个库当前是比较火的&＃xff0c;其中&＃xff0c;okhttp和retrofit由square团队开发。关于这三个库的区别&＃xff0c;请移步stackoverflow或者知乎查看。开发过程中选择什么样的开源库需要更具我们APP来做出选择。我们选出stackoverflow中的一段话来看下。

上面说&＃xff0c;需要与web service通信的时候&＃xff0c;我们使用retrofit。百度百科 web service介绍&＃xff0c;那么我们见天就来了解下retrofit。

什么是retrofit

关于什么是retrofit&＃xff0c;官网文档上们有一句话。A type-safe HTTP client for Android and Java。额&＃xff0c;似乎什么也看出去来&＃xff0c;就知道是一个类型安全的http client库。那么什么是类型安全呢&＃xff1f;类型安全代码指访问被授权可以访问的内存位置。例如&＃xff0c;类型安全代码不能从其他对象的私有字段读取值。它只从定义完善的允许方式访问类型才能读取。类型安全的代码具备定义良好的数据类型。更多内容百度百科-类型安全&＃xff0c;关于这里还引用上面知乎的一句话。

RESTful-百度百科
rest-百度百科
上面这么多抽象的概念太抽象&＃xff0c;我们不管他。我们只需要知道retrofit确实是个很好的开源库就可以了。

入门打老虎

开源库是不错&＃xff0c;但是&＃xff0c;你文档能不能写的详细点。入门就是个大老虎。怎么说呢&＃xff0c;文档给出的代码精辟&＃xff0c;但是不能运行。那么&＃xff0c;我们来看看具体的&＃xff0c;真正的入门步骤。

1.在gradle脚本中添加

compile &＃39;com.squareup.retrofit:retrofit:2.0.0-beta2&＃39;
compile &＃39;com.squareup.retrofit:converter-gson:2.0.0-beta2&＃39;

retrofit是中有用的okhttp&＃xff0c;添加gson库是为了将返回数据转化为实体类。

2.将http api转化为java接口

以下称这货为http接口
比如我们想去这个网址上获取json数据。https://api.github.com/users/Guolei1130
你们也可以将Guolei1130替换为你们自己的github。

public interface gitapi {&＃64;GET("/users/{user}")Call getFeed(&＃64;Path("user") String user);
}

这里使用注解&＃xff0c;&＃64;GET表示我们的请求方式是get请求&＃xff0c;&＃64;GET(“STR”)&＃xff0c;标明这里的请求地址为BASEURL&＃43;STR&＃xff0c;{user}&＃xff0c;这里会在后面被getFeed的user参数替换&＃xff0c;最后就拼接成了最终的请求路径。返回的数据室什么呢。Call&＃xff0c;这里返回的Call是用来让我们执行请求的。需要注意的是&＃xff1a;Call表示返回体中的数据&＃xff0c;我们看下上面那个网址的返回数据。
&＃xff0c;很明显是个json对象。
但是如果是返回数据为json数组的话我们就需要注意&＃xff0c;这里具体怎么用还要根据返回数据以及我们的model来确定&＃xff0c;倘若model对应json中的对象&＃xff0c;便用Call>,倘若对应json数组&＃xff0c;用Call。多的不说了&＃xff0c;自己体会体会。

3.model的编写

只需要将json对象的键值&＃xff0c;编写model对应的成员变量&＃xff0c;在生成get set方法就好。
如图&＃xff1a;

4.执行请求

Retrofit retrofit&＃61; new Retrofit.Builder().baseUrl("https://api.github.com").addConverterFactory(GsonConverterFactory.create()).build();
gitapi service &＃61; retrofit.create(gitapi.class);
Call model &＃61; service.getFeed("Guolei1130");
model.enqueue(new Callback() {&＃64;Overridepublic void onResponse(Response response, Retrofit retrofit) {Log.e(TAG, "onResponse: "&＃43;response.body().getLogin() );}&＃64;Overridepublic void onFailure(Throwable t) {Log.e(TAG, "onFailure: " &＃43; t.getMessage());}
});

这里我们先构造Retrofit对象&＃xff0c;由于我们将返回的json数据转化成了model对象&＃xff0c;所以在构造Retrofit对象的时候&＃xff0c;通过addConverterFactory来添加转化器来完成数据转化。
然后利用http接口的方法生成Call对象&＃xff0c;最后用Call对象来执行http请求(异步和同步&＃xff0c;后面会说到)。别忘记添加权限。

好&＃xff0c;到这里入门老虎就被我们打死了。

注解爽歪歪

我们既然知道了retrofit是通过注解将HTTP转化为java接口&＃xff0c;那么我们就需要了解下都有哪些注解&＃xff0c;该怎么用。

请求方式

GET, POST, PUT, DELETE, 和 HEAD&＃xff0c;我们平常开发中经常用的也就get和post。关于HTTP请求方式&＃xff0c;这里就不再说了&＃xff0c;网上有很多介绍HTTP协议的文章&＃xff0c;都特别详细。
我们知道get请求方式&＃xff0c;参数是放在路径当中的。看下图的路径。
&＃xff0c;
是不是很长&＃xff0c;不过没关系&＃xff0c;用retrofit一样可以将这么长的串拼接到路径中&＃xff0c;怎么做呢&＃xff1f;
这里就用到了&＃64;Query&＃xff08;一个键值对&＃xff09;和&＃64;QueryMap&＃xff08;多对键值对&＃xff09;。

// 假设 baseurl &＃61; "http://baidu.com"&＃64;GET("/s") Call onekey(&＃64;Query("wd") String wdvalue);

上面代码拼接出来的 &＃61; “http://baidu.com/s?wd&＃61;wdvalue“.
上面只是一个参数的时候&＃xff0c;很多时候我们有许多参数&＃xff0c;这个时候就需要我们使用&＃64;QueryMap 了

Call manykey(&＃64;QueryMap Map<String, String> options);

上面的即可将多对键值对拼接到路径当中。

请求体

我们知道post和get的区别当中有一点就是参数的位置&＃xff0c;get放在url路径当中&＃xff0c;post放在请求体当中。
注意&＃xff1a;前方高能&＃xff0c;请仔细阅读。前方高能&＃xff0c;请仔细阅读。前方高能&＃xff0c;请仔细阅读。下面我们模拟一个登录&＃xff0c;请求参数为用户名和密码&＃xff0c;返回参数为我们的用户名。

1.转化为接口

&＃64;POST("/index.php")
Call post(&＃64;Body User user);

2.编写User和Des&＃xff0c;用 来转化数据

public class Des {public String des;public String getDes() {return des;}public void setDes(String des) {this.des &＃61; des;}
}

public class User {public String username;public String password;public User(String username,String password){this.username &＃61; username;this.password &＃61; password;}public String getUsername() {return username;}public void setUsername(String username) {this.username &＃61; username;}public String getPassword() {return password;}public void setPassword(String password) {this.password &＃61; password;}
}

3.发送请求

Retrofit retrofit&＃61; new Retrofit.Builder()
// .baseUrl("https://api.github.com").baseUrl("http://192.168.1.214").addConverterFactory(GsonConverterFactory.create()).build();gitapi service &＃61; retrofit.create(gitapi.class);Call model &＃61; service.post(new User("guolei","123456"));model.enqueue(new Callback() {&＃64;Overridepublic void onResponse(Response response, Retrofit retrofit) {Log.e(TAG, "onResponse: "&＃43;response.body().getDes());}&＃64;Overridepublic void onFailure(Throwable t) {Log.e(TAG, "onFailure: "&＃43;t.getMessage() );}});

客户端的代码很简单&＃xff0c;在这里就不做过多的解释。重点在于客户端和服务器之间的交互。妈蛋&＃xff0c;坑死我了。官方文档上有一句话是这样说的。

意思就是请求体对象也会转化为json&＃xff0c;刚开始我们并不知道会转化为json&＃xff0c;我们还傻傻的在php代码中$_POST[‘username’]&＃xff0c;试了几次没效果之后。果断拿出工具来分析。

抓包神器Charles&＃xff0c;关于如何使用我这里不说&＃xff0c;我这里只说下如何设置android端代理。长按链接的网络-》修改 网络-》将代理设为手动&＃xff0c;输入IP和端口。如下图&＃xff1a;
。
接下来&＃xff0c;我们利用抓包工具去看看服务器接受的数据。如下图&＃xff1a;
&＃xff0c;
果然&＃xff0c;是json数据&＃xff0c;但是我擦&＃xff0c;我们明显感觉这种数据我们没法通过$_POST来接收。怎么办呢&＃xff0c;不着急&＃xff0c;咱们可以通过如下代码来接收。php完整代码如下&＃xff08;ps&＃xff1a;只是演示&＃xff0c;没几行&＃xff09;

$var&＃61;file_get_contents("php://input");$obj&＃61; json_decode($var,true);$des &＃61; $obj[&＃39;username&＃39;];$arr &＃61; array("des"&＃61;>$des);echo json_encode($arr);

恩&＃xff0c;就这么少&＃xff0c;关于如下安装php开发环境就不说了&＃xff0c;so easy不是么。最后&＃xff0c;我们来看下效果图&＃xff1a;

表单编码和多part

什么叫表单&＃xff0c;我想大家都应该知道&＃xff0c;表单中有很多元素&＃xff0c;我们这里也不例外。在html代码中&＃xff0c;我们经常通过form表单来提交。在上面的请求体中&＃xff0c;我们明显感觉那玩意十分貌似有点难用。不过没关系&＃xff0c;我们有表单。
还是和上个例子一样。

&＃64;FormUrlEncoded
&＃64;POST("/index.php")
Call form(&＃64;Field("username") String username,&＃64;Field("password") String password);

Call model &＃61; service.form("guolei","123456");

看下输出结果;

这个多part是什么呢&＃xff0c;就是将请求提分为多个部分&＃xff0c;这个就没啥好说了的。

请求头

我们知道http是有请求头的&＃xff0c;有些时候我们是需要填写或者配置一下请求头的&＃xff0c;比如说&＃xff0c;文件上传&＃xff0c;或者COOKIE保持。这里的请求头支持动态配置和静态配置。

1.静态配置

通过&＃64;Headers注解。如&＃xff1a;下面这段是官方文档上的。

&＃64;Headers({"Accept: application/vnd.github.v3.full&＃43;json","User-Agent: Retrofit-Sample-App"
})

2.动态配置

也来一段官方文档上面的吧。

&＃64;GET("/user")
Call getUser(&＃64;Header("Authorization") String authorization)

这些都相对简单的&＃xff0c;没啥好说的&＃xff0c;事实上&＃xff0c;在开发过程中需要我们配置请求头的地方也不多。

执行方式

这里支持异步和同步。上面的例子中我们都是用的异步。那么我们看下如何执行同步请求&＃xff0c;也很简单。

//同步请求
//model.execute().body().getLogin();

混淆代码

-dontwarn retrofit.**
-keep class retrofit.** { *; }
-keepattributes Signature
-keepattributes Exceptions

retrofit&＃43;rxjava

在抛物线大大的RxJava入门当中&＃xff0c;我们知道了retrofit和rxjava可以结合使用&＃xff0c;那么我们现在便来看看如何使用。

1.添加

dependencies {compile fileTree(dir: &＃39;libs&＃39;, include: [&＃39;*.jar&＃39;])testCompile &＃39;junit:junit:4.12&＃39;compile &＃39;com.android.support:appcompat-v7:23.0.1&＃39;compile &＃39;com.squareup.retrofit:retrofit:2.0.0-beta2&＃39;compile &＃39;com.squareup.retrofit:converter-gson:2.0.0-beta2&＃39;compile &＃39;io.reactivex:rxjava:1.0.16&＃39;compile &＃39;io.reactivex:rxandroid:1.0.1&＃39;compile &＃39;com.squareup.retrofit:adapter-rxjava:2.0.0-beta2&＃39;
}

2.http api接口

&＃64;FormUrlEncoded
&＃64;POST("/index.php")
public Observable rxpost(&＃64;Field("username") String username,&＃64;Field("password") String password);

3.在retrofit中添加RxJavaCallAdapterFactory

Retrofit retrofit&＃61; new Retrofit.Builder()
// .baseUrl("https://api.github.com").addConverterFactory(GsonConverterFactory.create()).addCallAdapterFactory(RxJavaCallAdapterFactory.create()).baseUrl("http://192.168.1.214").build();

4.执行

gitapi service &＃61; retrofit.create(gitapi.class);Observable observable &＃61; service.rxpost("quanshijie", "123456");observable.observeOn(AndroidSchedulers.mainThread()).subscribeOn(Schedulers.newThread()).subscribe(new Action1() {&＃64;Overridepublic void call(Des des) {Log.e(TAG, "call: " &＃43; des.getDes().toString());mText.setText(des.getDes().toString());}}, new Action1() {&＃64;Overridepublic void call(Throwable throwable) {Log.e(TAG, "call: " &＃43; throwable.getLocalizedMessage());}});

在这里我们要做好线程调度&＃xff0c;现在网络上那些坑爹的代码&＃xff0c;少一行代码&＃xff0c;把我坑了好长时间。喵了个咪的。最后看下效果图。

总结

到这里&＃xff0c;还差我们网络请求的其他需求&＃xff0c;比如说文件上传下载&＃xff0c;COOKIE保持&＃xff0c;https协议支持等。在okhttp中&＃xff0c;这些东西都可以&＃xff0c;retrofit作为okhttp的兄弟&＃xff0c;我想也不会太差&＃xff0c;还得继续学习啊。
不过&＃xff0c;在查了一些资料之后&＃xff0c;我们知道&＃xff0c;网络库的选择要根据需求&＃xff0c;一个很大的项目中用一个网络库很显然是不可能的。那么&＃xff0c;okhttp&＃43;retrofit&＃43;图片缓存库&＃43;rxjava会不会成为日后开发的主流呢。还是期待吧。
好累啊&＃xff0c;到现在饭都没吃。retrofit的坑还是有的。我估计剩下的三点地方坑更大&＃xff0c;不扯了&＃xff0c;收工。