快速上手模块化开发，CJS和ESM

约 2222 字大约 7 分钟

JavaScript

2025-02-17

模块化规范

模块化的定义：

将程序文件依据规则拆分成多个文件，这种编码方式就是模块化

拆分出来每个文件就是一个模块，模块中的数据都是私有的，模块之间互相隔离。

同时也能通过一些手段，可以把模块内的指定数据交出去，供其他模块使用。

模块化的作用：

应用的复杂度越来越高，代码量和文件数量都会急剧增加，可能会引发以下问题

全局污染问题
依赖混乱问题
数据安全问题

针对 JavaScript 的不同运行环境相继出现了多种模块化规范，按时间排序，分别为：

CommonJS —— 服务端应用广泛
AMD
CMD
ES6 模块化 —— 浏览器端应用广泛

导入与导出的概念

模块化的核心思想就是：模块之间是隔离的，通过导入和导出进行数据和功能的共享。

导出（暴露）：模块公开其内部的一部分（如变量、函数等），使这些内容可以被其他模块使用。
导入（引入）：模块引入和使用其他模块导出的内容，以重用代码和功能。

CommonJS 规范

导出数据

在 CommonJS 标准中，导出数据有两种方式：

第一种方式：module.exports = value
第二种方式：exports.name = value

demo

创建school.js

const name = '尚硅谷'
const slogan = '让天下没有难学的技术！'

function getTel (){
  return '010-56253825'
}

function getCities(){
  return ['北京','上海','深圳','成都','武汉','西安']
}

// 通过给exports对象添加属性的方式，来导出数据（注意：此处没有导出getCities）
exports.name = name
exports.slogan = slogan
exports.getTel = getTel

创建student.js

const name = '张三'
const motto = '相信明天会更好！'

function getTel (){
  return '13877889900'
}

function getHobby(){
  return ['抽烟','喝酒','烫头']
}

// 通过给exports对象添加属性的方式，来导出数据（注意：此处没有导出getHobby）
exports.name = name
exports.slogan = slogan
exports.getTel = getTel

创建index.js

// 引入school模块暴露的所有内容
const school = require('./school')

// 引入student模块暴露的所有内容
const student = require('./student')

注意点：

警告

每个模块内部的：this、exports、modules.exports在初始时，都指向同一个空对象，该空对象就是当前模块导出的数据，如下图：

无论如何修改导出对象，最终导出的都是module.exports的值。

exports是对module.exports的初始引用，仅为了方便给导出象添加属性，所以不能使用 exports = value的形式导出数据，但是可以使用module.exports = xxxx导出数据。

导入数据

在CJS模块化标准中，使用内置的require函数进行导入数据

// 直接引入模块
const school = require('./school')

// 引入同时解构出要用的数据
const { name, slogan, getTel } = require('./school')

// 引入同时解构+重命名
const {name:stuName,motto,getTel:stuTel} = require('./student')

扩展理解

一个 JS 模块在执行时，是被包裹在一个内置函数中执行的，所以每个模块都有自己的作用域，我们可以通过如下方式验证这一说法：

console.log(arguments)
console.log(arguments.callee.toString())

内置函数的大致形式如下：

function (exports, require, module, __filename, __dirname){
  /*********************/
}

浏览器端运行

Node.js 默认是支持 CommonJS 规范的，但浏览器端不支持，所以需要经过编译，步骤如下：

第一步：全局安装 browserify ：npm i browserify -g
第二步：编译

browserify index.js -o build.js

注

备注：index.js 是源文件，build.js 是输出的目标文件

第三步：页面中引入使用

<script type="text/javascript" src="./build.js"></script>

ES6 模块化规范

ES6 模块化规范是一个官方标准的规范，它是在语言标准的层面上实现了模块化功能，是目前最流行的模块化规范，且浏览器与服务端均支持该规范。

demo

创建 school.js

// 导出name
export let name = {str:'尚硅谷'}
// 导出slogan
export const slogan = '让天下没有难学的技术！'

// 导出name
export function getTel (){
  return '010-56253825'
}

function getCities(){
  return ['北京','上海','深圳','成都','武汉','西安']
}

创建 student.js

// 导出name
export const name = '张三'
// 导出motto
export const motto = '相信明天会更好！'

// 导出getTel
export function getTel (){
  return '13877889900'
}

function getHobby(){
  return ['抽烟','喝酒','烫头']
}

创建 index.js

// 引入school模块暴露的所有内容
import * as school from './school.js'

// 引入student模块暴露的所有内容
import * as student from './student.js'

页面中引入 index.js

<script type="module" src="./index.js"></script>

Node 中运行 ES6 模块

Node.js中运行ES6模块代码有两种方式：

方式一：将JavaScript文件后缀从.js 改为.mjs，Node 则会自动识别 ES6 模块。
方式二：在package.json中设置type属性值为module。

导出数据

ES6 模块化提供 3 种导出方式：

分别导出
同一导出
默认导出

分别导出

备注：在上方【demo】环节，我们使用的导出方式就是【分别导出】

// 导出name
export let name = {str:'尚硅谷'}
// 导出slogan
export const slogan = '让天下没有难学的技术！'

// 导出getTel
export function getTel (){
  return '010-56253825'
}

统一导出

const name = {str:'尚硅谷'}
const slogan = '让天下没有难学的技术！'

function getTel (){
  return '010-56253825'
}

function getCities(){
  return ['北京','上海','深圳','成都','武汉','西安']
}

// 统一导出了：name,slogan,getTel
export {name,slogan,getTel}

默认导出

const name = '张三'
const motto = '走自己的路，让别人五路可走！'

function getTel (){
  return '13877889900'
}

function getHobby(){
  return ['抽烟','喝酒','烫头']
}

//默认导出：name,motto,getTel
export default {name,motto,getTel}

备注 :「上述多种导出方式，可以同时使用」

// 导出name ———— 分别导出
export const name = {str:'尚硅谷'}
const slogan = '让天下没有难学的技术！'

function getTel (){
  return '010-56253825'
}

function getCities(){
  return ['北京','上海','深圳','成都','武汉','西安']
}

// 导出slogan ———— 统一导出
export {slogan}
// 导出getTel ———— 默认导出
export default getTel

导入数据

对于 ES6 模块化来说，使用何种导入方式，要根据导出方式决定。

导入全部

通用方法

可以将模块中的所有导出内容整合到一个对象中。

import * as school from './school.js'

命名导入

对应导出方式：分别导出、统一导出

导出数据的模块

//分别导出
export const name = {str:'尚硅谷'} 
//分别导出
export const slogan = '让天下没有难学的技术！' 

function getTel (){
  return '010-56253825'
}

function getCities(){
  return ['北京','上海','深圳','成都','武汉','西安']
}

//统一导出
export { getTel }

命名导入：

import { name,slogan,getTel } from './school.js'

通过as重命名:

import { name as myName,slogan,getTel } from './school.js'

默认导入

对应导出方式：默认导出

导出数据的模块

const name = '张三'
const motto = '走自己的路，让别人五路可走！'

function getTel (){
  return '13877889900'
}

function getHobby(){
  return ['抽烟','喝酒','烫头']
}

//使用默认导出的方式，导出一个对象，对象中包含着数据
export default { name,motto,getTel }

默认导入:

import student from './student.js' //默认导出的名字可以修改，不是必须为student

混合使用

命名导入 与 默认导入可以混合使用

导出数据的模块

//分别导出
export const name = {str:'尚硅谷'} 
//分别导出
export const slogan = '让天下没有难学的技术！'

function getTel (){
  return '010-56253825'
}

function getCities(){
  return ['北京','上海','深圳','成都','武汉','西安']
}

//统一导出
export default getTel

重要

「命名导入」与「默认导入」混合使用，且默认导入的内容必须放在前方：

import getTel,{name,slogan} from './school.js'

动态导入

通用

允许在运行时按需加载模块，返回值是一个 Promise。

const school = await import('./school.js');
console.log(school)

运行导入

import 可以不接收任何数据

例如只是让 mock.js 参与运行

import './mock.js'

注

此时，我们感受到模块化确实解决了：

全局污染问题
依赖混乱问题
数据安全问题

来自尚硅谷-随课笔记

数据引用问题

以下代码的输出结果？

function count (){
  let sum = 1
  function increment(){
    sum += 1
  }
  return {sum,increment}
}

const {sum,increment} = count()

console.log(sum)
increment() 
increment()
console.log(sum)

使用 CommonJS 规范，编写如下代码，输出结果?

let sum = 1

function increment (){
  sum += 1
}

module.exports = {sum,increment}

const {sum,increment} = require('./count.js')

console.log(sum)
increment()
increment()
console.log(sum)

使用 ES6 模块化规范，编写如下代码，输出结果?

let sum = 1

function increment(){
  sum += 1
}

export {sum,increment}

import {sum,increment} from './count.js'

console.log(sum) //1
increment()
increment()
console.log(sum) //3

提示

使用原则：导出的常量，务必用const定义

AMD

...

CMD

...