Retrofit 2 0 how to get deserialised error response body

Question

I m using Retrofit 2 0 0-beta1   In tests i have an alternate scenario and expect error HTTP 400  I would like to have retrofit Response lt MyError gt  response but response body      null  MyError is not deserialised - i see it only here  response errorBody   string     but it doesn t give me MyError as object

User · Answer

ErrorResponse is your custom response object  Kotlin    val gson   Gson   val type   object   TypeToken lt ErrorResponse gt       type var errorResponse  ErrorResponse    gson fromJson response errorBody     charStream    type    Java  Gson gson   new Gson    Type type   new TypeToken lt ErrorResponse gt       getType    ErrorResponse errorResponse   gson fromJson response errorBody charStream   type

User · Answer

It s actually very straight forward  Kotlin  val jsonObj   JSONObject response errorBody     charStream   readText    responseInterface onFailure jsonObj getString  quot msg quot     Java      if response errorBody    null       JSONObject jsonObj   new JSONObject TextStreamsKt readText response errorBody   charStream              responseInterface onFailure jsonObj getString  quot msg quot          else          responseInterface onFailure  quot you might want to return a generic error message  quot           Tested on retrofit 2 5 0  Read the text from the charStream which will give you a String  then parse to JSONObject  Adios

User · Answer

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

User · Answer

Override  public void onResponse Call lt Void gt  call  retrofit2 Response lt Void gt  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

User · Answer

If you use Kotlin another solution could be just create extension function for Response class   inline fun  lt reified T gt Response lt   gt  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     Usage   val myError   response parseErrJsonResponse lt MyErrorResponse gt    if myError    null          handle your error logic here

User · Answer

I solved it by    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                                                  MyErrorMessage Class     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

User · Answer

This seems to be the problem when you use OkHttp along with Retrofit  so either you can remove OkHttp or use code below to get error body   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

User · Answer

Create a model of the Error response  amp  user Gson to convert the response to it  This will just work fine   APIError java  public class APIError       private String message       public String getMessage             return message            MainActivity java  inside request 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

User · Answer

In Kotlin   val call   APIClient getInstance   signIn AuthRequestWrapper AuthRequest  1234567890z    12341234    nonce     call enqueue object   Callback lt AuthResponse gt        override fun onResponse call  Call lt AuthResponse gt   response  Response lt AuthResponse gt             if  response isSuccessful               else               val a   object   Annotation               val errorConverter   RentalGeekClient getRetrofitInstance   responseBodyConverter lt AuthFailureResponse gt  AuthFailureResponse  class java  arrayOf a               val authFailureResponse   errorConverter convert response errorBody                         override fun onFailure call  Call lt AuthResponse gt   t  Throwable

User · Answer

if  response isSuccessful          StringBuilder error   new StringBuilder        try           BufferedReader bufferedReader   null          if  response errorBody      null                bufferedReader   new BufferedReader new InputStreamReader                      response errorBody   byteStream                   String eLine   null              while   eLine   bufferedReader readLine       null                    error append eLine                             bufferedReader close                     catch  Exception e            error append e getMessage                Log e  quot Error quot   error toString

User · Answer

I currently use a very easy implementation  which does not require to use converters or special classes  The code I use is the following   public void onResponse Call lt ResponseBody gt  call  Response lt ResponseBody gt  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

User · Answer

I did it this way for asynchronous calls using Retrofit 2 0-beta2    Override public void onResponse Response lt RegistrationResponse gt  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

User · Answer

I was facing same issue  I solved it with retrofit  Let me show this      If your error JSON structure are like      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           And this my Error status class  public class ErrorStatus       SerializedName  status      Expose   private String status     public String getStatus           return status         public void setStatus String status          this status   status          Now we need a class which can handle our json      public class ErrorUtils       public static ErrorResponse parseError  Response lt   gt  response         Converter lt ResponseBody   ErrorResponse gt  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        Now we can check our response in retrofit api call   private void registrationRequest String name   String email   String password   String c password         final Call lt RegistrationResponce gt  registrationResponceCall   apiInterface getRegistration name   email   password   c password       registrationResponceCall enqueue new Callback lt RegistrationResponce gt               Override         public void onResponse Call lt RegistrationResponce gt  call  Response lt RegistrationResponce gt  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 lt RegistrationResponce gt  call  Throwable t                           That s it now you can show your Toast

User · Answer

In https   stackoverflow com a 21103420 2914140 and https   futurestud io tutorials retrofit-2-simple-error-handling this variant is shown for Retrofit 2 1 0   call enqueue new Callback lt MyResponse gt           Override     public void onResponse Call lt MyResponse gt  call  Response lt MyResponse gt  response            if  response isSuccessful                                else               Converter lt ResponseBody  MyError gt  converter                       MyApplication getRetrofit   responseBodyConverter                      MyError class  new Annotation 0                MyError errorResponse   null              try                   errorResponse   converter convert response errorBody                   catch  IOException e                    e printStackTrace

User · Answer

solved it by   Converter lt MyError gt  converter         Converter lt MyError gt  JacksonConverterFactory create   get MyError class   MyError myError    converter fromBody response errorBody

User · Answer

Tested and works   public BaseModel parse Response lt BaseModel gt  response   Retrofit retrofit               BaseModel error   null              Converter lt ResponseBody  BaseModel gt  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

User · Answer

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

User · Answer

Here is elegant solution using Kotlin extensions   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     and usage   showError retrofitThrowable getApiError    message

User · Answer

In Retrofit 2 0 beta2 this is the way that I m getting error responses    Synchronous     try      Call lt RegistrationResponse gt  call   backendServiceApi register data in account  data in password             data in email      Response lt RegistrationResponse gt  response   call execute       if  response    null  amp  amp   response isSuccess    amp  amp  response errorBody      null           Converter lt ResponseBody  BasicResponse gt  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    Asynchronous  Call lt BasicResponse gt  call   service loadRepo    call enqueue new Callback lt BasicResponse gt           Override     public void onResponse Response lt BasicResponse gt  response  Retrofit retrofit            if  response    null  amp  amp   response isSuccess    amp  amp  response errorBody      null                Converter lt ResponseBody  BasicResponse gt  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              Update for Retrofit 2 beta3    Synchronous - not changed Asynchronous - Retrofit parameter was removed from onResponse  Call lt BasicResponse gt  call   service loadRepo    call enqueue new Callback lt BasicResponse gt           Override     public void onResponse Response lt BasicResponse gt  response            if  response    null  amp  amp   response isSuccess    amp  amp  response errorBody      null                Converter lt ResponseBody  BasicResponse gt  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

User · Answer

errorBody values should set APIError object in Retrofit  So that  you can use the below code structure   public class APIErrorUtils        public static APIError parseError Response lt   gt  response            Converter lt ResponseBody  APIError gt  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

User · Answer

This way you do not need a Retrofit instance if you only are injecting a service created from Retrofit    public class ErrorUtils      public static APIError parseError Context context  Response lt   gt  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          Use it like this   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

[java] Retrofit 2.0 how to get deserialised error response.body

Examples related to java

Examples related to retrofit

Examples related to retrofit2