Retrofit的基本使用(Get请求)

版权声明:本文为博主原创文章,转载请注明原地址

有两个星期没有写博客了,满满的罪恶感啊,所以今天无论怎么着也得写一篇解解渴了。

最近一直在重构毕设的项目,再加上实验室最近手头上有两个项目要写,事情稍微有点儿多。最近的项目中做的最多的就是网络请求,以前都是用的okhttp,但是看现在主流的模式都是Retrofit+okhttp+Rxjava,所以,学习了一下Retrofit。

以前也大致看过Retrofit,但是看他的主要特色就是利用的注解的形势,而我对注解一直都有点儿懵B,所以一直没有深入学习使用,这次找了一些博客和视频之后,总算是学会了基本的用法。

下面开始干活

导入Retrofit

compile 'com.squareup.retrofit2:retrofit:2.1.0'
compile 'com.squareup.retrofit2:converter-gson:2.1.0'
compile 'com.squareup.retrofit2:adapter-rxjava:2.1.0'

主要导入三个包,第一个是retrofit的基本功能包,第二个是把请求到的json数据映射到对象的转换器包,第三个是一般会结合rxjava使用的rxjava适配器包

创建业务请求接口

在我们平时一般的开发中,网络请求用的最多的无非就是get、post请求,这里我主要演示一下get请求的实现方式,其他的大体实现思路是一样的

使用的API是天狗云提供的免费菜谱列表接口传送门

首先需要定义一个网络请求接口,如下:

public interface HttpService {

   @GET("/api/cook/list")
   Call<Tngou> getCook(@Query("page") int page, @Query("rows") int rows);
   
}

解释一下这一段代码
该接口定义了一个getCook的方法,这个方法就是直接用来请求数据的,在括号中包括一些参数,使用@query的注解方式表示在该get请求中可以附带的请求参数,比如在上面我们使用的api中,它包括了一些可选的请求参数

api请求参数.jpg

在我写的接口方法中选了page和row两个可选参数
另外方法的返回类型是一个泛型参数的call,而泛型写的是Tngou类型,这个Tngou是我自定义的针对返回的json数据映射的一个实体类

之所以这样写,是因为到时候在请求返回的结果response时,经过特定转换器的转换,response.body的类型就能直接转换为映射的Tngou型,就不再需要我们另外去针对response,用Gson之类的方式去解析它。

在接口方法getCook的上面使用了@Get的注解,以将getCook方法指定为get请求方式,括号中的参数"/api/cook/list"并不是不是完整的get请求api地址,而是api地址的子目录,比如该完整的Api地址是http://www.tngou.net/api/cook/list,那么前面的http://www.tngou.net 是固定网址,而后面的/api/cook/list就是该api的子目录

到这,请求方法就这么简单的定义好了,接下来的工作就是实例化一个Retrofit对象,然后利用Rertrofit对象和接口方法去完成网络请求。

实例化Retrofit对象

实例化Retrofit对象使用的Builder的模式去创建,以完成相关参数的设置

Retrofit retrofit = new Retrofit.Builder()
                .baseUrl("http://www.tngou.net")
                .addConverterFactory(GsonConverterFactory.create())
                .build();

其中basdUrl用来设置api地址的主网址,在这里就是"http://www.tngou.net";
addConvertFactroy用来设置转换器,转换器就是用来将请求的数据转换为用户想要的格式,比如这里我们请求的是json格式的数据,我们就可以利用Gson转换器将json数据转换为映射的实体类,也就是上面提到的,将response.body的类型直接转换为映射的实体类Tngou型;
得到了Retrofit对象,就可以利用它的create方法得到上面定义的网络请求接口对象,即HttpService的对象,这样也就把Retrofit对象和请求接口联系起来了;

HttpService httpService = retrofit.create(HttpService.class);

既然得到了定义的业务请求接口HttpService的对象,那么就可以调用里面的请求方法getCook,该方法返回得到一个Call<Tngou>的对象callCook;

Call<Tngou> cookCall = httpService.getCook(1, 10);

这样就已经生成了一个网络请求任务cookCall,而请求期望是获取到菜谱数据的一个页面的十条数据;
最后调用callCook的enqueue方法,即异步执行网络请求(当然也有同步执行的方法execute()),enqueue方法参数中有一个CallBack的回调接口,new 一个接口对象,即能获取到返回数据

 cookCall.enqueue(new Callback<Tngou>() {
            @Override
            public void onResponse(Call<Tngou> call, Response<Tngou> response) {
                List<Cook> list=response.body().getList();
                for (int i = 0; i <list.size() ; i++) {
                    String imgUri="http://tnfs.tngou.net/image"+list.get(i).getImg();
                    String text=list.get(i).getDescription();
                    imageDataArrayList.add(new ImageData(imgUri,text));
                }
                handler.sendEmptyMessage(0);
            }

            @Override
            public void onFailure(Call<Tngou> call, Throwable t) {
                t.printStackTrace();
            }
        });

获取数据成功会回调onResponse方法,失败会回调onFailure方法;

这样一次完整的get请求就完成了,是不是so easy

运行效果图

retrofit get请求.gif

好了,基本的使用就先写到这吧,学完之后发现Retrofit还是很NB的,封装的很全面,以后有时间还会来写一写Retrofit的其他的一些使用。

另外推荐两个博客,感觉他们写的很全面也比较通俗易懂
传送门:
Retrofit2前篇[基本使用]
Retrofit用法详解

若有意见或建议,欢迎批评指正

2017.5.7 00:16
806 实验室

推荐阅读更多精彩内容