Android基于Retrofit2.0 +RxJava 封装的超好用的RetrofitClient工具类(六)

原创 2016年07月19日 17:44:00

csdn :码小白
原文地址:
http://blog.csdn.net/sk719887916/article/details/51958010


这里写图片描述


RetrofitClient

基于Retrofit2.0封装的RetrofitClient. 已加入RxJava1, Rxjav2请看 - RxJava2和Retrofit封装的RetrofitClient2终于来了!一文。

  • 避免重复创建Retrofit实列.
  • 调用方便简洁.
  • 无需重复设置属性的步骤.
  • 可固定配置 Host 也可动态配置Url、请求头、参数等.
  • 支持文件下载和上传.
  • 可支持泛型扩展的ApiService
  • 支持RxJava
  • 支持缓存机制
  • 支持统一错误结果处理

使用原生的Retrofit请求网络,熟悉的朋友必定了解,在某个ApiServie方法多时 Retrofit设置就显得有点累赘,今天给大家带来对Retrofit的基本封装。这次对Retrofit进阶篇,本次封装已加入RxJava,请在阅读下文前请先了解RXJAVA和本人写的Retrofit系列文章,


友情导读:


基本步骤:

构建Retrofit的接口service.

构建基础拦截器 Interceptor.

构建Cookie管理工具CookieManger.

构建 单列RetrofitClient客户端.

RetrofitClient的使用.

ApiService

请求网络的API接口类,这里你可以增加你需要的请求接口,也可复用已经实现的几个方法。

/**
 * Created by Tamic on 2016-07-08.
 */
 public interface ApiService {

  public static final String Base_URL = "http://ip.taobao.com/";
  /**
  *普通写法
  */
 @GET("service/getIpInfo.php/")
 Observable<ResponseBody> getData(@Query("ip") String ip);

 @GET("{url}")
 Observable<ResponseBody> executeGet(
        @Path("url") String url, 
        @QueryMap Map<String, String> maps);


@POST("{url}")
Observable<ResponseBody> executePost(
        @Path("url") String url,
        @QueryMap Map<String, String> maps);

@Multipart
@POST("{url}")
Observable<ResponseBody> upLoadFile(
        @Path("url") String url,
        @Part("image\\\\"; filename=\\"image.jpg") RequestBody avatar);


@POST("{url}")
Observable<ResponseBody> uploadFiles(
        @Path("url") String url,
        @Path("headers") Map<String, String> headers,
        @Part("filename") String description,
        @PartMap()  Map<String, RequestBody> maps);

 @Streaming
 @GET
 Observable<ResponseBody> downloadFile(@Url String fileUrl);

}

上面新增了几个常用的请求方法

第一个只是普通写法的列子, url ,请求头,参数都是写死的。 不建议这么做

第二,三个分别是Get 和POST请求,method Url,headers, body参数都可以动态外部传入。

四和 五是单文件/图片和多文件/图片上传

最后是文件下载

如果你觉得麻烦 可以用T代替,技术不到位的悠着点哈

 @GET()
<T> Observable<ResponseBody> executeGet(
        @Url String url,
        @QueryMap Map<String, T> maps);

构建基础拦截器

用来设置基础header,这里是通过MAP键值对来构建,将heder加入到Request中。

/**
 * BaseInterceptor,use set okhttp call header
 * Created by Tamic on 2016-06-30.
 */
public class BaseInterceptor implements Interceptor{

   private Map<String, String> headers;

   public BaseInterceptor(Map<String, String> headers) {
      this.headers = headers;
    }

   @Override
   public Response intercept(Chain chain) throws    IOException {

    Request.Builder builder = chain.request()
            .newBuilder();
    if (headers != null && headers.size() > 0) {
        Set<String> keys = headers.keySet();
        for (String headerKey : keys) {
            builder.addHeader(headerKey,      headers.get(headerKey)).build();
        }
    }
    return chain.proceed(builder.build());

 }
}

构建Cookie管理者

用来管理cookie, 储存cookie的store这里不再重复说明,具体列子请见:

构建RetrofitClient客户端.

今天重要的环节来了,RetrofitClient主要负责创建具体Retrofit,和调度分发请求。设置格式工厂。添加cookie同步,构建OkHttpClient,添加BaseUrl,对加密证书https我没做加入,希望读者参考我的本系列文章自行加入,因为我不喜欢升伸手党。

   /**
 * RetrofitClient
 * Created by Tamic on 2016-06-15.
 */
public class RetrofitClient {

private static final int DEFAULT_TIMEOUT = 5;

private ApiService apiService;

private OkHttpClient okHttpClient;

public static String baseUrl = ApiService.Base_URL;

private static Context mContext;

private static RetrofitClient sNewInstance;
private static class SingletonHolder {
    private static RetrofitClient INSTANCE = new RetrofitClient(
            mContext);
}

public static RetrofitClient getInstance(Context context) {
    if (context != null) {
        Log.v("RetrofitClient", DevUtil.isDebug() + "");
        mContext = context;
    }
    return SingletonHolder.INSTANCE;
}


public static RetrofitClient getInstance(Context context, String url) {
    if (context != null) {
        mContext = context;
    }
    sNewInstance = new RetrofitClient(context, url);
    return sNewInstance;
}

private RetrofitClient(Context context) {

    this(context, null);
}

private RetrofitClient(Context context, String url) {

    if (TextUtils.isEmpty(url)) {
        url = baseUrl;
    }
    okHttpClient = new OkHttpClient.Builder()
            .addNetworkInterceptor(
                    new HttpLoggingInterceptor().setLevel(HttpLoggingInterceptor.Level.HEADERS))
            .cookieJar(new NovateCookieManger(context))
            .addInterceptor(new BaseInterceptor(mContext))
            .connectTimeout(DEFAULT_TIMEOUT, TimeUnit.SECONDS)
            .build();
    Retrofit retrofit = new Retrofit.Builder()
            .client(okHttpClient)
            .addConverterFactory(GsonConverterFactory.create())
            .addCallAdapterFactory(RxJavaCallAdapterFactory.create())
            .baseUrl(url)
            .build();
    apiService = retrofit.create(ApiService.class);
}

public void getData(Subscriber<ResponseBody> subscriber, String ip) {
    apiService.getData(ip)
            .subscribeOn(Schedulers.io())
            .unsubscribeOn(Schedulers.io())
            .observeOn(AndroidSchedulers.mainThread())
            .subscribe(subscriber);
}

public void get(String url, Map headers, Map parameters, Subscriber<ResponseBody> subscriber) {
    apiService.executeGet(url, headers, parameters)
            .subscribeOn(Schedulers.io())
            .unsubscribeOn(Schedulers.io())
            .observeOn(AndroidSchedulers.mainThread())
            .subscribe(subscriber);
}

public void post(String url, Map headers, Map parameters, Subscriber<ResponseBody> subscriber) {
    apiService.executePost(url, headers, parameters)
            .subscribeOn(Schedulers.io())
            .unsubscribeOn(Schedulers.io())
            .observeOn(AndroidSchedulers.mainThread())
            .subscribe(subscriber);
}

}

大家发现上面的指定生产线程和消费线程的步骤有点麻烦,每个api都得进行指定线程,那么可以利用rxJava的转换器写一个Transformer

Observable.Transformer schedulersTransformer() {
  return new Observable.Transformer() {


  @Override
  public Object call(Object observable) {
   return ((Observable)  observable).subscribeOn(Schedulers.io())
   .unsubscribeOn(Schedulers.io())
   .observeOn(AndroidSchedulers.mainThread());
   }
   };
}

那么api可以这样优化了:

 public Subscription getData(Subscriber<IpResult> subscriber, String ip) {
   return apiService.getData(ip)
   .compose(schedulersTransformer())
   .subscribe(subscriber);
  }

调用 RetrofitClient

   RetrofitClient.getInstance(MainActivity.this).createBaseApi().getData(new BaseSubscriber<IpResult>(MainActivity.this) {

                @Override
                public void onError(ResponeThrowable e) {
                    Log.e("Lyk", e.code + " "+ e.message);
                    Toast.makeText(MainActivity.this, e.message, Toast.LENGTH_LONG).show();

                }

                @Override
                public void onNext(IpResult responseBody) {
                    Toast.makeText(MainActivity.this, responseBody.toString(), Toast.LENGTH_LONG).show();
                }
            }, "21.22.11.33");

代码很简洁,在用到的地方获取单列直接调用你需要的方法,在RxSubscriber回调中处理你的业务逻辑即可,无需考虑是否在主线程,其他调用方法同上。

很多时候BaseApiService无法满足需求时,Retrofit增加了扩展接口
create 来创建你的API,接着调用execute就可以和RxJava关联

//create  you APiService
 MyApiService service = RetrofitClient.getInstance(MainActivity.this).create(MyApiService.class);

            // execute and add observable
            RetrofitClient.getInstance(MainActivity.this, "http://lbs.sougu.net.cn/").execute(
                    service.getSougu(), new BaseSubscriber<SouguBean>(MainActivity.this) {

                        @Override
                        public void onError(ResponeThrowable e) {
                            Log.e("Tamic", e.getMessage());
                            Toast.makeText(MainActivity.this, e.getMessage(), Toast.LENGTH_LONG).show();

                        }
                        @Override
                        public void onNext(SouguBean souguBean) {

                            Toast.makeText(MainActivity.this, souguBean.toString(), Toast.LENGTH_LONG).show();

                        }
                    });

这里写图片描述

总结

本次封装只对retrofit进行了简单封装,很多场景和需求还是存在缺陷,这种单列模式已不符合目前流行的Builder模式,本人已开始进行下一步的封装工作,在这里提前进行下预告:
笔者已进行新的框架开发novate,估计下个月就能和大家见面,敬请继续关注!


系列导读:

源码 GitHub :https://github.com/NeglectedByBoss/RetrofitClient

简书 :Tamic_码小白
原文地址:
http://www.jianshu.com/p/29c2a9ac5abf

版权声明:本文为博主原创文章,请尊重原创,转载请标明地址。有问题请关注 [开发者技术前线] 咨询

相关文章推荐

Retrofit2+Rxjava2之优雅的封装

Retrofit2+Rxjava2之优雅的封装   这篇文章主要是教大家如何封装Retrofit2+Rxjava2,所以实现原理不做过多的解释,如有不付,额(你咬我呀!), 还有就是看这篇文章的同时,...

RxJava+Retrofit+OkHttp深入浅出-终极封装二(网络请求)

Rxjava+ReTrofit+okHttp背景:    学习Rxjava+Retrofit+okhttp已经一段时间了,发现确实很强大,但是使用起来稍微有点麻烦,在工作中重复的代码太多,所以决定对h...

Rxjava2和Retrofit2网络库的封装

Rxjava2和Retrofit2网络库的封装,支持文件下载监听,单文件/多文件上传监听,支持https ,详细代码见我的Gitbub:https://github.com/makewhat/Retr...

【Android】RxJava + Retrofit完成网络请求

【Android】RxJava + Retrofit完成网络请求

MVP模式实现网络请求数据并添加到列表(Rxjava+Retrofit)

使用MVP模式实现网络请求数据并添加到列表,网络请求数据使用的是RXjava和Retrofit 我在代码中添加了recyclerview和fragment来实现页面滑动 首先是导入依赖 ...

Delphi7高级应用开发随书源码

  • 2003年04月30日 00:00
  • 676KB
  • 下载

Android 优雅的让RxJava2.0+Retrofit2.0结合使用

转载自:http://blog.csdn.net/demonliuhui/article/details/77868677 前言 本文参考: RxJava...
  • Liu_ser
  • Liu_ser
  • 2017年11月07日 19:50
  • 58

Retrofit+Rxjava 网络请求的完美封装(二)(观察者模式)

上一篇是Retrofit+Rxjava简单封装,是在MainActivity中构建的请求体,这篇博文是将请求体Request也置入到Rxjava中 Retrofit+Rxjava 网络请求的简单封...

RxJava+Retrofit+OkHttp 深入浅出-终极封装一

背景 之前学习完Retrofit+Rxjava之后写了一篇关于封装的博客,发出后受到大家的关注以及使用,由于不断的完善之前的项目,所以决定把最新的项目封装过程讲解出来,供大家查看!  原博客地...

Retrofit2+Rxjava2联网的封装

Retrofit2+Rxjava2联网模块的封装以及mvp架构的使用
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:Android基于Retrofit2.0 +RxJava 封装的超好用的RetrofitClient工具类(六)
举报原因:
原因补充:

(最多只允许输入30个字)