Android使用Retrofit實現自定義Converter解析介面流程詳解

2023-08-24 18:00:59

　　不知道你們在使用Retrofit存取後臺介面時返回的資料是否是一樣的格式，比如登入介面，在我們輸入密碼成功或錯誤的時候後臺返回的資料格式是不同的，這樣我們在新增GsonConverterFactory解析後臺資料時由於後臺會返回兩種不同的資料所以會導致Gson解析失敗的錯誤資訊。這裡以自己專案的登入介面為例子記錄下自己的解決方案。

登入成功和失敗的兩種資料格式：

{"success":false,"code":-1,"msg":"密碼錯誤","data":"密碼錯誤"}

{"success":true,"code":1,"msg":"操作成功","data":{"JXHDAPIToken":"1ccf7b01ed544882aacda365c8f620d2"}}

從上面資料中我們可以發現後臺返回的資料只有data中的資料是不一樣，其他幾個欄位都是一樣的。這個時候我們可以將幾個相同欄位抽取出來，通過修改GsonConverterFactory來實現解析不同資料。

修改GsonConverterFactory：

我們只需要點選進入GsonConverterFactory的原始碼中看看它的程式碼,這裡面我們只需要修改返回的GsonResponseBodyConverter物件。

@Override
  public Converter<ResponseBody, ?> responseBodyConverter(Type type, Annotation[] annotations,
      Retrofit retrofit) {
    TypeAdapter<?> adapter = gson.getAdapter(TypeToken.get(type));
    return new GsonResponseBodyConverter<>(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 {
      return adapter.read(jsonReader);
    } finally {
      value.close();
    }
  }
}

我們是無法直接在GsonResponseBodyConverter裡面直接進行修改的，所以我們可以自定義一個MyGsonResponseBodyConverter類：

final class MyGsonResponseBodyConverter<T> implements Converter<ResponseBody,T>{
    private Gson gson;
    private Type type;
    public MyGsonResponseBodyConverter(Gson gson, Type type) {
        this.gson = gson;
        this.type = type;
    }
    @Override
    public T convert(ResponseBody value) throws IOException {
        String response = value.string();
        try {
            BaseBean baseBean = gson.fromJson(response,BaseBean.class);
            if (!baseBean.isSuccess()) {
                throw new DataResultException(baseBean.getMsg(),baseBean.getCode());
            }
            return gson.fromJson(JsonUtils.getData(response),type);
        }finally {
            value.close();
        }
    }
}

這裡面我們通過自己抽取出來的BaseBean去判斷當前介面返回的欄位success,如果為true的情況下我們正常返回資料即可，為false的情況我們通過自定義DataResultException異常類將其丟擲。

public class BaseBean {
    private boolean success;
    private int code;
    private String msg;
    public boolean isSuccess() {
        return success;
    }
    public void setSuccess(boolean success) {
        this.success = success;
    }
    public int getCode() {
        return code;
    }
    public void setCode(int code) {
        this.code = code;
    }
    public String getMsg() {
        return msg;
    }
    public void setMsg(String msg) {
        this.msg = msg;
    }
}

通過DataResultException獲取success為false的情況下返回的資料：

public class DataResultException extends IOException {
    private String msg;
    private int code;
    public DataResultException(String msg, int code) {
        this.msg = msg;
        this.code = code;
    }
    public DataResultException(String message, String msg, int code) {
        super(message);
        this.msg = msg;
        this.code = code;
    }
    public String getMsg() {
        return msg;
    }
    public void setMsg(String msg) {
        this.msg = msg;
    }
    public int getCode() {
        return code;
    }
    public void setCode(int code) {
        this.code = code;
    }
}

這個時候我們對GsonConverterFactory的修改就基本完成了，但是我們要使用它的時候還需要在自定義MyGsonConverterFactory和MyGsonRequestBodyConverter兩個類。

public class MyGsonRequestBodyConverter<T> implements Converter<T, RequestBody> {
    private static final MediaType MEDIA_TYPE = MediaType.parse("application/json; charset=UTF-8");
    private static final Charset UTF_8 = Charset.forName("UTF-8");
    private final Gson gson;
    private final TypeAdapter<T> adapter;
    MyGsonRequestBodyConverter(Gson gson, TypeAdapter<T> adapter) {
        this.gson = gson;
        this.adapter = adapter;
    }
    @Override public RequestBody convert(T value) throws IOException {
        Buffer buffer = new Buffer();
        Writer writer = new OutputStreamWriter(buffer.outputStream(), UTF_8);
        JsonWriter jsonWriter = gson.newJsonWriter(writer);
        adapter.write(jsonWriter, value);
        jsonWriter.close();
        return RequestBody.create(MEDIA_TYPE, buffer.readByteString());
    }

這裡主要是為了將之前自定義的MyGsonResponseBodyConverter新增進去，而MyGsonRequestBodyConverter這個類和GsonRequestBodyConverter原始碼內容是一樣的，我們直接將內容copy過來即可。

public final class MyGsonConverterFactory extends Converter.Factory {
    public static MyGsonConverterFactory create() {
        return create(new Gson());
    }
    public static MyGsonConverterFactory create(Gson gson) {
        if (gson == null) throw new NullPointerException("gson == null");
        return new MyGsonConverterFactory(gson);
    }
    private final Gson gson;
    private MyGsonConverterFactory(Gson gson) {
        this.gson = gson;
    }
    @Override
    public Converter<ResponseBody, ?> responseBodyConverter(Type type, Annotation[] annotations,
                                                            Retrofit retrofit) {
        return new MyGsonResponseBodyConverter<>(gson,type);
    }
    @Override
    public Converter<?, RequestBody> requestBodyConverter(Type type,
                                                          Annotation[] parameterAnnotations, Annotation[] methodAnnotations, Retrofit retrofit) {
        TypeAdapter<?> adapter = gson.getAdapter(TypeToken.get(type));
        return new MyGsonRequestBodyConverter<>(gson, adapter);
    }
}

我們只需要將MyGsonConverterFactory替換之前的GsonConverterFactory即可：addConverterFactory(MyGsonConverterFactory.create())

這個時候我們再去呼叫之前的登入介面,當我們登入失敗的時候會進入onError方法中，這個時候我們就可以判斷是否丟擲的是我們自定義的異常，如果是的話，那我們就可以獲得當前的msg和code值從而去進行一些操作：

RetrofitUtils.getInstance().getApi().login()
                .subscribeOn(Schedulers.io())
                .observeOn(AndroidSchedulers.mainThread())
                .subscribe(new Subscriber<LoginResult>() {
                    @Override
                    public void onSubscribe(Subscription s) {
                    }
                    @Override
                    public void onNext(LoginResult loginResult) {
                    }
                    @Override
                    public void onError(Throwable t) {
                     if (t instanceof DataResultException) {
                         DataResultException resultException = (DataResultException) t;
                         Log.d(TAG, "Code: " + resultException.getCode() + "Message:" + resultException.getMessage());
                       }
                    }
                    @Override
                    public void onComplete() {
                    }
                });

這裡我們可以對Subscriber進行一下封裝，要不我們每次請求都需要去進行判斷顯得很是繁瑣：

public abstract class MySubscriber<T> implements Subscriber<T> {
    @Override
    public void onSubscribe(Subscription s) {
        s.request(Long.MAX_VALUE);
    }
    @Override
    public void onComplete() {
    }
    @Override
    public void onError(Throwable t) {
        //這裡面根據自己專案需求進行操作，比如code判斷。
        if (t instanceof DataResultException) {
            DataResultException resultException = (DataResultException) t;
            Log.d(TAG, "Code: " + resultException.getCode() + "Message:" + resultException.getMessage());
        }
    }

封裝後我們只會呼叫onNext的方法，當然我們如果需要其他操作的話也可以將其他幾個方法重寫：

RetrofitUtils.getInstance().getApi().login()
                .subscribeOn(Schedulers.io())
                .observeOn(AndroidSchedulers.mainThread())
                .subscribe(new MySubscriber<LoginResult>() {
                    @Override
                    public void onNext(LoginResult loginResult) {
                       //登入成功
                    }
                });

好了，到這裡就結束了，不知不覺感覺時間過的好快，總感覺自己的時間不夠用，感覺還有好多好多東西需要自己去學習但總是莫名的懶惰。哈哈，希望自己在以後的道路上能繼續努力慢慢成長。

到此這篇關於Android使用Retrofit實現自定義Converter解析介面流程詳解的文章就介紹到這了,更多相關Android自定義Converter解析介面內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com！

Android使用Retrofit實現自定義Converter解析介面流程詳解

熱門文章