- 简单的用法
- 解析 JSON
- 自定义解析方法
- RxJava + Retrofit
初步的使用
先说一下依赖：
compile 'com.squareup.retrofit2:retrofit:2.2.0'
compile 'com.squareup.retrofit2:converter-gson:2.2.0'
第二个是可选的依赖包，取决于你想要用什么来解析你的网络请求的返回数据。
官方支持以下：
- Gson: com.squareup.retrofit2:converter-gson
- Jackson: com.squareup.retrofit2:converter-jackson
- Moshi: com.squareup.retrofit2:converter-moshi
- Protobuf: com.squareup.retrofit2:converter-protobuf
- Wire: com.squareup.retrofit2:converter-wire
- Simple XML: com.squareup.retrofit2:converter-simplexml
- Scalars (primitives, boxed, and String): com.squareup.retrofit2:converter-scalars
service 接口的定义
public interface APIService {
@GET("4/news/latest")
Call<ZHI> getNewsInfo();
@GET
Call<ZHI> getNewsInfo(@Url String url);
@GET("url")
Call<LoginResult> getData(@Query("name") String name, @Query("password") String pw);
}
一个方法和第二个方法区别是第一个方法的 url 固定，而第二个的 url 可以手动的赋值。
getData 方法的 @Query("name") 对应的是接口的参数，String name 就是实际上传的对象，Call<LoginResult> 会根据你的设置来自动将返回数据解析成 LoginResult 对象，这个对象和上面的ZHI都是根据返回的 JSON 数据而建立的实体类。
初始化 Retrofit
Retrofit retrofit = new Retrofit.Builder()
.baseUrl("http://news-at.zhihu.com/api/")
.addConverterFactory(GsonConverterFactory.create())
.build();
netService service = retrofit.create(netService.class);
Call<ZHI> call = service.getNewsInfo("http://news-at.test/api/1231/news/latest");
Call<ZHI> call_test = service.getNewsInfo();
ZHI z = call.execute().body();//同步请求，直接这样获取返回的对象
//call.enqueue(callback); //异步请求，在下面的 callback 中获取返回
Call<ZHI> callback = new Callback<ZHI>() {
@Override
public void onResponse(Call<ZHI> call, Response<ZHI> response) {
ZHI z = response.body();
}
@Override
public void onFailure(Call<ZHI> call, Throwable t) {
}
});
-
URL 的定义
初始化 Retrofit 的时候，指定的 baseUrl 会和@GET("4/news/latest")这一句中的 "4/news/latest" 拼接成完整的 url
上面的例子中，getNewsInfo()实际访问的地址为：
"http://news-at.test/api4/news/latest"
这里两者的格式还是比较随意的但是建议： - BaseURL : 以 / 结尾
- @Url : 不要以 / 开头
而对于
service.getNewsInfo("http://news-at.test/api/1231/news/latest");
它会忽略 BaseUrl 去访问传入的 url
- 添加 Converter
同样在初始化的过程，
.addConverterFactory(GsonConverterFactory.create())
这一句就是之前提到的指定不同的库去解析返回的数据，这一句就指定了 Gson，这是一个比较成熟的讲 JSON 转换成 JAVA 对象的第三方库，为了用上它记得加上上面的依赖
- 同步与异步
同步请求和异步请求只有一点不同：
call.execute(); //同步请求
call.enqueue(callback); //异步请求
异步请求需要传入一个 Callback<T>，这个对象中有两个方法，onResponse 和 onFailure，他们都是在主线程中调用的，不管是否成功解析到数据，onResponse 都会被调用
解析 JSON 数据
上面已经实现利用 Retrofit 自带的 Gson 来解析返回的 JSON 数据，
这里补充一个，快速的建立一个对应 JSON 数据格式的 JAVA 对象的方法，那就是很多人都提到的 GsonFormat。
重点是如何实现自己手动的解析 JSON 数据：
一个简单的方法，直接获取到 JsonObject 对象( Retrofit 不进行 Json 解析，直接返回 String)
@GET
Call<JsonObject> getNewsInfo(@Url String u);
...//其他同上，在 callback 的 onResponse 中
@Override
public void onResponse(Call<JsonObject> call, Response<JsonObject> response) {
JsonObject jsonObject = response.body();
}
...
要注意的一个点，这里返回值的类型是 JsonObject 而不是 JSONObject，它们是有区别，而且用后者是不能直接获取到的。
还有一种方法是自定义Converter( Retrofit 2.0 自定义 Converter )
- 继承Converter.Factory
[图片上传失败...(image-ce8d1a-1554774761263)]](https://mobupiaobo.gitbooks.io/retrofit-2-0/content/2.pic_hd.jpg) -
分别实现 request,response 转换器 image
- 引用：
Retrofit retrofit = new Retrofit.Builder() .baseUrl("").client(client)
.addConverterFactory(DemoConverterFactory.create()) .build();
RxJava + Retrofit
在 Retrofit 配合 RxJava 使用的时候有另一套 api
在 service：
//原来的写法
@GET
Call<JsonObject> getNewsInfo(@Url String u);
//使用 RxJava 的写法
@GET
Observable<ZHI> getInfo(@Url String u);
返回的对象变成了被封装在一个 Observable 对象里
初始化 Retrofit：
不同的是在初始化的时候要加上一个 addCallAdapterFactory(RxJava2CallAdapterFactory.create())
//添加 RxJava2 Adapter
Retrofit retrofit = new Retrofit.Builder()
.baseUrl("http://n/api/")
.addConverterFactory(GsonConverterFactory.create())
.addCallAdapterFactory(RxJava2CallAdapterFactory.create())
.build();
netService service = retrofit.create(netService.class);
service.getInfo("http://n/api/4/news/latest")
.observeOn(AndroidSchedulers.mainThread())
.subscribe(new Observer<ZHI>() {
@Override
public void onSubscribe(Disposable d) {
Log.e("HERE", "onSubscribe: ");
}
@Override
public void onNext(ZHI value) {
Log.e("HERE", "onNext ZHI: "+value);
}
@Override
public void onError(Throwable e) {
Log.e("HERE", "onError: ");
}
@Override
public void onComplete() {
Log.e("HERE", "onComplete: ");
}
});
调用 service.getInfo() 会返回一个 Observable 对象，使用这个对象创建和绑定 Observer 对象，对于 RxJava 可以见我另一篇 RxJava 2.0 笔记。
实际开发中需要注意
- 不同的注解使用
对于用 Get 的方式请求时，参数通常会以 key-value 的方式拼接到 Url 后面，
可以使用 @Path 替换 ：
@GET("group/{id}/users")
Call<List<User>> groupList(@Path("id") int groupId);
可以使用 @Query 注解，添加一个查询条件 ：
@GET("group/{id}/users")
Call<List<User>> groupList(@Path("id") int groupId, @Query("sort") String sort);
如果请求的参数比较多，可以用 @QueryMap 一次性提交：
@GET(Urls.LOGIN)
Call<List<User>> login(@Query("user_name") String name,@Query("user_password")String password );
//改为
@GET(Urls.LOGIN)
Call<List<User>> login(@QueryMap Map<String,String> options);
//调用时传入的 map
Map<String,String> map = new ArrayMap<>();
map.put("user_name","");
map.put("user_password","");
对于 @Post 的请求方式，通常与 @FormUrlEncoded 和 @ Field 将参数以表单的形式上传：
@FormUrlEncoded
@POST("user/edit")
Call<User> updateUser(@Field("first_name") String first, @Field("last_name") String last);
其中 @FormUrlEncoded 表示请求正文将使用表单网址编码。@Field 注解将标识的参数存放至请求体中。
类似于 @QueryMap 的注解是 @FieldMap，两者使用方式一样，不再赘述。
值得一提的是 @Body，我们可以将需要提交的参数封装成一个实体类，然后直接将实体类作为参数上传：
@POST("user/login.do")
Call<User> login(@Body User user);
这种做法也常作为提交 JSON 的方法：
通过 Gson 将一个实体类转换成 JSON 格式的 String，然后提交。
login(new Gson().toJson(userBean));
