不知道你們在使用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) {
//登錄成功
}
});
好了,到這裏就結束了,不知不覺感覺時間過的好快,總感覺自己的時間不夠用,感覺還有好多好多東西需要自己去學習但總是莫名的懶惰。哈哈,希望自己在以後的道路上能繼續努力慢慢成長。