Android网络框架之Retrofit + RxJava + OkHttp

现在Android网络请求大部分已经换成了Retrofit2.0 +RxJava + 0kHttp3.0,Retrofit 使用接口的方式,负责请求的数据和请求的结果,OkHttp 负责请求的过程,RxJava 负责异步,各种线程之间的切换。毫无疑问这三剑客 已成为当前Android 网络请求最流行的方式。

简介

Retrofit: Retrofit是Square 公司开发的一款基于restful风格接口的Android 网络请求的框架,对Okhttp做了一层封装。网络请求还是基于Okhttp,我们只需要通过简单的配置就能使用Retrofit来进行网络请求了。Retrofit官网

RxJava:RxJava 在 GitHub 主页上介绍 "a library for composing asynchronous and event-based programs using observable sequences for the Java VM"(一个在 Java VM 上使用可观测的序列来组成异步的、基于事件的程序的库)。总之,rxjava让异步操作变得非常简单。RxJava

OkHttp: Square 公司开源的网络请求库。 OkHttp

基本使用

HTTP协议中共定义了八种方法或者叫“动作”来表明对Request-URI指定的资源的不同操作方式,分别是OPTIONS、HEAD、GET、POST、PUT、DELETE、TRACE、CONNECT,介绍就省略了。

虽然有这么多种请求方式,但App的接口请求无非就是数据的增删改查,增删改查对应到Restful风格接口上也就是post,delete,put,get四种请求。在Retrofit框架提供的注解中,其中HTTP注解有五个,用来修饰请求方法,除了post,delete,put,get还有一个head。除了这五种网络请求方式外,App无非还会用到retrofit的单文件或者多文件的上传下载,同步请求或者异步请求的处理,还有okhttp数据缓存的问题。

注解 请求方式 用途
@Path GET 用于替换Url路径中的变量字符
@Query GET 用于拼接在Url路径后的查询参数,但相对于直接在Url后拼接,@Query则是添加一个变量
@QueryMap GET 效果等同于多个@Query 参数为Map类型
@FormUrlEncoded/@Field POST @FormUrlEncoded修饰表单域,每个表单域子件key-value采用@Field修饰
@Body POST 可以指定一个对象作为HTTP请求体@Body
@FormUrlEncoded/@Field PUT @FormUrlEncoded修饰表单域,每个表单域子件key-value采用@Field修饰
@HTTP/@Body DELETE @HTTP修饰表单域,以指定一个对象作为HTTP请求体@Body,此时表单域一定要写上hasBody = true
@Multipart/@Part或者@PartMap POST 文件上传使用,@Multipart修饰表单域,参数@Part修饰或者参数使用@PartMap

举例说明

引入依赖
compile 'com.squareup.retrofit2:retrofit:2.2.0'
compile 'com.squareup.retrofit2:adapter-rxjava:2.2.0'
compile 'com.squareup.retrofit2:converter-gson:2.0.0-beta3'
compile 'com.squareup.okhttp3:logging-interceptor:3.4.1'
compile 'com.squareup.okhttp3:okhttp:3.4.1'
compile 'io.reactivex:rxjava:1.1.9'
compile 'io.reactivex:rxandroid:1.2.1'
创建Retrofit对象
public class RetrofitManager {
private static RetrofitManager mRetrofitManager;
private Retrofit mRetrofit;

private RetrofitManager(){
    initRetrofit();
}

public static synchronized RetrofitManager getInstance(){
    
    if (mRetrofitManager == null){
        mRetrofitManager = new RetrofitManager();
    }
    return mRetrofitManager;
}

private void initRetrofit() {
    HttpLoggingInterceptor LoginInterceptor = new HttpLoggingInterceptor();
    LoginInterceptor.setLevel(HttpLoggingInterceptor.Level.BODY);

    OkHttpClient.Builder builder = new OkHttpClient.Builder();
    builder.addInterceptor(new RspCheckInterceptor());

    if (AppConfig.DEBUG){
        builder.addInterceptor(LoginInterceptor);
    }

    builder.connectTimeout(15, TimeUnit.SECONDS);
    builder.readTimeout(20, TimeUnit.SECONDS);
    builder.writeTimeout(20, TimeUnit.SECONDS);
    builder.retryOnConnectionFailure(true);
    OkHttpClient client = builder.build();

    Gson gson = new GsonBuilder()
            .setDateFormat("yyyy-MM-dd'T'HH:mm:ss.SSS'Z'")
            .setExclusionStrategies(new ExclusionStrategy() {
                                        @Override
                                        public boolean shouldSkipField(FieldAttributes f) {
                                            return false;
                                        }

                                        @Override
                                        public boolean shouldSkipClass(Class<?> clazz) {
                                            return false;
                                        }
                                    })
            .create();

    mRetrofit = new Retrofit.Builder()
            .baseUrl(AppConfig.BASE_URL)
            .addConverterFactory(GsonConverterFactory.create(gson))
            .addCallAdapterFactory(RxJavaCallAdapterFactory.create())
            .client(client)
            .build();
}

public <T> T createReq(Class<T> reqServer){
    return mRetrofit.create(reqServer);
}
}
创建访问API的请求
 /**
 * 添加标签
 *
 * @param supplier_id
 * @param staff_id
 * @param name
 * @param type
 * @return
 */
@FormUrlEncoded
@POST("memberservice/addMemberTag/suppliers/{supplier_id}/operator/{staff_id}")
Observable<BaseResponse> addMemberTag(@Path("supplier_id") String supplier_id,
                                      @Path("staff_id") String staff_id,
                                      @Field("name") String name, @Field("type") String type, @Field("timestamp") String timestamp);

/**
 * 删除标签(注意一定要写hasBody = true,否则delete不能使用body参数请求)
 *
 * @param supplier_id
 * @param operator_id
 * @return
 */
@HTTP(method = "DELETE", path = "memberservice/delMemberTag/suppliers/{supplier_id}/operator/{operator_id}", hasBody = true)
Observable<BaseResponse> deletMemberTag(@Path("supplier_id") String supplier_id,
                                        @Path("operator_id") String operator_id,
                                        @Body RequestBody content);


/**
 * 修改标签
 *
 * @param supplier_id
 * @param operator_id
 * @param map
 * @return
 */
@FormUrlEncoded
@PUT("memberservice/updateMemberTag/suppliers/{supplier_id}/operator/{operator_id}")
Observable<BaseResponse> updateMemberTag(@Path("supplier_id") String supplier_id,
                                         @Path("operator_id") String operator_id,
                                         @FieldMap Map<String, String> map);


/**
 * 查询标签
 *
 * @param supplier_id
 * @param staff_id
 * @return
 */
@GET("memberservice/queryStaffTag/suppliers/{supplier_id}/operator/{staff_id}")
Observable<BaseResponse<TagsBean>> queryMemberTag(@Path("supplier_id") String supplier_id,
                                                  @Path("staff_id") String staff_id,
                                                  @Query("timestamp") String timestamp);
}
发送请求以及处理结果
  RetrofitManager.getInstance().createReq(Api.class).addMemberTag(supply_id, staff_id, data, "2", getTime()).subscribeOn(Schedulers.io())
                            .observeOn(AndroidSchedulers.mainThread())
                            .subscribeOn(Schedulers.io())
                            .subscribe(new Subscriber<BaseResponse>() {
                                @Override
                                public void onCompleted() {

                                }

                                @Override
                                public void onError(Throwable e) {

                                      //处理请求失败的操作
                                }

                                @Override
                                public void onNext(BaseResponse baseResponse) {
                                    
                                    //处理成功后的结果
                                }

                            });
多图以及单图上传
方法一:
@Multipart
@POST("suppliers/{supplier_id}/staff/{staff_id}/meeting/{meeting_id}/upload")
Observable<BaseResponse> uploadePics(
        @Path("supplier_id")String supplier_id,@Path("staff_id")String staff_id,
        @Path("meeting_id")String meeting_id,@Part List<MultipartBody.Part> partList);


     MultipartBody.Builder builder = new MultipartBody.Builder()
                                .setType(MultipartBody.FORM)//表单类型 
                                .addFormDataPart("summary_position", formatted_address); //地理位置

                        //单张或者多张
                        for (int i = 0; i < listString.size(); i++) {
                            File file = new File(listString.get(i));
                            RequestBody imageBody = RequestBody.create(MediaType.parse("multipart/form-data"), file);
                            builder.addFormDataPart("summary_pics[]", file.getName(), imageBody);
                        }

                        List<MultipartBody.Part> parts = builder.build().parts();

                     RetrofitManager2.getInstance().createReq(PhpApi.class).uploadePics(
                                supplier_id,staff_id,meeting_id,parts)
                                .observeOn(AndroidSchedulers.mainThread())
                                .subscribeOn(Schedulers.io())
                                .subscribe(new Subscriber<BaseResponse>() {
                                    @Override
                                    public void onCompleted() {

                                    }

                                    @Override
                                    public void onError(Throwable e) {

                                    }

                                    @Override
                                    public void onNext(BaseResponse baseResponse) {

                                    }
                                });
方法二:
Observable<BaseResponse> uploadePics2(
        @Path("supplier_id")String supplier_id,@Path("staff_id")String staff_id,
        @Path("meeting_id")String meeting_id,
        @PartMap Map<String, RequestBody> params);

                        //单张或多张图片
                        List<File>files = new ArrayList<File>();
                        for (int i = 0; i < listString.size(); i++) {
                            File file = new File(listString.get(i));
                            files.add(file);
                        }

                        //组装partMap对象
                        Map<String, RequestBody> partMap = new HashMap<>();
                        for(File file : files ){
                            RequestBody fileBody = RequestBody.create(MediaType.parse("image/*"), file);
                            partMap.put("summary_pics[]\"; filename=\""+file.getName()+"\"", fileBody);
                        }
                        RequestBody formatted_addressString = RequestBody.create(MediaType.parse("text/plain"), formatted_address);
                        partMap.put("summary_position" , formatted_addressString);


                        RetrofitManager2.getInstance().createReq(PhpApi.class).uploadePics2(
                                supplier_id,staff_id,meeting_id,partMap)
                                .observeOn(AndroidSchedulers.mainThread())
                                .subscribeOn(Schedulers.io())
                                .subscribe(new Subscriber<BaseResponse>() {
                                    @Override
                                    public void onCompleted() {

                                    }

                                    @Override
                                    public void onError(Throwable e) {

                                    }

                                    @Override
                                    public void onNext(BaseResponse baseResponse) {

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

推荐阅读更多精彩内容