使用Retrofit Android为多个API进行常见成功/失败/错误处理的良好设计

Question

我希望以这样一种方式设计API调用，即从一个地方轻松处理成功和失败响应（而不是为所有API编写相同的调用函数代码）

null

1. apiInterface.java-它是一个包含不同API调用定义的接口。
2. apiclient.java-获取referfit客户机对象来调用API。
3. apimanager.java--它有调用API并解析其响应的方法。

apiInterface.java

public interface ApiInterface {

    // Get Devices
    @GET("https://example-base-url.com" + "/devices")
    Call<ResponseBody> getDevices(@Header("Authorization) String token);

    // Other APIs......
}

apiclient.java

public class ApiClient {
    
    private static Retrofit retrofitClient = null;
    
    static Retrofit getClient(Context context) {

        OkHttpClient okHttpClient = new OkHttpClient.Builder()
                    .sslSocketFactory(sslContext.getSocketFactory(), systemDefaultTrustManager())
                    .connectTimeout(15, TimeUnit.SECONDS)
                    .writeTimeout(15, TimeUnit.SECONDS)
                    .readTimeout(15, TimeUnit.SECONDS)
                    .build();

        retrofitClient = new Retrofit.Builder()
                .baseUrl(BASE_URL)
                .addConverterFactory(GsonConverterFactory.create())
                .addCallAdapterFactory(RxJava2CallAdapterFactory.create())
                .client(okHttpClient)
                .build();
    }
}

apimanager.java

public class ApiManager {

private static ApiManager apiManager;

    public static ApiManager getInstance(Context context) {
        if (apiManager == null) {
            apiManager = new ApiManager(context);
        }
        return apiManager;
    }

    private ApiManager(Context context) {
        this.context = context;
        apiInterface = ApiClient.getClient(context).create(ApiInterface.class);   
    }

    public void getDevices(ResponseListener listener) {
        // API call and response handling
    }
    // Other API implementation
}

Answer 1

通过在中心位置处理成功/失败响应，我假设您希望消除基于错误解析逻辑以及它如何为应用程序创建UI副作用的重复样板。

我可能建议通过为callback创建一个自定义抽象来使事情变得非常简单，该抽象根据域逻辑调用API的成功/失败。

下面是用例（1）的一个相当简单的实现：

abstract class CustomCallback<T> implements Callback<T> {

    abstract void onSuccess(T response);
    abstract void onFailure(Throwable throwable);
    
    @Override
    public void onResponse(Call<T> call, Response<T> response) {
        if (response.isSuccessful()) {
            onSuccess(response.body());
        } else {
            onFailure(new HttpException(response));
        }
    }

    @Override
    public void onFailure(Call<T> call, Throwable t) {
        onFailure(t);
    }
}

对于用例(2)，为了能够在logout这样的全局事件上取消所有排队调用，您必须保留对所有此类对象的引用。幸运的是，referfit支持插入自定义调用工厂OKHTTP3.call.factory

您可以将您的实现作为一个单例来保存调用集合，并在注销的情况下通知它取消飞行中的所有请求。请注意，一定要在集合中使用此类调用的弱引用，以避免泄漏/对死调用的引用。（另外，您可能希望针对要使用的正确集合或基于事务的弱引用定期清理进行集思广益）

对于用例(3)，authenticator应该很好，因为您已经了解了用法，有两个选项-

1. 将刷新令牌调用迁移到OKHTTP/regetfit并同步激发它
2. 使用倒数锁存器使身份验证器等待异步调用完成（将超时设置为刷新令牌API调用的连接/读/写超时）

下面是一个示例实现：

abstract class NetworkAuthenticator implements Authenticator {

    private final SessionRepository sessionRepository;

    public NetworkAuthenticator(SessionRepository repository) {
        this.sessionRepository = repository;    
    }

    public Request authenticate(@Nullable Route route, @NonNull Response response) {
        String latestToken = getLatestToken(response);

        // Refresh token failed, trigger a logout for the user
        if (latestToken == null) {
            logout();
            return null;
        }

        return response
                .request()
                .newBuilder()
                .header("AUTHORIZATION", latestToken)
                .build();
    }

    private synchronized String getLatestToken(Response response) {
        String currentToken = sessionRepository.getAccessToken();

        // For a signed out user latest token would be empty
        if (currentToken.isEmpty()) return null;

        // If other calls received a 401 and landed here, pass them through with updated token
        if (!getAuthToken(response.request()).equals(currentToken)) {
            return currentToken;
        } else {
            return refreshToken();
        }
    }

    private String getAuthToken(Request request) {
        return request.header("AUTHORIZATION");
    }

    @Nullable
    private String refreshToken() {
        String result = null;
        CountDownLatch countDownLatch = new CountDownLatch(1);

        // Make async call to fetch token and update result in the callback
    
        // Wait up to 10 seconds for the refresh token to succeed
        try {
            countDownLatch.await(10, TimeUnit.SECONDS);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
    
        return result;
    }

    abstract void logout();
}

我希望这有助于您的网络层实现