Retrofit的一些应用心得

之前对RX系列和Retrofit简单的了解下，最新花了点时间仔细研究了下，简单谈谈自己的理解吧

1、包引用:

//retrofit2--看名字就知道是啥了
compile 'com.squareup.retrofit2:retrofit:2.1.0'
//CallAdapterFactory的Rx依赖包---导这个包才能配合rxAndroid使用
compile 'com.squareup.retrofit2:adapter-rxjava:2.1.0'
//ConverterFactory的String依赖包----这个是解析数据的工厂.用来格式化数据的,配置编码啊,gson解析啊.
compile 'com.squareup.retrofit2:converter-scalars:2.1.0'

retrofit注解简单介绍

方法注解 : 包含@GET、@POST、@PUT、@DELETE、@PATCH、@HEAD、@OPTIONS、@HTTP。

这个不多讲.一般用的就是@GET、@POST,很明显,一个是get请求,一个是post请求
标记注解 : 包含@FormUrlEncoded、@Multipart、@Streaming。
这个得和参数注解一起说
参数注解 : 包含@Query,@QueryMap、@Body、@Field，@FieldMap、@Part，@PartMap。

@Get---------用的参数注解就@Query,@QueryMap,

@Post--------则会用到 @Body、@Field，@FieldMap、@Part，@PartMap。

@Body-------将数据转化成Json,然后post.具体转化根据设置的解析工厂(下面有讲)
---------------------------------------------------分割线----------------------------------------------------------
@Field，@FieldMap------post上传表单.@Field表示单个,@FieldMap表示集合.
需要添加上面的@FormUrlEncoded表示表单提交 ,
对应Content-Type:application/x-www-form-urlencoded
如:
@FormUrlEncoded
@POST("login的url")
Observable login(@Field("name") String name, @FieldMap Map params);
--------------------------------------------------分割线------------------------------------------------------------
@Part，@PartMap----post上传文件/数据.@Part表示单个,@PartMap表示集合.
其中@Part MultipartBody.Part 类型代表文件，@Part("key") RequestBody类型代表参数 
需要添加@Multipart表示支持文件上传的表单，Content-Type: multipart/form-data
@Multipart
@POST("update的url")
Observable update(@Part ("file") MultipartBody.Part file, @Part("key") RequestBody key,@PartMap Map files);
如果参数较少,使用@Part ("file")就可以解决了,如果参数较多,那就需要使用@PartMap了.
其他注解 : @Path、@Header,@Headers、@Url
这几个用处挺大的,这里就不细说了,并不是必用的,我用的不多.

Retrofit简单封装：

/**
* 写成单例模式,因为并不需要多个Retrofit存在.
*/
public class RetrofitUtil {
    /**
     * 服务器地址
     */
    private static final String API_HOST ="你的BaseUrl";
    private RetrofitUtil() {

    }
    public static Retrofit getRetrofit() {
        return Instanace.retrofit;
    }
    //静态内部类,保证单例并在调用getRetrofit方法的时候才去创建.
    private static class Instanace {
        private static final Retrofit retrofit = getInstanace();
        private static Retrofit getInstanace() {
            HttpLoggingInterceptor interceptor = new HttpLoggingInterceptor(new HttpLoggingInterceptor.Logger(){
                @Override
                public void log(String message) {
                    HLog.i("RxJava", message);
                }
            });
            OkHttpClient client = new OkHttpClient.Builder()
                    .addInterceptor(interceptor)
                    .build();
            Reretrofit = new Retrofit.Builder()
                    .client(client)
                    .baseUrl(API_HOST)
                    .addConverterFactory(FastjsonConverterFactory.create())
                    .addCallAdapterFactory(RxJavaCallAdapterFactory.create())
                    .build();
            return retrofit;
        }
    }
}

配合RxAndroid的使用

基本使用介绍

@GET("login地址")
Observable<BaseResponse> login(@QueryMap HashMap params);
其实所谓的Reretrofit+RxAndroid就是这么回事.

没有RxAndroid的Reretrofit请求接口是这样写的:

@GET("login地址")
Call<BaseResponse> login(@QueryMap HashMap params);

相比较就是把Call换成了Observable而已.

具体实现

1）、首先写一个接口

/**
*所有的网络请求都可以写在这个接口类里面.
*/
public interface APIService {
     @GET("login地址")
     Observable<BaseResponse> login(@QueryMap HashMap params);
     ......
}

2）、接口类的实现

/**
 * 请求生成类。Retrofit一次生成,并作为单例.
 */
public class ApiServcieImpl {
    private ApiServcieImpl() {

    }
    public static APIService getInstance() {
        return createAPIService.apiService;
    }

    /**
     * Retrofit生成接口对象.
     */
    private static class createAPIService {
        //Retrofit会根据传入的接口类.生成实例对象.
        private static final APIService apiService = RetrofitUtil.getRetrofit().create(APIService.class);
    }
}

然后就可以通过ApiServcieImpl.getInstance()去调用APIService里面写的接口了. 如:

ApiServcieImpl.getInstance().login(new HashMap()) //传入参数
       .subscribe(new Action1<BaseResponse>() {//简单的回调
            @Override 
             public void call(BaseResponse loginDataBaseResponse) { 
                //拿到数据,做处理
            }
    });

4.封装

有没有发现,设置泛型的是,包了一层BaseResponse 这么做是为了请求完成后对返回的数据进行统一处理.

先看BASERESPONSE:

public class BaseResponse {
    private boolean success;//请求是否成功
    private int resultCode;//状态吗
    private String msg;//返回的提示消息
    private T data;//主要内容,因为不知道返回的会是什么类型,所以用泛型来表示
    //get set方法就不贴了.
}

怎么处理.

/**
 * @author hcl  2017/11/15 16:14
 */
public class ModelFilteredFactory {
    private final static Observable.Transformer transformer = new SimpleTransformer();

    /**
     * 将Observable<BaseResponse>转化Observable,并处理BaseResponse
     *
     * @return 返回过滤后的Observable.
     */
    @SuppressWarnings("unchecked")
    public static  Observable compose(Observable<BaseResponse> observable) {
        return observable.compose(transformer);
    }

    /**
     * 这里就不细讲了,具体可以去看rxjava的使用.这个类的意义就是转换Observable.
     */
    private static class SimpleTransformer implements Observable.Transformer<BaseResponse, T> {
        //这里对Observable,进行一般的通用设置.不用每次用Observable都去设置线程以及重连设置
        @Override
        public Observable call(Observable<BaseResponse> observable) {
            return observable.subscribeOn(Schedulers.io())
                      .observeOn(AndroidSchedulers.mainThread())
                      .unsubscribeOn(Schedulers.io())
                      .timeout(5, TimeUnit.SECONDS)//重连间隔时间
                      .retry(5)//重连次数
                      .flatMap(new Func1<BaseResponse, Observable>() {
                          @Override
                          public Observable call(BaseResponse tBaseResponse) {
                              return flatResponse(tBaseResponse);
                          }
                      });
        }

        /**
         * 处理请求结果,BaseResponse
         * @param response 请求结果
         * @return 过滤处理, 返回只有data数据的Observable
         */
        private Observable flatResponse(final BaseResponse response) {
            return Observable.create(new Observable.OnSubscribe() {
                @Override
                public void call(Subscriber subscriber) {
                    if (response.isSuccess()) {//请求成功
                        if (!subscriber.isUnsubscribed()) {
                            subscriber.onNext(response.getData());
                        }
                    } else {//请求失败
                        int resultCode = response.getResultCode();
                        if (!subscriber.isUnsubscribed()) {
                            //这里抛出自定义的一个异常.可以处理服务器返回的错误.
                            subscriber.onError(new APIException(response.getResultCode(), response.getMsg()));
                        }
                        return;
                    }
                    if (!subscriber.isUnsubscribed()) {//请求完成
                        subscriber.onCompleted();
                    }
                }
            });
        }
    }
}

仅仅只有上面那些了么?接着看.

/**
 * @author hcl  2017/11/14 17:32
  * Subscriber,这个是用来处理Observable的结果的.
 */
public abstract class SimpleSubscriber extends Subscriber {
 
    @Override
    public void onCompleted() {//这个是请求完成时调用.如果走了onError()就不会走这个方法.
       
    }

    @Override
    public void onError(Throwable e) {//这里通常就处理异常
        if (e instanceof APIException) {
            APIException exception = (APIException) e;
            ToastUtil.showToast( exception.message);
        } else if (e instanceof UnknownHostException) {
            ToastUtil.showToast("请打开网络");
        } else if (e instanceof SocketTimeoutException) {
            ToastUtil.showToast( "请求超时");
        } else if (e instanceof ConnectException) {
            ToastUtil.showToast("连接失败");
        } else if (e instanceof HttpException) {
            ToastUtil.showToast("请求超时");
        }else {
            ToastUtil.showToast("请求失败");
        }
        e.printStackTrace();
    }

    @Override
    public void onNext(T t) {//这里的是获得了数据,方法意思很明显,下一步干啥
        if (t != null) {//这里最好判断一下是否为null.
            call(t);
        } else {
            ToastUtil.showToast("连接失败");
        }
    }
    /**
    *因为具体的处理这里无法得知,所以抽象.
    */
    public abstract void call(T t);
}

好了,看看现在的具体使用吧:

ModelFilteredFactory.compose(ApiServcieImpl.getInstance().login(new HashMap()))
                .subscribe(new SimpleSubscriber() {
                    @Override
                    public void call(LoginData loginData) {
                  
                    }
                });

看起来之前用起来差不多,但是却做了很多的处理:
1.对Observable做了通用设置.网络重连次数,线程设置,重连时间.
2.做了对服务器返回结果的统一处理.比如根据resultcode,处理登陆过期啊啥的.
3.判断了data是否为null,不会在call()里面担心loginData是否为null
4.统一处理了请求的各种异常.

5.用到MVP中.

你以为上面那些就完了吗?NO!

如果我们在PRESENTER中这样调用其实是很不科学的.

ModelFilteredFactory.compose(ApiServcieImpl.getInstance().login(new HashMap()))

这个转换我们应该放在MODLE和MODLEIMPL中去写

public class LoginContract{
     ....//view接口省略
    public interface Model {  
      /**   
      * 获取登陆数据  
      * @return Observable 
      */  
      Observable login(HashMap treeMap);
    }
    ....//prensent接口省略
}

public class LoginModelImpl implements LoginContract.Model { 
   @Override 
   public Observable login(HashMap hashMap) {     
       return ModelFilteredFactory.compose(ApiServcieImpl.getInstance().login(hashMap));   
 }}

那么我们在PRESENTER中调用就可以这样:

public class LoginPresenterImpl exdents BasePresenter implements LoginContract.Presenter{
     .....
     private  LoginModelImpl  loginModelImpl;
     public void onCreate(){
       loginModelImpl = new LoginModelImpl();//创建modle实例
     }
     public void login(){
        //通过modle请求接口
        loginModelImpl.login(new HashMap()))
                .subscribe(new SimpleSubscriber() {
                    @Override
                    public void call(LoginData loginData) {
                          //处理请求的数据,绑定视图 
                    }
                });
        }
    ....
}

6.管理Observable的生命周期,也就是网络请求的生命周期.

Observable是不是很高大上,然而如果你不进行处理,可是会内存泄漏的 RxAndroid也不会自动的根据Activity/frgament的生命周期结束异步请求. 但处理其实很简单.

使用COMPOSITESUBSCRIPTION

只需要将Observable,异步处理到最后返回的subscribe添加到CompositeSubscription实例里就行了.

public void login(){
    Subscription subscribe = loginModelImpl.login(new HashMap()))
                .subscribe(new SimpleSubscriber() {
                    @Override
                    public void call(LoginData loginData) {
                          //处理请求的数据,绑定视图 
                    }
                });
      compositeSubscription.add(subscribe);//添加订阅
  }
  //在销毁的时候,结束订阅事件.
  public void onDestroy() {
    compositeSubscription.unsubscribe();//结束所有add的subscribe事件
 }