Square全家桶正传——Retrofit使用及配合RxJava
写作原因：Retrofit被许多安卓程序员称为当下最优秀的网络请求框架，是Square重要的成员之一。相比传统的网络请求框架，Retrofit更加优秀。所以学习使用Retrofit有重要的意义。此外结合上RxJava使用可以使请求代码逻辑更加清晰。下面一起走进Retrofit的世界。
http://square.github.io/retrofit/
https://github.com/square/retrofit/
简介
Retrofit是Square推出的一款用于网络请求的框架。官方对其定义为"A type-safe HTTP client for Android and Java"。在Retrofit之前，我们请求网络数据采用的是AsyncTask+HttpURLConnection（或者HttpClient）+JsonObject，可想而知重复性工作量之大；之后Volley框架出现，但是Volley对于大数据的请求非常糟糕；Okhttp足够优秀，事实上Retrofit网络情求部分的实现基于Okhttp完成。此外Retrofit利用接口、方法和注解将网络请求直接转化为Java对象（POJO），类似数据库ORM模式。下面结合调用银行卡数据API接口的实例简述一下Retrofit的使用。
先添加项目依赖：
compile 'com.squareup.retrofit2:retrofit:2.1.0'
compile 'com.squareup.retrofit:converter-gson:2.1.0'
compile 'com.squareup.retrofit2:adapter-rxjava:2.1.0'
compile 'com.squareup.okhttp3:okhttp:3.3.1'
此外需要配置一下RxJava，关于RxJava配置与基本使用移步：
Square全家桶前传——RxJava函数式编程入门（一）
Retrofit基本使用
整体思路（此部分建议结合实例同时阅读）：
1.创建请求接口：以GET为例，把客户端希望向服务器端发送的请求封装成接口的形式。模板如下：
public interface RequestService {
@GET("请求具体地址")
Call<ResInfo> getResInfo(@header("apikey") String apikey,
@Query("cardnum") String cardNum);
}
```
具体地址指的是URL主机后面的部分，然后新建一个以请求需要的参数作为形参的方法，返回值为Call类型的泛型。请求参数使用注解转化为形参，如：`@Query("type") String type。`如果请求无需参数如下：
```
@GET("/record")
Call<PhoneResult> getResult();
```
这里介绍一下请求参数内的常用的几个注解，根据请求接口的格式灵活选择需要的注解：
@header("apikey") String apikey 用于接口请求数据的版本，设备信息，用户id，apikey等;
@Query("apikey") String apikey 用于接口键值对类型参数，eg:cardnum="123456789";
@Body：Java对象;
@Path("id") String id
用于直接请求数据的情况，如：
@GET("/result/{id}")
Call<PhoneResult> getResult(@Path("id") String id);
2.创建请求Response JSON对象的实体类：
个人喜欢使用GsonFormat插件来生成JSON对象对应的Java实体类对象，关于GsonFormat的用法这里不多阐述了，由于下文仍然要用到这个实体类，假设获得的实体类名为：ResInfo.class。
2.创建Retrofit对象
Retrofit retrofit = new Retrofit.Builder()
.baseUrl(baseUrl)
.addConverterFactory(GsonConverterFactory.create())
.build();
除了使用Gson来解析，还可以使用下面这些解析库进行解析：
Converter Library
Gson com.squareup.retrofit:converter-gson:2.0.0-beta2
Jackson com.squareup.retrofit:converter-jackson:2.0.0-beta1
Moshi com.squareup.retrofit:converter-moshi:2.0.0-beta1
Protobuf com.squareup.retrofit:converter-protobuf:2.0.0-beta1
Wire com.squareup.retrofit:converter-wire:2.0.0-beta1
Simple XML com.squareup.retrofit:converter-simplexml:2.0.0-beta1
3.通过Retrofit对象来实现请求接口赋予其具体的功能：
`RequestService service = retrofit.create(RequestService.class);`
4.现在接口已经实现，调用接口我们定义的内部方法获得Call对象：
`Call<ResInfo> call = service.getResInfo(apiKey,"cardNum");`
5.调用Call对象的enqueue方法，将Call对象放入请求队列中：
call.enqueue(new Callback<ResInfo>() {
@Override
public void onResponse(Call<ResInfo> call, Response<ResInfo> response) {
ResInfo resInfo = response.body();
Log.i("way","Your card name is:" + resInfo.data.cardname);
}
@Override
public void onFailure(Call<ResInfo> call, Throwable t) {
}
});
注意在onResponse中的response是返回的JSON对象，可以将其取出。
### 具体例子 ###
下面我给出调用百度API查询银行卡信息的例子，结合上文的总结自己分析便可更好地理解Retrofit的用法。
1.项目结构
2.具体代码
MainActivity.java
package com.example.vincebarry.retrofitdemo;
import android.support.v7.app.AppCompatActivity;
import android.os.Bundle;
import android.util.Log;
import retrofit2.Call;
import retrofit2.Callback;
import retrofit2.GsonConverterFactory;
import retrofit2.Response;
import retrofit2.Retrofit;
public class MainActivity extends AppCompatActivity {
private final static String baseUrl = "http://apis.baidu.com";
private final static String apiKey = "yourAPIKey";
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
Retrofit retrofit = new Retrofit.Builder()
.baseUrl(baseUrl)
.addConverterFactory(GsonConverterFactory.create())
.build();
RequestService service = retrofit.create(RequestService.class);
Call<ResInfo> call = service.getResInfo(apiKey,"cardNum");
call.enqueue(new Callback<ResInfo>() {
@Override
public void onResponse(Call<ResInfo> call, Response<ResInfo> response) {
ResInfo resInfo = response.body();
Log.i("way","Your card name is:" + resInfo.data.cardname);
}
@Override
public void onFailure(Call<ResInfo> call, Throwable t) {
}
});
}
}
```
RequestService.java
package com.example.vincebarry.retrofitdemo;
import retrofit2.Call;
import retrofit2.http.GET;
import retrofit2.http.Query;
public interface RequestService {
@GET("/datatiny/cardinfo/cardinfo")
Call<ResInfo> getResInfo(@Query("apikey") String apikey,
@Query("cardnum") String cardNum);
}
```
ResInfo.java
package com.example.vincebarry.retrofitdemo;
import com.google.gson.Gson;
import com.google.gson.reflect.TypeToken;
import org.json.JSONException;
import org.json.JSONObject;
import java.lang.reflect.Type;
import java.util.ArrayList;
import java.util.List;
public class ResInfo {
/**
* status : 1
* data : {"cardtype":"贷记卡","cardlength":16,"cardprefixnum":"518710","cardname":"MASTER信用卡","bankname":"招商银行信用卡中心","banknum":"03080010"}
*/
public int status;
/**
* cardtype : 贷记卡
* cardlength : 16
* cardprefixnum : 518710
* cardname : MASTER信用卡
* bankname : 招商银行信用卡中心
* banknum : 03080010
*/
public DataBean data;
public static List<ResInfo> arrayResInfoFromData(String str, String key) {
try {
JSONObject jsonObject = new JSONObject(str);
Type listType = new TypeToken<ArrayList<ResInfo>>() {
}.getType();
return new Gson().fromJson(jsonObject.getString(str), listType);
} catch (JSONException e) {
e.printStackTrace();
}
return new ArrayList();
}
public static class DataBean {
public String cardtype;
public int cardlength;
public String cardprefixnum;
public String cardname;
public String bankname;
public String banknum;
public static List<DataBean> arrayDataBeanFromData(String str, String key) {
try {
JSONObject jsonObject = new JSONObject(str);
Type listType = new TypeToken<ArrayList<DataBean>>() {
}.getType();
return new Gson().fromJson(jsonObject.getString(str), listType);
} catch (JSONException e) {
e.printStackTrace();
}
return new ArrayList();
}
}
}
上面是Retrofit的一般使用方法，下面介绍一下将RxJava和Retrofit结合使用的方法。如果真正掌握两者的结合，外加Picasso的辅助，可以解决大部分网络请求问题：
## 结合RxJava使用 ##
1.定义接口：
interface RequestService {
@GET("user/login" )
Observable<ResInfo> getResInfo(
@header("apikey") String apikey,
@Query("cardnum") String cardNum
);
}
**注意这里返回的不再是Call对象而是Observable对象，及RxJava中的事件源。**
2.创建Retrofit对象，实现接口：
Retrofit retrofit = new Retrofit.Builder()
.addConverterFactory(GsonConverterFactory.create())
.addCallAdapterFactory(RxJavaCallAdapterFactory.create())
.baseUrl(baseURL)
.build();
RequestService service = retrofit.create(RequestService.class);
注意加入.addCallAdapterFactory(RxJavaCallAdapterFactory.create())配置RxJava。
3.调用接口我们定义的内部方法获得事件源：
`Observable<ResInfo> call = service.getResInfo(apiKey,"cardNum");`
4.下面就是熟悉的RxJava函数式编程了：
call.subscribeOn(Schedulers.newThread())//请求在新的线程中执行
.observeOn(Schedulers.io()) //请求完成后在io线程中执行
.doOnNext(new Action1<ResInfo>() {
@Override
public void call(ResInfo resInfo) {
//操作
}
})
.observeOn(AndroidSchedulers.mainThread())//最后在主线程中执行
.subscribe(new Subscriber<UserInfo>() {
@Override
public void onCompleted() {
}
@Override
public void onError(Throwable e) {
//请求失败
}
@Override
public void onNext(UserInfo userInfo) {
//请求成功
}
});
上面的doOnNext()是在每次输出一个元素之前做一些额外的事情，比如可以保存数据等等。
## 总结：##
到此我将Retrofit的使用的流程和个人对Retrofit的理解梳理了一遍，希望上面的例子和总结能够帮助大家更好地理解Retrofit的使用。更多的Square同系列文章可以关注我的博客。还有什么见解或是文中有某些错误希望大家提出，谢谢。
