本文将详细介绍如何利用 Java 泛型来解析 retrofit 框架返回的动态类型的错误响应。正如摘要所述,通过泛型,我们可以创建一个通用的 parseError 方法,能够处理不同类型的 BaseApiResponse,避免代码冗余,提高代码的复用性和可维护性。
使用 Java 泛型解析 Retrofit 错误响应
在 Retrofit 中,我们经常需要处理服务器返回的错误响应。如果错误响应的结构是固定的,我们可以直接定义相应的类来解析。但是,如果错误响应的结构是动态的,例如,BaseApiResponse 中的 DATA 和 ERROR 类型会根据不同的 API 接口而变化,那么我们需要一种更灵活的方法来处理。Java 泛型提供了一种很好的解决方案。
1. 定义泛型 parseError 方法
我们可以定义一个泛型的 parseError 方法,该方法接受 Retrofit 的 Response> 对象作为参数,并返回一个 BaseApiResponse
import com.google.gson.Gson; import com.google.gson.reflect.TypeToken; import retrofit2.Response; import java.lang.reflect.Type; public class CommonUtils { public static <D, E> BaseApiResponse<D, E> parseError(Response<?> response) { try { Gson gson = new Gson(); // 注意:这里的 Type 需要动态构建,不能写死 Type type = TypeToken.getParameterized(BaseApiResponse.class, Object.class, Object.class).getType(); // 根据传入的泛型类型创建对应的 Type 对象 if (response.errorBody() != null) { return gson.fromJson(response.errorBody().charStream(), type); } else { BaseApiResponse<D, E> erResponse = new BaseApiResponse<>(); erResponse.setMessage("Error body is null!"); return erResponse; } } catch (Exception e) { BaseApiResponse<D, E> erResponse = new BaseApiResponse<>(); erResponse.setMessage("Error unexpected in JSON! " + e.getMessage()); return erResponse; } } }
注意: 上述代码中,TypeToken.getParameterized(BaseApiResponse.class, Object.class, Object.class).getType() 这行代码需要根据实际情况进行修改。 Object.class 需要替换为实际的类型,否则反序列化时可能会出现问题。 更通用的做法是,不直接在 parseError 方法中进行反序列化,而是将 response.errorBody().String() 返回,然后在调用方进行反序列化,这样可以更灵活地处理不同类型的错误响应。
立即学习“Java免费学习笔记(深入)”;
2. 调用泛型 parseError 方法
在调用 parseError 方法时,我们需要显式地指定泛型类型参数。例如,如果我们想要解析一个 BaseApiResponse
Response<?> response = ...; // 获取 Retrofit 的 Response 对象 BaseApiResponse<LoginResponse, LoginErrorResponse> errResponse = CommonUtils.parseError(response);
同样,如果我们想要解析一个 BaseApiResponse
Response<?> response = ...; // 获取 Retrofit 的 Response 对象 BaseApiResponse<RegisterResponse, RegisterErrorResponse> errResponse = CommonUtils.parseError(response);
3. 改进方案
上面的代码存在一个问题,就是 TypeToken 的创建是写死的,无法根据实际的泛型类型动态创建。为了解决这个问题,可以将反序列化的逻辑放到调用方,parseError 方法只负责读取 errorBody 的内容。
修改后的 parseError 方法如下:
import retrofit2.Response; import java.io.IOException; public class CommonUtils { public static String parseError(Response<?> response) throws IOException { if (response.errorBody() != null) { return response.errorBody().string(); } else { return null; } } }
调用方代码如下:
import com.google.gson.Gson; import java.io.IOException; Response<?> response = ...; // 获取 Retrofit 的 Response 对象 String errorBody = null; try { errorBody = CommonUtils.parseError(response); } catch (IOException e) { e.printStackTrace(); } if (errorBody != null) { Gson gson = new Gson(); BaseApiResponse<LoginResponse, LoginErrorResponse> errResponse = gson.fromJson(errorBody, new TypeToken<BaseApiResponse<LoginResponse, LoginErrorResponse>>() {}.getType()); // 使用 errResponse }
这样,我们就可以在调用方根据实际的泛型类型来创建 TypeToken,从而实现动态类型的错误响应解析。
总结
通过使用 Java 泛型,我们可以创建一个通用的 parseError 方法,能够处理不同类型的 BaseApiResponse,避免代码冗余,提高代码的复用性和可维护性。需要注意的是,在创建 TypeToken 时,需要根据实际的泛型类型来创建,否则反序列化时可能会出现问题。 更通用的做法是,将 response.errorBody().string() 返回,然后在调用方进行反序列化,这样可以更灵活地处理不同类型的错误响应。