跳到主要内容JavaScriptNode.js大前端
import/export:前端模块化实战 | JS 基础语法与数据操作
综述由AI生成介绍前端 ES Modules 中 import 和 export 的基础用法及最佳实践。通过对比非模块化代码的痛点,阐述了模块化在隔离作用域、明确依赖关系和提升可维护性方面的优势。提供了基于 Vite + Vue 的最小可运行项目示例,包含 utils、api、composables 和 constants 的标准目录结构。最后总结了常见坑点,如循环依赖、魔法数字等,旨在帮助开发者建立清晰的前端工程化思维。
星落26 浏览 一、先体验一下:没有模块化有多难受
1.1 一个真实的场景
假设你要做一个「用户列表」页面,需要:
如果全写在一个文件里,大概是这样的:
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>用户列表</title>
</head>
<body>
<div id="app"></div>
<script src="./app.js"></script>
</body>
</html>
const API_BASE = '/api';
const list = [];
let loading = false;
function formatDate(date) {
return new Date(date).toLocaleDateString('zh-CN');
}
() {
loading = ;
( + )
.( res.())
.( {
list = data;
loading = ;
});
}
function
getUserList
true
fetch
API_BASE
'/user/list'
then
res =>
json
then
data =>
false
- 变量、函数全混在一起,改一处容易影响别处
formatDate 如果别的页面也要用,只能复制粘贴
- 文件越来越长,找个函数要翻很久
1.2 模块化能做到的三件事
- 隔离:每个文件有自己的作用域,不互相污染
- 依赖清晰:用
import 明确「谁用了谁」
- 可维护:按职责拆文件,找代码、改代码都更轻松
后面我们就用 ES Modules(import / export)来做这件事。
二、import / export 基础
2.1 先搞懂 export:导出
export function formatDate(date) {
return new Date(date).toLocaleDateString('zh-CN');
}
export function formatMoney(num) {
return `¥${num.toFixed(2)}`;
}
方式二:默认导出(一个文件只能有一个 default)
export default {
apiBase: '/api',
timeout: 5000,
};
- 命名导出:可以导出很多个,
import 时要用同名
- 默认导出:只有一个,
import 时可以随便起名字
2.2 再搞懂 import:引入
import { formatDate, formatMoney } from './utils/format.js';
import config from './config.js';
console.log(config.apiBase);
import * as formatUtils from './utils/format.js';
formatUtils.formatDate(new Date());
| 写法 | 含义 |
|---|
import { foo } | 引入命名导出,{} 是语法,不是解构 |
import foo | 引入默认导出 |
三、完整的可运行示例
下面是一个最小可运行项目,涵盖:utils、api、constants、composables,可以直接照抄跑起来。
3.1 项目结构
my-project/
├── index.html
├── package.json
├── vite.config.js
└── src/
├── main.js
├── constants/
│ └── index.js
├── utils/
│ ├── format.js
│ └── index.js
├── api/
│ ├── request.js
│ ├── user.js
│ └── index.js
├── composables/
│ └── useUserList.js
└── App.vue
3.2 完整代码(可直接复制)
{
"name": "module-demo",
"version": "1.0.0",
"type": "module",
"scripts": {
"dev": "vite"
},
"dependencies": {
"vue": "^3.4.0",
"axios": "^1.6.0"
},
"devDependencies": {
"vite": "^5.0.0",
"@vitejs/plugin-vue": "^5.0.0"
}
}
<!DOCTYPE html>
<html lang="zh-CN">
<head>
<meta charset="UTF-8">
<title>用户列表 - 模块化示例</title>
</head>
<body>
<div id="app"></div>
<script type="module" src="/src/main.js"></script>
</body>
</html>
3. src/constants/index.js
export const API_BASE = '/api';
export const TIMEOUT = 10000;
export const ORDER_STATUS = {
PENDING: 0,
PAID: 1,
SHIPPED: 2,
COMPLETED: 3,
};
export const ORDER_STATUS_TEXT = {
0: '待支付',
1: '已支付',
2: '已发货',
3: '已完成',
};
export function formatDate(date, options = {}) {
if (!date) return '-';
return new Date(date).toLocaleDateString('zh-CN', {
year: 'numeric',
month: '2-digit',
day: '2-digit',
...options,
});
}
export function formatMoney(num) {
if (num == null || isNaN(num)) return '¥0.00';
return `¥${Number(num).toFixed(2)}`;
}
export function formatPhone(phone) {
if (!phone || phone.length !== 11) return phone;
return `${phone.slice(0, 3)}****${phone.slice(7)}`;
}
export { formatDate, formatMoney, formatPhone } from './format.js';
import axios from 'axios';
import { API_BASE, TIMEOUT } from '../constants/index.js';
const request = axios.create({
baseURL: API_BASE,
timeout: TIMEOUT,
});
request.interceptors.response.use(
(res) => res.data,
(err) => {
if (err.response?.status === 401) {
console.warn('未登录,请先登录');
}
return Promise.reject(err);
}
);
export default request;
import request from './request.js';
export function getUserList(params = {}) {
return request.get('/user/list', { params });
}
export function getUserDetail(id) {
return request.get(`/user/${id}`);
}
export * from './user.js';
9. src/composables/useUserList.js
import { ref, watch } from 'vue';
import { getUserList } from '../api/index.js';
export function useUserList(params = {}) {
const list = ref([]);
const loading = ref(false);
const error = ref(null);
async function fetchList() {
loading.value = true;
error.value = null;
try {
const res = await getUserList(params);
list.value = res.data || res;
} catch (err) {
error.value = err.message;
} finally {
loading.value = false;
}
}
watch(() => [params.page, params.pageSize], () => fetchList(), {
immediate: true,
});
return { list, loading, error, fetchList };
}
<template>
<div v-if="loading">加载中...</div>
<div v-else-if="error">出错了:{{ error }}</div>
<div v-else style="padding: 20px">
<h1>用户列表</h1>
<ul>
<li v-for="user in list" :key="user.id">
{{ user.name }} - 注册时间:{{ formatDate(user.createdAt) }}
</li>
</ul>
</div>
</template>
<script setup>
import { useUserList } from './composables/useUserList.js';
import { formatDate } from './utils/index.js';
const { list, loading, error } = useUserList({ page: 1, pageSize: 10 });
</script>
import { createApp } from 'vue';
import App from './App.vue';
createApp(App).mount('#app');
import { defineConfig } from 'vite';
import vue from '@vitejs/plugin-vue';
export default defineConfig({
plugins: [vue()],
});
3.3 怎么运行
cd my-project
npm install
npm run dev
浏览器打开 http://localhost:5173 即可(接口需自行 mock 或接真实后端)。
四、这一套结构在解决什么问题
4.1 utils:通用纯函数
- 职责:格式化、校验、防抖节流等和业务无关的函数
- 原则:尽量纯函数,不依赖接口、路由、业务状态
- 示例:
formatDate、formatMoney、isValidPhone
4.2 api:请求层
- 职责:封装 axios/fetch,按业务拆接口文件
- 原则:只负责发请求、返回数据,不写业务判断
- 示例:
getUserList、getUserDetail
4.3 composables:可复用逻辑
- 职责:把「请求 + loading + error」等可复用逻辑抽成组合式函数
- 原则:只在多处复用时抽,不要过度抽象
- 示例:
useUserList、useDebounce
4.4 constants:常量与配置
- 职责:状态码、业务码、环境配置等
- 原则:只放常量,不放逻辑
- 示例:
ORDER_STATUS、API_BASE
五、常见坑
| 坑 | 建议 |
|---|
| utils 里写业务逻辑 | 工具函数只做通用处理,不依赖具体业务 |
| api 层写业务判断 | api 只管请求和错误,业务逻辑在组件/composable 里 |
| 魔法数字 | 状态码、业务码用常量,如 ORDER_STATUS.PENDING |
| watch 依赖写错 | watch 的监听源要写对,否则会多请求或漏更新 |
| ref 忘记 .value | 在 script 里访问 ref 要加 .value,模板中自动解包 |
| 循环依赖 | 保持单向依赖:constants → api → composables → 组件 |
六、小结
先按 utils、api、composables、constants 这几类把代码分好,再按项目规模慢慢细化,不必一上来就设计得很复杂。
相关免费在线工具
- Keycode 信息
查找任何按下的键的javascript键代码、代码、位置和修饰符。 在线工具,Keycode 信息在线工具,online
- Escape 与 Native 编解码
JavaScript 字符串转义/反转义;Java 风格 \uXXXX(Native2Ascii)编码与解码。 在线工具,Escape 与 Native 编解码在线工具,online
- JavaScript / HTML 格式化
使用 Prettier 在浏览器内格式化 JavaScript 或 HTML 片段。 在线工具,JavaScript / HTML 格式化在线工具,online
- JavaScript 压缩与混淆
Terser 压缩、变量名混淆,或 javascript-obfuscator 高强度混淆(体积会增大)。 在线工具,JavaScript 压缩与混淆在线工具,online
- Base64 字符串编码/解码
将字符串编码和解码为其 Base64 格式表示形式即可。 在线工具,Base64 字符串编码/解码在线工具,online
- Base64 文件转换器
将字符串、文件或图像转换为其 Base64 表示形式。 在线工具,Base64 文件转换器在线工具,online