十、Retrofit简析

Retrofit注解分为三类

请求方法注解:GET、POST、PUT、DELETE、 HEAD、PATCH、OPTIONS和HTTP
标记类注解:FormUrlEncoded标记表单请求、Multipart标记上传文件请求、Streaming代表响应数据已流的形式返回,如果不设置则会默认把全部数据加载到内存,所以下载大文件时需要使用。
参数类注解:Header、Headers、Body、Path、Field、FieldMap、Part、PartMap、Query、QueryMap

对于GET请求

@Path动态配置接口地址
@Query动态更换请求参数
@QueryMap设置一组动态参数

public interface IpService{
    @GET("getIpInfo.pho?ip=59.108.54.37")//定义请求方法和请求接口
    Call<IpModel> getIpMsg()//定义返回类型参数
}
String url = "http://www.baidu.com/"
Retrofit retrofit = new Retrofit.Builder()
                           .baseUrl(url)
                           .addConverterFactory(GsonConverterFactory.create())//设置返回值Json支持
                           .bulid()
IpServer ipServer = retrofit.create(IpServer.class)
Call<IpModel> call = ipServer.getIpMsg()
call.enqueue(new Callback<IpModel>(){
    public void onResponse(Call<IpModel> call,Response<IpModel> response)
    public void onFailure()
})

中断请求可以调用call.cancel()方法。

对POST请求

@FormUrlEncoded标记请求为表单请求
@Field用于设置请求参数
@Body传输数据类型JSON,传入对应对象会自动转成字符串进行传输
@Part单个文件上传,需要加上标记@Multipart表示允许多个@Part。
@PartMap多个文件上传,也需要加上标记@Multipart

@Header用于添加header

源码分析

构建Retrofit使用的Builder,其构造函数内部调用了Platform.get()方法,调用了findPlatform()方法其内部判断根据不同的平台构建不同的线程池。
在Builder.build()方法中返回Retrofit实例,方法中首先判断baseUrl是否设置,如未设置抛出异常,接下来获取默认的Call.Factory即为构建Retrofit时调用callFactoty方法传入的对象并利用它的OkhttpClient对象,没有设置callFactory时会新创建OkhttpClient,build方法中还会利用callbackExector = platform.defaultCallbackExecutor()安卓中利用handler将回调切换到UI线程。接下来利用adapterFactories将Call进行对象转化。

Call的创建过程

IpServer ipServer = retrofit.create(IpServer.class)
Call<IPModel> call = ipServer.getIpMsg()
在create方法中返回一个Proxy.newProxyInstance动态代理对象,当调用getIpMsg()方法获取Call对象时调用的是InvocationHandler(Proxy.newProxyInstance构建时传入的匿名对象)的invoke方法,拿到Call其实是ExecutorCallbackCall,其是对Call的封装。invoke方法中还获取到了ServiceMethod
serviceMethod = loadServiceMethod(method)//method即为定义的getIpMsg()方法,在此方法中会先从InvocationHandler中的serviceMethodCache查询是否有缓存,有直接使用,没有创建一个ServiceMethod并加入serviceMethodCache中缓存起来。ServiceMethod是通过调用其Buidler的build方法构建的,查看build方法内部调用了createCallAdapter方法,即创建Retrofit时传入的adapterFactories添加对象的get方法,同时会默认添加defaultCallAdapterFactory即ExecutorCallAdapterFactory,从其get方法中得到CallAdapter对象,CallAdapter的responseType方法会返回数据的真实类型,adapt 方法会创建ExecutorCallbackCall,它会将call 的回调转发至UI线程。在ServiceMethod中的build方法中在调用createResponseConverter遍历converterFactories得到合适的Converter用来转换对象,在构建Retrofit时调用了 addConverterFactory将GsonConverterFactory(Converter.Factory的子类)添加到converterFactories列表中表示返回数据类型为Json对象。接着利用parseMethodAnnotation方法对请求方式和地址进行解析,然后解析请求参数最后构建return new ServiceMethod<>(this)。ServiceMethod类主要用于处理构建Retrofit时传入的设置,以及解析注解获取请求方法和请求参数。
在Retrofit的create方法中即InvocationHandler的invoke方法中,在调用了loadServiceMethod方法后会创建 OkHttpCall进行赋值操作,紧接着调用 serviceMethod.callAdapter.adapt(okHttpCall)得到ExecutorCallbackCall,其是对Call的封装通过callbackExecutor将请求回调到 UI 线程。我们得到 Call 对象后会调用它的 enqueue 方法,其实调用的是ExecutorCallbackCall的enqueue方法,最终调用的是delegate的enqueue方法。 delegate是传入的OkHttpCall。OkHttpCall的enqueue方法中调用了parseRespinse方法,根据不同的状态码进行不同操作,最后T body = serviceMethod.toResponse(catchingBody)在此根据传入的GsonConverterFactory利用调用responseConverter.convert转换为特定的数据格式(JSON)。

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

推荐阅读更多精彩内容