降低代码圈复杂度优化技巧

当一个项目经过持续迭代,不断增加功能,逐渐变成一个复杂的产品时,新功能的开发变得相对困难。其中一个很大的原因是代码复杂度高,导致可维护性和可读性都很差。本文将从前端JavaScript的角度出发,介绍一些有效的方法和技巧来优化前端代码的圈复杂度

什么是圈复杂度

圈复杂度的计算基于程序中的决策结构,如条件语句(if语句)、循环语句(for、while语句)、分支语句(switch语句)等。每当程序流程图中增加一个决策点,圈复杂度就会增加1。圈复杂度的值越高,表示代码的复杂性越大,代码的可读性、可测性和可维护性也会受到影响。

通常情况下,圈复杂度的推荐值应该在1到10之间。超过10的代码模块可能需要进行重构,以提高代码的可理解性和可测试性,并降低引入错误的风险。

辅助工具

VScode插件Code Metrics

VScode插件Code Metrics可以帮助我们快速发现那些需要优化复杂度的代码,安装好插件后如下图所示,在代码上方会出现对应的复杂度值,根据值的大小可以看出哪些代码是急需优化提升可读性。

鼠标点击所提示复杂度数值的地方可以看到具体是哪些代码影响了复杂度,可以进行针对性的优化。

eslint检查

可以使用 eslint 帮助检查代码的圈复杂度,当超出了某个值就会报错。

rules: {
  complexity: [
    'error',
    {
      max: 10
    }
  ]
}

如上面的配置就是超出了 10 就会出现报错信息。

圈复杂度的常用解决方法

函数拆分和重构,单一职责

较高的圈复杂度往往意味着函数或方法内部有过多的决策路径。通过将复杂的函数分解成多个小而清晰的函数,可以降低每个函数的圈复杂度,并使代码更易于理解和维护。拆分函数时,可根据功能模块或责任进行分类,确保每个函数只负责一项具体的任务。

优化前代码:

function handle(arr) {
    // 去重
    let _arr=[],_arrIds=[];
    for(let i=0;i<arr.length;i++){
        if(_arrIds.indexOf(arr[i].id)===-1){
            _arrIds.push(arr[i].id);
            _arr.push(arr[i]);
        }
    }
    // 替换
    _arr.map(item=>{
        for(let key in item){
            if(item[key]===''){
                item[key]='--';
            }
        }
    });
    // 排序
    _arr.sort((item1,item2)=>item1.id-item2.id);
    return _arr;
}

优化后代码:

function removeDuplicates(arr) {
  const uniqueArr = [];
  const uniqueIds = [];

  for(let i = 0; i < arr.length; i++) {
    if(uniqueIds.indexOf(arr[i].id) === -1) {
      uniqueIds.push(arr[i].id);
      uniqueArr.push(arr[i]);
    }
  }

  return uniqueArr;
}

function replaceEmptyValues(arr) {
  const processedArr = arr.map(item => {
    for(let key in item) {
      if(item[key] === '') {
        item[key] = '--';
      }
    }
    return item;
  });

  return processedArr;
}

function sortById(arr) {
  const sortedArr = arr.sort((item1, item2) => item1.id - item2.id);
  return sortedArr;
}

function handle(arr) {
  const uniqueArr = removeDuplicates(arr);
  const processedArr = replaceEmptyValues(uniqueArr);
  const sortedArr = sortById(processedArr);
  return sortedArr;
}

以上将原始函数拆分成了三个函数。removeDuplicates 函数用于去除数组中的重复元素,replaceEmptyValues 函数用于遍历替换空值,sortById 函数用于根据 id 进行排序。每个函数都只负责一个明确的职责。

卫语句可以减少分支

对输入条件进行多重判断时,使用卫语句可以减少分支语句的使用,提高代码的可读性和可维护性。

// 优化前
function calculateScore(score) {
  if (score < 0) {
    return "Invalid score";
  } else if (score < 50) {
    return "Fail";
  } else if (score < 70) {
    return "Pass";
  } else if (score < 90) {
    return "Good";
  } else {
    return "Excellent";
  }
}

// 优化后
function calculateScore(score) {
  if (score < 0) {
    return "Invalid score";
  }
  if (score < 50) {
    return "Fail";
  }
  if (score < 70) {
    return "Pass";
  }
  if (score < 90) {
    return "Good";
  }
  return "Excellent";
}

通过使用卫语句,我们将每个条件判断独立出来,避免了嵌套的分支语句。这种优化方式使得代码更加清晰,每个条件判断都独立成为一个逻辑块,并且消除了使用 else 的需要。这样做不仅提高了代码的可读性,还方便了后续对每个条件判断的修改和维护。

简化条件表达式

有相同逻辑代码进行条件合并输出,减少条件判断代码,提升可读性。

// 优化前
function a (num) {
    if (num === 0) {
        return 0;
    } else if (num === 1) {
        return 1;
    } else if (num === 2) {
        return 2;
    } else {
        return 3;
    }
}

// 优化后
function a (num) {
    if ([0, 1, 2].indexOf(num) > -1) {
        return num;
    } else {
        return 3;
    }
}
---
// 优化前
function a() {
  if (this.a == 0) return;
  if (!this.b) return;
  ...
}

// 优化后
function a() {
  if (this.a == 0 || !this.b) return;
  ...
}
---
// 优化前
function a (type) {
    if (type === 'a') {
        return 'String';
    } else if (type === 'b') {
        return 'Number';
    } else if (type === 'c') {
        return 'Object';
    }
}

// 优化后
function a (type) {
    let obj = {
        'a': 'String',
        'b': 'Number',
        'c': 'Object'
    };
    return obj[type];
}

表达式逻辑优化

逻辑计算也会增加圈复杂度,优化一些结构复杂的逻辑表达式,减少不必要的逻辑判断,也将一定程度上降低圈复杂度。

// 优化前
a && b || a && c

// 优化后
a && (b || c)

通过多态方式替代条件式。

通过多态方式替代条件式是一种优化技巧,多态允许我们根据不同的类型执行不同的操作,而不需要使用复杂的条件判断逻辑。

优化前的代码:

class Shape {
  constructor(type) {
    this.type = type;
  }

  calculateArea() {
    if (this.type === "circle") {
      // 计算圆形的面积
    } else if (this.type === "rectangle") {
      // 计算矩形的面积
    } else if (this.type === "triangle") {
      // 计算三角形的面积
    }
  }
}

优化后的代码:

class Shape {
  calculateArea() {
    throw new Error("calculateArea() method must be implemented");
  }
}

class Circle extends Shape {
  calculateArea() {
    // 计算圆形的面积
  }
}

class Rectangle extends Shape {
  calculateArea() {
    // 计算矩形的面积
  }
}

class Triangle extends Shape {
  calculateArea() {
    // 计算三角形的面积
  }
}

使用多态的方式,我们可以通过调用相应对象的calculateArea方法来执行特定形状的面积计算,而无需使用复杂的条件判断逻辑。

替换算法,优化复杂度

当发现某个算法的时间复杂度较高时,可以考虑替换为一个具有更优时间复杂度的算法,以提高代码的性能。

// 优化前
function findDuplicates(nums) {
  let duplicates = [];
  for (let i = 0; i < nums.length; i++) {
    for (let j = i + 1; j < nums.length; j++) {
      if (nums[i] === nums[j]) {
        duplicates.push(nums[i]);
      }
    }
  }
  return duplicates;
}

// 优化后
function findDuplicates(nums) {
  let freq = {};
  let duplicates = [];
  for (let num of nums) {
    if (freq[num]) {
      duplicates.push(num);
    } else {
      freq[num] = true;
    }
  }
  return duplicates;
}

需要注意的是,优化算法并不总是适用于所有情况。在选择替代算法时,应该综合考虑数据规模、特定问题的特性以及算法的复杂度等因素。

分解条件式,拆分函数

当遇到复杂的条件判断式或函数时,可以考虑将其分解为更小的部分,以提高代码的可读性和维护性。

优化前代码:

function calculateScore(player) {
  if (player.score >= 100 && player.level === "expert") {
    return player.score * 2;
  } else if (player.score >= 50 || player.level === "intermediate") {
    return player.score * 1.5;
  } else {
    return player.score;
  }
}

优化后代码:

function hasHighScore(player) {
  return player.score >= 100 && player.level === "expert";
}

function hasIntermediateScore(player) {
  return player.score >= 50 || player.level === "intermediate";
}

function calculateScore(player) {
  if (hasHighScore(player)) {
    return player.score * 2;
  } else if (hasIntermediateScore(player)) {
    return player.score * 1.5;
  } else {
    return player.score;
  }
}

将原始的复杂条件判断式拆分成了两个独立的函数:hasHighScorehasIntermediateScore。这样calculateScore函数中的条件判断变得更加清晰和可读。通过分解条件式和拆分函数,我们可以提高代码的可读性、可维护性和重用性。

减少return出现

当前大多数圈复杂度计算工具对return个数也进行计算,如果要针对这些工具衡量规则进行优化,减少return语句个数也为一种方式。

// 优化前
function a(){
    const value = getSomething();
    if(value) {
        return true;
    } else {
        return false;
    }
}

// 优化后
function a() {
    return getSomething();
}

移除控制标记,减少变量

移除控制标记可以使代码更加简洁、可读性更高,并且减少了不必要的变量使用。

优化前的代码:

function findFirstPositive(numbers) {
  let found = false;
  let firstPositive = null;

  for (let num of numbers) {
    if (num > 0) {
      found = true;
      firstPositive = num;
      break;
    }
  }

  if (found) {
    return firstPositive;
  } else {
    return -1;
  }
}

优化后的代码:

function findFirstPositive(numbers) {
  for (let num of numbers) {
    if (num > 0) {
      return num;
    }
  }

  return -1;
}

在优化后的代码中,我们直接在找到第一个正数后立即返回结果,而无需使用控制标记和额外的变量。如果遍历完整个数组后仍未找到正数,则返回-1。

最后

如果只是刻板的使用圈复杂度的算法去衡量一段代码的清晰度,这并不可取。在重构系统时,我们可以使用代码圈复杂度工具来统计代码的复杂度,并对复杂度较高的代码进行具体的场景分析。而不是说一定要将复杂度优化到某种程度,应该根据实际的业务情况做出优化决策。


看完本文如果觉得有用,记得点个赞支持,收藏起来说不定哪天就用上啦~

专注前端开发,分享前端相关技术干货,公众号:南城大前端(ID: nanchengfe)

头像

南城

城南花已开,愿君今安在

暂无评论

发表评论

您的电子邮件地址不会被公开,必填项已用*标注。

相关推荐

前端代码重复度检测

在前端开发中,代码的重复度是一个常见的问题。重复的代码不仅增加了代码的维护成本,还可能导致程序的低效运行。为了 …

放个烟花迎接龙年春节吧

不知不觉即将迎来2024龙年春节了。龙的形象在中国传统文化中有着广泛的应用,比如在传统文化中,龙代表着权力、威 …

20行JS代码实现屏幕录制

在开发中可能有遇到过屏幕录制的需求,无论是教学、演示还是游戏录制,都需要通过屏幕录制来记录和分享内容。一般在A …