前端模块化开发:从面条代码到结构化代码的蜕变

前端模块化开发:从面条代码到结构化代码的蜕变

毒舌时刻

模块化开发?不就是把代码分成几个文件嘛,有什么大不了的?我见过很多所谓的模块化代码,其实就是把一堆函数随便塞进不同的文件里,根本没有任何结构可言。

你以为把代码分成模块就万事大吉了?别天真了!如果你的模块设计不合理,反而会让代码变得更加混乱。比如那些互相依赖的模块,就像一团乱麻,让你根本理不清头绪。

为什么你需要这个

  1. 代码可维护性:模块化代码结构清晰,易于理解和维护,当需要修改某个功能时,只需要修改对应的模块即可。
  2. 代码复用:模块化可以让你在不同的项目中复用相同的代码,减少重复开发的工作量。
  3. 团队协作:模块化可以让不同的开发者负责不同的模块,减少代码冲突和沟通成本。
  4. 性能优化:模块化可以帮助你实现代码分割,减少初始加载时间,提高应用的性能。

反面教材

// 这是一个典型的面条代码 let users = []; let products = []; function fetchUsers() { fetch('https://api.example.com/users') .then(response => response.json()) .then(data => { users = data; renderUsers(); }); } function fetchProducts() { fetch('https://api.example.com/products') .then(response => response.json()) .then(data => { products = data; renderProducts(); }); } function renderUsers() { const userList = document.getElementById('user-list'); userList.innerHTML = ''; users.forEach(user => {matter what he wrote const li = document.createElement('li'); li.textContent = user.name; userList.appendChild(li); }); } function renderProducts() { const productList = document.getElementById('product-list'); productList.innerHTML = ''; products.forEach(product => { const li = document.createElement('li'); li.textContent = product.name; productList.appendChild(li); }); } // 调用函数 fetchUsers(); fetchProducts(); 

问题

  • 所有代码都在一个文件中,随着功能增加,代码量会变得非常庞大
  • 变量和函数都是全局的,容易产生命名冲突
  • 代码逻辑混乱,难以理解和维护
  • 无法实现代码复用

正确的做法

ES6模块

// api.js - 负责API调用 const API_BASE_URL = 'https://api.example.com'; export async function fetchUsers() { const response = await fetch(`${API_BASE_URL}/users`); return response.json(); } export async function fetchProducts() { const response = await fetch(`${API_BASE_URL}/products`); return response.json(); } 
// render.js - 负责渲染 import { fetchUsers, fetchProducts } from './api.js'; export function renderUsers(users) { const userList = document.getElementById('user-list'); userList.innerHTML = ''; users.forEach(user => { const li = document.createElement('li'); li.textContent = user.name; userList.appendChild(li); }); } export function renderProducts(products) { const productList = document.getElementById('product-list'); productList.innerHTML = ''; products.forEach(product => { const li = document.createElement('li'); li.textContent = product.name; productList.appendChild(li); }); } 
// app.js - 主应用 import { fetchUsers, fetchProducts } from './api.js'; import { renderUsers, renderProducts } from './render.js'; async function init() { try { const [users, products] = await Promise.all([ fetchUsers(), fetchProducts() ]); renderUsers(users); renderProducts(products); } catch (error) { console.error('Error initializing app:', error); } } init(); 

CommonJS模块

// api.js - 负责API调用 const API_BASE_URL = 'https://api.example.com'; async function fetchUsers() { const response = await fetch(`${API_BASE_URL}/users`); return response.json(); } async function fetchProducts() { const response = await fetch(`${API_BASE_URL}/products`); return response.json(); } module.exports = { fetchUsers, fetchProducts }; 
// render.js - 负责渲染 function renderUsers(users) { const userList = document.getElementById('user-list'); userList.innerHTML = ''; users.forEach(user => { const li = document.createElement('li'); li.textContent = user.name; userList.appendChild(li); }); } function renderProducts(products) { const productList = document.getElementById('product-list'); productList.innerHTML = ''; products.forEach(product => { const li = document.createElement('li'); li.textContent = product.name; productList.appendChild(li); }); } module.exports = { renderUsers, renderProducts }; 
// app.js - 主应用 const { fetchUsers, fetchProducts } = require('./api.js'); const { renderUsers, renderProducts } = require('./render.js'); async function init() { try { const [users, products] = await Promise.all([ fetchUsers(), fetchProducts() ]); renderUsers(users); renderProducts(products); } catch (error) { console.error('Error initializing app:', error); } } init(); 

模块化的最佳实践

  1. 单一职责原则:每个模块只负责一个功能,避免模块过大或职责过多。
  2. 依赖管理:合理管理模块间的依赖关系,避免循环依赖。
  3. 命名规范:使用清晰的命名规范,让模块的用途一目了然。
  4. 文档:为模块添加适当的文档,说明模块的用途、参数和返回值。
  5. 测试:为每个模块编写测试,确保模块的功能正确。

毒舌点评

模块化开发确实是前端开发的重要实践,但我见过太多开发者滥用模块化,把简单的功能拆分成无数个小模块,结果导致代码结构变得更加复杂。

想象一下,当你需要修改一个简单的功能时,你需要在多个文件之间来回跳转,这真的提高了开发效率吗?

还有那些过度设计的模块,为了所谓的模块化而模块化,结果导致代码变得更加难以理解。比如一个只有几行代码的功能,也要拆分成多个模块,这纯粹是浪费时间。

所以,在进行模块化开发时,一定要把握好度。不要为了模块化而模块化,要根据实际情况来决定模块的大小和数量。

当然,对于大型项目来说,模块化是必不可少的。但对于小型项目,过度的模块化反而会增加开发成本。所以,在决定是否使用模块化时,要根据项目的规模和复杂度来决定。

最后,记住一句话:模块化的目的是为了提高代码的可维护性和复用性,而不是为了炫技。如果你的模块化代码比非模块化代码更难理解,那你就失败了。

Read more

安卓手机安装Termux+AstrBot+NapCat搭建QQ个人机器人【非官方】(简易版)

安卓手机安装Termux+AstrBot+NapCat搭建QQ个人机器人【非官方】(简易版)

前言        好久不见,亲爱的友友们,这次我来了!这次我学会了用旧安卓手机安装termux软件搭建了一个AstrBotQQ机器人(大模型可能跑不了),我使用的旧安卓手机是vivoY31s标准版,手机型号有点久,到时能用就行了。其实方法都通用差不多。 目录 目录 前言 目录 一、简介 1.Termux 2.AstrBot 3.NapCat  二、步骤 1. 安装Termux 2. 更新系统包打开 Termux,依次执行以下命令,更新软件源并安装基础工具。 换源 (可选) 3. 申请存储权限 正式部署 安装 proot-distro 及 其他必须组件 登录 Ubuntu环境 添加第三方PPA 安装 Python 克隆 AstrBot 仓库 运行 AstrBot

具身神经-机器人运控通讯架构与实现系列

具身智能热潮之下,大量企业投身具身行业。在机器人本体控制方案上各家争鸣,但是试错路径太长,不少团队会在底层控制方案上走大量的弯路,导致资源浪费、项目延期甚至破产。 以第一性原则,探索当前具身机器人通讯架构实现最优解,加速具身机器人行业底层控制(通讯)系统技术方向收敛。尽可能帮助机器人本体系统工程师减少试错。 本系列仅针对机器人本体控制系统底层通讯部分:小脑<--->执行器/传感器之间的架构和具体实现。 gitee链接:https://gitee.com/Lenz_s_law/embodied-nerve 博文汇总 欢迎投稿 通讯架构分析篇 * MIT开源四足机器狗通讯架构分析 * 智元灵犀X1通讯分析1-整机通讯架构 * 智元灵犀X1通讯分析2-CANFD性能优化 * 宇树G1主控拆解分析 * RS485、CAN/FD、EtherCAT三种主流机器人总线方案分析 CAN/FD技术篇 * CAN/FD总线性能分析-机器人应用 * 机器人CAN/FD总线通讯架构设计 * 机器人CAN/FD接口关键性能指标 * 机器人CAN/FD接口扩展/实现方案

Ubuntu搭建PX4无人机仿真环境(5) —— 仿真环境搭建(以Ubuntu 22.04,ROS2 Humble,Micro XRCE-DDS Agent为例)

Ubuntu搭建PX4无人机仿真环境(5) —— 仿真环境搭建(以Ubuntu 22.04,ROS2 Humble,Micro XRCE-DDS Agent为例)

目录 * 前言 * 1. 准备 * 1.1 下载 PX4 源码 * 方式一: * 方式二: * 1.2 安装仿真依赖 * 1.3 安装 Gazebo * 2. 安装 Micro XRCE-DDS Agent * 3. 编译 PX4 * 4. 通信测试 * 5. 官方 offboard 程序 * 6. offboard 测试 * 参考 前言 本教程基于 ROS2 ,在搭建之前,需要把 ROS2、QGC 等基础环境安装配置完成。但是这块的资料相比较于 ROS1 下的少很多,不利于快速上手和后期开发,小白慎选! 小白必看:

win11本地部署openclaw实操第2集-让小龙虾具有telegram机器人能力和搜索网站能力

win11本地部署openclaw实操第2集-让小龙虾具有telegram机器人能力和搜索网站能力

1 按照第一集的部署完成后,我们就开始考虑给小龙虾增加telegram机器人和搜索网站能力,实现效果如下: 2 telegram机器人能力部署 C:\Users\Administrator.openclaw的配置文件openclaw.json 增加一段内容 "channels":{"telegram":{"enabled": true, "dmPolicy":"pairing", "botToken":"你的telegram机器人的token", "groupPolicy":"allowlist", "streamMode":"partial", "network":{"