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

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结构:

  test  test  test1  test1

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

立即学习“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. 事件委托:简化事件处理

我们将事件监听器附加到所有相关按钮的共同父元素上(例如一个

元素),而不是每个按钮。当点击事件发生时,通过 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 是包含所有输入框和按钮的父级 元素的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代码:

// change below arrays if you need this functionality for more fieldsconst 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结构,注意父级

元素现在有了 id=”myTable”:

test test
test1 test1

注意事项与最佳实践

可扩展性优化:当前的 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代码重构:优化重复逻辑与提升可维护性的详细内容,更多请关注创想鸟其它相关文章!

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容, 请发送邮件至 chuangxiangniao@163.com 举报,一经查实,本站将立刻删除。
发布者:程序猿,转转请注明出处:https://www.chuangxiangniao.com/p/1598848.html

(0)
打赏 微信扫一扫 微信扫一扫 支付宝扫一扫 支付宝扫一扫
上一篇 2025年12月23日 13:16:51
下一篇 2025年12月23日 13:17:06

相关推荐

  • SASS 中的 Mixins

    mixin 是 css 预处理器提供的工具,虽然它们不是可以被理解的函数,但它们的主要用途是重用代码。 不止一次,我们需要创建多个类来执行相同的操作,但更改单个值,例如字体大小的多个类。 .fs-10 { font-size: 10px;}.fs-20 { font-size: 20px;}.fs-…

    2025年12月24日
    000
  • 前端代码辅助工具:如何选择最可靠的AI工具?

    前端代码辅助工具:可靠性探讨 对于前端工程师来说,在HTML、CSS和JavaScript开发中借助AI工具是司空见惯的事情。然而,并非所有工具都能提供同等的可靠性。 个性化需求 关于哪个AI工具最可靠,这个问题没有一刀切的答案。每个人的使用习惯和项目需求各不相同。以下是一些影响选择的重要因素: 立…

    2025年12月24日
    000
  • React 开关按钮点击无响应怎么办?

    解决点击“开关”按钮无响应问题 在提供的 react 代码中,“开关”按钮点击事件不响应的原因可能是由于: 事件名拼写错误:请确保 onclick 属性拼写正确,并且事件处理函数名为 handleclick。元素遮盖:检查按钮是否被其他元素遮挡,例如另一个按钮或 div。控制台重写:如果您的代码中对…

    2025年12月24日
    000
  • 如何自定义 details 和 summary 元素的点击范围,仅对图标起作用?

    定制 details 和 summary 元素的点击范围 本文旨在解决如何自定义 details 和 summary 元素的点击范围,使其只对特定区域起作用。 问题描述 一位用户想要创建一个类似树形结构的表格,其中 details 和 summary 元素用于展开和关闭内容。但是,当前点击该行的任何…

    2025年12月24日
    000
  • 如何仅通过点击行最前面的图标展开或隐藏 和 标签中的内容?

    点击范围自定义:细节和概要 在 html 中,ails> 和 标签可以创建可折叠的内容。通常,单击行中的任何位置都可以展开或关闭内容。但是,为了实现更精细的控制,可以通过自定义点击范围来指定仅特定区域可以触发操作。 问题详情 一位开发者希望构建一个类似树形表的内容,但希望只能通过点击行最前面的…

    2025年12月24日
    000
  • 如何仅通过点击图标来控制“和“的折叠和展开?

    自定义details、summary控件的点击范围 目前,使用 和 标签创建树形结构时,整个行的点击都会触发折叠或展开操作。为了仅当点击最前面的图标时才触发此操作,可以进行以下调整: 在summary中添加额外的标签:在 标签中,添加一个额外的标签来包裹图标。 阻止的默认行为:使用css,为设置ev…

    2025年12月24日
    000
  • React 按钮点击事件不响应怎么办?

    react 按钮点击事件不响应 你的代码中遇到了一个问题,导致点击按钮时没有响应。这里有原因和解决方法: 1. 按钮不响应的原因 经过仔细检查,我们在你的代码中没有发现明显的错误。请检查以下可能的原因: 事件名称是否拼写正确(”onclick”)?元素是否被遮盖或禁用?con…

    2025年12月24日
    200
  • React 中“开关”按钮点击无响应,如何排查问题?

    点击“开关”按钮无响应,原因分析 在给出的 react 代码中,“开关”按钮未响应点击事件,可能原因如下: 事件名书写错误:确保 handleclick 方法的 onclick 事件名拼写正确。变量名错误:检查 handleclick 方法的 onclick 事件是否正确引用了 handleclic…

    2025年12月24日
    300
  • 为什么点击开关按钮没有响应?

    点击开关按钮无响应的问题分析 在提供的代码中,按钮点击事件绑定的处理函数 handleclick 的写法没有问题。因此,按钮不响应的原因可能是由于以下因素: 事件名书写错误:请检查 onclick={handleclick} 中的事件名是否拼写正确,应该是 onclick 而不是 onclick。元…

    2025年12月24日
    000
  • React 或 Vite 是否会自动加载 CSS?

    React 或 Vite 是否自动加载 CSS? 在 React 中,如果未显式导入 CSS,而页面却出现了 CSS 效果,这可能是以下原因造成的: 你使用的第三方组件库,例如 AntD,包含了自己的 CSS 样式。这些组件库在使用时会自动加载其 CSS 样式,无需显式导入。在你的代码示例中,cla…

    2025年12月24日
    000
  • 如何使用 SVG 实现动态时间轴的复杂效果?

    SVG 实现动态时间轴 这个问题涉及到实现一个复杂的动态时间轴,其中包含了渐变进度、可点击的小圆点、弹出卡片和高斯模糊效果。 SVG 解决方案 使用 SVG 可以很好地满足这个需求,因为它提供了精确绘制和控制线条、形状和文本的能力。 具体实现 示例代码使用了 SVG 来创建一条渐变的轨迹,代表时间轴…

    2025年12月24日
    000
  • uniapp/vue 中父元素 pointer-events: none 如何让子元素点击事件生效?

    在 uniapp/vue 中解决父元素 pointer-events: none 下子元素点击事件无效的问题 在使用 uniapp/vue 时,当父元素设置了 pointer-events: none 属性后,子元素的点击事件可能会失效。 问题分析 当父元素设置为 pointer-events: n…

    2025年12月24日
    200
  • UniApp/Vue 中如何让父元素 Pointer-Events: None 下的子元素点击生效?

    在 uniapp/vue 中让父元素 pointer-events: none 下的子元素点击生效 当我们设置父元素的 pointer-events 为 none 时,它将阻止鼠标或触摸事件传递给子元素。在这种情况下,底部的点击事件将无法生效。 要解决此问题,可以给需要点击事件的子元素添加 poin…

    2025年12月24日
    200
  • 如何在父元素 `pointer-events: none` 时让子元素点击事件生效?

    如何在父元素 pointer-events: none 下保持子元素点击事件生效? 在使用 uniapp/vue 框架时,遇到这样的问题:给父元素设置 pointer-events: none 后,子元素的点击事件失效了。 要解决这个问题,在需要点击事件的子元素上添加以下 css 样式即可: poi…

    2025年12月24日
    000
  • React 和 Vite 如何处理 CSS 加载?

    React 或 Vite 是否会自动加载 CSS? 在 React 中,默认情况下,使用 CSS 模块化时,不会自动加载 CSS 文件。需要手动导入或使用 CSS-in-JS 等技术才能应用样式。然而,如果使用了第三方组件库,例如 Ant Design,其中包含 CSS 样式,则这些样式可能会自动加…

    2025年12月24日
    000
  • ElementUI el-table 子节点选中后为什么没有打勾?

    elementui el-table子节点选中后没有打勾? 当您在elementui的el-table中选择子节点时,但没有出现打勾效果,可能是以下原因造成的: 在 element-ui 版本 2.15.7 中存在这个问题,升级到最新版本 2.15.13 即可解决。 除此之外,请确保您遵循了以下步骤…

    2025年12月24日
    200
  • 您不需要 CSS 预处理器

    原生 css 在最近几个月/几年里取得了长足的进步。在这篇文章中,我将回顾人们使用 sass、less 和 stylus 等 css 预处理器的主要原因,并向您展示如何使用原生 css 完成这些相同的事情。 分隔文件 分离文件是人们使用预处理器的主要原因之一。尽管您已经能够将另一个文件导入到 css…

    2025年12月24日
    000
  • CSS 中如何正确使用 box-shadow 设置透明度阴影?

    css 中覆盖默认 box-shadow 样式时的报错问题 在尝试修改导航栏阴影时遇到报错,分析发现是 box-shadow 样式引起的问题。 问题原因 使用 !important 仍无法覆盖默认样式的原因在于,你使用了 rgb() 而不是 rgba(),这会导致语法错误。 立即学习“前端免费学习笔…

    2025年12月24日
    300
  • CSS 如何实现鼠标悬停图片变亮,又不影响点击?

    css 如何实现鼠标悬停图片变亮,不影响点击 为了实现给图片增加鼠标悬停变亮效果,很多时候会用到在图片上方增加一个 before 伪类,在悬停时改变其背景颜色。但当图片需要被点击触发事件时,这个 before 伪类却会阻碍点击。 一种解决方法是利用 :hover 选择器,在鼠标经过时直接修改图片的 …

    2025年12月24日
    100
  • 为何scss中嵌套使用/*rtl:ignore*/无法被postcss-rtl插件识别?

    postcss-rtl插件为何不支持在scss中嵌套使用/*rtl:ignore*/ 在使用postcss-rtl插件时,如果希望对某个样式不进行转换,可以使用/*rtl:ignore*/在选择器前面进行声明。然而,当样式文件为scss格式时,该声明可能会失效,而写在css文件中则有效。 原因 po…

    2025年12月24日
    000

发表回复

登录后才能评论
关注微信