什么样的代码需要重构

  • 代码后期可复用
  • 代码无副作用
  • 代码逻辑单一

image.png

image.png

渐进式重构

过早重构可能会因需求变化太快白白浪费许多时间；
过晚重构会因为代码逻辑复杂、相似代码积压过多导致变更风险太高，难以维护。
image.png

重构的技巧

1.使用 Array.includes 来处理多个条件

我们来看看下面的例子：

  1. // condition
  2. function test(fruit) {
  3.   if (fruit == 'apple' || fruit == 'strawberry') {
  4.     console.log('red');
  5.   }
  6. }

乍一看，上面的例子看起来似乎没什么问题。 但是，如果我们还有更多的红色水果呢？比如樱桃（cherry）和蔓越莓（cranberries）。 我们是否要用更多的 || 操作符来扩展该语句呢？

我们可以使用 Array.includes 重写上面的条件语句。

  1. function test(fruit) {
  2.   // 条件提取到数组中
  3.   const redFruits = ['apple', 'strawberry', 'cherry', 'cranberries'];
  5.   if (redFruits.includes(fruit)) {
  6.     console.log('red');
  7.   }
  8. }

我们将红色水果（条件）提取到一个数组中。这样做，可以让代码看起来更整洁。

2.减少嵌套，提前使用 return 语句

让我们扩展前面的示例，再包含另外两个条件：

  • 如果没有提供水果，抛出错误
  • 接受水果 quantity（数量）参数，如果超过 10，则并打印相关信息。

function test(fruit, quantity) { const redFruits = [‘apple’, ‘strawberry’, ‘cherry’, ‘cranberries’];

// 条件 1：fruit 必须有值 if (fruit) { // 条件 2：必须为红色 if (redFruits.includes(fruit)) { console.log(‘red’);

// 条件 3：数量必须大于 10 if (quantity > 10) { console.log(‘big quantity’); } } } else { throw new Error(‘No fruit!’); } }

// 测试结果 test(null); // 抛出错误：No fruits test(‘apple’); // 打印：red test(‘apple’, 20); // 打印：red，big quantity

看看上面的代码，我们有： – 1 个 if / else 语句过滤掉无效条件 – 3 层 if 语句嵌套（分别是条件1,2和3）

我个人遵循的一般规则是 在发现无效条件时提前 return。

  1. /* 在发现无效条件时提前 return */
  3. function test(fruit, quantity) {
  4.   const redFruits = ['apple', 'strawberry', 'cherry', 'cranberries'];
  6.   // 条件 1：提前抛出错误
  7.   if (!fruit) throw new Error('No fruit!');
  9.   // 条件2：必须为红色
  10.   if (redFruits.includes(fruit)) {
  11.     console.log('red');
  13.     // 条件 3：数量必须大于 10
  14.     if (quantity > 10) {
  15.       console.log('big quantity');
  16.     }
  17.   }
  18. }

这样做，我们可以减少一个嵌套层级。 这种编码风格很好，特别是当你的 if 语句很长时（想象一下，你需要滚动到最底部才知道那里有一个 else 语句，这样代码的可读性就变得很差了）。

如果通过反转条件并提前 return ，我们可以进一步减少嵌套。 请查看下面的条件 2 ，看看我们是如何做到的：

  1. /* 在发现无效条件时提前 return */
  3. function test(fruit, quantity) {
  4.   const redFruits = ['apple', 'strawberry', 'cherry', 'cranberries'];
  6.   if (!fruit) throw new Error('No fruit!'); // 条件 1：提前抛出错误
  7.   if (!redFruits.includes(fruit)) return;  // 条件 2：当 fruit 不是红色的时候，提前 return
  9.   console.log('red');
  11.   // 条件 3：必须是大量存在
  12.   if (quantity > 10) {
  13.     console.log('big quantity');
  14.   }
  15. }

通过反转条件2的条件，我们的代码现在没有嵌套语句了。 当我们有很长的逻辑代码时，这种技巧非常有用，我们希望在条件不满足时停止下一步的处理。

然而，这并不是严格的规定。问问自己，这个版本（没有嵌套）是否要比前一个版本（条件 2 有嵌套）的更好、可具可读性？

对我来说，我会选择前一个版本（条件 2 有嵌套）。 这是因为：

  • 代码简短直接，嵌套 if 更清晰
  • 反转条件可能会引发更多的思考过程（增加认知负担）

因此，始终追求更少的嵌套，提前 return，但是不要过度。但不要过度。如果您感兴趣，这里有一篇文章和 StackOverflow 的讨论， 进一步讨论这个话题：

3.使用函数的默认参数 和 解构

我想下面的代码可能看起来很熟悉，我们在使用 JavaScript 时总是需要检查 null / undefined 值并分配默认值：

  1. function test(fruit, quantity) {
  2.   if (!fruit) return;
  3.   const q = quantity || 1; // 如果没有提供 quantity 参数，则默认为 1
  5.   console.log(`We have ${q} ${fruit}!`);
  6. }
  8. // 测试结果
  9. test('banana'); // We have 1 banana!
  10. test('apple', 2); // We have 2 apple!

实际上，我们可以通过分配默认函数参数来消除变量 q 。

  1. function test(fruit, quantity = 1) { // i如果没有提供 quantity 参数，则默认为 1
  2.   if (!fruit) return;
  3.   console.log(`We have ${quantity} ${fruit}!`);
  4. }
  6. // 测试结果
  7. test('banana'); // We have 1 banana!
  8. test('apple', 2); // We have 2 apple!

更简单直观不是吗？ 请注意，每个函数参数都有自己的默认值。 例如，我们也可以为 fruit 分配一个默认值：function test(fruit = ‘unknown’, quantity = 1)。

愚人码头注：如果你还不了解 ES6 中函数默认参数的新特性，可以查看 JavaScript 函数中默认参数 了解更多详情。

如果我们的 fruit 是一个 Object 对象怎么办？ 我们可以指定默认参数吗？

  1. function test(fruit) { 
  2.   // 如果有值，则打印 fruit.name
  3.   if (fruit && fruit.name)  {
  4.     console.log (fruit.name);
  5.   } else {
  6.     console.log('unknown');
  7.   }
  8. }
  10. //测试结果
  11. test(undefined); // unknown
  12. test({ }); // unknown
  13. test({ name: 'apple', color: 'red' }); // apple

看看上面的例子，我们想要的是如果 fruit.name 可用则打印水果名称，否则将打印 unknown 。我们可以使用默认函数参数和解构(destructing) 来避免 fruit && fruit.name 这样的检查。

  1. // 解构 —— 只获得 name 属性
  2. // 参数默认分配空对象 {}
  3. function test({name} = {}) {
  4.   console.log (name || 'unknown');
  5. }
  7. //测试结果
  8. test(undefined); // unknown
  9. test({ }); // unknown
  10. test({ name: 'apple', color: 'red' }); // apple

由于我们只需要来自 fruit 的 name 属性，我们可以使用 {name} 来解构参数，然后我们可以在代码中使用 name 作为变量来取代fruit.name。

我们还将空对象 {} 指定为默认值。 如果我们不这样做，你将在执行行测试时遇到test(undefined) – Cannot destructure property name of ‘undefined’ or ‘null’.(无法解析’undefined’或’null’的属性名称)。 因为 undefined中 没有 name 属性。

如果您不介意使用第三方库，有几种方法可以减少空检查：

  • 使用 Lodash get 函数
  • 使用 Facebook 开源的 idx 库（需搭配 Babeljs）

愚人码头注：如果你还不了解 ES6 中 destructure(解构) 的新特性，可以查看 www.css88.com/archives/ta… 这些文章了解更多详情。

以下是使用Lodash的示例：

  1. // 引入 lodash 库，我们将获得 _.get()
  2. function test(fruit) {
  3.   console.log(_.get(fruit, 'name', 'unknown'); // 获取 name 属性，如果没有分配，则设为默认值 unknown
  4. }
  6. //测试结果
  7. test(undefined); // unknown
  8. test({ }); // unknown
  9. test({ name: 'apple', color: 'red' }); // apple

您可以在这里 运行演示代码 。此外，如果你喜欢函数式编程（FP），您可以选择使用Lodash fp ，Lodash的函数式能版本（方法名更改为 get 或 getOr）。

4.选择 Map / Object 字面量，而不是Switch语句

让我们看看下面的例子，我们想根据颜色打印水果：

  1. function test(color) {
  2.   // 使用 switch case 语句，根据颜色找出对应的水果
  3.   switch (color) {
  4.     case 'red':
  5.       return ['apple', 'strawberry'];
  6.     case 'yellow':
  7.       return ['banana', 'pineapple'];
  8.     case 'purple':
  9.       return ['grape', 'plum'];
  10.     default:
  11.       return [];
  12.   }
  13. }
  15. //测试结果
  16. test(null); // []
  17. test('yellow'); // ['banana', 'pineapple']

上面的代码似乎没有错，但我觉得它很冗长。使用具有更清晰语法的 object 字面量可以实现相同的结果：

  1. // 使用对象字面量，根据颜色找出对应的水果
  2.   const fruitColor = {
  3.     red: ['apple', 'strawberry'],
  4.     yellow: ['banana', 'pineapple'],
  5.     purple: ['grape', 'plum']
  6.   };
  8. function test(color) {
  9.   return fruitColor[color] || [];
  10. }

或者，您可以使用 Map 来实现相同的结果：

  1. // 使用 Map ，根据颜色找出对应的水果
  2.   const fruitColor = new Map()
  3.     .set('red', ['apple', 'strawberry'])
  4.     .set('yellow', ['banana', 'pineapple'])
  5.     .set('purple', ['grape', 'plum']);
  7. function test(color) {
  8.   return fruitColor.get(color) || [];
  9. }

Map 是 ES2015(ES6) 引入的新的对象类型，允许您存储键值对。

我们是不是应该禁止使用 switch 语句呢？ 不要局限于此。 就个人而言，我尽可能使用对象字面量，但我不会设置硬规则来阻止使用 switch ，是否使用应该根据你的场景而决定。

Todd Motto 有一篇文章深入地研究了 switch语句与对象字面量，你可以在 这里 阅读。

重构语法

对于上面的示例，我们实际上可以使用 Array.filter 来重构我们的代码，以实现相同的结果。

  1. const fruits = [
  2.     { name: 'apple', color: 'red' }, 
  3.     { name: 'strawberry', color: 'red' }, 
  4.     { name: 'banana', color: 'yellow' }, 
  5.     { name: 'pineapple', color: 'yellow' }, 
  6.     { name: 'grape', color: 'purple' }, 
  7.     { name: 'plum', color: 'purple' }
  8. ];
  10. function test(color) {
  11.   // 使用 Array filter  ，根据颜色找出对应的水果
  13.   return fruits.filter(f => f.color == color);
  14. }

总有不止一种方法可以达到相同的效果。对于这个例子我们展示了 4 种实现方法。编码很有趣！

5. 使用 Array.every 和 Array.some 来处理全部/部分满足条件

最后一个小技巧更多地是利用新的（但不是那么新的）Javascript Array函数来减少代码行。查看下面的代码，我们想检查所有水果是否都是红色的：

  1. const fruits = [
  2.     { name: 'apple', color: 'red' },
  3.     { name: 'banana', color: 'yellow' },
  4.     { name: 'grape', color: 'purple' }
  5.   ];
  7. function test() {
  8.   let isAllRed = true;
  10.   // 条件：所有的水果都必须是红色
  11.   for (let f of fruits) {
  12.     if (!isAllRed) break;
  13.     isAllRed = (f.color == 'red');
  14.   }
  16.   console.log(isAllRed); // false
  17. }

代码太长了！我们可以使用 Array.every 减少行数：

  1. const fruits = [
  2.     { name: 'apple', color: 'red' },
  3.     { name: 'banana', color: 'yellow' },
  4.     { name: 'grape', color: 'purple' }
  5.   ];
  7. function test() {
  8.   // 条件：简短方式，所有的水果都必须是红色
  9.   const isAllRed = fruits.every(f => f.color == 'red');
  11.   console.log(isAllRed); // false
  12. }

干净多了对吧？类似的，如果我们想要检查是否有至少一个水果是红色的，我们可以使用 Array.some 仅用一行代码就实现出来。

  1. const fruits = [
  2.     { name: 'apple', color: 'red' },
  3.     { name: 'banana', color: 'yellow' },
  4.     { name: 'grape', color: 'purple' }
  5. ];
  7. function test() {
  8.   // 条件：是否存在红色的水果
  9.   const isAnyRed = fruits.some(f => f.color == 'red');
  11.   console.log(isAnyRed); // true
  12. }