Retrofit的分析以及实现步骤

简介

Retrofit是Square开发的一个Android和Java的REST客户端库。这个库非常简单并且具有很多特性,相比其他的网络库,更容易让初学者快速掌握。它可以处理GET、POST、PUT、DELETE...等请求,还可以使用picasso加载图片。

为什么要使用retrofit,看一下下面一张图就明了了。


实现步骤

1、添加Retrofit库到项目中
MAVEN

<dependency>
  <groupId>com.squareup.retrofit2</groupId>
  <artifactId>retrofit</artifactId>
  <version>2.0.0-beta3</version>
</dependency>

或者Gradle

compile 'com.squareup.retrofit2:retrofit:2.0.0-beta3'

2、添加网络权限

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

3、实例化Retrofit

 Retrofit retrofit = new Retrofit.Builder() .baseUrl(HttpUtil.URL_BASE) .build();

baseUrl里面的一般都放基本的链接

在Retrofit 2.0中,OkHttp 是必须的,并且自动设置为了依赖,OkHttp已经自动被用作HTTP 接口。下面的代码是从Retrofit 2.0的pom文件中抓取的。你不需要再做任何事情了。

<okhttp.version>3.0.0</okhttp.version>

      <dependency>
        <groupId>com.squareup.okhttp3</groupId>
        <artifactId>okhttp</artifactId>
        <version>${okhttp.version}</version>
      </dependency>

4、设置解析库
在Retrofit 2.0中,Converter 不再包含在package 中了。你需要自己插入一个Converter, 不然的话Retrofit 只能接收字符串结果。同样的,Retrofit 2.0也不再依赖于Gson 。如果你想接收json 结果并解析成DAO,你必须把Gson Converter 作为一个独立的依赖添加进来。

compile 'com.squareup.retrofit2:converter-gson:2.0.0-beta3'

然后使用addConverterFactory把它添加进来。注意RestAdapter的别名仍然为Retrofit。

        Retrofit retrofit = new Retrofit.Builder()
                .baseUrl(HttpUtil.URL_BASE)
                .addConverterFactory(GsonConverterFactory.create())
                .build();

注意:
如果你不需要解析json,只要字符串,那就不需要使用addConverterFactory。
当然,Retrofit 2 现在支持许多种解析方式来解析响应数据,如下:

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

5、service接口

public interface APIService {

    @GET("getForumNoteListV1.0.php")
    Call<JsonObjectResult<JsonArrayResult<NoteListModel>>> loadForumNoteList(@Query("plateItemID") String plateItemID,@Query("searchType") String searchType,@Query("index") int index);

    @GET("adat/sk/{cityId}.html")
    Call<ResponseBody> getWeather(@Path("cityId") String cityId);
}

如上述代码中的2个Endpoints,需要提醒以下几点:
a)@GET是指用get请求,@POST是指post请求

b)Retrofit 2后,返回值始终是一个参数化了的Call<T>对象,比如
Call<JsonObjectResult<JsonArrayResult<NoteListModel>>>。如果你不需要任何类型安全的响应,你可以把返回值指定为Call<ResponseBody>

c)一般地,base URL是在实例化 Retrofit instance的时候定义的。Retrofit 2 允许你在注解里面重写base URL 。例如HttpUtil.URL_BASE的值为
http://www.xxxx.com/appapi/,那么第一个Endpoints的地址就是
http://www.xxxx.com/appapi/getForumNoteListV1.0.php
当然,写法不同,地址就不同,出于安全考虑,
建议:

  • Base URL: 总是以 /结尾
  • @Url: 不要以 / 开头

d)每个endpoint 都指定了一个关于HTTP(GET, POST, 等等。) 方法的注解以及用于分发网络调用的方法。而且这些方法的参数也可以有特殊的注解。


6、接口请求
做好了上述准备后,就可以在代码中请求数据了。

public void loadData(final String plateItemID, final String plateItemName, String searchType, int page) {

        Retrofit retrofit = new Retrofit.Builder()
                .baseUrl(HttpUtil.URL_BASE)
                .addConverterFactory(GsonConverterFactory.create())
                .build();

        APIService service = retrofit.create(APIService.class);
        Call<JsonObjectResult<JsonArrayResult<NoteListModel>>> call = service.loadForumNoteList(plateItemID, searchType, page);
        
        call.enqueue(new Callback<JsonObjectResult<JsonArrayResult<NoteListModel>>>() {
            @Override
            public void onResponse(Response<JsonObjectResult<JsonArrayResult<NoteListModel>>> response) {
                modelList.clear();
                String mTotalCount = "";

                String success = response.body().getSuccess();
                LogCat.i("success=" + success);

                if (success != null && success.equals(Constant.JSON_SUCCESS_BACK)) {
                    modelList = response.body().getData().getDataList();
                    mTotalCount = response.body().getData().getTotalCount();
                    LogCat.i("mTotalCount=" + mTotalCount);
                }
            }

            @Override
            public void onFailure(Throwable t) {
            }
        });

    }

以上代码发起了一个在后台线程的请求并从response 的response.body()方法中获取一个结果对象。注意这里的onResponse和onFailure方法是在主线程中调用的。

参考文献:
http://square.github.io/retrofit/
https://github.com/square/retrofit
使用Retrofit请求API数据
Retrofit 2.0:有史以来最大的改进

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

推荐阅读更多精彩内容