Android下如何优雅流畅地写代码

原创博客，如有转载，请注明出处，非常感谢。

首先说一下，灵感来自于RxAndroid，自从用上了这个库之后，整个思路都变了，原来异步还可以玩的这么溜，这还不是重点，重点是我学会了如何使写代码更加的流畅！

那么除了Rx的异步之外，我究竟学到了什么呢？对的，就是方法链（Method Chaining，或者叫Named method idiom）和方法参数尽可能少于等于1个，在链条的末端偶尔出现两三个参数还是可以接受的，这两个点让我从此代码风格完全变了，思路也完全变了！先举些例子：

当你设置全局配置的时候，可能会这样做，并且你一直认为，这样挺好，我也是一直这么认为的：

GlobalConfig.getInstance().setServerInfo("192.168.1.2", 65530, 5 * 60 * 1000, true);

这种风格对我来说，有两个问题，一直困扰我，但是我居然懒惰的没去想过解决这两个困扰我的问题，第一个问题是参数多，哪个对应哪个经常记不清楚，需要翻看方法的定义的位置看看，或者鼠标点在方法上，再按ctrl之类的一堆快捷键看看方法签名：

public void setServerInfo(String ip, int port, long heartBeatTime, boolean reconnectOnNetworkChange) {
        // code comes here
    }

哦，原来第一个参数是ip地址，第二个是端口，第三个是心跳包间隔，第四个是网络改变的时候是否重连，大家看到没？记忆力差那么一丁点的时候，必然在这样的方法调用时卡你一下，而我们的项目里面经常充满这种N个参数的方法，每天写代码就这样卡几次，谁来救救我？
第二个问题是总感觉有点问题，就像长城宽带看高清，总会卡你几帧，宽带你知道是网络问题，这个代码有什么问题还一时说不上来，长期习惯了也就觉得，卡一下是应该的，毕竟本人又不是清华北大的高才生，还不是计算机专业出身的，就像长城宽带看高清，你交的网费还不到电信的五分之一，偶尔卡一下也能接受。对于方法链，或者有人叫链式调用，我是一直知道的，并且也在用，各种Builder模式不就是经典的代表场景么？Hibernate不是这样的么？都习以为常了，要不是RxAndroid给我的震撼感觉，我绝对不会想到，上面的代码应该要重构优化的！！！现在我的调用变成了：

GlobalConfig
                .getInstance()
                .ip("192.168.1.2")
                .port(65530)
                .heartBeatTime(5 * 60 * 1000)
                .reconnectOnNetworkChange(true);

一下子就豁然开朗了，记忆力没有了负担，整个人都精神多了，腰也不酸腿也不疼，妈妈再也不用担心我没有名牌大学毕业了。怎么做到的呢？看重构后的代码(这里为了篇幅去掉了注释，不过方法名本身就已经非常好的注释自己了，可能这也是为什么方法链有人叫Named method idiom的原因吧)：

public GlobalConfig ip(String ip) {
        this.ip = ip;
        return this;
    }

    public GlobalConfig port(int port) {
        this.port = port;
        return this;
    }

    public GlobalConfig heartBeatTime(long time) {
        this.heartBeatTime = time;
        return this;
    }

    public GlobalConfig reconnectOnNetworkChange(boolean reconn) {
        this.reconnectOnNetworkChange = reconn;
        return this;
    }

换个思维，生活就是这么幸福。

以下场景更常见，创建一个POJO对象，为对应的字段一一赋值，没有哪个场景比这个更常见更习以为常了吧？像这样：

User user = new User();
user.setName(name);
user.setAge(age);
user.setGender(gender);
// ... 省略更多
UserDao.getInstance().save(user);

有没有想过可以这样呢？

UserDao.getInstance()
       .save(
           User.newInstance()
               .setName(name)
               .setAge(age)
               .setGender(gender)
               // 省略更多
        );

对应的，在User这个类里，setter的方法变了，变成如下:

  public User setName(String name) {
      this.name = name;
      return this;
  }
  // 其他方法类似，略去，自行脑补

这时候估计你会跳出来说，我setter方法都是自动生成的，你这不是坑我么？生成setter之后，我还需要手工去改所有的setter，WTF！
等等，我有说这些代码是我手工写的么？Android Studio生成getter/setter的时候本身就自带这种实现，你不看怪我咯，看，连AS都觉得有必要提供这样的setter生成方式了，不用是不是有点浪费了呢？过程如下：

去到你需要生成getter/setter的类，注意了，操作跟以前是一样的，按ALT + Insert键，弹出菜单选择getter/setter

选择字段，在setter template那个框选择Builder，然后OK，完成了，生成的代码就是上面那种了
以防说的不清楚，有图有真相：

setter.png

default.png

builder.png

对了，就是这样。

对于下面这种activity的跳转方法，大家都一致认为是比较不错的，至少，这是目前公认的做的比较合理的一种方式：

  // 这个方法是静态的，写在XXXActivity里，如果有多种跳转方式的，写多个类似的方法
   public static void startXXXActivity(Activity fromActivity, String articleId, String thumbImgUrl) {
      Intent in = new Intent(fromActivity, XXXActivity.class);
      in.putExtra("articleId", articleId);
      in.putExtra("thumbImgUrl", thumbImgUrl);
      fromActivity.startActivity(in);
  }

然后调用的时候就相对简单了：

  XXXActivity.startXXXActivity(this, "id123456", "http://www.example.com/example.png");

这里的问题跟第一个几乎是一模一样的，但是相对于第一种情况，这里复杂不止一点点，首先，这里有放进Intent的key要管理，如果很多activity用到的key都相同，该抽出来吗？好吧，key的问题不展开了。其次你没法getInstance()，XXXActivity还没创造出来呢，你怎么使用这个实例来创建方法链？即使你有办法做出方法链，那么多activity，你得写的多累啊，有了RxAndroid的启发，我现在是接受不了旧的启动方式了，怎么办？好的，我只好自己写了一个库，并且开源了，托管在github上：SmartKey，大家可以参考一下，如果觉得好请给个星星鼓励一下，如果大家有更好的实现，也请告诉我一声，让我开开眼界，提前谢谢大家。终于现在代码就成了：

SmartTargets.toXXXActivityATarget()
        .params(ParamsIBuilder
            .newBuilder()
            .articleId("id123456")
            .thumbImgUrl("http://www.example.com/example.png"))
        .go(this);

注意，这里SmartTargets类、ParamsIBuilder类都是自动生成的，你要做的就是在你的Application类告诉我，你的manifest文件在哪，然后把XXXActivity需要的所有参数，写一个叫做Params（名字随意，N个组件可以公用，只要是通过Bundle、Intent传递参数的都可以用）的非常简单的连getter/setter都省了的POJO用于描述参数，并且在XXXActivity里可以直接用这个Params类访问到传进来的参数，至于放进Intent的key，忘掉它吧，你放了参数进ParamsIBuilder，在目标Activity就能直接问ParamsIBuilder要回Params对象了，key的事情，还是不用管最好。关于这个库，我会再写两篇博客详细说一下，两篇文章题目都想好了，分别是：《原来Activity跳转还可以这么舒畅》和《如何优雅地管理SharedPreferences》，正在编写中。

好了，先写到这里，总结一下，从RxAndroid我学到的额外东西主要两个：

第一个是方法链，让你可以专心当前的流程，不再为每次从头写变量名等分心了，一直点到目的地，点到天荒地老，别看这么一点点变化，就像高手喜欢终端上做关键的事情一样，减少了例行性的参数名的编写就像使用终端减少了鼠标使用减少双手离开键盘一样，能极大的提高效率。

第二个是一个方法尽可能的接受更少量的参数，链条内尽可能保证少于等于一个参数，末端允许偶尔出现两个三个的参数，再多就要认真想想是不是哪里有问题了，这样可以让你的方法更语义化，方法内的职责也可以更加单一化了，这样可以极大减少记忆力的负担，不再需要以前那样经常翻看方法签名了，相当于家里的电缆换成了光纤，网络一下子流畅了，离准时下班又近一步了。

Android下如何优雅流畅地写代码

你可能感兴趣的:(Android下如何优雅流畅地写代码)