如何写好函数？从重构JavaScript代码着手

2023-10-31 09:45:23

前言

函数是任何编程语言中不可或缺的构建块。它们封装了特定的功能或行为，允许代码块在程序的不同部分重用。然而，编写良好、可维护的函数并非易事。本文将探讨重构JavaScript代码时编写良好函数的原则，重点关注避免代码复杂性、保持抽象层级清晰以及专注于单个功能。

避免代码复杂性

复杂性是函数设计的大敌。当一个函数负责多种任务或处理多种数据结构时，它就会变得难以理解和维护。为了避免复杂性，请遵循以下准则：

遵循单一职责原则： 每个函数只应负责一项特定任务或操作。
避免嵌套： 嵌套层次过多会使代码难以理解和调试。
使用简洁的语法： 尽量使用清晰简洁的语法，避免不必要的复杂性。

保持抽象层级清晰

抽象层级是指函数中使用的不同抽象级别。理想情况下，函数应仅使用与其当前抽象级别相关的概念。混合不同抽象级别会导致混乱和难以理解。例如，一个用于操作文件系统的高级函数不应该包含低级文件操作的实现细节。

专注于单个功能

一个函数只应专注于完成一项特定功能。当函数混合多种功能时，它就会变得难以重用和测试。例如，一个用于生成和发送电子邮件的函数不应包含用于验证用户输入或管理电子邮件模板的功能。

实践重构

以下是一些JavaScript代码重构示例，展示了如何应用上述原则：

// 复杂且难以理解的函数
function doEverything(data) {
  // 验证输入
  if (data.length === 0) {
    throw new Error("Empty data");
  }

  // 处理数据
  for (let i = 0; i < data.length; i++) {
    data[i] = data[i] * 2;
  }

  // 保存数据
  const result = JSON.stringify(data);
  return result;
}

// 重构后的函数
function validateInput(data) {
  if (data.length === 0) {
    throw new Error("Empty data");
  }
}

function processData(data) {
  for (let i = 0; i < data.length; i++) {
    data[i] = data[i] * 2;
  }
}

function saveData(data) {
  const result = JSON.stringify(data);
  return result;
}