Android OkHttp 史上最优雅的设置baseUrl

RxHttp截止本文发表已经推广了4个礼拜，目前已经有了141个star，如下：

本文将在RxHttp的基础上带大家如何优雅的设置BaseUrl，如果您还未了解RxHttp，请移步

RxHttp 一条链发送请求，新一代Http请求神器（一）

RxHttp 一条链发送请求之强大的数据解析功能（二）

RxHttp 一条链发送请求之强大的Param类（三）

RxHttp 一条链发送请求之注解处理器 Generated API（四）

RxHttp一经推出，就有人问：难道Retrofit不好用吗？为啥还要自己去封装呢？借此文，跟大家简单聊一聊。 为什么要重复造轮子？无非就一个原因

以前的轮子有些功能不好用，用起来不够优雅

Retrofit哪里不好用，用起来不够优雅？

首先，我觉得是对文件的操作不是那么的友好，如文件上传/下载、上传/下载进度监听、断点下载，这些都需要我们进行二次封装，看过Android 史上最优雅的实现文件上传、下载及进度的监听的同学知道，使用RxHttp是多么的简单；

然后，是对多个baseUrl，或者说动态baseUrl不够友好，Retrofit要求baseUrl 必须是一个final常量，我们想要动态修改，就只能通过增加拦截器去实现，这也是本文重点要说的；

最后，也是非常重要的一点，那就是Activity/Fragment销毁时，对请求的关闭，通常我们的做法是为请求设置Tag，然后根据此Tag去关闭一系列请求，又或者拿到Call对象，去关闭单个请求，极其的麻烦，如果你使用RxHttp，在Activity/Fragment中，一行代码就能搞定，并且支持在任意生命周期方法关闭请求，极其简单高效。(注意：Retrofit结合RxJava，依然能够在RxJava中断上下游时，调用Call对象的cancel方法，感谢评论区卓_修武大佬的指正)

以上就是我重复造轮子的主要原因，欢迎大家交(Da)流(Lian)讨论，下面将进入正题。

如果你的项目中只有一个BaseUrl，那么只需要使用@DefaultDomain注解即可，如下：

public class Url {
    @DefaultDomain() //设置为默认域名，对final关键字没有要求
    public static String baseUrl = "http://ip.taobao.com/";
}

发送请求，我们就可以这样

  String url = "/service/getIpInfo.php";
  RxHttp.get(url) //Get请求
        .add("ip", "63.223.108.42") //添加参数
        .addHeader("accept", "*/*") //添加请求头
        .addHeader("connection", "Keep-Alive")
        .addHeader("user-agent", "Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1;SV1)")
        .fromSimpleParser(String.class)  //这里返回Observable 对象
        //感知生命周期，并在主线程回调，Activity/fragment销毁，自动关闭为完成的请求
        .as(RxLife.asOnMain(this))
        .subscribe(s -> {
            //成功回调
        }, throwable -> {
            //失败回调
        });

此时，发送请求前，RxHttp会对我们传入url做判断，如果url里已经有baseUrl，即是一条完成url链接，就不会添加@DefaultDomain注解表明的baseUrl，否则就会添加，我们通过日志来观察以下结果(过滤RxHttp)

注：注解@DefaultDomain只能使用一处，多处使用将编译不通过

在上面代码中，我们只需要传入一条完整的url链接，其实就已经实现了多个baseUrl的问题，然后，大部分开发者都喜欢将baseUrl 多带带写在一个变量里，如果每次发请求，我们都需要以baseUrl+url的方式去实现，显然不够友好，那么RxHttp又是如果去解决的呢？很简单，使用@Domain注解，如下：

public class Url {
    @Domain(name = "Update")
    public static String update = "http://update.9158.com";

    @DefaultDomain() //设置为默认域名,对final关键字没有要求
    public static String baseUrl = "http://ip.taobao.com/";
}

此时rebuild一下项目，RxHttp类就会自动生成一个setDomainToUpdateIfAbsent()方法，此方法的命名规则为setDomainTo+@Domain注解中指定的name字段的值+IfAbsent，见名思议，此方法是会在域名缺席的情况下，添加我们指定的域名，如果没有指定，就会添加@DefaultDomain注解标记的默认域名。

此时发请求，我们就可以这样：

  String destPath = getExternalCacheDir() + "/" + System.currentTimeMillis() + ".apk";
  RxHttp.get("/miaolive/Miaolive.apk")
        .setDomainToUpdateIfAbsent() //使用指定的域名
        .download(destPath) //注意这里使用DownloadParser解析器，并传入本地路径
        .as(RxLife.asOnMain(this))  //感知生命周期，并在主线程回调
        .subscribe(s -> {
            Log.d("RxHttp", "download success 
path=" + s);
            //下载成功,回调文件下载路径
        }, throwable -> {
            //下载失败
        });

我们再通过日志来观察一下

可以看到，baseUrl跟url成功拼接在了一起,并完成了下载操作。

@Domain注解可以使用多处，如下：

public class Url {
    @Domain(name = "Baidu")
    public static String update = "http://www.baidu.com";
    
    @Domain(name = "Hao123")
    public static String update = "https://www.hao123.com/";

    @Domain(name = "Update")
    public static String update = "http://update.9158.com";

    @DefaultDomain() //设置为默认域名,对final关键字没有要求
    public static String baseUrl = "http://ip.taobao.com/";
}

此时rebuild一下项目，RxHttp类下就会再新增setDomainToBaiduIfAbsent()、setDomainToHao123IfAbsent()这两个方法，故我们发请求就可以调用setDomainToXXXIfAbsent方法指定baseUrl。

某些情况下，我们的域名可能会被封，又或者其它原因，导致我们需要在app启动的时候动态配置域名，如果你使用Retrofit的话，由于Retrofit要求baseUrl必须是final常量，所以我们就只能通过拦截器去实现，而RxHttp对baseUrl ，没有final关键字的限制，我们只需要对baseUrl重新赋值即可，而且，可以在代码中多次赋值，赋值后立即生效。

如：我们将baseUrl里taobao域名改为baidu,改完立即发送请求。

  Url.baseUrl = "http://www.baidu.com";  //更改域名，将taobao域名改为baidu
  RxHttp.get("/service/getIpInfo.php") //Get请求
        .add("ip", "63.223.108.42") //添加参数
        .addHeader("accept", "*/*") //添加请求头
        .addHeader("connection", "Keep-Alive")
        .addHeader("user-agent", "Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1;SV1)")
        .fromSimpleParser(String.class)  //这里返回Observable 对象
        .as(RxLife.asOnMain(this))  //感知生命周期，并在主线程回调
        .subscribe(s -> {
            //成功回调
        }, throwable -> {
            //失败回调
        });

看一下日志

小结

怎么样，是不是最优雅的设置baseUrl？欢迎打脸。 其实，RxHttp远不止本篇文章说的这些优点，更多彩蛋，请查看源码

本文的目的并不在于说Retrofit不好，而是提供一种新的思路与方案，供开发者去选择。曾经有读者问我，有没有打算将RxHttp融入Retrofit，Retrofit的注解请求很好用，而且写在一个类里，很直观。我的回答是 NO ！RxHttp如果融入Retrofit，那RxHttp就是Retrofit，那还有什么区别呢？ 如果你喜欢将请求写在一个类里，RxHttp也是能实现的。如下：

public class Http {

    public static Observable> getStudents(int id, int page, int size) {
        return RxHttp.get("xxx/getStudent")
                .add("id", id).add("page", page).add("size", size)
                .fromListParser(Student.class);
        //后期会增加add(key,value,key,value....)可变参数方法
    }
    
    //其它请求同理
}

借此机会，如果你对RxHttp感兴趣，又有自己的想法，欢迎你加入维护的队伍中。

好了，转载请注明出处，