运行时动态修改Retrofit BaseUrl的完美实践

2023-09-09 18:29:28

前言

在实际的网络请求中，我们经常会遇到需要切换不同BaseUrl的情况，例如：

多个服务器环境：开发环境、测试环境、生产环境等。
不同区域或国家/地区：不同的服务器可能位于不同的区域或国家/地区。
负载均衡：为了提高系统的可靠性和性能，可能需要将请求分散到多个服务器上。

为了应对这些情况，我们需要能够动态地修改Retrofit的BaseUrl。

实现方案

实现运行时动态修改Retrofit BaseUrl的方法有很多，其中最常用和推荐的方法是使用拦截器（Interceptor）。拦截器是一种强大的工具，可以让我们在网络请求发送之前或之后做一些自定义的操作，例如添加额外的请求头、修改请求参数、处理错误响应等。

要使用拦截器来动态修改BaseUrl，我们需要创建一个自定义的拦截器，并将其添加到OkHttpClient中。在拦截器中，我们可以根据需要来修改请求的BaseUrl。

以下是实现步骤：

创建一个自定义的拦截器，如下所示：

public class DynamicBaseUrlInterceptor implements Interceptor {

    private Map<String, String> baseUrls;

    public DynamicBaseUrlInterceptor(Map<String, String> baseUrls) {
        this.baseUrls = baseUrls;
    }

    @Override
    public Response intercept(Chain chain) throws IOException {
        Request originalRequest = chain.request();

        String baseUrl = baseUrls.get(originalRequest.url().host());
        if (baseUrl != null) {
            HttpUrl newHttpUrl = originalRequest.url().newBuilder()
                    .scheme(originalRequest.url().scheme())
                    .host(baseUrl)
                    .build();

            Request newRequest = originalRequest.newBuilder()
                    .url(newHttpUrl)
                    .build();

            return chain.proceed(newRequest);
        }

        return chain.proceed(originalRequest);
    }
}

将自定义的拦截器添加到OkHttpClient中，如下所示：

OkHttpClient.Builder builder = new OkHttpClient.Builder();
builder.addInterceptor(new DynamicBaseUrlInterceptor(baseUrls));

OkHttpClient client = builder.build();

将OkHttpClient对象传递给Retrofit，如下所示：

Retrofit retrofit = new Retrofit.Builder()
        .baseUrl(BASE_URL)
        .client(client)
        .build();

这样，我们就可以在运行时动态地修改Retrofit的BaseUrl了。

使用方法

要使用动态BaseUrl功能，我们需要先将需要切换的BaseUrl存储在一个Map中，然后将Map传递给DynamicBaseUrlInterceptor。

Map<String, String> baseUrls = new HashMap<>();
baseUrls.put("dev.example.com", "https://dev.example.com/");
baseUrls.put("test.example.com", "https://test.example.com/");
baseUrls.put("prod.example.com", "https://prod.example.com/");

然后，在创建Retrofit对象时，将DynamicBaseUrlInterceptor添加到OkHttpClient中，并传递baseUrls Map。

OkHttpClient.Builder builder = new OkHttpClient.Builder();
builder.addInterceptor(new DynamicBaseUrlInterceptor(baseUrls));

OkHttpClient client = builder.build();

Retrofit retrofit = new Retrofit.Builder()
        .baseUrl(BASE_URL)
        .client(client)
        .build();

现在，我们可以通过改变请求的host来动态地切换BaseUrl。例如，要切换到测试环境，我们可以使用以下代码：

Request originalRequest = ...;

HttpUrl newHttpUrl = originalRequest.url().newBuilder()
        .scheme(originalRequest.url().scheme())
        .host("test.example.com")
        .build();

Request newRequest = originalRequest.newBuilder()
        .url(newHttpUrl)
        .build();

然后，使用newRequest来执行网络请求。