美文网首页android 开发程序员
RxJava入门与提高-网络Retrofit 篇(5)

RxJava入门与提高-网络Retrofit 篇(5)

作者: 小玉1991 | 来源:发表于2017-11-09 13:01 被阅读41次

    Retrofit简介

    Retrofit与okhttp共同出自于Square公司,retrofit就是对okhttp做了一层封装。把网络请求都交给给了Okhttp,我们只需要通过简单的配置就能使用retrofit来进行网络请求了,

    其主要作者是Android大神JakeWharton

    导包:

    compile 'com.squareup.retrofit2:retrofit:2.0.0-beta4'//Retrofit2所需要的包
    compile 'com.squareup.retrofit2:converter-gson:2.0.0-beta4'//ConverterFactory的Gson依赖包
    compile 'com.squareup.retrofit2:converter-scalars:2.0.0-beta4'//ConverterFactory的String依赖包
    
    
    • 这里需要值得注意的是导入的retrofit2包的版本必须要一致,否则就会报错。

    首先定义我们请求的Api,我们假设是这样的

    http://106.3.227.33/pulamsi/mobileLogin/submit.html
    

    与Okhttp不同的是,Retrofit需要定义一个接口,用来返回我们的Call对象,这里示范的是Post请求:

    public interface RequestServes {
        @POST("mobileLogin/submit.html")
        Call<String> getString(@Query("loginname") String loginname,
                               @Query("nloginpwd") String nloginpwd);
    }
    

    Retrofit提供的请求方式注解有@GET和@POST,参数注解有@PATH和@Query等,我们只介绍常用的;
    前两个顾名思义就是定义你的请求方式Get or Post,后面的@PATH指的是通过参数填充完整的路径,一般用法:

    @GET("{name}")
    Call<User>
    getUser(@Path("name") String username);
    

    这里的参数username会被填充至{name}中,形成完整的Url请求地址,{name}相当于一个占位符;

    @Query就是我们的请求的键值对的设置,我们构建Call对象的时候会传入此参数,

    @POST("mobileLogin/submit.html")
        Call<String> getString(@Query("loginname") String loginname,
                              @Query("nloginpwd") String nloginpwd);
    

    这里@Query("loginname")就是键,后面的loginname就是具体的值了,值得注意的是Get和Post请求,都是这样填充参数的;

    接口写完了之后我们需要来定义Retrofit对象来进行请求了;
    创建一个Retrofit 对象

    Retrofit retrofit = new Retrofit.Builder()
                   .baseUrl("http://106.3.227.33/pulamsi/")
                   //增加返回值为String的支持
                   .addConverterFactory(ScalarsConverterFactory.create())
                   //增加返回值为Gson的支持(以实体类返回)
                   .addConverterFactory(GsonConverterFactory.create())
                   //增加返回值为Oservable<T>的支持
                   .addCallAdapterFactory(RxJavaCallAdapterFactory.create())
                   .build();
    

    这里的baseUrl加上之前@POST("mobileLogin/submit.html")定义的参数形成完整的请求地址;

    addConverterFactory(ScalarsConverterFactory.create())的意思是构建了一个返回支持,如果你的Call对象的泛型接收另外的格式需要添加另外的支持,上述代码已经列出;

    接下来我们用这个Retrofit对象创建一个RequestSerives接口对象,也就是我们之前定义的那个接口,并且得到我们的Call对象;

    RequestSerives requestSerives = retrofit.create(RequestSerives.class);//这里采用的是Java的动态代理模式
    Call<String> call = requestSerives.getString("userName", "1234");//传入我们请求的键值对的值
    
    //利用得到的Call对象,然后我们就发出网络请求了:
    call.enqueue(new Callback<String>() {
        @Override
        public void onResponse(Call<String> call, Response<String> response) {
            Log.e("===","return:"response.body().toString());
        }
    
        @Override
        public void onFailure(Call<String> call, Throwable t) {
            Log.e("===","失败");
        }
    });
    

    返回javaBean对象

    private void EasyRetrofit() {
            GithubService service = GenServiceUtil.createService(RequestSerives.class);
            Call<GithubUserBean> call =.getString("userName", "1234");//传入我们请求的键值对的值
            call.enqueue(new Callback<GithubUserBean>() {
                @Override
                public void onResponse(Call<GithubUserBean> call, Response<GithubUserBean> response) {
                    GithubUserBean bean = response.body();
                    //loading.dismiss();
                   //setUserView(bean);
                }
    
                @Override
                public void onFailure(Call<GithubUserBean> call, Throwable t) {
                   // loading.dismiss();
                }
            });
        }
    

    使用Call实例完成同步或异步请求

    • 同步请求。这里需要注意的是网络请求一定要在子线程中完成,不能直接在UI线程执行,不然会crash
    BookSearchResponse response = call.execute().body();
    
    • 异步请求
    call.enqueue(new Callback<BookSearchResponse>() {
    @Override
    public void onResponse(Call<BookSearchResponse> call,        Response<BookSearchResponse> response) {
    asyncText.setText("异步请求结果: " + response.body().books.get(0).altTitle);
    }
    @Override
    public void onFailure(Call<BookSearchResponse> call, Throwable t) {
    
    }
    });
    

    Rxjava+Retrofit

    关于什么是RxJava,这里不再赘述,不了解的点击这里看看 RxJava入门与提高(1)

    现在我们就看看将RxJava 和Retrofit的内容结合在一起会有怎样的效果。(安卓开发)

    Step 1 加入依赖

     //retrofit
        compile 'com.squareup.retrofit2:retrofit:2.1.0'
        compile 'com.squareup.retrofit2:converter-gson:2.1.0'
        compile 'com.squareup.retrofit2:adapter-rxjava:2.1.0'
    
        //rxjava
        compile'io.reactivex:rxandroid:1.1.0'
        compile'io.reactivex:rxjava:1.1.0'
    

    还是要注意版本一致的问题

    Step 2 创建一个工具类

    public class GenServiceUtil {
        private static final String BASE_URL = "https://api.github.com/";
    
        private static OkHttpClient.Builder httpClient = new OkHttpClient.Builder();
    
        private static Retrofit.Builder builder = new Retrofit.Builder()
                .baseUrl(BASE_URL)
                .addConverterFactory(GsonConverterFactory.create());
    
        private static Retrofit retrofit = builder.client(httpClient.build()).build();
    
        public static <S> S createService(Class<S> serviceClass) {
            return retrofit.create(serviceClass);
        }
    
    }
    

    Step 3 RxJava+Retrofit 实现

    GithubUserBean为返回的javaBean,需要注意的是,这个bean的属性字段必须要跟返回的json数据严格匹配。当然,bean的字段可以比json数据的多一些。

    创建这个bean,可以用android studio gsonformat插件,根据上面的json格式自动生成一个Bean类,直接把json格式数据复制进去,插件就会自动创建好一个bean。(个人觉得这样的模式不好。还不如自己用注解的方式去匹配呢,或者直接操作json格式数据,对页面进行填充)

    private void RxRetrofit() {
            //GithubService为定义的访问接口
            GithubService service = GenServiceUtil.createService(GithubService.class);
            final Call<GithubUserBean> call = service.getUser(name);
            final Observable myObserable = Observable.create(new Observable.OnSubscribe<GithubUserBean>() {
                @Override
                public void call(Subscriber<? super GithubUserBean> subscriber) {
                    Response<GithubUserBean> bean = null;
                    try {
                        bean = call.execute();
                        subscriber.onNext(bean.body());
    
                    } catch (IOException e) {
                        e.printStackTrace();
                        subscriber.onError(e);
                    }
    
                    subscriber.onCompleted();
                }
            });
    
            myObserable
                    .subscribeOn(Schedulers.io())
                    .observeOn(AndroidSchedulers.mainThread())
                    .map(new Func1<GithubUserBean, GithubUserBean>() {
                        @Override
                        public GithubUserBean call(GithubUserBean o) {
                            if (TextUtils.isEmpty(o.getBio())) {
                                o.setBio("nothing !");
                            }
                            return o;
                        }
                    })
                    .subscribe(new Subscriber<GithubUserBean>() {
                        @Override
                        public void onCompleted() {
                            loading.dismiss();
                        }
    
                        @Override
                        public void onError(Throwable e) {
                            loading.dismiss();
                        }
    
                        @Override
                        public void onNext(GithubUserBean o) {
                            setUserView(o);//填充页面
                        }
                    });
    
        }
    

    这里有几点需要注意:

    • RxJava 本身最大的特定就是异步,因此这里我们Retrofit执行网络请求的时候,使用了execute(同步请求),而不再是enqueue。
    • RxJava 可以使用subscribeOn和observeOn完美处理Observeable和Subscribe的执行线程问题。
    • 这里使用RxJava中map操作符,对返回内容中的为null或“” 的对象做了简单的处理。

    至此,Rxjava的系列教程五篇,您已经全部看完了。

    上一篇:RxJava入门与提高-线程控制Scheduler篇(4)

    感谢您的阅读,本系列教程暂时告一段落。如果您觉得对您有帮助,欢迎打赏!
    作者:ZhangYushui
    來源:简书
    著作权归作者所有。商业转载请联系作者获得授权,非商业转载请注明出处。

    相关文章

      网友评论

        本文标题:RxJava入门与提高-网络Retrofit 篇(5)

        本文链接:https://www.haomeiwen.com/subject/qumpmxtx.html