Retrofit详解

警言:慎终如始!

1. REST 介绍:

Resources Representational State Transfer

资源表现层状态转化

每一个URI代表一种资源 客户端和服务器之间,传递这种资源的某种 表现层(“资源”具体呈现出来的形式,比如.txt,.png,.jpg) 客户端通过四个HTTP动词(GET用来获取资源,POST用来新建或更新资源,PUT用来更新资源,DELETE用来删除资源)对服务器端资源进行操作,实现”表现层状态转化”

关于REST,这里只仅仅列出了结论,文末有超级好的链接,请查看。如果你所使用的API是REST的,那么恭喜你,这样的API看起来真的很舒服,庆幸的是我司就使用的是REST API。

2.Retrofit基本用法

(1)在build.gradle中添加依赖

compile 'com.squareup.retrofit2:retrofit:2.0.2'

compile 'com.squareup.retrofit2:converter-gson:2.0.2'

compile 'com.squareup.retrofit2:adapter-rxjava:2.0.2'

compile 'com.squareup.okhttp3:logging-interceptor:3.2.0'

compile 'com.squareup.retrofit2:converter-scalars:2.0.0'

(小问题,想通过retrofit得到json字符串)

在使用Retrofit来作为网络请求库之后,笔者查阅了网上的有关教程,无外乎都是请求json数据,使用addConverterFactory(GsonConverterFactory.create())来作为转化器,如果业务需求是请求 字符串,而不是json数据格式呢,继续使用这个转换器就会产生错误。

好,来到正题,如何使用Retrofit请求一段字符串:

其实官方已经提供了一个字符串的转换器,那么接下来把它导入项目使用就可以了。

添加gradle依赖

compile'com.squareup.retrofit2:converter-scalars:2.0.0'

mRetrofit = new Retrofit.Builder()                .baseUrl(HttpAddress.SITE).addConverterFactory(ScalarsConverterFactory.create()).build();

(2)创建接口,声明API

//创建接口,声明GitHub的API

publicinterfaceGitHubAPI {

/*

请求该接口:https://api.github.com/users/baiiu

*/

@GET("users/{user}")

Call userInfo(@Path("user") String user);

}

(3)在MainActivity.onCreate()方法中调用

1.初始化OkHttpClient

*/

OkHttpClient client =newOkHttpClient();

/*

2.创建Retrofit

*/

retrofit =newRetrofit.Builder()

//设置OKHttpClient

.client(client)

//设置baseUrl,注意,baseUrl必须后缀"/"

.baseUrl("https://api.github.com/")

//添加Gson转换器

.addConverterFactory(GsonConverterFactory.create())

.build();

/*

2.获取GitHub的API

*/

GitHubAPI gitHubAPI = retrofit.create(GitHubAPI.class);

/*

3.异步调用

*/

Call userCall = gitHubAPI.userInfo("baiiu");

userCall.enqueue(newCallback() {

@OverridepublicvoidonResponse(Call call, Response response) {

User body = response.body();

LogUtil.d(body ==null?"body == null": body.toString());

}

@OverridepublicvoidonFailure(Call call, Throwable t) {

/*

判断是否被cancel掉了

*/

if(call.isCanceled()) {

LogUtil.d("the call is canceled , "+ toString());

}else{

LogUtil.e(t.toString());

}

}

});

/*

取消调用

*/

//userCall.cancel();

/*

同步调用,举个例子,写法如下(当然不能在主线程调用):

*/

Call clone = userCall.clone();

Response response = clone.execute();

User body = response.body();

LogUtil.d(body ==null?"body == null": body.toString());

(Android正常情况下都只会用到异步回调)

注意:

1. 设置BaseUrl时必须后缀”/”,如https://api.github.com/

(否而: java.lang.IllegalArgumentException: baseUrl must end in /:)

2. 因为Retrofit在创建时候传入了BaseUrl,所以基本上所有请求都基于该BaseUrl了。但是总有些API不是以该BaseUrl开头的,特别是有些公司可能不是restful API的。那么该怎么办呢。Retrofit提供了一个注解@Url解决这个问题,可以在运行时直接使用该Url直接访问。代码如下:

//使用@Url注解,传入该Url地址就OK啦,跨过BaseUrl,直接访问该Url地址

@GETCall getNewsList(@UrlString url);  get后面不能加参数

4. Retrofit注解

请求头的设置可以通过@Header注解添加,又有两种添加方式:

设置静态的请求头:

@Headers("Cache-Control: max-age=640000")

@GET("widget/list")

Call> widgetList();

@Headers({

"Accept: application/vnd.github.v3.full+json",

"User-Agent: Retrofit-Sample-App"

})

@GET("users/{username}")

Call getUser(@Path("username") String username);

动态的设置请求头:

@GET("user")

Call getUser(@Header("Authorization") String authorization)


                               希望小伙伴们多多支持(如有错误,希望指出)

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

推荐阅读更多精彩内容

  • Retrofit详解 在目前的开发环境下,相信Retrofit这个词大家已经非常熟悉了,就像之前volley刚出来...
    OpenCoder阅读 5,786评论 0 10
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,637评论 18 139
  • 前段时间看了RxJava,发现跟他一起用的Retrofit,今天就把认识的他们俩个来总结梳理一下 一、什么是RxJ...
    毹毹阅读 668评论 0 5
  • Retrofit用法详解 一、简介 Retrofit是Square公司开发的一款针对Android网络请求的框架,...
    流水潺湲阅读 847评论 0 6
  • 写在前面## 其实一直都没有写博客的习惯,借着这次公司内部分享的机会,开始写博客,希望以后渐渐养成习惯。也方便以后...
    seph_von阅读 878评论 0 1