Retrofit进阶

前言

什么是Retrofit?
这类文章太多了,这里就不多做介绍,贴个官方链接:
http://square.github.io/retrofit/

以前抱着新鲜感使用Retrofit, 并没有感觉出太大的用处,最近接触到了RESTful API 才感受到了Retrofit的方便与强大。

读本文之前,建议对RxJava, Retrofit, RESTful稍做了解:
RESTful API 设计指南
RxJava 与 Retrofit 结合的最佳实践

关于RESTful API我再补充一句,gank.io的api在国内比较主流但不属于RESTful, GitHub的Api 才是。

下面直入主题。

提交表单

Post请求可以通过@Body提交整个表单,也可以通过@Field提交单个字段。

    @POST("/login")
    Observable<Response<UserEntity>> login(@Body LoginRequest loginRequest);

    /* == ↑非等同,取决于服务器接收 */
    @FormUrlEncoded
    @POST("/login")
    Observable<Response<UserEntity>> loginOtherWay(
            @Field("phone") String phone,
            @Field("password") String password,
            @Field("macAddress") String macAddress,
            @Field("ip") String ip
    );

使用拦截器统一处理Http请求头部与尾缀

@Headers自然可以添加头部,但是如何统一添加呢?
答:在拦截器里添加。

下面这段代码优点长,请注意httpClient.addInterceptor()内的代码:

    private Retrofit getRetrofit(final String baseUrl, final boolean isWithToken) {
        final OkHttpClient.Builder httpClient = new OkHttpClient.Builder();
        httpClient.addInterceptor(new Interceptor() {
            @Override
            public Response intercept(Chain chain) throws IOException {
                Request original = chain.request();

                Request.Builder builder = original.newBuilder()
                        .method(original.method(), original.body())
                        //添加请求头部
                        .header("Content-Type", "application/json")
                        .header("Accept", "application/json")
                        .header("key", "value")
                        .header("key2", "value2");
                if (isWithToken)
                    builder.header("token", App.get().getPreferencesHelper().getToken());

                Request finalRequest = builder.build();
                HttpUrl url = finalRequest.url().newBuilder()
                        // 在原链接上添加后缀,相当于在url上添加了 &platform=android&v=1.0
                        .addQueryParameter("platform", "android")
                        .addQueryParameter("v", "1.0")
                        .build();

                Logger.i(url.toString());
                return chain.proceed(builder.build());
            }
        });

        OkHttpClient okHttpClient = httpClient.build();

        Retrofit retrofit = new Retrofit.Builder()
                .baseUrl(baseUrl)
                .client(okHttpClient)
                .addConverterFactory(GsonConverterFactory.create())
                .addCallAdapterFactory(RxJavaCallAdapterFactory.create())
                .build();
        return retrofit;
    }

有没有发现,这个拦截器很强大~它可以在网络请求前对请求进行修改,而且它还能处理网络返回的结果。相当于一扇大门,外面是服务器,里面是客户端,二者间的通信都得经过它~~

与RxJava结合,在Observer中处理错误

当然,错误也可以在拦截器中统一处理,这里讲一下和RxJava的配合使用。

下面是Api网络请求的返回处理:

        // 未作任何封装
        new UserApi().getInfo("XunMengWinter").subscribe(
                new Observer<UserEntity>() {
                    @Override
                    public void onCompleted() {
                        // 成功后
                    }

                    @Override
                    public void onError(Throwable e) {
                        // 所有的错误全在这里
                    }

                    @Override
                    public void onNext(UserEntity userEntity) {
                        // 成功后
                    }
                }
        );
        
        // 对Observer封装后,统一处理错误
        new UserApi().getInfo("XunMengWinter").subscribe(
                new HttpObserver<UserEntity>() {
                    @Override
                    public void onComplete() {

                    }

                    @Override
                    public void onSuccess(UserEntity model) {

                    }
                });

采用RESTful的Api与RxJava是完美配合的,所有的错误全都在onError()里面,尽管在onNext()里使用数据就好了。下面看下如何对RxJava的Observer稍作封装以统一处理错误(GitHub链接在此):

/**
 * 网络请求返回需要的模型
 * Created by ice on 3/3/16.
 */
public abstract class HttpObserver<T> implements Observer<T>, INetResult<T> {

    /**
     * 请求失败, 对错误信息进行处理,
     * 默认显示一个Toast提醒用户.
     */
    @Override
    public void onFail(int errorCode, String msg) {
        App.get().showToast(msg);
    }


    @Override
    public void onCompleted() {
        onComplete();
    }

    @Override
    public void onError(Throwable e) {
        onComplete();
        Logger.e(e.toString());
        if (e instanceof SocketTimeoutException) {
            App.get().showToast("连接超时");
        } else if (e instanceof HttpException) {
            HttpException httpException = (HttpException) e;
            Logger.e(httpException.code() + "");
            Logger.e(httpException.message() + "");
            if (httpException.response() != null && httpException.response().errorBody() != null) {
                try {
                    Logger.e(httpException.response().message());
                    String bodyStr = httpException.response().errorBody().string();
                    Logger.e(bodyStr);
                    ErrorBodyEntity errorBodyEntity = JSON.parseObject(bodyStr, ErrorBodyEntity.class);
                    onFail(httpException.code(), errorBodyEntity.getMessage());
                } catch (IOException e1) {
                    e1.printStackTrace();
                }
            }
        }
    }

    @Override
    public void onNext(T model) {
        Logger.i(JSONObject.toJSONString(model));
        onSuccess(model);
    }

}

注意在onError()方法里一定要将Throwable e强转为HttpException httpException才能看到网络请求错误的全部内容。
经封装,无论网络请求是否成功都会调用onComplete(),这样的话你可以在里面处理进度条等;成功的话会调用onSuccess(model);错误的话会执行默认处理,你也可以重写onFail()来进行特殊的错误处理~~

后记

其实想把Retrofit玩6,主要还是用好拦截器啦~^^
代码地址:https://github.com/XunMengWinter/PowerfulRetrofit

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

推荐阅读更多精彩内容