JavaScript代码重构：优化重复逻辑与提升可维护性-html教程-PHP中文网

JavaScript代码重构：优化重复逻辑与提升可维护性

本文旨在探讨如何通过数据驱动、事件委托和函数封装等策略，对前端 javascript代码中重复的ui交互逻辑进行重构。通过将元素配置数据化，并利用事件委托机制集中处理事件，结合一系列通用辅助函数，可以显著减少代码量，提高代码的可读性、可维护性和可扩展性，从而构建更健壮、更易于管理的前端应用。

在前端开发中，我们经常会遇到需要处理多个相似UI元素交互逻辑的场景。例如，页面上有多个输入框和对应的提交按钮，每个按钮点击后都需要根据输入框的值执行相似的校验和UI更新操作。如果为每个元素都编写独立的事件监听器和处理逻辑，代码将变得冗余、难以维护，并且在需求变更或元素增多时，修改成本会急剧上升。

问题分析：重复代码的挑战

考虑以下初始代码示例，它展示了为两个独立的输入框和按钮对编写的重复逻辑：

const an1 = document.getElementById("an1");
const bt1 = document.getElementById("bt1");

bt1.addEventListener("click", () => {
  if (an1.value.toLowerCase() === "test") {
    document.getElementById("bt1").style.display = "none";
    document.getElementById("an1").style.display = "none";
    document.getElementById("wo1").style.display = "initial";
  } else {
    bt1.innerText = "Wrong!";
    document.getElementById("bt1").style.background = "red";
  }
});

const an2 = document.getElementById("an2");
const bt2 = document.getElementById("bt2");

bt2.addEventListener("click", () => {
  if (an2.value.toLowerCase() === "test1") {
    document.getElementById("bt2").style.display = "none";
    document.getElementById("an2").style.display = "none";
    document.getElementById("wo2").style.display = "initial";
  } else {
    bt2.innerText = "Wrong!";
    document.getElementById("bt2").style.background = "red";
  }
});

登录后复制

以及对应的HTML结构：

<tr>
  <td class="c1"><input id="an1" placeholder="test" type="text" onblur="this.value=removeSpaces(this.value);" /><a id="wo1" style="display: none;">test</a><button id="bt1">Submit</button></td>
  <td class="c1">test</td>
</tr>
<tr>
  <td class="c2"><input id="an2" placeholder="test1" type="text" onblur="this.value=removeSpaces(this.value);" /><a id="wo2" style="display: none;">test1</a><button id="bt2">Submit</button></td>
  <td class="c2">test1</td>
</tr>

登录后复制

这段代码的问题显而易见：

立即学习“Java免费学习笔记（深入）”；

代码重复：bt1 和 bt2 的点击事件处理逻辑高度相似，仅在元素ID和预期值上有所不同。
可维护性差：如果需要修改校验逻辑或UI更新方式，必须在多处进行修改。
可扩展性差：当页面上出现更多的 anX/btX 组合时，需要复制粘贴大量代码，导致文件膨胀。

重构策略：数据驱动与事件委托

为了解决上述问题，我们可以采用以下核心重构策略：

数据结构化：将所有与UI元素及其行为相关的信息（如ID、预期值、显示状态等）存储在易于管理的数据结构中，例如数组或对象。
事件委托：利用事件冒泡机制，在父元素上设置一个事件监听器，而不是为每个子元素单独设置，从而集中管理事件。
函数封装：将通用的DOM操作和逻辑判断封装成独立的辅助函数，提高代码的复用性。

1. 数据结构化：配置化管理UI元素

首先，我们将每个输入框的预期答案和每个按钮点击后需要改变显示状态的元素及其目标状态，分别定义为数组对象。

const expectedElementAnswer = [
  { id: 'an1', expectAns: 'test' },
  { id: 'an2', expectAns: 'test1' }
];

const btnElementList = [
  [{ id: 'bt1', displayValue: 'none' }, { id: 'an1', displayValue: 'none' }, { id: 'wo1', displayValue: 'initial' }],
  [{ id: 'bt2', displayValue: 'none' }, { id: 'an2', displayValue: 'none' }, { id: 'wo2', displayValue: 'initial' }]
];

登录后复制

expectedElementAnswer 数组存储了每个输入框的ID及其对应的正确答案。
btnElementList 是一个二维数组，每个子数组对应一个按钮点击后需要操作的一组元素。每个对象包含元素的ID和其目标 display 样式值。这种配置化的方式使得添加或修改元素行为变得极其简单，只需更新这些数组即可。

2. 事件委托：简化事件处理

我们将事件监听器附加到所有相关按钮的共同父元素上（例如一个 <table> 元素），而不是每个按钮。当点击事件发生时，通过 event.target 判断是哪个按钮被点击，然后执行相应的逻辑。

document.getElementById('myTable').addEventListener('click', (event) => {
  const curElemetId = event.target.id;
  // 根据点击的按钮ID确定是哪一组逻辑
  const btnIndex = (curElemetId === 'bt1') ? 1 : (curElemetId === 'bt2') ? 2 : -1;

  if ((btnIndex === 1) || (btnIndex === 2)) {
    const idx = btnIndex - 1; // 转换为数组索引
    const { id, expectAns } = expectedElementAnswer[idx];

    if (getElementValue(id).toLowerCase() === expectAns) {
      changeDisplayStyles(idx);
    } else {
      setErrorWarning(curElemetId);
    }
  }
});

登录后复制

myTable 是包含所有输入框和按钮的父级 <table> 元素的ID。
event.target.id 获取实际被点击元素的ID。
通过判断 curElemetId，我们可以确定是 bt1 还是 bt2 被点击，从而获取对应的配置数据索引 idx。

3. 封装通用操作：提升代码复用性

为了进一步减少重复并提高可读性，我们将常用的DOM操作和数据获取逻辑封装成独立的函数：

function changeDisplayStyles(idx) {
  btnElementList[idx].forEach(({ id, displayValue }) => {
    setDisplayStyle(id, displayValue)
  });
}

function setDisplayStyle(displayId, value) {
  document.getElementById(displayId).style.display = value;
}

function setErrorWarning(displayId, bgColor = 'red') {
  const element = document.getElementById(displayId);
  element.innerText = 'Wrong!';
  element.style.background = bgColor;
}

function getElementValue(id) {
  const value = document.getElementById(id)?.value || '';
  return value;
}

登录后复制

changeDisplayStyles(idx)：根据索引 idx 从 btnElementList 中获取需要改变样式的元素列表，并遍历调用 setDisplayStyle。
setDisplayStyle(displayId, value)：一个通用的函数，用于设置指定ID元素的 display 样式。
setErrorWarning(displayId, bgColor)：用于显示错误提示，修改按钮文本和背景色。
getElementValue(id)：安全地获取指定ID输入框的值，处理了元素可能不存在的情况。

完整重构代码示例

结合上述策略，以下是完整的JavaScript和HTML代码：

Poixe AI

统一的 LLM API 服务平台，访问各种免费大模型

查看详情

// change below arrays if you need this functionality for more fields

const expectedElementAnswer = [{ id: 'an1', expectAns: 'test' }, { id: 'an2', expectAns: 'test1' }];
const btnElementList = [
        [{ id: 'bt1', displayValue: 'none' },{ id: 'an1', displayValue: 'none' }, { id: 'wo1', displayValue: 'initial' }],
        [{ id: 'bt2', displayValue: 'none' }, { id: 'an2', displayValue: 'none' }, { id: 'wo2', displayValue: 'initial' }]
];

document.getElementById('myTable').addEventListener('click', (event) => {
      const curElemetId = event.target.id;
      // 这里的逻辑可以进一步优化，例如使用数据驱动的查找，而非硬编码的if-else if
      const btnIndex = (curElemetId === 'bt1') ? 1 : (curElemetId === 'bt2') ? 2 : -1;

      if ((btnIndex === 1) || (btnIndex === 2)) {
        const idx = btnIndex - 1;
        const { id, expectAns } = expectedElementAnswer[idx];

        if (getElementValue(id).toLowerCase() === expectAns) {
          changeDisplayStyles(idx);
        } else {
          setErrorWarning(curElemetId);
        }
      }
});

function changeDisplayStyles(idx) {
      btnElementList[idx].forEach(({ id, displayValue }) => {
        setDisplayStyle(id, displayValue)
      });
}

function setDisplayStyle(displayId, value) {
      document.getElementById(displayId).style.display = value;
}

function setErrorWarning(displayId, bgColor = 'red') {
      const element = document.getElementById(displayId);
      element.innerText = 'Wrong!';
      element.style.background = bgColor;
}

function getElementValue(id) {
      const value = document.getElementById(id)?.value || '';
      return value;
}

登录后复制

对应的HTML结构，注意父级 <table> 元素现在有了 id="myTable"：

<table id="myTable">
<tr>
    <td class="c1">
        <input id="an1" placeholder="test" type="text"/>
        <a id="wo1" style="display: none;">test</a>
        <button id="bt1">Submit</button>
    </td>
    <td class="c1">test</td>
  </tr>

  <tr>
    <td class="c2">
        <input id="an2" placeholder="test1" type="text"/>
        <a id="wo2" style="display: none;">test1</a>
        <button id="bt2">Submit</button>
    </td>
    <td class="c2">test1</td>
  </tr>
</table>

登录后复制

注意事项与最佳实践

可扩展性优化：当前的 btnIndex 判断仍是硬编码的 if-else if 结构。为了更好的可扩展性，可以进一步优化为通过遍历 expectedElementAnswer 或 btnElementList 来动态查找 idx，例如：

const btnMap = new Map();
expectedElementAnswer.forEach((item, index) => {
  // 假设每个expectedElementAnswer的索引对应btnElementList的索引
  // 且btnElementList[index]的第一个元素是对应的按钮
  btnMap.set(btnElementList[index][0].id, index);
});

document.getElementById('myTable').addEventListener('click', (event) => {
  const curElementId = event.target.id;
  const idx = btnMap.get(curElementId); // 直接获取索引

  if (idx !== undefined) { // 确保是需要处理的按钮
    const { id, expectAns } = expectedElementAnswer[idx];
    // ... 后续逻辑不变
  }
});

登录后复制

这样，当添加新的输入/按钮对时，只需更新 expectedElementAnswer 和 btnElementList 数组，无需修改事件处理逻辑。

错误处理与用户反馈：当前的错误提示仅限于改变按钮文本和背景色。在实际应用中，可以考虑更友好的用户反馈方式，例如在输入框下方显示错误信息、使用动画效果等。
性能考量：事件委托对于包含大量可交互元素的列表或表格尤其有效，因为它减少了需要注册的事件监听器数量，从而降低了内存占用和提高页面性能。
代码可读性：清晰的变量命名（如 expectedElementAnswer, btnElementList）和函数命名（如 changeDisplayStyles, setErrorWarning）对于提升代码可读性至关重要。
解耦HTML与JavaScript：避免在HTML中直接使用 onblur 等行内事件处理器，将所有事件逻辑集中在JavaScript中处理，可以更好地分离结构与行为。

总结

通过本教程中介绍的重构方法，我们将原本重复且难以维护的代码转换为一个结构清晰、高度可配置和易于扩展的解决方案。核心思想是将数据与逻辑分离，利用数据结构来定义UI元素的行为，并通过事件委托和函数封装来集中管理和复用交互逻辑。这种模式不仅减少了代码量，还显著提升了应用的可维护性和可扩展性，为构建高质量的前端应用奠定了基础。

以上就是JavaScript代码重构：优化重复逻辑与提升可维护性的详细内容，更多请关注php中文网其它相关文章！