【Android架构】基于MVP模式的Retrofit2+RXjava封装之数据预处理（六）

时间  2019-11-09
标签 Android架构 基于 mvp 模式 retrofit2+rxjava retrofit rxjava 封装 数据 预处理 栏目 Java 繁體版
原文   原文链接

前言

mvp框架也用了至关长的时间了，通常让人比较纠结的就是后台数据的处理问题。大多数的公司因为代码的不规范、经手人员太多等等缘由，后台的代码至关混乱，接口返回的数据格式也五花八门，固然，若是你能直接让后台大哥改代码的话，就另当别论，大多数状况仍是要Android端来背锅。这里，咱们就聊聊这个。php

通常套路

咱们会直接复制接口返回的json，而后用插件转换为实体类（国际惯例，不贴get和set）java

public class ShareModel {
 
    private int status;
    private String msg;
    private List<DataBean> data;
    public static class DataBean {
        private String id;
        private String wshare_name;
        private String wshare_head;
        private String wshare_content;
  }
}
复制代码

进阶套路

后台返回的数据格式以下：git

{
	"status": 1,
	"msg": "请求成功",
	"data": []
}
复制代码

咱们会定义一个BaseModel（国际惯例，不贴get和set）github

public class BaseModel<T> implements Serializable {
    private int status;
    private String msg;
    private T data;
}
复制代码

若是data 是list的话，还会定义个BaseListModel，只是其中的data 为List<T>而已。 而后，在ApiServer中定义接口json

@FormUrlEncoded
    @POST("/mapi/index.php?ctl=user&act=userbaseinfo")
    Observable<BaseModel<UserModel>> getUserInfo(@FieldMap Map<String, String> params);
复制代码

在presenter中使用api

/** * 获取用户详情 * * @param params */
    public void getUserInfo(Map<String, String> params) {
        addDisposable(apiServer.getUserInfo(params), new BaseObserver<BaseModel<UserModel>>(baseView) {

            @Override
            public void onSuccess(BaseModel<UserModel> o) {
                baseView.onGetUserInfoSucc(o.getData());

            }

            @Override
            public void onError(String msg) {
                baseView.showError(msg);
            }
        });

    }
复制代码

而后回调到activity或者fragment中处理，这部分就不详细说了，能够看看以前的文章。网络

这样看似没有问题，可是若是后台某个接口返回的数据的格式以下，架构

{
	"status": 1,
	"error": "请求成功",
	"data": []
}
复制代码

有人说了，在BaseModel和BaseListModel再加一个error字段不就行了？框架

若是数据是这样呢？ide

{
	"code": 1,
	"error": "请求成功",
	"data": []
}
复制代码

可能这张图能表达你如今的心情

image.png

终极套路

虽然生活如此艰难，可是问题仍是要解决的。

咱们能够回想一下，http请求返回的是对象是ResponseBody，它是怎么转换为咱们的实体类呢？ 主要代码在这里 retrofit.addConverterFactory(GsonConverterFactory.create())

咱们跟进去看看

public final class GsonConverterFactory extends Converter.Factory {
  /** * Create an instance using a default {@link Gson} instance for conversion. Encoding to JSON and * decoding from JSON (when no charset is specified by a header) will use UTF-8. */
  public static GsonConverterFactory create() {
    return create(new Gson());
  }

  /** * Create an instance using {@code gson} for conversion. Encoding to JSON and * decoding from JSON (when no charset is specified by a header) will use UTF-8. */
  @SuppressWarnings("ConstantConditions") // Guarding public API nullability.
  public static GsonConverterFactory create(Gson gson) {
    if (gson == null) throw new NullPointerException("gson == null");
    return new GsonConverterFactory(gson);
  }

  private final Gson gson;

  private GsonConverterFactory(Gson gson) {
    this.gson = gson;
  }

  @Override
  public Converter<ResponseBody, ?> responseBodyConverter(Type type, Annotation[] annotations,
      Retrofit retrofit) {
    TypeAdapter<?> adapter = gson.getAdapter(TypeToken.get(type));
    return new GsonResponseBodyConverter<>(gson, adapter);
  }

  @Override
  public Converter<?, RequestBody> requestBodyConverter(Type type,
      Annotation[] parameterAnnotations, Annotation[] methodAnnotations, Retrofit retrofit) {
    TypeAdapter<?> adapter = gson.getAdapter(TypeToken.get(type));
    return new GsonRequestBodyConverter<>(gson, adapter);
  }
}
复制代码

能够看到，主要逻辑是在GsonResponseBodyConverter里面

final class GsonResponseBodyConverter<T> implements Converter<ResponseBody, T> {
  private final Gson gson;
  private final TypeAdapter<T> adapter;

  GsonResponseBodyConverter(Gson gson, TypeAdapter<T> adapter) {
    this.gson = gson;
    this.adapter = adapter;
  }

  @Override public T convert(ResponseBody value) throws IOException {
    JsonReader jsonReader = gson.newJsonReader(value.charStream());
    try {
      T result = adapter.read(jsonReader);
      if (jsonReader.peek() != JsonToken.END_DOCUMENT) {
        throw new JsonIOException("JSON document was not fully consumed.");
      }
      return result;
    } finally {
      value.close();
    }
  }
}
复制代码

能够看到，先是拿到字节流，而后调用TypeAdapter的read方法，转换为咱们的实体类，这个原理咱们先不深究，后面有时间在讲。这里咱们能不能作文章呢，答案是能够。

首先，这几个类都是final修饰的，不能被继承，不过没事，咱们能够复制这几个类的代码，而后改个名字

image.png

其中，BaseConverterFactory和BaseRequestBodyConverter与源码一致，只须要修改类名便可。重点在BaseResponseBodyConverter

public class BaseResponseBodyConverter<T> implements Converter<ResponseBody, T> {
    private final Gson gson;
    private final TypeAdapter<T> adapter;

    BaseResponseBodyConverter(Gson gson, TypeAdapter<T> adapter) {
        this.gson = gson;
        this.adapter = adapter;
    }

    @Override
    public T convert(ResponseBody value) throws IOException {

        String jsonString = value.string();
        try {
            JSONObject object = new JSONObject(jsonString);

            int code = object.getInt("code");
            if (code != 1) {
                String msg = object.getString("msg");
                if (TextUtils.isEmpty(msg)) {
                    msg = object.getString("error");
                }
                //异常处理
                throw new BaseException(msg, code);
            }

            return adapter.fromJson(object.getString("data"));

        } catch (JSONException e) {
            e.printStackTrace();
            //数据解析异常
            throw new BaseException(BaseException.PARSE_ERROR_MSG, BaseException.PARSE_ERROR);
        } finally {
            value.close();
        }
    }
}
复制代码

判断的代码能够本身根据项目须要，自行添加 BaseException

public class BaseException extends IOException {

    /** * 解析数据失败 */
    public static final int PARSE_ERROR = 1001;
    public static final String PARSE_ERROR_MSG = "解析数据失败";

    /** * 网络问题 */
    public static final int BAD_NETWORK = 1002;
    public static final String BAD_NETWORK_MSG = "网络问题";
    /** * 链接错误 */
    public static final int CONNECT_ERROR = 1003;
    public static final String CONNECT_ERROR_MSG = "链接错误";
    /** * 链接超时 */
    public static final int CONNECT_TIMEOUT = 1004;
    public static final String CONNECT_TIMEOUT_MSG = "链接超时";
    /** * 未知错误 */
    public static final int OTHER = 1005;
    public static final String OTHER_MSG = "未知错误";


    private String errorMsg;
    private int errorCode;


    public String getErrorMsg() {
        return errorMsg;
    }

    public int getErrorCode() {
        return errorCode;
    }

    public BaseException(String errorMsg, Throwable cause) {
        super(errorMsg, cause);
        this.errorMsg = errorMsg;
    }

    public BaseException(String message, Throwable cause, int errorCode) {
        super(message, cause);
        this.errorCode = errorCode;
        this.errorMsg = message;
    }

    public BaseException(String message, int errorCode) {
        this.errorCode = errorCode;
        this.errorMsg = message;
    }
}
复制代码

修改BaseObserver代码，onNext中只处理成功回调，onError中处理各类异常

public abstract class BaseObserver<T> extends DisposableObserver<T> {

    protected BaseView view;

    private boolean isShowDialog;


    public BaseObserver(BaseView view) {
        this.view = view;
    }

    public BaseObserver(BaseView view, boolean isShowDialog) {
        this.view = view;
        this.isShowDialog = isShowDialog;
    }

    @Override
    protected void onStart() {
        if (view != null && isShowDialog) {
            view.showLoading();
        }
    }

    @Override
    public void onNext(T o) {
        onSuccess(o);
    }

    @Override
    public void onError(Throwable e) {
        if (view != null && isShowDialog) {
            view.hideLoading();
        }
        BaseException be = null;

        if (e != null) {

            if (e instanceof BaseException) {
                be = (BaseException) e;

                //回调到view层 处理 或者根据项目状况处理
                if (view != null) {
                    view.onErrorCode(new BaseModel(be.getErrorCode(), be.getErrorMsg()));
                } else {
                    onError(be.getErrorMsg());
                }

            } else {
                if (e instanceof HttpException) {
                    // HTTP错误
                    be = new BaseException(BaseException.BAD_NETWORK_MSG, e, BaseException.BAD_NETWORK);
                } else if (e instanceof ConnectException
                        || e instanceof UnknownHostException) {
                    // 链接错误
                    be = new BaseException(BaseException.CONNECT_ERROR_MSG, e, BaseException.CONNECT_ERROR);
                } else if (e instanceof InterruptedIOException) {
                    // 链接超时
                    be = new BaseException(BaseException.CONNECT_TIMEOUT_MSG, e, BaseException.CONNECT_TIMEOUT);
                } else if (e instanceof JsonParseException
                        || e instanceof JSONException
                        || e instanceof ParseException) {
                    // 解析错误
                    be = new BaseException(BaseException.PARSE_ERROR_MSG, e, BaseException.PARSE_ERROR);
                } else {
                    be = new BaseException(BaseException.OTHER_MSG, e, BaseException.OTHER);
                }
            }
        } else {
            be = new BaseException(BaseException.OTHER_MSG, e, BaseException.OTHER);
        }

        onError(be.getErrorMsg());

    }

    @Override
    public void onComplete() {
        if (view != null && isShowDialog) {
            view.hideLoading();
        }

    }


    public abstract void onSuccess(T o);

    public abstract void onError(String msg);


}

复制代码

在ApiRetrofit中添加咱们自定义的ConverterFactory

.addConverterFactory(BaseConverterFactory.create())
复制代码

这样的话，ApiServer即可以这样定义了

@FormUrlEncoded
    @POST("/mapi/index.php?ctl=user&act=userbaseinfo")
    Observable<UserModel> getUserInfo(@FieldMap Map<String, String> params);
复制代码

相应的，presenter能够这样写

public void getUserInfo(Map<String, String> params) {
        addDisposable(apiServer.getUserInfo(params), new BaseObserver<UserModel>(baseView) {

            @Override
            public void onSuccess(UserModel o) {
                baseView.onGetUserInfoSucc(o);

            }

            @Override
            public void onError(String msg) {
                baseView.showError(msg);
            }
        });

    }
复制代码

是否是精简了许多，快来试试吧

参考 RxJava2 + Retrofit2 彻底指南 之 统一状态码/Exception处理

最后，献上源码 Github

你的承认，是我坚持更新博客的动力，若是以为有用，就请点个赞，谢谢

相关文章
相关标签/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公众号
   欢迎关注本站公众号,获取更多信息
联系我们 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程