更新到Retrofit2的一些技巧

原文链接:Tips on updating to Retrofit 2
ps:其实我老早就更新到Retrofit2了 但是不同的beta版目前改变还是挺大的,如果你在用的话 ,要时刻跟进并查看它的changelog.该文章还是比较倾向于1.9升级2.0 但是就像前面说的 beta2到beta4改变也是非常大的 所以同样可以参考用于备忘

Retrofit2.0已经公开发布几个月了,但是现在依然是beta版,一些开发者已经开始从之前的版本进行升级,虽然官方已经提供了文档,文章或博客让你了解最新版的相关信息,但是在StackOverflow还是可以看到一些提问关于在升级版本的过程中怎么处理常见功能像logging打印日志,添加request parameter或者使用JSON对象等,所以在这篇文章中,我会告诉你关于这些问题的一些技巧。

写文章时,Retrofit的版本是v2.0.0-beta4.

新的group id

第一个你会注意到的改变是新的group id,变成了com.squareup.retrofit2,所以新的依赖声明是:

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

新的包名

主包名已经改成了

package retrofit2;

这意味的你需要更改所有关于Retrofit的import,此外,如果你还有其他涉及到包名的代码或任务,记得也要更新他们。

proguard 配置

因为新包名,如果你开启了混淆代码,第一件要做的事就是更新配置文件的规则,它们可以在官方网站找到:

-dontwarn retrofit2.**
-keep class retrofit2.** { *; }
-keepattributes Signature
-keepattributes Exceptions

okhttp

okhttp现在Retrofit2内置的默认依赖,实际上,查看Retrofit2的pom文件(maven的依赖配置文件),会发现下面的依赖:

<dependency>
      <groupId>com.squareup.okhttp3</groupId>
      <artifactId>okhttp</artifactId>
</dependency>

如果你不需要用一个特殊版本的okhttp或者其他http client,你不用做任何事情。

生成服务接口实现

service interface implementation generation

你会立即注意到的另外一件事是你的生成服务接口实现的代码没法编译了。

下面是Retrofit的典型代码:

RestAdapter restAdapter = new RestAdapter.Builder()
                .setEndpoint("https://api.github.com")
                .build();
GitHubService service = restAdapter.create(GitHubService.class);

在Retrofit2,会变成:

Retrofit retrofit = new Retrofit.Builder()
    .baseUrl("https://api.github.com")
    .build();
GitHubService service = retrofit.create(GitHubService.class);

你可以看到,依然是build模式,但是涉及的方法和类已经变了。

logging

在开发中打印网络请求和返回结果是非常重要的,如果你在Retrofit中启用了这个功能,你会发现实现该功能的方法已经不可用了。

setLogLevel(RestAdapter.LogLevel.FULL)    

那是因为你现在必须依靠okhttp提供的日志系统,HttpLoggingInterceptor.

首先声明一个新的依赖,因为它不是okhttp的一部分所以要另外添加依赖:

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

然后,创建一个interceptor实例:

HttpLoggingInterceptor httpLoggingInterceptor = new HttpLoggingInterceptor();
httpLoggingInterceptor.setLevel(HttpLoggingInterceptor.Level.BODY);

再然后,添加到OkHttp client实例中:

OkHttpClient okHttpClient = new OkHttpClient.Builder().addInterceptor(httpLoggingInterceptor).build();

最后,把client设置到service interface实现中:

Retrofit retrofit = new Retrofit.Builder()
    .client(okHttpClient)
    .baseUrl(MovieDbApi.END_POINT)
    .build();
movieDbApi = retrofit.create(MovieDbApi.class);

ps:其实这个log并不是很好用,最好自己参考源码自己自定义一个,分分钟就搞定了。

gson converter

By default, Retrofit can only deserialize HTTP bodies into OkHttp’s ResponseBody type and it can only accept its RequestBodytype for @Body.

这意味得用来支持其他types的converter必须在创建服务接口时进行设置

为了让JSON和Java对象相互转换,我们需要设置一个GSON转换器

首先,需要一个新的依赖:

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

然后设置converter factory:

Retrofit retrofit = new Retrofit.Builder()
    .client(okHttpClient)
    .baseUrl(MovieDbApi.END_POINT)
    .addConverterFactory(GsonConverterFactory.create())
    .build();
movieDbApi = retrofit.create(MovieDbApi.class);

完整的可用converters可以查看官方文档

interceptor

Retrofit另外一个有用的功能是可以拦截http请求进行监控,重写或重试

一个典型应用场景是所有http请求需要加上api key,在Retrofit2之前,可以通过RequestInterceptor实现:

final RequestInterceptor authorizationInterceptor = new RequestInterceptor() {
        @Override
        public void intercept(RequestInterceptor.RequestFacade request) {
            request.addQueryParam(MovieDbApi.PARAM_API_KEY, "YOUR_API_KEY");
        }
    };

然后

RestAdapter restAdapter = new RestAdapter.Builder()
                .setEndpoint(MovieDbApi.END_POINT)
                .setRequestInterceptor(authorizationInterceptor)
                .build();
movieDbApi = restAdapter.create(MovieDbApi.class);

在Retrofit2中已经不再有效了,因为你现在必须依靠OKHttp interceptors.

你可以直接在OKHttp client实例化时进行设置:

OkHttpClient okHttpClient = new OkHttpClient.Builder().addInterceptor(new Interceptor() {
    @Override
    public Response intercept(Chain chain) throws IOException {
        Request request = chain.request();
        HttpUrl url = request.url().newBuilder().addQueryParameter(
MovieDbApi.PARAM_API_KEY, BuildConfig.MOVIE_DB_API_KEY).build();
        request = request.newBuilder().url(url).build();
        return chain.proceed(request);
    }
}).build();

然后像前面那样设置client:

Retrofit retrofit = new Retrofit.Builder()
    .client(okHttpClient)
    .baseUrl(MovieDbApi.END_POINT)
    .build();
movieDbApi = retrofit.create(MovieDbApi.class);

RxJava observable

如果你正在使用RxJava,你会注意到Retrofit2 interfaces已经不支持Observable了,实际上,Call模式被用于标准的http请求。

当然你可以用你自己的类型,提供你自己的CallAdapter实现,但是幸运的是已经有可用的了,RxJavaCallAdapterFactory.简单说,它把Call转换成Observable.

首先,添加依赖:

com.squareup.retrofit2:adapter-rxjava:2.0.0-beta4

然后,用addCallAdapterFactory进行设置:

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

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 170,570评论 25 707
  • 本博客为作者原创,如需转载请注明原博客出处:WONDER'TWO 0X00 写在前面 相信做过And...
    一只酸奶牛哇阅读 4,271评论 9 34
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,100评论 18 139
  • 文/魏千洛 谁的年华不曾虚度。 谨以此文追忆逝去的那些琐碎美好。 1. 对北京的初印象起于一碗面。 2006年,在...
    千洛读书阅读 524评论 -1 5
  • 2017年写50篇走心的高质量技术文章,20篇非技术类思想性质文章,看完30本书,发展重点在写作上,适当的投资一些...
    我是硕儿阅读 350评论 5 5