Android日记之Retrofit的基本使用

前言

之前做的项目都是用okhttp框架来进行网络请求的,然后自己自行封装,虽然以前也有使用过Retrofit,但是Retrofit本质上还是对okhttp的封装,而且面试的时候也会经常的Retrofit框架的使用和原理以及它内部使用的设计模式之类的,这篇文章主要讲述如何使用Retrofit请求框架,以及一些使用的细节,毕竟是一个很灵活的使用框架,后续在写一篇关于Retrofit的源码解析和使用了哪些设计模式。

Retrofit的导入

我们主要以是2.0版本来进行讲解,第一个是Retrofit,第二个是Retrofit的Json解析,至于有什么用后面就知道了,当然换成别的Json解析也是可以的

implementation 'com.squareup.retrofit2:retrofit:2.5.0'
implementation 'com.squareup.retrofit2:converter-gson:2.5.0'

还有网络权限也要记得添加:

<uses-permission android:name="android.permission.INTERNET" />


Call接口

首先它需要一个请求的Call接口来进行请求,Retrofit使用注解的方式来区分是Get请求还是Post请求等等之类的,比如:

public interface ApiService {

    @GET(".")
    Call<ResponseBody> get();
}

这就是一个很简单的get请求的接口,泛型是你要返回的Model数据的类型,当然如果你的请求地址是动态的话,可以这么写:

@GET("api/{path}")
Call<ResponseBody> get(@Path("path")int path);

Post请求的话可以这么写:

@FormUrlEncoded
@POST(".")
Call<ResponseBody> post(@Field("ip") String first);

@FormUrlEncoded表示这是一个表单的请求,传输数据类型为键值对,使用@Field注解来标示所对应的String类型数据的键,从而组成一组键值对进行传递。

当然还有其它的注解:

注解代码如图,侵删

字段注解代码如图,侵删

这里需要注意的是在@GET或者@POST的括号里面如果没有要请求的URL的话,是不能空着的,空的话默认写 . 或者 / 都是可以的,如果是空的话则会报错:
Call接口报错如图

创建Retrfit客户端对象

//创建Retrfit
Retrofit retrofit = new Retrofit.Builder()
        .baseUrl("https://wanandroid.com/wxarticle/chapters/json/")
        .addConverterFactory(GsonConverterFactory.create())
        .build();

通过Retrofit的Builder()构建者模式可以快速构建客户端以及所需要的配置,addConverterFactory()这个方法就是配置你要用哪个Gson对返回的数据进行解析。没错,这也是为什么要在Call设置泛型的原因,Retrofit是会自动进行Json解析的,然后最后返回的结果就是解析后的Response实体,这样就不用另外写解析Json的业务逻辑,大大节省了代码的行数。

这里有一个非常需要注意的点!这里填入的baseUrl()是公共的Url,后面就是跟着你自己定义接口路径的Url,这里的baseUrl()填的Url结尾一定要跟一个 / ,否则它也是会报错的(PS:这里用的请求接口是“玩Android 开放API”的公共API)。

Url报错如图

Retrofit的异步请求

//用Retrofit创建接口实例对象
ApiService apiService = retrofit.create(ApiService.class);
//获取Call对象
Call<DataModel> call = apiService.get();
//开始异步操作
call.enqueue(new Callback<DataModel>() {
    @Override
    public void onResponse(Call<DataModel> call, Response<DataModel> response) {

        Toast.makeText(MainActivity.this, response.body().getData().get(0).getName(), Toast.LENGTH_SHORT).show();
        b1.setText("请求完毕更新UI");
    }

    @Override
    public void onFailure(Call<DataModel> call, Throwable t) {

    }
});

接下来就跟okhttp的请求差不多,通过Retrofit客户端创建一个接口的实例对象,然后通过Call进行获取,最后使用enqueue()来进行异步请求返回一个Callback的回调接口,回调接口的泛型就是Retrofit客户端Json解析后的Model。

结果如图

这里我们发现了,我们是可以在回调回来的接口里面进行直接更新UI的操作的,这也就代表回调回来的接口是在主线程上面的,不像okhttp那样回调回来的接口还是在子线程上,我们还需要通过Handler来进行更新UI的操作。

返回原始Json字段

刚刚也说了,Retrofit返回过来的是已经经过Json解析过的Response对象,但是有时候Json字段是不断更新的话,你的Model也要进行相应的更新,这就需要返回原始的字段了,Retrofit本身没提供这个方法,但是毕竟是封装okhttp,它是可以返回原始的Json字段的。

@GET(".")
Call<ResponseBody> get();
//创建Retrfit
Retrofit retrofit = new Retrofit.Builder()
        .baseUrl("https://wanandroid.com/wxarticle/chapters/json/")
        .addConverterFactory(GsonConverterFactory.create())
        .build();

//用Retrofit创建接口实例对象
ApiService apiService = retrofit.create(ApiService.class);
//获取Call对象
Call<ResponseBody> call = apiService.get();
//开始异步操作
call.enqueue(new Callback<ResponseBody>() {
    @Override
    public void onResponse(Call<ResponseBody> call, Response<ResponseBody> response) {

        String json = null;
        try {
            json = response.body().string();
        }catch (Exception e){
            e.printStackTrace();
        }


        Toast.makeText(MainActivity.this, json, Toast.LENGTH_SHORT).show();
        b1.setText("请求完毕更新UI");
    }

    @Override
    public void onFailure(Call<ResponseBody> call, Throwable t) {

    }
});

其实只要把Call要传入的泛型接口改成ResponseBody就好了,对应的回调接口也要改成ResponseBody,ResponseBody是okhttp的Response的返回体,所以就可以通过string()方法返回就好了。

Json返回结果如图

参考

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 218,451评论 6 506
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,172评论 3 394
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,782评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,709评论 1 294
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,733评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,578评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,320评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,241评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,686评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,878评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,992评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,715评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,336评论 3 330
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,912评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,040评论 1 270
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,173评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,947评论 2 355

推荐阅读更多精彩内容