Retrofit(OKHttp)多BaseUrl情况下url实时自动替换完美解决方法

前言

多数项目中会出现用到多个BaseUrl的情况,而Retrofit未提供实时切换BaseUrl的方法,且我们在使用Retrofit以及OkHttp时,通常使用单例模式创建Retrofit和OkHttpClient,也不可能每个请求都创建一个Retrofit实例。面对这个实际问题,我们需要做的不仅仅是解决当前问题,更应该从根本上解决该问题,即实现任何情况下的自动切换BaseUrl。 主要用于个人积累及分享,如有错误请随时指出,文中可能引用其他大牛文章(仅引用链接不转载),如有侵权请告知必妥善处理。

思路分析

问题
一个例子,给出资源如下:

`//账户服地址`

`String base_url_user =` `"[https://www.111.com/](https://www.111.com/)"`

`//支付服地址`

`String base_url_pay =` `"[https://www.222.com/](https://www.222.com/)"`

`//**********账户接口方法(使用账户服地址base_url_user)`

`String method_path_user_01 =` `"user/login"``;`

`String method_path_user_02 =` `"user/register"``;`

`//**********支付接口方法(使用支付服地址base_url_pay)`

`String method_path_pay_01 =` `"pay/getorder"``;`

`String method_path_pay_02 =` `"pay/payment"``;`

通常情况下,RetrofitService.java中,我们这样写:

@POST("user/login")
Observable login(@QueryMap
Map paramMap);

@POST("user/register")
Observable register(@QueryMap
Map paramMap);

@POST("pay/getorder")
Observable getOrder(@QueryMap
Map paramMap);

@POST("pay/payment")
Observable payment(@QueryMap
Map paramMap);

RetrofitHelper.java中这样定义:

package com.mooc.ppjoke.ui.publish;
 public  class RetrofitHelper {
        private  static final String BASE_URL_USER = "https://www.111.com/";
        private static  final String BASE_URL_PAY = "https://www.222.com/";
         private static  final long TIME_OUT = 5000;
        private RetrofitService retrofitService;
        public static RetrofitHelper getInstance() {
            return SingleHolder.INSTANCE;
        }
        
       private  static class SingleHolder {
        private    static final RetrofitHelper INSTANCE = new
                    RetrofitHelper();

        }
        private RetrofitHelper() {
            OkHttpClient okHttpClient = new
                    OkHttpClient
                             .Builder()
                             .connectTimeout(TIME_OUT, TimeUnit.MILLISECONDS)
                             .build();
            Retrofit retrofit = new
                    Retrofit.Builder()
                    .client(okHttpClient)
                    .baseUrl(BASE_URL_USER)
                    .addConverterFactory(GsonConverterFactory.create())
                    .addCallAdapterFactory(RxJavaCallAdapterFactory.create())
                    .build();
                    retrofitService = retrofit.create(RetrofitService.class);
        }



    ......

    }

如上,当有多个BaseUrl时,Retrofit并没有提供切换BaseUrl的方法。若是每一个请求均build一个Retrofit,那么单例也就没什么意义了;若通过在RetrofitService.java的@POST(…)注解中写死整个url的方式,也缺乏灵活性,一旦项目升级再升级,接口数增多,或接口有变化时,会特别混乱。

思路

要实现灵活的配置BaseUrl,首先需要了解OkHttpClient的应用拦截器Interceptor。应用拦截器Interceptor是当前app和okhttp之间的中间层,主要用于截获app向okhttp的request请求,并可在回调中进行自定义修改、重置等(另外还有网络拦截器NetworkInterceptor,相当于okhttp和network之间的中间层,用于截获okhttp和network之间的请求和响应)。Interceptor通过如下方式添加

OkHttpClient okHttpClient = new
OkHttpClient.Builder()
                            ......
                            .addInterceptor(new Interceptor() {
                                @Override
                       public Response intercept(Chain chain) throws IOException {
                                    //获取请求request
                                    Request request = chain.request();
                                    //获取请求request的创建者builder实例
                                    Request.Builder builder = request.newBuilder();
                                    //通过builder.xxxx.build()修改相关配置等,并调用
                                    //chain.proceed(Request request)返回响应response
                                    return
                                   chain.proceed(builder.xxxx.build());
                                }
                            })
                            .build();

上面代码给我们提供了一个机会,在okhttp向network请求之前,我们可以很方便的替换请求的内容,只需要再修改builder后,重新build就会生成新的request实例。

现在已经知道了如何在请求network之前修改请求,那么,剩下需要考虑的问题就是,我们如何判断当前的request需要哪一个BaseUrl?
这里我们可以考虑使用@Headers({“xxx_key:yyy_value”}),当在RetrofitService.java的接口中配置了这个标签,我们就可以在Interceptor中获取当前请求的头,并根据你配置的维一对应的yyy_value,来匹配当前所需使用的BaseUrl,然后将原有的url替换掉,当okhttp向network请求时,就是最新的url了。

解决

以下将做简单示例,你可以在项目中根据实际情况做优化。还是上面的例子,我们如下处理即可:
RetrofitService.java中

//添加Headers:使用同样的键url_name;使用不同值user或pay,对应账户服地址和支付服地址。下同。
@Headers({"url_name:user"})
@POST("user/login")
Observable login(@QueryMap
Map paramMap);
@Headers({"url_name:user"})
@POST("user/register")
Observable register(@QueryMap
Map paramMap);
@Headers({"url_name:pay"})
@POST("pay/getorder")
Observable getOrder(@QueryMap
Map paramMap);
@Headers({"url_name:pay"})
@POST("pay/payment")
Observable payment(@QueryMap
Map paramMap);

RetrofitHelper.java中:



public
class RetrofitHelper {
    private static final String BASE_URL_USER = "https://www.111.com/";
    private static final String BASE_URL_PAY = "https://www.222.com/";
    private static final long TIME_OUT = 5000;
    private RetrofitService retrofitService;

    public
    static RetrofitHelper getInstance() {
        return SingleHolder.INSTANCE;
    }

    private
    static class SingleHolder {
        private
        static final RetrofitHelper INSTANCE = new
                RetrofitHelper();
    }

    private RetrofitHelper() {
        OkHttpClient okHttpClient = new
                OkHttpClient.Builder()
                .connectTimeout(TIME_OUT, TimeUnit.MILLISECONDS)
                //添加应用拦截器
                .addInterceptor(new Interceptor() {
                    @Override
                    public Response intercept(Chain chain) throws IOException {
                        //获取request
                        Request request = chain.request();
                        //获取request的创建者builder
                        Request.Builder builder = request.newBuilder();
                        //从request中获取headers,通过给定的键url_name
                        List headerValues = request.headers("url_name");
                        if
                        (headerValues != null
                                && headerValues.size() > 0) {
                            //如果有这个header,先将配置的header删除,因此header仅用作app和okhttp之间使用
                            builder.removeHeader(HttpConfig.HEADER_KEY);
                            //匹配获得新的BaseUrl
                            String headerValue = headerValues.get(0);
                            HttpUrl newBaseUrl = null;
                            if
                            ("user".equals(headerValue)) {
                                newBaseUrl = HttpUrl.parse(BASE_URL_USER);
                            } else if ("pay".equals(headerValue)) {
                                newBaseUrl = HttpUrl.parse(BASE_URL_PAY);
                            } else {
                                newBaseUrl = oldHttpUrl;
                            }
                            //从request中获取原有的HttpUrl实例oldHttpUrl
                            HttpUrl oldHttpUrl = request.url();
                            //重建新的HttpUrl,修改需要修改的url部分
                            HttpUrl newFullUrl = oldHttpUrl
                                    .newBuilder()
                                    .scheme(newBaseUrl.scheme())
                                    .host(newBaseUrl.host())
                                    .port(newBaseUrl.port())
                                    .build();
                            //重建这个request,通过builder.url(newFullUrl).build();
                            //然后返回一个response至此结束修改
                            return
                                    chain.proceed(builder.url(newFullUrl).build());
                        } else {
                            return
                                    chain.proceed(request);

                        }

                    }

                })

                .build();

        Retrofit retrofit = new
                Retrofit
                        .Builder()
                .client(okHttpClient)
                //创建retrofit时的baseUrl可以不需担心、随意指定了
                .baseUrl(BASE_URL_USER)
                .addConverterFactory(GsonConverterFactory.create())
                .addCallAdapterFactory(RxJavaCallAdapterFactory.create())
                .build();
        retrofitService = retrofit.create(RetrofitService.class);

    }
    ......
}

你可能感兴趣的:(Retrofit(OKHttp)多BaseUrl情况下url实时自动替换完美解决方法)