网站建设水平,dede 网站改宽屏代码,wordpress怎么对接公众号,360网站弹窗推广怎么做的上几节课中#xff0c;我们学习了经典的 SOLID 原则。今天#xff0c;我们讲两个设计原则#xff1a;KISS 原则和 YAGNI 原则。其中#xff0c;KISS 原则比较经典#xff0c;耳熟能详#xff0c;但 YAGNI 你可能没怎么听过#xff0c;不过它理解起来也不难。
理解这两个…上几节课中我们学习了经典的 SOLID 原则。今天我们讲两个设计原则KISS 原则和 YAGNI 原则。其中KISS 原则比较经典耳熟能详但 YAGNI 你可能没怎么听过不过它理解起来也不难。
理解这两个原则时候经常会有一个共同的问题那就是看一眼就感觉懂了但深究的话又有很多细节问题不是很清楚。比如怎么理解 KISS 原则中“简单”两个字什么样的代码才算“简单”怎样的代码才算“复杂”如何才能写出“简单”的代码YAGNI 原则跟 KISS 原则说的是一回事吗
如果你还不能非常清晰地回答出上面这几个问题那恭喜你又得到了一次进步提高的机会。等你听完这节课我相信你很自然就能回答上来了。话不多说让我们带着这些问题正式开始今天的学习吧
如何理解“KISS 原则”
KISS 原则的英文描述有好几个版本比如下面这几个。
Keep It Simple and Stupid.Keep It Short and Simple.Keep It Simple and Straightforward.
不过仔细看你就会发现它们要表达的意思其实差不多翻译成中文就是尽量保持简单。
KISS 原则算是一个万金油类型的设计原则可以应用在很多场景中。它不仅经常用来指导软件开发还经常用来指导更加广泛的系统设计、产品设计等比如冰箱、建筑、iPhone 手机的设计等等。不过咱们的专栏是讲代码设计的所以接下来我还是重点讲解如何在编码开发中应用这条原则。
我们知道代码的可读性和可维护性是衡量代码质量非常重要的两个标准。而 KISS 原则就是保持代码可读和可维护的重要手段。代码足够简单也就意味着很容易读懂bug 比较难隐藏。即便出现 bug修复起来也比较简单。
不过这条原则只是告诉我们要保持代码“Simple and Stupid”但并没有讲到什么样的代码才是“Simple and Stupid”的更没有给出特别明确的方法论来指导如何开发出“Simple and Stupid”的代码。所以看着非常简单但不能落地这就有点像我们常说的“心灵鸡汤”。哦咱们这里应该叫“技术鸡汤”。
所以接下来为了能让这条原则切实地落地能够指导实际的项目开发我就针对刚刚的这些问题来进一步讲讲我的理解。
代码行数越少就越“简单”吗
我们先一起看一个例子。下面这三段代码可以实现同样一个功能检查输入的字符串 ipAddress 是否是合法的 IP 地址。
一个合法的 IP 地址由四个数字组成并且通过“.”来进行分割。每组数字的取值范围是 0~255。第一组数字比较特殊不允许为 0。对比这三段代码你觉得哪一段代码最符合 KISS 原则呢如果让你来实现这个功能你会选择用哪种实现方法呢你可以先自己思考一下然后再看我下面的讲解。
// 第一种实现方式: 使用正则表达式
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 的正则表达本身就比较有挑战另一方面并不是每个程序员都精通正则表达式。对于不怎么懂正则表达式的同事来说看懂并且维护这段正则表达式是比较困难的。这种实现方式会导致代码的可读性和可维护性变差所以从 KISS 原则的设计初衷上来讲这种实现方式并不符合 KISS 原则。
讲完了第一种实现方式我们再来看下其他两种实现方式。
第二种实现方式使用了 StringUtils 类、Integer 类提供的一些现成的工具函数来处理 IP 地址字符串。第三种实现方式不使用任何工具函数而是通过逐一处理 IP 地址中的字符来判断是否合法。从代码行数上来说这两种方式差不多。但是第三种要比第二种更加有难度更容易写出 bug。从可读性上来说第二种实现方式的代码逻辑更清晰、更好理解。所以在这两种实现方式中第二种实现方式更加“简单”更加符合 KISS 原则。
不过你可能会说第三种实现方式虽然实现起来稍微有点复杂但性能要比第二种实现方式高一些啊。从性能的角度来说选择第三种实现方式是不是更好些呢
在回答这个问题之前我先解释一下为什么说第三种实现方式性能会更高一些。一般来说工具类的功能都比较通用和全面所以在代码实现上需要考虑和处理更多的细节执行效率就会有所影响。而第三种实现方式完全是自己操作底层字符只针对 IP 地址这一种格式的数据输入来做处理没有太多多余的函数调用和其他不必要的处理逻辑所以在执行效率上这种类似定制化的处理代码方式肯定比通用的工具类要高些。
不过尽管第三种实现方式性能更高些但我还是更倾向于选择第二种实现方法。那是因为第三种实现方式实际上是一种过度优化。除非 isValidIpAddress() 函数是影响系统性能的瓶颈代码否则这样优化的投入产出比并不高增加了代码实现的难度、牺牲了代码的可读性性能上的提升却并不明显。
代码逻辑复杂就违背 KISS 原则吗
刚刚我们提到并不是代码行数越少就越“简单”还要考虑逻辑复杂度、实现难度、代码的可读性等。那如果一段代码的逻辑复杂、实现难度大、可读性也不太好是不是就一定违背 KISS 原则呢在回答这个问题之前我们先来看下面这段代码
// KMP algorithm: a, b 分别是主串和模式串n, m 分别是主串和模式串的长度。
public static int kmp(char[] a, int n, char[] b, int m) {int[] next getNexts(b, m);int j 0;for (int i 0; i n; i) {while (j 0 a[i] ! b[j]) { // 一直找到 a[i] 和 b[j]j next[j - 1] 1;}if (a[i] b[j]) {j;}if (j m) { // 找到匹配模式串的了return i - m 1;}}return -1;
}
// b 表示模式串m 表示模式串的长度
private static int[] getNexts(char[] b, int m) {int[] next new int[m];next[0] -1;int k -1;for (int i 1; i m; i) {while (k ! -1 b[k 1] ! b[i]) {k next[k];}if (b[k 1] b[i]) {k;}next[i] k;}return next;
}这段代码来自我的另一个专栏《数据结构与算法之美》中KMP 字符串匹配算法的代码实现。这段代码完全符合我们刚提到的逻辑复杂、实现难度大、可读性差的特点但它并不违反 KISS 原则。为什么这么说呢
KMP 算法以快速高效著称。当我们需要处理长文本字符串匹配问题几百 MB 大小文本内容的匹配或者字符串匹配是某个产品的核心功能比如 Vim、Word 等文本编辑器又或者字符串匹配算法是系统性能瓶颈的时候我们就应该选择尽可能高效的 KMP 算法。而 KMP 算法本身具有逻辑复杂、实现难度大、可读性差的特点。本身就复杂的问题用复杂的方法解决并不违背 KISS 原则。
不过平时的项目开发中涉及的字符串匹配问题大部分都是针对比较小的文本。在这种情况下直接调用编程语言提供的现成的字符串匹配函数就足够了。如果非得用 KMP 算法、BM 算法来实现字符串匹配那就真的违背 KISS 原则了。也就是说同样的代码在某个业务场景下满足 KISS 原则换一个应用场景可能就不满足了。
如何写出满足 KISS 原则的代码
实际上我们前面已经讲到了一些方法。这里我稍微总结一下。
不要使用同事可能不懂的技术来实现代码。比如前面例子中的正则表达式还有一些编程语言中过于高级的语法等。不要重复造轮子要善于使用已经有的工具类库。经验证明自己去实现这些类库出 bug 的概率会更高维护的成本也比较高。不要过度优化。不要过度使用一些奇技淫巧比如位运算代替算术运算、复杂的条件语句代替 if-else、使用一些过于底层的函数等来优化代码牺牲代码的可读性。
实际上代码是否足够简单是一个挺主观的评判。同样的代码有的人觉得简单有的人觉得不够简单。而往往自己编写的代码自己都会觉得够简单。所以评判代码是否简单还有一个很有效的间接方法那就是 code review。如果在 code review 的时候同事对你的代码有很多疑问那就说明你的代码有可能不够“简单”需要优化啦。
这里我还想多说两句我们在做开发的时候一定不要过度设计不要觉得简单的东西就没有技术含量。实际上越是能用简单的方法解决复杂的问题越能体现一个人的能力。
YAGNI 跟 KISS 说的是一回事吗
YAGNI 原则的英文全称是You Ain’t Gonna Need It。直译就是你不会需要它。这条原则也算是万金油了。当用在软件开发中的时候它的意思是不要去设计当前用不到的功能不要去编写当前用不到的代码。实际上这条原则的核心思想就是不要做过度设计。
比如我们的系统暂时只用 Redis 存储配置信息以后可能会用到 ZooKeeper。根据 YAGNI 原则在未用到 ZooKeeper 之前我们没必要提前编写这部分代码。当然这并不是说我们就不需要考虑代码的扩展性。我们还是要预留好扩展点等到需要的时候再去实现 ZooKeeper 存储配置信息这部分代码。
再比如我们不要在项目中提前引入不需要依赖的开发包。对于 Java 程序员来说我们经常使用 Maven 或者 Gradle 来管理依赖的类库library。我发现有些同事为了避免开发中 library 包缺失而频繁地修改 Maven 或者 Gradle 配置文件提前往项目里引入大量常用的 library 包。实际上这样的做法也是违背 YAGNI 原则的。
从刚刚的分析我们可以看出YAGNI 原则跟 KISS 原则并非一回事儿。KISS 原则讲的是“如何做”的问题尽量保持简单而 YAGNI 原则说的是“要不要做”的问题当前不需要的就不要做。
重点回顾
好了今天的内容到此就讲完了。我们现在来总结回顾一下你需要掌握的重点内容。
KISS 原则是保持代码可读和可维护的重要手段。KISS 原则中的“简单”并不是以代码行数来考量的。代码行数越少并不代表代码越简单我们还要考虑逻辑复杂度、实现难度、代码的可读性等。而且本身就复杂的问题用复杂的方法解决并不违背 KISS 原则。除此之外同样的代码在某个业务场景下满足 KISS 原则换一个应用场景可能就不满足了。
对于如何写出满足 KISS 原则的代码我还总结了下面几条指导原则
不要使用同事可能不懂的技术来实现代码不要重复造轮子要善于使用已经有的工具类库不要过度优化。
课堂讨论
你怎么看待在开发中重复造轮子这件事情什么时候要重复造轮子什么时候应该使用现成的工具类库、开源框架
欢迎在留言区写下你的答案和同学一起交流和分享。如果有收获也欢迎你把这篇文章分享给你的朋友。
