查看原文
其他

高效排除 JavaScript 问题的 10 个技巧

小懒 FED实验室 2024-02-12
关注下方公众号,获取更多系列文章

调试和故障排除是软件开发人员和工程师的重要技能。这些技能涉及识别和解决软件应用程序中的问题、漏洞和错误。有效的调试不仅能解决直接问题,还能提高代码质量并改进开发过程。在本文中,我们将探讨 JavaScript 有效调试和故障排除的 10 个宝贵技巧和方法,并提供实际的示例。

无论您是经验丰富的开发人员,还是刚刚开始 Coding 之旅,这些技巧都将帮助您像专家一样进行调试。通过实施这些技巧,您将获得解决 JavaScript 问题的信心和效率:

  • 理解问题
  • 分而治之
  • 利用浏览器开发工具
  • 使用调试技巧
  • 使用断言和单元测试
  • 查看错误信息和堆栈跟踪
  • 记录和分析数据
  • 参考文档和在线资源
  • 进行代码隔离实验
  • 寻求新的方向

1.理解问题

在深入研究代码之前,清楚地了解当前的问题至关重要。与相关方进行交流,收集关于问题的详细信息,并在可能的情况下重现问题。这一步骤为成功的故障排除奠定基础。

示例:

假设您正在开发一个 Web 应用程序,用户报告称单击按钮没有反应,不能正常提交记录。通过重现问题并分析用户的操作,您可以将问题缩小到特定的函数调用上。

const submitButton = document.getElementById('submit')
submitButton.addEventListener('click', () => {
  // Perform the desired action
});

2.分而治之

分治法将您的代码分解为较小的部分,并独立测试每个组件。这种方法有助于隔离有问题的区域,并缩小寻找错误的范围。使用console.log 语句或现代调试(debugger)工具检查中间结果,并确定问题出现在哪里。

示例:将代码分解成更小的部分,并独立测试每个组件。这种方法有助于隔离有问题的区域,缩小查找错误的范围。使用 console.log 语句或现代调试工具检查中间结果,找出问题所在。


示例:假设您有一个复杂的算法,用于对一个数组进行排序,但结果不正确。通过将排序逻辑拆分为较小的函数并记录中间步骤,您可以确定引入错误的算法部分。

function sortArray(array) {
  // Divide and conquer by splitting the sorting logic.
  const sortedLeft = mergeSort(array.slice(0, array.length / 2));
  const sortedRight = mergeSort(array.slice(array.length / 2));

  // Merge the sorted parts.
  return merge(sortedLeft, sortedRight);
}

function mergeSort(array) {
  // Perform the sorting algorithm.
  console.log(‘Sorting array:’, array);

  // …
}

function merge(left, right) {
  // Merge the sorted arrays.
  console.log('Merging:', left, right);

  // ...
}

3.利用浏览器开发工具

现代 Web 浏览器提供了功能强大的开发工具,这些工具包含了很多有价值的功能。这些工具包括 JavaScript 控制台、网络分析器、DOM检查器、性能分析器等等。利用这些工具可以检查变量、跟踪函数调用、分析网络请求和诊断性能瓶颈。

Chrome DevTools的更多调试技巧可以查看:多图预警!Chrome 118 DevTools 新功能介绍

示例:假设你遇到了一个 AJAX 请求不返回预期数据的问题。使用浏览器开发工具中的网络分析器,你可以检查请求和响应的细节、头部和载荷,以识别异常。

// Create a new XMLHttpRequest object. 
var xhr = new XMLHttpRequest(); 

// Open a GET request to the API endpoint. 
xhr.open('GET''https://api.example.com/data'false);

// Send the request. 
xhr.send(); 

// Check the response status. 
if (xhr.status === 200) { 
  console.log('Received data:', xhr.responseText); 
  // Process the received data. 
else { 
  console.error('Error fetching data:', xhr.status); 
}

4.使用调试技巧

JavaScript 提供了几种调试技巧来帮助你。在代码中设置断点,可以在特定的位置暂停执行并检查变量的值。逐行调试代码,以了解代码的流程并找出错误发生的地方。现代集成开发环境(IDE)通常具有内置的调试功能,简化了这个过程。

此外,你可以在代码中使用 debugger 语句(小懒在开发中经常使用哦😯)。执行这个语句时,会触发浏览器的调试工具,允许你检查变量、逐行调试代码并定位问题。

下面的代码显示了如何添加一个 debugger 语句来在调用函数时调试。

function troubleshootCode() {
  ...
  ...
  // 进行潜在错误的调试、逐行调试等操作。
  debugger;
  ...
  ...
}

示例:假设你在一个循环中遇到了意外的行为。通过在循环内设置一个断点,你可以检查迭代变量并分析循环的行为,帮助你找出问题的原因。

for (let i = 0; i < array.length; i++) {
  // 在下面的行上设置断点以检查迭代变量。
  console.log('迭代:', i, '值:', array[i]);

  // 其他代码。
}

通过在 console.log 语句上设置断点,可以暂停循环的执行并检查当前迭代的索引(i)和相应的值 array[i]。这样可以分析循环的行为并识别出意外的值或逻辑。

调试的另一个有用工具是 console.trace() 方法。它将堆栈跟踪输出到控制台,显示导致当前代码点的函数调用序列。

堆栈跟踪错误示例:假设你有以下代码片段遇到了错误。

function divide(a, b) {
  if (b === 0) {
    throw new Error('除以零错误');
  }
  return a / b;
}

function calculateRatio(x, y) {
  const ratio = divide(x, y);
  return ratio;
}

function performCalculation() {
  try {
    const result = calculateRatio(100);
    console.log('结果:', result);
  } catch (error) {
    console.error('发生错误:', error.message);
    console.trace();
  }
}

performCalculation();

在这个示例中,当调用 calculateRatio(10, 0) 时,遇到了除以零的错误,抛出一个带有消息“除以零错误”的错误对象。然后使用 console.trace() 方法将堆栈跟踪输出到控制台。

当你运行这段代码时,你会在控制台中看到以下堆栈跟踪。

An error occurred: Division by zero
    at divide (script.js:3:11)
    at calculateRatio (script.js:8:19)
    at performCalculation (script.js:14:17)
    at script.js:18:1

堆栈跟踪显示错误发生在 divide() 函数的第3行,该函数被calculateRatio()函数于第8行调用,而 calculateRatio() 函数又被 performCalculation() 函数于第14行调用。最终,在第18行触发了该错误。

通过检查堆栈跟踪,您可以追踪函数调用的流程并确定错误源自哪些具体行。

5.使用断言和单元测试

添加断言并编写单元测试可以帮助检测错误并监视代码的正确性。断言在特定点验证某些条件是否成立,帮助您及早捕获问题。单元测试确保您的函数和组件对不同输入产生预期的输出。

示例:假设在一个计算数组的求和函数中遇到了一个bug。编写一个单元测试来验证不同输入数组的预期结果,可以快速确定bug是否出现在计算逻辑中。

function sumArray(array) {
  let sum = 0;
  for (let i = 0; i < array.length; i++) {
    sum += array[i];
  }
  return sum;
}

// 断言检查[1, 2, 3]的和是否为6
console.assert(sumArray([123]) === 6'求和结果不正确');

// 更多测试用例...

好消息: 现在Node.js 已经原生支持测试运行器,可以不用依赖 Mocha、Jest 等单元测试框架来书写测试用例了,详细参考:Node.js 测试运行器 Test Runner 初探

使用断言和编写全面的单元测试,您可以快速捕获潜在的问题并确保您的函数产生预期的结果。这种方法有助于在代码演进的同时保持代码的正确性。

6.查看错误消息和堆栈跟踪


当遇到 “undefined is not a function” 错误时,堆栈跟踪会显示函数调用的顺序。通过检查这些函数中相关的行号和变量,可以确定问题的源头。

示例:

function calculateTotal(price, quantity) {
  return price * quantity;
}

function displayTotal() {
  const price = getProductPrice(); // 假设这个函数导致了错误。
  const quantity = getQuantity();

  const total = calculateTotal(price, quantity);
  console.log('总数:', total);
}

displayTotal();

在这个示例中,如果 getProductPrice() 函数是undefined,错误消息和堆栈跟踪将帮助你识别问题的源头。

7.记录和分析数据

在处理复杂的数据转换时,记录中间数据结构可以揭示不一致性或意外更改,从而更接近问题的根本原因。

示例:

function processData(data) {
  console.log('输入数据:', data);

  // 执行数据转换。
  console.log('转换后的数据:', transformedData);

  // 执行更多操作。
  console.log('最终的结果数据:', finalResultantData);
}

const data = fetchData(); // 假设这个函数获取数据。
processData(data);

可以通过分析记录的值来了解数据的转换方式,以及通过记录输入、转换后和最终结果数据来识别问题是否产生了变化。

8.查阅文档和在线资源

在进行故障排除时,可以查阅文档、论坛和在线资源以获取洞察和解决方案。像 Stack Overflow、MDN Web Docs、官方文档等,可以为常见的JavaScript问题提供有价值的信息。

例如,假设你遇到了与特定 JavaScript 方法有关的错误。在这种情况下,查阅官方文档可以提供解释、使用示例和可能的解决方案。

9.使用代码隔离进行实验

创建一个最小化、隔离的代码版本来重现问题有助于简化故障排除过程并理解根本原因。

例如,如果在一个 React 组件中遇到了一个bug,可以创建一个独立的沙箱项目或CodePen,只包含必要的代码。这种隔离可以帮助确定问题是来自组件还是更复杂的应用中的其他因素。

10.寻求新的方向

当你已经尽尽全力进行故障排除时,寻求新的方向可能是有价值的。与其他开发人员交流,参加代码审查会议,或者与团队合作以获得洞见和潜在解决方案。

例如,向同事展示你的代码,或者加入一个开发者社区,你可以讨论问题并寻求建议。其他开发人员可能会提供不同的视角或方法,帮助你发现问题。

最后

掌握良好的开发调试技巧可以显著提升软件开发人员故障排查、日常研发的效率。通过以上这些技巧和建议,你可以不断优化故障排除方法,增强代码检测和错误修复能力,让自己快速成为一个技术娴熟的 JavaScript 开发人员。

大家都在看

继续滑动看下一个

高效排除 JavaScript 问题的 10 个技巧

小懒 FED实验室
向上滑动看下一个

您可能也对以下帖子感兴趣

文章有问题?点此查看未经处理的缓存