Retrofit 2.0 cara mendapatkan respons kesalahan deserialised

129

Saya menggunakan Retrofit 2.0.0-beta1 .

Dalam tes saya punya skenario alternatif dan mengharapkan kesalahan HTTP 400

Saya ingin memiliki retrofit.Response<MyError> response tetapiresponse.body() == null

MyError tidak di-deserialisasi - saya hanya melihatnya di sini

response.errorBody().string()

tetapi itu tidak memberi saya MyError sebagai objek

Piotr Boho
sumber
Apakah ini praktik yang baik untuk menghilangkan deserialise terhadap respons kesalahan? karena responsnya mungkin kesalahan server web yang merupakan html.
Hossein Shahdoost
1
thx @ahmadalibaloch, tautan itu benar-benar sangat membantu.
Ravi Vaniya

Jawaban:

138

Saat ini saya menggunakan implementasi yang sangat mudah, yang tidak perlu menggunakan konverter atau kelas khusus. Kode yang saya gunakan adalah sebagai berikut:

public void onResponse(Call<ResponseBody> call, Response<ResponseBody> response) {
    DialogHelper.dismiss();

    if (response.isSuccessful()) {
        // Do your success stuff...
    } else {
        try {
            JSONObject jObjError = new JSONObject(response.errorBody().string());
            Toast.makeText(getContext(), jObjError.getJSONObject("error").getString("message"), Toast.LENGTH_LONG).show();
        } catch (Exception e) {
            Toast.makeText(getContext(), e.getMessage(), Toast.LENGTH_LONG).show();
        }
    }
}
Saif Bechan
sumber
6
Solusi Anda tidak menampilkan konten respons kesalahan.
CoolMind
1
Periksa edit saya, tidak tahu mengapa saya membuatnya begitu tidak jelas di tempat pertama.
Saif Bechan
4
Akhirnya, jawaban sederhana untuk pertanyaan android yang berfungsi (sebagian besar jawaban android komikal kompleks).
Doug Voss
Ini jelas tidak menjawab pertanyaan. Itu hanya mengembalikan pesan kesalahan dan bukan Objek Kesalahan Enum. Silakan ikuti respons ini: stackoverflow.com/a/21103420/2914140
Tobliug
Dalam jawaban itu sedang mencari pemetaan untuk "pesan", tetapi respons kesalahan saya tidak memilikinya. Itu pemetaan untuk "kesalahan". Jadi semua orang membaca, itu tergantung pada respons yang Anda dapatkan!
mco
43

ErrorResponse adalah objek respons khusus Anda

Kotlin

val gson = Gson()
val type = object : TypeToken<ErrorResponse>() {}.type
var errorResponse: ErrorResponse? = gson.fromJson(response.errorBody()!!.charStream(), type)

Jawa

Gson gson = new Gson();
Type type = new TypeToken<ErrorResponse>() {}.getType();
ErrorResponse errorResponse = gson.fromJson(response.errorBody.charStream(),type);
Shahab Rauf
sumber
3
Anda tidak boleh dipaksa membuka opsional:gson.fromJson(response.errorBody()?.charStream(), type)
hopeman
37

Saya menyelesaikannya dengan:

 if(!response.isSuccessful()){
       Gson gson = new Gson();
       MyErrorMessage message=gson.fromJson(response.errorBody().charStream(),MyErrorMessage.class);
       if(message.getCode()==ErrorCode.DUPLICATE_EMAIL_ID_CODE){
                  //DO Error Code specific handling                        
        }else{
                 //DO GENERAL Error Code Specific handling                               
        }
    }

Kelas MyErrorMessage:

  public class MyErrorMessage {
     private int code;
     private String message;

     public int getCode() {
        return code;
     }

     public void setCode(int code) {
        this.code = code;
     }

     public String getMessage() {
         return message;
     }

     public void setMessage(String message) {
        this.message = message;
     }
   }
Pooja Gupta
sumber
2
java.lang.IllegalStateException: Diharapkan BEGIN_OBJECT tetapi STRING di jalur 1 kolom 2 jalur $
Ronel Gonzales
Use .addConverterFactory(ScalarsConverterFactory.create())@RonelGonzales
Pratik Butani
30

Di Retrofit 2.0 beta2 inilah cara saya mendapatkan respons kesalahan:

  1. Sinkronis

    try {
       Call<RegistrationResponse> call = backendServiceApi.register(data.in.account, data.in.password,
               data.in.email);
       Response<RegistrationResponse> response = call.execute();
       if (response != null && !response.isSuccess() && response.errorBody() != null) {
           Converter<ResponseBody, BasicResponse> errorConverter =
                   MyApplication.getRestClient().getRetrofitInstance().responseConverter(BasicResponse.class, new Annotation[0]);
           BasicResponse error = errorConverter.convert(response.errorBody());
           //DO ERROR HANDLING HERE
           return;
       }
       RegistrationResponse registrationResponse = response.body();
       //DO SUCCESS HANDLING HERE
    } catch (IOException e) {
       //DO NETWORK ERROR HANDLING HERE
    }
  2. Tidak sinkron

    Call<BasicResponse> call = service.loadRepo();
    call.enqueue(new Callback<BasicResponse>() {
        @Override
        public void onResponse(Response<BasicResponse> response, Retrofit retrofit) {
            if (response != null && !response.isSuccess() && response.errorBody() != null) {
                Converter<ResponseBody, BasicResponse> errorConverter =
                    retrofit.responseConverter(BasicResponse.class, new Annotation[0]);
                BasicResponse error = errorConverter.convert(response.errorBody());
                //DO ERROR HANDLING HERE
                return;
            }
            RegistrationResponse registrationResponse = response.body();
            //DO SUCCESS HANDLING HERE
        }
    
        @Override
        public void onFailure(Throwable t) {
            //DO NETWORK ERROR HANDLING HERE
        }
    });

Pembaruan untuk Retrofit 2 beta3:

  1. Sinkron - tidak diubah
  2. Asinkron - Parameter retrofit telah dihapus dari onResponse

    Call<BasicResponse> call = service.loadRepo();
    call.enqueue(new Callback<BasicResponse>() {
        @Override
        public void onResponse(Response<BasicResponse> response) {
            if (response != null && !response.isSuccess() && response.errorBody() != null) {
                Converter<ResponseBody, BasicResponse> errorConverter =
                    MyApplication.getRestClient().getRetrofitInstance().responseConverter(BasicResponse.class, new Annotation[0]);
                BasicResponse error = errorConverter.convert(response.errorBody());
                //DO ERROR HANDLING HERE
                return;
            }
            RegistrationResponse registrationResponse = response.body();
            //DO SUCCESS HANDLING HERE
        }
    
        @Override
        public void onFailure(Throwable t) {
            //DO NETWORK ERROR HANDLING HERE
        }
    });
JFreeman
sumber
4
apa yang Anda miliki di BasicResponse?
Jemshit Iskenderov
2
Hanya kelas dasar Jackson beranotasi yang berisi pesan dan kode kesalahan. Bagaimanapun, Anda dapat memiliki kelas beranotasi di sana yang cocok dengan jenis respons server Anda. Coba gunakan jsonschema2pojo untuk menghasilkan satu yang sesuai dengan kebutuhan Anda.
JFreeman
Untuk yang lain, Anda dapat menggunakan ini sebagai gantinya: Konverter <ResponseBody, <Message> errorConverter = retrofit.responseBodyConverter (Message.class, Annotation baru [0]);
Kim Montano
@ Jeffreeman, bagaimana jika saya ingin deserialize List<BasicResponse>?
azizbekian
dapatkah Anda melihat kelas MyApplication
dungtv
10

Dalam https://stackoverflow.com/a/21103420/2914140 dan https://futurestud.io/tutorials/retrofit-2-simple-error-handling varian ini ditampilkan untuk Retrofit 2.1.0.

call.enqueue(new Callback<MyResponse>() {
    @Override
    public void onResponse(Call<MyResponse> call, Response<MyResponse> response) {
        if (response.isSuccessful()) {
            ...
        } else {
            Converter<ResponseBody, MyError> converter
                    = MyApplication.getRetrofit().responseBodyConverter(
                    MyError.class, new Annotation[0]);
            MyError errorResponse = null;
            try {
                errorResponse = converter.convert(response.errorBody());
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
    }
CoolMind
sumber
10

Buat model respons Galat & pengguna Gson untuk mengonversi respons terhadapnya. Ini hanya akan berfungsi dengan baik.

APIError.java

public class APIError {
    private String message;

    public String getMessage() {
        return message;
    }
}

MainActivity.java (permintaan di dalam onResponse)

if (response.isSuccessful()) {
    // Do your success stuff...

} else {
    APIError message = new Gson().fromJson(response.errorBody().charStream(), APIError.class);
    Toast.makeText(MainActivity.this, "" + message.getMessage(), Toast.LENGTH_SHORT).show();
}
Sreekant Shenoy
sumber
9
 @Override
 public void onResponse(Call<Void> call, retrofit2.Response<Void> response) {
            if (response.isSuccessful()) {

            //Do something if response is ok
            } else {

                JsonParser parser = new JsonParser();
                JsonElement mJson = null;
                try {
                    mJson = parser.parse(response.errorBody().string());
                    Gson gson = new Gson();
                    MyError errorResponse = gson.fromJson(mJson, MyError.class);
                } catch (IOException ex) {
                    ex.printStackTrace();
                }

            }
Vins
sumber
7

Saya melakukannya dengan cara ini untuk panggilan asinkron menggunakan Retrofit 2.0-beta2:

@Override
public void onResponse(Response<RegistrationResponse> response, 
                       Retrofit retrofit) {
    if (response.isSuccess()) {
        // Do success handling here
    } else {
        try {
            MyError myError = (MyError)retrofit.responseConverter(
                    MyError.class, MyError.class.getAnnotations())
                .convert(response.errorBody());
            // Do error handling here
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}
shantanu
sumber
Apa yang akan menjadi kelas MyError?
Dhrupal
Saya pikir onResponse seharusnya berisi parameter Panggilan dan parameter Respons. Bagaimana Anda memiliki parameter Retrofit?
Marty Miller
@MartyMiller ini dilakukan untuk versi retrofit berikut Retrofit 2.0-beta2
shantanu
7

Jika Anda menggunakan Kotlin solusi lain bisa saja membuat fungsi ekstensi untuk kelas Respons:

inline fun <reified T>Response<*>.parseErrJsonResponse(): T?
{
    val moshi = MyCustomMoshiBuilder().build()
    val parser = moshi.adapter(T::class.java)
    val response = errorBody()?.string()
    if(response != null)
        try {
            return parser.fromJson(response)
        } catch(e: JsonDataException) {
            e.printStackTrace()
        }
    return null
}

Pemakaian

val myError = response.parseErrJsonResponse<MyErrorResponse>()
if(myError != null) {
   // handle your error logic here
   // ...
}
Arsenius
sumber
Akhirnya seseorang menggunakan kekuatan Kotlin untuk membuat kode mudah dibaca!
Vince
6

Ini sebenarnya sangat lurus ke depan.

Kotlin:

val jsonObj = JSONObject(response.errorBody()!!.charStream().readText())
responseInterface.onFailure(jsonObj.getString("msg"))

Jawa:

JSONObject jsonObj = new JSONObject(response.errorBody().charStream().readText());
responseInterface.onFailure(jsonObj.getString("msg"));

Diuji pada retrofit: 2.5.0. Baca teks dari charStream yang akan memberi Anda String, kemudian parse ke JSONObject.

Adios.

Whales_Corps
sumber
tidak ada readText()ekstensi di java, gunakan TextStreamsKt.readText(response.errorBody().charStream())jika Anda masih di java
mochadwi
4

Saya menghadapi masalah yang sama. Saya menyelesaikannya dengan retrofit. Biarkan saya tunjukkan ini ...

Jika struktur JSON kesalahan Anda seperti

{
"error": {
    "status": "The email field is required."
}
}


My ErrorRespnce.java 

public class ErrorResponse {

   @SerializedName("error")
   @Expose
   private ErrorStatus error;

   public ErrorStatus getError() {
      return error;
   }

   public void setError(ErrorStatus error) {
      this.error = error;
   }
}

Dan ini kelas status Kesalahan saya

public class ErrorStatus {

  @SerializedName("status")
  @Expose
  private String status;

  public String getStatus() {
      return status;
  }

  public void setStatus(String status) {
      this.status = status;
  }
}

Sekarang kita membutuhkan kelas yang dapat menangani json kita.

  public class ErrorUtils {

   public static ErrorResponse parseError (Response<?> response){
      Converter<ResponseBody , ErrorResponse> converter =          ApiClient.getClient().responseBodyConverter(ErrorResponse.class , new Annotation[0]);
    ErrorResponse errorResponse;
    try{
        errorResponse = converter.convert(response.errorBody());
    }catch (IOException e){
        return new ErrorResponse();
    }
    return errorResponse;
}
}

Sekarang kita dapat memeriksa respons kita di retrofit api call

private void registrationRequest(String name , String email , String password , String c_password){


    final Call<RegistrationResponce> registrationResponceCall = apiInterface.getRegistration(name , email , password , c_password);
    registrationResponceCall.enqueue(new Callback<RegistrationResponce>() {
        @Override
        public void onResponse(Call<RegistrationResponce> call, Response<RegistrationResponce> response) {



            if (response.code() == 200){


            }else if (response.code() == 401){


                ErrorResponse errorResponse = ErrorUtils.parseError(response);
                Toast.makeText(MainActivity.this, ""+errorResponse.getError().getStatus(), Toast.LENGTH_SHORT).show();
            }
        }

        @Override
        public void onFailure(Call<RegistrationResponce> call, Throwable t) {

        }
    });
}

Itu saja sekarang Anda dapat menunjukkan Toast Anda

pavel
sumber
4

Berikut adalah solusi elegan menggunakan Kotlinekstensi:

data class ApiError(val code: Int, val message: String?) {
    companion object {
        val EMPTY_API_ERROR = ApiError(-1, null)
    }
}

fun Throwable.getApiError(): ApiError? {
    if (this is HttpException) {
        try {
            val errorJsonString = this.response()?.errorBody()?.string()
            return Gson().fromJson(errorJsonString, ApiError::class.java)
        } catch (exception: Exception) {
            // Ignore
        }
    }
    return EMPTY_API_ERROR
}

dan penggunaan:

showError(retrofitThrowable.getApiError()?.message)

Antonis Radz
sumber
3

Dengan cara ini Anda tidak perlu instance Retrofit jika Anda hanya menyuntikkan layanan yang dibuat dari Retrofit.

public class ErrorUtils {

  public static APIError parseError(Context context, Response<?> response) {

    APIError error = new APIError();

    try {
        Gson gson = new Gson();
        error = gson.fromJson(response.errorBody().charStream(), APIError.class);
    } catch (Exception e) {
        Toast.makeText(context, e.getMessage(), Toast.LENGTH_LONG).show();
    }

    if (TextUtils.isEmpty(error.getErrorMessage())) {
        error.setError(response.raw().message());
    }
    return error;
  }
}

Gunakan seperti ini:

if (response.isSuccessful()) {

      ...

    } else {

      String msg = ErrorUtils.parseError(fragment.getActivity(), response).getError(); // would be from your error class
      Snackbar.make(someview, msg, Snackbar.LENGTH_LONG).show();
    }
  }
Kode terbalik
sumber
3

Baca errorBody to a String dan secara manual parse json.

 if(!response.isSuccessful()) {
   
    String error = "";
    try {
        BufferedReader ereader = new BufferedReader(new InputStreamReader(
                response.errorBody().byteStream()));
        String eline = null;
        while ((eline = ereader.readLine()) != null) {
            error += eline + "";
        }
        ereader.close();
    } catch (Exception e) {
        error += e.getMessage();
    }
    Log.e("Error",error);
    
    try {
        JSONObject reader = new JSONObject(error);
        String message = reader.getString("message");
    
        Toast.makeText(context,message,Toast.LENGTH_SHORT).show();
    
    } catch (JSONException e) {
        e.printStackTrace();
    }
 }
Riyas PK
sumber
2

Ini tampaknya menjadi masalah ketika Anda menggunakan OkHttp bersama dengan Retrofit, jadi Anda dapat menghapus OkHttp atau menggunakan kode di bawah ini untuk mendapatkan badan kesalahan:

if (!response.isSuccessful()) {
 InputStream i = response.errorBody().byteStream();
 BufferedReader r = new BufferedReader(new InputStreamReader(i));
 StringBuilder errorResult = new StringBuilder();
 String line;
 try {
   while ((line = r.readLine()) != null) {
   errorResult.append(line).append('\n');
   }
 } catch (IOException e) { 
    e.printStackTrace(); 
}
}
KRUPEN GHETIYA
sumber
0

diselesaikan dengan:

Converter<MyError> converter = 
    (Converter<MyError>)JacksonConverterFactory.create().get(MyError.class);
MyError myError =  converter.fromBody(response.errorBody());
Piotr Boho
sumber
Bagaimana saya bisa mengonversi melalui GsonConverterFactory? Ada ide ?
Shan Xeeshi
Saya menemukan jalan. Saya hanya mengubah JacksonConverterFactory ke GsonConverterFactoryIni mengubah json menjadi objek kustom saya tetapi memberikan peringatan cor retrofit.Converter Tidak
Terkunci
3
Apa yang dimiliki kelas MyError?
Dhrupal
0
try{
                ResponseBody response = ((HttpException) t).response().errorBody();
                JSONObject json = new JSONObject( new String(response.bytes()) );
                errMsg = json.getString("message");
            }catch(JSONException e){
                return t.getMessage();
            }
            catch(IOException e){
                return t.getMessage();
            }
Mike6679
sumber
0

Di Kotlin:

val call = APIClient.getInstance().signIn(AuthRequestWrapper(AuthRequest("1234567890z", "12341234", "nonce")))
call.enqueue(object : Callback<AuthResponse> {
    override fun onResponse(call: Call<AuthResponse>, response: Response<AuthResponse>) {
        if (response.isSuccessful) {

        } else {
            val a = object : Annotation{}
            val errorConverter = RentalGeekClient.getRetrofitInstance().responseBodyConverter<AuthFailureResponse>(AuthFailureResponse::class.java, arrayOf(a))
            val authFailureResponse = errorConverter.convert(response.errorBody())
        }
    }

    override fun onFailure(call: Call<AuthResponse>, t: Throwable) {
    }
})
Adam Johns
sumber
0

nilai errorBody harus menetapkan objek APIError di Retrofit. Jadi, Anda dapat menggunakan struktur kode di bawah ini.

public class APIErrorUtils {

    public static APIError parseError(Response<?> response) {
        Converter<ResponseBody, APIError> converter = API.getClient().responseBodyConverter(APIError.class, new Annotation[0]);

        APIError error;

        try {
            error = converter.convert(response.errorBody());
            Log.d("SERVICELOG", "****************************************************");
            Log.d("SERVICELOG", "***** SERVICE LOG");
            Log.d("SERVICELOG", "***** TIMESTAMP: " + String.valueOf(error.getTimestamp()));
            Log.d("SERVICELOG", "***** STATUS: " + String.valueOf(error.getStatus()));
            Log.d("SERVICELOG", "***** ERROR: " + error.getError());
            Log.d("SERVICELOG", "***** MESSAGE: " + error.getMessage());
            Log.d("SERVICELOG", "***** PATH: " + error.getPath());
            Log.d("SERVICELOG", "****************************************************");
        } catch (IOException e) {
            return new APIError();
        }

        return error;
    }
}

APIError error = APIErrorUtils.parseError(response);
if (error.getStatus() == 400) {
    ....
}
Egemen Mede
sumber
0

Diuji dan bekerja

 public BaseModel parse(Response<BaseModel> response , Retrofit retrofit){
            BaseModel error = null;
            Converter<ResponseBody, BaseModel> errorConverter =
                    retrofit.responseBodyConverter(BaseModel.class, new Annotation[0]);
            try {
                if (response.errorBody() != null) {
                    error = errorConverter.convert(response.errorBody());
                }
            } catch (IOException e) {
                e.printStackTrace();
            }
            return error;
        }
MJ
sumber
-1
val error = JSONObject(callApi.errorBody()?.string() as String)
            CustomResult.OnError(CustomNotFoundError(userMessage = error["userMessage"] as String))

open class CustomError (
    val traceId: String? = null,
    val errorCode: String? = null,
    val systemMessage: String? = null,
    val userMessage: String? = null,
    val cause: Throwable? = null
)

open class ErrorThrowable(
    private val traceId: String? = null,
    private val errorCode: String? = null,
    private val systemMessage: String? = null,
    private val userMessage: String? = null,
    override val cause: Throwable? = null
) : Throwable(userMessage, cause) {
    fun toError(): CustomError = CustomError(traceId, errorCode, systemMessage, userMessage, cause)
}


class NetworkError(traceId: String? = null, errorCode: String? = null, systemMessage: String? = null, userMessage: String? = null, cause: Throwable? = null):
    CustomError(traceId, errorCode, systemMessage, userMessage?: "Usted no tiene conexión a internet, active los datos", cause)

class HttpError(traceId: String? = null, errorCode: String? = null, systemMessage: String? = null, userMessage: String? = null, cause: Throwable? = null):
    CustomError(traceId, errorCode, systemMessage, userMessage, cause)

class UnknownError(traceId: String? = null, errorCode: String? = null, systemMessage: String? = null, userMessage: String? = null, cause: Throwable? = null):
    CustomError(traceId, errorCode, systemMessage, userMessage?: "Unknown error", cause)

class CustomNotFoundError(traceId: String? = null, errorCode: String? = null, systemMessage: String? = null, userMessage: String? = null, cause: Throwable? = null):
    CustomError(traceId, errorCode, systemMessage, userMessage?: "Data not found", cause)`
Gary Loyola
sumber