美文网首页
KISS、YAGNI原则

KISS、YAGNI原则

作者: 凯玲之恋 | 来源:发表于2020-04-15 22:35 被阅读0次

    1、如何理解“KISS 原则”?

    KISS 原则的英文描述有好几个版本,比如下面这几个。

    • Keep It Simple and Stupid.
    • Keep It Short and Simple.
    • Keep It Simple and Straightforward.

    翻译成中文就是:尽量保持简单。

    代码的可读性和可维护性是衡量代码质量非常重要的两个标准。

    KISS 原则就是保持代码可读和可维护的重要手段。代码足够简单,也就意味着很容易读懂,bug 比较难隐藏。

    看着非常简单,但不能落地,这就有点像我们常说的“心灵鸡汤”。

    2、代码行数越少就越“简单”吗?

    检查输入的字符串 ipAddress 是否是合法的 IP 地址。

    
    // 第一种实现方式: 使用正则表达式
    public boolean isValidIpAddressV1(String ipAddress) {
      if (StringUtils.isBlank(ipAddress)) return false;
      String regex = "^(1\\d{2}|2[0-4]\\d|25[0-5]|[1-9]\\d|[1-9])\\."
              + "(1\\d{2}|2[0-4]\\d|25[0-5]|[1-9]\\d|\\d)\\."
              + "(1\\d{2}|2[0-4]\\d|25[0-5]|[1-9]\\d|\\d)\\."
              + "(1\\d{2}|2[0-4]\\d|25[0-5]|[1-9]\\d|\\d)$";
      return ipAddress.matches(regex);
    }
    
    // 第二种实现方式: 使用现成的工具类
    public boolean isValidIpAddressV2(String ipAddress) {
      if (StringUtils.isBlank(ipAddress)) return false;
      String[] ipUnits = StringUtils.split(ipAddress, '.');
      if (ipUnits.length != 4) {
        return false;
      }
      for (int i = 0; i < 4; ++i) {
        int ipUnitIntValue;
        try {
          ipUnitIntValue = Integer.parseInt(ipUnits[i]);
        } catch (NumberFormatException e) {
          return false;
        }
        if (ipUnitIntValue < 0 || ipUnitIntValue > 255) {
          return false;
        }
        if (i == 0 && ipUnitIntValue == 0) {
          return false;
        }
      }
      return true;
    }
    
    // 第三种实现方式: 不使用任何工具类
    public boolean isValidIpAddressV3(String ipAddress) {
      char[] ipChars = ipAddress.toCharArray();
      int length = ipChars.length;
      int ipUnitIntValue = -1;
      boolean isFirstUnit = true;
      int unitsCount = 0;
      for (int i = 0; i < length; ++i) {
        char c = ipChars[i];
        if (c == '.') {
          if (ipUnitIntValue < 0 || ipUnitIntValue > 255) return false;
          if (isFirstUnit && ipUnitIntValue == 0) return false;
          if (isFirstUnit) isFirstUnit = false;
          ipUnitIntValue = -1;
          unitsCount++;
          continue;
        }
        if (c < '0' || c > '9') {
          return false;
        }
        if (ipUnitIntValue == -1) ipUnitIntValue = 0;
        ipUnitIntValue = ipUnitIntValue * 10 + (c - '0');
      }
      if (ipUnitIntValue < 0 || ipUnitIntValue > 255) return false;
      if (unitsCount != 3) return false;
      return true;
    }
    

    第一种实现方式利用的是正则表达式,只用三行代码就把这个问题搞定了。它的代码行数最少,那是不是就最符合 KISS 原则呢?答案是否定的。虽然代码行数最少,看似最简单,实际上却很复杂。

    一方面,正则表达式本身是比较复杂的,写出完全没有 bug 的正则表达本身就比较有挑战;另一方面,并不是每个程序员都精通正则表达式。对于不怎么懂正则表达式的同事来说,看懂并且维护这段正则表达式是比较困难的。

    第二种实现方式使用了 StringUtils 类、Integer 类提供的一些现成的工具函数,来处理 IP 地址字符串。

    第三种实现方式,不使用任何工具函数,而是通过逐一处理 IP 地址中的字符,来判断是否合法。

    从代码行数上来说,这两种方式差不多。但是,第三种要比第二种更加有难度,更容易写出 bug。

    从可读性上来说,第二种实现方式的代码逻辑更清晰、更好理解。

    为什么说第三种实现方式性能会更高一些。一般来说,工具类的功能都比较通用和全面,所以,在代码实现上,需要考虑和处理更多的细节,执行效率就会有所影响。

    而第三种实现方式,完全是自己操作底层字符,只针对 IP 地址这一种格式的数据输入来做处理,没有太多多余的函数调用和其他不必要的处理逻辑,所以,在执行效率上,这种类似定制化的处理代码方式肯定比通用的工具类要高些。

    尽管第三种实现方式性能更高些,但我还是更倾向于选择第二种实现方法。那是因为第三种实现方式实际上是一种过度优化。

    3、代码逻辑复杂就违背 KISS 原则吗?

    并不是代码行数越少就越“简单”,还要考虑逻辑复杂度、实现难度、代码的可读性等。

    同样的代码,在某个业务场景下满足 KISS 原则,换一个应用场景可能就不满足了。

    4、如何写出满足 KISS 原则的代码?

    • 不要使用同事可能不懂的技术来实现代码。
    • 不要重复造轮子,要善于使用已经有的工具类库。经验证明,自己去实现这些类库,出 bug 的概率会更高,维护的成本也比较高。
    • 不要过度优化。不要过度使用一些奇技淫巧(比如,位运算代替算术运算、复杂的条件语句代替 if-else、使用一些过于底层的函数等)来优化代码,牺牲代码的可读性。

    代码是否足够简单是一个挺主观的评判。

    评判代码是否简单,还有一个很有效的间接方法,那就是 code review。如果在 code review 的时候,同事对你的代码有很多疑问,那就说明你的代码有可能不够“简单”,需要优化啦。

    越是能用简单的方法解决复杂的问题,越能体现一个人的能力。

    5、YAGNI 跟 KISS 说的是一回事吗?

    YAGNI 原则的英文全称是:You Ain’t Gonna Need It。
    直译就是:你不会需要它。
    意思是:不要去设计当前用不到的功能;不要去编写当前用不到的代码。

    这条原则的核心思想就是:不要做过度设计。

    参考

    20 | 理论六:我为何说KISS、YAGNI原则看似简单,却经常被用错?

    相关文章

      网友评论

          本文标题:KISS、YAGNI原则

          本文链接:https://www.haomeiwen.com/subject/lhkkvhtx.html