前面一篇的内容已经初步讲了Retrofit2.0的配置以及简单的介绍,接下来要做的就是熟悉使用Retrofit2.0的各种网络请求方法。在这里先要说明的是我们这里需要改变的东西并不多, Retrofit工具类也是不变的。因为在这里我只介绍初步的一些使用方法,所以做很详细的介绍,之后我会慢慢的完善这个内容,通过多次使用 Retrofit2更多的来了解它。
首先这是 Retrofit工具类。记住,在这里baseUrl是在创建retrofit实力的时候定义的,我们也可以在API接口中定义完整的url。在这里建议在创建baseUrl中以”/”结尾,在API中不以”/”开头和结尾。
package com.gxuwz.retrofitdemo;
import java.util.concurrent.TimeUnit;
import okhttp3.OkHttpClient;
import retrofit2.Retrofit;
import retrofit2.converter.gson.GsonConverterFactory;
/**
* Retrofit工具类
* author:hkq
* Date:16/7/29 下午3:40
* 单例模式
*/
public class RetrofitHttp {
private static final String BaseUrl = "http://sns.maimaicha.com/";
//网络请求的接口
private static HttpInterface singleton;
//全局变量配置OkHttpClient
private static OkHttpClient mOkHttpClient;
//单例模式得到网络请求接口的变量
public static HttpInterface getRetrsofit() {
if (singleton == null) {
synchronized (RetrofitHttp.class) {
singleton = createRetrofit().create(HttpInterface.class);
}
}
return singleton;
}
private static Retrofit createRetrofit() {
if (BuildConfig.DEBUG) {
OkHttpClient.Builder builder = new OkHttpClient().newBuilder()
.connectTimeout(10, TimeUnit.SECONDS)//设置超时时间
.readTimeout(10, TimeUnit.SECONDS)//设置读取超时时间
.writeTimeout(10, TimeUnit.SECONDS);//设置写入超时时间
//此处设置的是自定义的缓存大小以及位置
// int cacheSize = 10 * 1024 * 1024; // 10 MiB
// Cache cache = new Cache(App.getContext().getCacheDir(), cacheSize);
// builder.cache(cache);
mOkHttpClient = builder.build();
}
//初始化Retrofit
Retrofit retrofit = new Retrofit.Builder()
.baseUrl(BaseUrl)//设置baseUrl
.addConverterFactory(GsonConverterFactory.create())//设置了GsonConverterFactory完成对象的转化。
.client(mOkHttpClient)
.build();
return retrofit;
}
}
在需要使用的位置,写使用方法:
HttpInterface retrofit = RetrofitHttp.getRetrsofit();
retrofit.search("1","10","我").enqueue(new Callback<MsgList>() {
@Override
public void onResponse(Call<MsgList> call, Response<MsgList> response) {
try {
Log.d("hkq", "hkq>>msgList>>" +"msgList.msgList()+"+response.body().getData().get(0).getWap_thumb());
} catch (Exception e) {
e.printStackTrace();
}
}
@Override
public void onFailure(Call<MsgList> call, Throwable t) {
Log.d("hkq", "hkq>>onFailure>>" + t.toString());
}
});
取消请求
我们可以终止一个请求。终止操作是对底层的httpclient执行cancel操作。即使是正在执行的请求,也能够立即终止。
call.cancel();
基本如此,这个第二次贴上这段代码,如果有什么疑问,回头看。
然后接下来就是请求方式的变化了:
get请求,不带参数:
@GET("api?apikey=b4f4ee31a8b9acc866ef2afb754c33e6&format=json&method=news.getSlideshow")
Call<Country> getCountrys();
在Retrofit 2.0添加了一个新的注解:@Url,它允许我们直接传入一个请求的URL。这样以来我们可以将上一个请求的获得的url直接传入进来。方便了我们的操作。
@GET
Call<List<Contributor>> repoContributorsPaginate(@Url String url);
get请求带参数:
@GET("api?apikey=b4f4ee31a8b9acc866ef2afb754c33e6&format=json&method=news.searcListByTitle")
Call<MsgList> search(@Query("page") String page, @Query("rows") String rows, @Query("search") String search);
或者
@GET("repos/{owner}/{repo}/contributors")
Call<ResponseBody> contributorsBySimpleGetCall(@Path("owner") String owner, @Path("repo") String repo);
get添加请求头
@Headers({
"Accept: application/vnd.github.v3.full+json",
"User-Agent: RetrofitBean-Sample-App",
"name:ljd"
})
@GET("repos/{owner}/{repo}/contributors")
Call<List<Contributor>> contributorsAndAddHeader(@Path("owner") String owner,@Path("repo") String repo);
我们可以使用@FormUrlEncoded注解来发送表单数据。使用 @Field注解和参数来指定每个表单项的Key,value为参数的值。
Post请求:
@FormUrlEncoded
@POST("user/edit")
Call<User> updateUser(@Field("first_name") String first, @Field("last_name") String last);
当我们有很多个表单参数时可以通过@FieldMap注解和Map对象参数来指定每个表单项的Key,value的值。
@FormUrlEncoded
@POST("user/edit")
Call<User> updateUser(@FieldMap Map<String,String> fieldMap);
我们还可以通过@Multipart注解来发送Multipart数据。通过@Part注解来定义需要发送的文件。
@Multipart
@PUT("/user/photo")
User updateUser(@Part("photo") TypedFile photo, @Part("description") TypedString description);
下载:
在这里下载的时候只要返回 ResponseBody,很多事情都可以做了。
InputStream is = response.body().byteStream();
总结一下
说实话,对于初学者来讲,个人觉得Retrofit真的很难用,并且入手很慢,像其他的网络框架对于我来说倒是简洁明了许多。但是大家都说它好用也有它的道理,这就需要我们深入的去体会了。然后在这里我需要把关于这个的文章先停一停,因为后面的内容还需要花点时间去理解,我需要尝试很多次才能够总结出自己的东西。有时候写写博客真的很不错,感兴趣的朋友可以试试。