模块化概述
传统开发模式对主要问题 命名冲突,多个js文件之间,如果存在多个重名的变量,则会发送变量覆盖问题。 文件依赖,js文件之间无法相互引用。
通过模块化解决 模块化就是把单独的一个功能封装到一个模块(文件)中,模块之间相互隔离,但是可以通过特定的接口公开内部成员,也可以依赖别的模块。
模块化开发的好处:方便代码的重用,从而提升开发效率,并且方便后期的维护。
浏览器端模块化规范
AMD
Require.js(http://www.requirejs.com)
CMD
Sea.js(https://seajs.github.io/seajs/docs/)
以上两个已经落伍了
服务器端模块化规范
CommonJS
- 模块分为但文件模块与包
- 模块成员导出:module.exports 和 exports
- 模块成员导入:require(模块标识符)
大一统的模块化规范--ES6模块化
在 ES6 模块化规范诞生之前,JavaScript社区已经尝试并提出了 AMD、CMD、CommonJS等模块化规范。
但是,这些社区提出的模块化标准,还是存在一定的差异性与局限性,并不是浏览器与服务器通用的模块化标准,例如: - AMD 和 CMD 适用于浏览器端的JavaScript 模块化 - CommonJS适用于服务器端的JavaScript模块化
因此,ES6语法规范中,在语言层面上定义了ES6模块化规范,是浏览器端与服务器端通用的模块化开发规范。
ES6模块化规范中定义: - 每个js文件都是一个独立的模块 - 导入模块成员使用 import 关键字 - 暴露模块成员使用 export 关键字
Node.js中通过bael体验ES6模块化
Node中默认支持CommonJS这个服务器端的模块化规范,但是对ES6的模块化,Node支持的并不是很好。通常需要使用babel这个插件在node中体验ES6的模块化特性。
babel是一个语法转换工具,它可以把高级的有兼容性的JavaScript代码转换成低级的没有兼容性的JavaScript代码。
npm install --save-dev @babel/core @babel/cli
npm install --save-dev @babel/preset-env @babel/node
npm install --save @babel/polyfill
以上命令局部安装(项目本地安装,这样会比较好,全局安装会对所有包都产生依赖,不利于开发)一个项目安装一个,需要就安装,切忌全局安装。
项目根目录创建文件 babel.config.js
babel.config.js 文件内容如下方代码所示,target中表示至少要支持的浏览器
const presets = [
["@babel/env",{
targets:{
edge:"17",
firefox:"60",
chrome:"67",
safari:"11.1"
}
}]
];
module.exports = {presets};
通过 npx babel-node index.js
执行代码
npx可以绕过全局就项目本地执行代码
默认导出和默认导入
- 默认导出语法 export default 默认导出的成员
- 默认导入语法 import 接收名称 from '模块标识符'
注意,每个模块中,只允许使用唯一的一次 export default,否则会报错!
按需导出和按需导入
- 按需导出语法 export let ss1 = 'aaa'
- 按需导入语法 import {ss1} from '模块标识符'
注意,每个模块可以使用多次按需导出
直接导入并执行代码
有时候我们只想单纯执行某个模块中的代码,并不需要得到模块中向外暴露的成员,此时,可以直接导入并执行模块代码。
import './m2.js'
webpack
当前Web开发面临的困境
- 文件依赖关系错综复杂
- 静态资源请求效率低
- 模块化支持不友好
- 浏览器对高级JavaScript特性兼容程度较低
- etc...
webpack是一个流行的前端项目构建工具(打包工具),可以解决当前web开发中所面临的困境。
webpack提供了友好的模块化支持,以及代码压缩混淆、处理js兼容性问题、性能优化等强大的功能,从而让程序员把工作重心放到具体的功能实现上,提高了开发效率和项目的可维护性。
基本使用
创建一个列表隔行变色的项目
- 新建项目空白目录,并运行
npm init -y
命令,初始化包管理配置文件 package.json - 在空白目录中新建一个
src
目录(源代码目录) - 在 src 目录中新建一个
index.html
首页 - 初始化首页的基本结构
- 运行
npm install jquery -s
命令,安装JQuery - 通过模块化的形式,实现列表隔行变色的效果
注意 npm init -y 的文件夹不能有中文、大写字母和空格。jquery也是安装在项目本地的。
index.js代码如下
import $ from 'jquery'
$(function(){
$('li:odd').css('backgroundColor','pink')
$('li:even').css('backgroundColor','lightblue')
})
index.html代码如下
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Document</title>
<script src="./index.js"></script>
</head>
<body>
<ul>
<li>这是第1个li</li>
<li>这是第2个li</li>
<li>这是第3个li</li>
<li>这是第4个li</li>
<li>这是第5个li</li>
<li>这是第6个li</li>
<li>这是第7个li</li>
<li>这是第8个li</li>
<li>这是第9个li</li>
</ul>
</body>
</html>
但是,这样最终是没有效果的,因为没有用webpack打包
现在,通过模块化的方式,用webpack打包。
在项目中安装和配置webpack
- 运行
npm install webpack webpack-cli -D
命令,安装webpack相关的包 - 在项目根目录中,创建名为
webpack.config.js
的配置文件 - 在webpack的配置文件中,初始化如下基本配置:
module.exports = {
mode:'development' //mode用来指定构建模式
}
- 在packge.json 配置文件中的 scripts 节点下,新增dev脚本如下:
"scripts":{
"dev":"webpack" //script脚本下可以通过npm run执行
}
- 在终端中运行
npm run dev
命令,启动webpack进行打包
配置打包的入口与出口
在webpack 4.x版本中默认约定: 打包的入口文件为 src --> index.js 打包的出口文件为 dist --> main.js
如果要修改打包的出口与入口,就要在webpack.config.js文件中添加如下配置:
const path = require('path') //导入node.js中专门操作路径的模块
module.exports = {
entry:path.join(__dirname,'./src/index.js'), //打包入口文件的路径 __dirname表示当前文件夹
output:{
path:path.join(__dirname,'./dist'), //打包出口文件的路径
filename:'bundle.js' //输出文件的名称
}
}
webpack自动打包功能(热更新)
- 运行
npm install webpack-dev-server -D
命令,安装支持项目自动打包的工具 - 修改
package.json --> scripts
中的dev
命令如下:
"scripts":{
"dev":"webpack-dev-server" //script 节点下的脚本,可以通过 npm run 执行
}
- 将
src --> index.html
中,script脚本的引用路径,修改为 "/bundle.js" - 运行
npm run dev
命令,重新进行打包 - 在浏览器中访问
http://localhost:8080
地址,查看自动打包效果
注意事项,遇到bug的解决情况
在macOS下如果出现No receipt for 'com.apple.pkg.CLTools_Executables' found at '/'.
错误,更新一下Xcode,命令行输入sudo xcode-select -r
即可
Mac 解决gyp: No Xcode or CLT version detected! 报错。执行
,用sudo rm -rf $(xcode-select -print-path)
和xcode-select --install
。上面两条命令用来安装Xcode命令行工具。
报错 Cannot find module 'webpack-cli/bin/config-yargs'
可以参考这个这个链接
一定要让本地项目的webpack-dev-server、webpack-cli版本是同一个大版本3.x,如此编译起来不会出大问题 我最后是这样的npm install webpack
npm install webpack-cli@3.x -D
npm install webpack-dev-server@3.x -D
粘贴一段对话,完美解决了我编译bug的问题(之前一直报同一个错误Cannot find module 'webpack-cli/bin/config-yargs'
和npm ERR! code ELIFECYCLE
):
注意: - webpack-dev-server 会启动一个实时打包的http服务器 - webpack-dev-server 打包生成的输出文件,默认放到了项目根目录下,而且是虚拟的看不见的
配置html-webpack-plugin生成预览页面
- 运行
npm install html-webpack-plugin -D
命令,安装生成预览页面的插件 - 修改 webpack.config.js 文件头部区域,添加如下配置信息:
// 导入生成预览页面的插件,得到一个构造函数
const HtmlWebpackPlugin = require('html-webpack-plugin')
const htmlPlugin = new HtmlWebpackPlugin({ //创建插件的实例对象
template:'./src/index.html', //指定要用到的模版文件
filename:'index.html' //指定生成的文件的名称,该文件存在于内存中,在目录中不显示
})
- 修改webpack.config.js文件中向外暴露的配置对象,新增如下配置节点:
module.exports = {
plugins:[htmlPlugin] //plugins数组是webpack打包期间会用到的一些插件列表
}
然后运行 npm run dev
就行了,打开localhost:8080就OK了
配置自动打包的相关参数
配置这个以达到运行命令之后自动打开网页查看效果,不必再手动打开网页了。
//package.json中的配置
// --open打包完成后自动打开浏览器页面
// --host配置ip地址
//port配置端口
"script":{
"dev":"webpack-dev-server --open --host 127.0.0.1 --port 8888"
}
webpack中的加载器
通过loader打包非js模块
在实际开发过程中,webpack默认只能打包处理以 .js后缀名结尾的模块,其他非 .js后缀名结尾的模块,webpack默认处理不了,需要调用loader加载器才可以正常打包,否则会报错!
loader加载器可以协助webpack打包处理特定的文件模块,比如: - less-loader可以打包处理 .less相关的文件 - sass-loader可以打包处理 .scss相关的文件 - url-loader可以打包处理 css中与 url相关的文件
打包处理css文件
- 运行
npm install style-loader css-loader -D
命令进行安装css的loader文件 - 在webpack.config.js的 module->rules数组中,添加loader规则如下:
//所有第三方文件的匹配模块规则
module:{
rules:[
{test:/.css$/,use:['style-loader','css-loader']}
]
}
其中,用test表示匹配的文件类型,use表示对应要调用的loader。要先配置style-loader 再配置css-loader,否则会出错。多个loader的调用顺序是从后往前调。
打包处理less文件
- 运行
npm install less-loader less -D
- 在webpack.config.js的 module->rules数组中,添加loader规则如下:
//所有第三方文件的匹配模块规则
module:{
rules:[
{test:/.less$/,use:['style-loader','css-loader','less-loader']}
]
}
style和css的loader都默认安装了
打包处理scss文件
- 运行
npm install sass-loader node-sass -D
- 在webpack.config.js的 module->rules数组中,添加loader规则如下:
//所有第三方文件的匹配模块规则
module:{
rules:[
{test:/.scss$/,use:['style-loader','css-loader','sass-loader']}
]
}
配置postCSS自动添加css的兼容前缀
比如写的伪类选择器,::placeholder{color:red}
在Chrome和IE上 一个有效一个无效。所以必须在css中做浏览器声明,但是这样很麻烦。 所以就需要webpack帮忙
- 运行
npm install postcss-loader autoprefixer -D
命令 - 在项目根目录中创建postcss的配置文件
postcss.config.js
,并初始化如下配置:
const autoprefixer = require('autoprefixer') //导入自动添加前缀的插件
module.exports = {
plugins:[autoprefixer] //挂载插件
}
- 在webpack.config.js的moudle -> rules 数组中,修改css的loader规则如下:
moudle:{
rules:[
{test:/.css$/,use:['style-loader','css-loader','postcss-loader']}
]
}
打包样式表中的图片和字体文件
对于在项目本地的图片 用css -> background: url(../../image/1.png);这种写法,没有loader处理的话会报错。
- 运行
npm install url-loader file-loader -D
命令 - 在webpack.config.js的 module->rules数组中,添加loader规则如下:
//所有第三方文件的匹配模块规则
module:{
rules:[
{
test:/.jpg|png|gif|bmp|ttf|eot|svg|woff|woff2$/,
use:'url-loader?limit=16940'
}
]
}
其中?之后的是loader的参数项。limit用来指定图片的大小,单位是字节,只有小于limit大小的图片才会被转为base64图片
打包处理js文件中的高级语法
class 语法 即ES6高级js语法
- 安装babel转换器相关的包:
npm i babel-loader @babel/core @babel/runtime -D
- 安装babel语法插件相关的包:
npm i @babel/preset-env @babel/plugin-transform-runtime @babel/plugin-proposal-class-properties -D
- 在项目根目录下,创建babel配置文件
babel.config.js
并初始化如下配置:
module.exports = {
presets:['@babel/preset-env'],
plugins:['@babel/plugin-transform-runtime','@babel/plugin-proposal-class-properties']
}
- 在webpack.config.js的 module->rules数组中,添加loader规则如下:
//exclude为排除项,表示babel-loader不需要处理node_modules目录下的js文件
module:{
rules:[
{test:/.js$/,use:'babel-loader',exclude:/node_modules/}
]
}
[1]
参考
- ^本人博客 https://hekvn.top