高级 JavaScript 代码整洁指南 - 重构篇

2023-12-04 15:14:52

JavaScript 代码整洁之道 - 重构篇

在软件开发中，重构是指对代码进行修改，以改善其结构，提高其可读性和可维护性，而不会改变其行为。重构是软件开发过程中不可或缺的一部分，它可以帮助我们保持代码的整洁和可维护性，避免代码随着时间的推移而变得难以理解和维护。

在本文中，我们将以凯撒密码为例，来介绍如何对代码进行重构。凯撒密码是一种简单的加密算法，它通过将每个字母向后移动一定数量的位置来对明文进行加密。

首先，我们来看一下未经重构的凯撒密码代码：

function caesarCipher(plaintext, shift) {
  let ciphertext = "";
  for (let i = 0; i < plaintext.length; i++) {
    let charCode = plaintext.charCodeAt(i);
    if (charCode >= 65 && charCode <= 90) {
      charCode += shift;
      if (charCode > 90) {
        charCode -= 26;
      }
    } else if (charCode >= 97 && charCode <= 122) {
      charCode += shift;
      if (charCode > 122) {
        charCode -= 26;
      }
    }
    ciphertext += String.fromCharCode(charCode);
  }
  return ciphertext;
}

这段代码的功能是将明文加密为凯撒密码密文。它首先将明文中的每个字符转换为字符编码，然后根据给定的偏移量对字符编码进行调整，最后将调整后的字符编码转换为字符，并将其添加到密文中。

这段代码存在一些问题：

代码的可读性和可维护性较差。代码中的逻辑比较分散，不易理解和维护。
代码中存在重复的代码。例如，对大写字母和对小写字母的处理逻辑是重复的。
代码中没有对输入进行校验。例如，如果给定的偏移量小于 0 或大于 25，那么代码将会产生错误。

为了解决这些问题，我们可以对代码进行重构。重构后的代码如下：

function caesarCipher(plaintext, shift) {
  // 对输入进行校验
  if (shift < 0 || shift > 25) {
    throw new Error("Shift must be between 0 and 25.");
  }

  // 创建一个字符映射表
  const charMap = {};
  for (let i = 65; i <= 90; i++) {
    charMap[String.fromCharCode(i)] = String.fromCharCode((i + shift - 65) % 26 + 65);
  }
  for (let i = 97; i <= 122; i++) {
    charMap[String.fromCharCode(i)] = String.fromCharCode((i + shift - 97) % 26 + 97);
  }

  // 将明文转换为密文
  let ciphertext = "";
  for (let i = 0; i < plaintext.length; i++) {
    const char = plaintext[i];
    ciphertext += charMap[char] || char;
  }

  return ciphertext;
}