webpack简介

一、简介

webpack 是一个现代 JavaScript 应用程序的静态模块打包器(module bundler)。主要是用来将前端资源打包、压缩、优化。

  • webpack 打包原理:
    当 webpack 处理应用程序时,不会根据 package.json 文件中的devDependencies 或者 Dependencies 的内容对文件进行打包。而是会根据入口文件做查询,加载其所依赖的包模块,它会递归地构建一个依赖关系图(dependency graph),其中包含应用程序需要的每个模块,然后将所有这些模块打包成一个或多个 bundle。
  • 两个最核心的概念:
    1.一切皆模块
    正如js文件可以是一个模块(module)一样,其他的(如css、image或html)文件也可视作模块。因此,你可以require(‘myJSfile.js’)也可以require(‘myCSSfile.css’)。这意味着我们可以业务分割成更小的易于管理的片段,从而达到重复利用的目的。
    2.按需加载
    传统的模块打包工具(module bundlers)最终将所有的模块编译生成一个庞大的bundle.js文件。但是在真实的app里边,bundle.js文件可能有10M到15M之大,可能会导致应用一直处于加载中状态。因此Webpack使用许多特性来分割代码然后生成多个bundle文件,而且异步加载部分代码以实现按需加载。
二、安装

webpack支持使用npm 或者 yarn 方式进行安装。不推荐全局安装 webpack,这会将你项目中的 webpack 锁定到指定版本,并且在使用不同的 webpack 版本的项目中,可能会导致构建失败。本地安装可以使我们更容易对不同的项目进行分别升级。通常,webpack 通过运行一个或多个 npm scripts,会在本地 node_modules 目录中查找安装的 webpack:

"scripts": {
    "start": "webpack"
}

如果使用 webpack 4+ 版本,还需要安装 CLI。webpack-cli 可以允许直接在控制台操作webpack命令。终端中输入 webpack --help,可以查看所有的帮助信息。

使用npm安装:
npm install webpack webpack-cli --save-dev
或者使用yarn安装:
yarn add webpack webpack-cli -D

三、webpack基本概念

以以下目录结构为例来了解以下webpack的基本概念:


  • 入口 entry:在webpack.config.js配置文件中,通过设置entry字段的值,指定一个入口起点(或多个入口起点),不配置的话,默认入口起点为src目录下的index.js模块。

默认值为:

module.exports = {
    entry: './src'
    //相当于
    entry:{ main:"/src/index.js" }
};

单页面配置:

module.exports = {
    entry: './path/to/my/entry/file.js'
};

多页面配置:

module.exports = {
    entry: {
      'main': "./src/js/index.js",
      'detail': "./src/js/detai.js"
  }
};
  • 输出output :output 属性告诉 webpack 在哪里输出它所创建的 bundles,以及如何命名这些文件,默认值为 ./dist。基本上,整个应用程序结构,都会被编译到指定的输出路径的文件夹中。可以通过在配置中指定一个 output 字段,来配置这些处理过程。

默认值为:

const path = require('path');
module.exports = {
    output: {
        //path需要为绝对路径
      path: path.resolve(__dirname, './dist'),
      filename: 'main.js'
    }
};

自定义配置:output 的 filename属性中,使用[name]来表示entry中的key;使用[hash],会自动在文件名称后面添加hash值,并直接关联到html模板文件中。

const path = require('path');
module.exports = {
    entry: {
        'main': "./src/js/index.js",
        'detail': "./src/js/detai.js"
    },
    output: {
        path: path.resolve(__dirname, './dev'),
        filename: '[name]-[hash].js'
    },
};
  • loader:loader 让 webpack 能够去处理那些非 JavaScript 文件(webpack 自身只理解 JavaScript)。简单来说,loader 就是一个翻译官,将浏览器不认识的语言,转化为浏览器能解析的语言,loader使用之前需要先安装。loader 能够 import 导入任何类型的模块(例如 .scss 文件),这是 webpack 特有的功能,其他打包程序或任务执行器的可能并不支持。

webpack.config.js文件:

module.exports = {
 module: {
   rules: [
     {
       test: /\.s[ac]ss$/,
       //当 use 里有多个loader时,执行的顺序为从右向左
       use: [
         // 将 JS 字符串生成为 style 节点,插入html中,生成内联样式
         'style-loader',
         //将 CSS 转化成 CommonJS 模块,可以直接使用import/require导入
         'css-loader',
         //把.scss文件文件转换为.css文件
         'sass-loader'
       ]
     }
   ]
 }
};

在webpack.config.js文件中,对一个单独的 module 对象定义了 rules 属性,里面包含两个必须属性:test 和 use。这告诉 webpack 编译器(compiler) 如下信息:当编译器碰到「在 require()/import 语句中被解析为 ‘.sass/.scss’ 的路径」时,在对它打包之前,先使用 sass-loader、css-loader、style-loader 转换一下。最终.scss文件会被转成内联样式,插入html页面中。

  • plugins 插件:loader 被用于转换某些类型的模块,而插件则可以用于执行范围更广的任务,插件的范围包括,从打包优化和压缩,一直到重新定义环境中的变量。想要使用一个插件,只需要 require() 它,然后把它添加到 plugins 数组中。多数插件可以通过选项(option)自定义,也可以在一个配置文件中因为不同目的而多次使用同一个插件,这时需要通过使用 new 操作符来创建它的一个实例。

webpack.config.js文件:

//html-webpack-plugin 将html模板文件和js文件整合到一起
const htmlWebpackPlugin = require('html-webpack-plugin');
module.exports = {
    plugins: [
        new HtmlWebpackPlugin({
            //模板文件路径
            template: "./src/views/index.html",
            //自动存储到output 配置的目录
            filename: 'index.html',
            chunks: ['main']
        })
    ]
};

html-webpack-plugin 插件的作用是将html模板文件和js文件整合到一起,如果是多页面应用,则每个页面都需要有对应的new HtmlWebpackPlugin()。webpack在编译的时候,会把所有的 js 合并输出在一个js文件,而设置 chunks 属性的目的,就是让当前页面模板只加载当前页面所需要的模块。上面的写法表示,在编译./src/views/index.html 时,只需要加载main.js文件。

四、webpack配置
  • mode 模式
    mode 配置选项,告知 webpack 使用相应模式的内置优化。有两个值:development(开发模式不会对代码做压缩、优化,方便代码调试,会将 process.env.NODE_ENV 的值设为 development)和production(生产模式下会对代码做压缩、优化,会将 process.env.NODE_ENV 的值设为 production)。如果不配置mode,会有警告信息,但是不影响项目运行。
module.exports = {
    mode:"development",
};
  • devtool
    开发模式通常配合devtool使用,可以在浏览器的控制台看到源代码,而不是解析后的代码。
module.exports = {
    //代码调试,可以看到源代码
    devtool: 'inline-source-map',
};
  • webpack-dev-server
    在开发模式下,新建一个开发服务器,并且当代码更新的时候自动刷新浏览器。可以使用webpack-dev-server插件。直接使用webpack执行,会对文件进行打包,并输出在指定目录下,默认为./dev下。使用webpack-dev-server执行,文件会放在内存里,不会生成整合后的文件,也不会将文件输出到指定目录里。
    在webpack.config.js文件中配置
module.exports = {
    devServer:{
        contentBase:"./dist", //设置Http服务器的文件根目录
        port:8088, //端口
        open:true, //是否打开浏览器
        proxy: { //配置代理
          "/api": {
                target: "http://localhost:3000",
                pathRewrite: {"^/api" : ""}
          }
        }
    }
};
  • webpack.config.js
    一个开发模式下,完整的webpack.config.js文件内容如下:
const path=require("path");
//将html模板和js文件整合在一起
const htmlWebpackPlugin=require("html-webpack-plugin");
//将css样式提取出来,使用Link标签导入
const miniCssExtractPlugin=require("mini-css-extract-plugin");
//将静态资源打包到输出目录中
const copyWebpackPlugin=require("copy-webpack-plugin");

module.exports={
    mode:"development",
    devtool:"inline-source-map",
    entry:"./src/js/index.js",
    output:{
        path:path.resolve(__dirname+"./dev"),
        filename:"[name]-[hash].js"
    },
    devServer:{
        port:8088,
        open:true,
        proxy: { //配置代理
          "/api": {
                target: "http://localhost:3000",
                pathRewrite: {"^/api" : ""}
          }
        }
    },
    plugins:[
        new htmlWebpackPlugin({
            title:"demo title",
            template:"./src/views/index.html",
            filename:"index.html",
            chunks:["main"]
        }),
        new miniCssExtractPlugin({
            filename:"[name]-[hash].css"
        }),
        new copyWebpackPlugin([
            {from:"./src/static",to:"./static"}
        ])
    ],
    module:{
        rules:[
            {
                test:/\.s[ac]ss$/,
                use:[
                    miniCssExtractPlugin.loader,
                    "css-loader",
                    "sass-loader"
                ]
            },        
            {
                test:/\.html$/,
                use:["string-loader"]
            }
        ]
    }
}

package.json文件内容如下:

{
  "name": "admin-fe",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "dev": "webpack-dev-server --config webpack.config.js"
  },
  "keywords": [],
  "author": "",
  "license": "ISC",
  "dependencies": {
    "handlebars": "^4.7.3",
    "sme-router": "^0.12.8"
  },
  "devDependencies": {
    "copy-webpack-plugin": "^5.1.1",
    "css-loader": "^3.4.2",
    "html-webpack-plugin": "^4.0.1",
    "mini-css-extract-plugin": "^0.9.0",
    "node-sass": "^4.13.1",
    "sass-loader": "^8.0.2",
    "string-loader": "^0.0.1",
    "style-loader": "^1.1.3",
    "webpack": "^4.42.1",
    "webpack-cli": "^3.3.11",
    "webpack-dev-server": "^3.10.3"
  }
}
五、webpack优势

与其他的构建工具相比,webpack具有如下的一些优势:

  • 对 CommonJS 、 AMD 、ES6 的语法做了兼容
  • 对 js、css、图片等资源文件都支持打包
  • 串联式模块加载器以及插件机制,让其具有更好的灵活性和扩展性,例如提供对 CoffeeScript、ES6的支持
  • 有独立的配置文件 webpack.config.js
  • 可以将代码切割成不同的 chunk,实现按需加载,降低了初始化时间
  • 支持 SourceUrls 和 SourceMaps,易于调试
  • 具有强大的 Plugin 接口,大多是内部插件,使用起来比较灵活
  • webpack 使用异步 IO 并具有多级缓存,这使得 webpack 很快且在增量编译上更加快
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,142评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,298评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,068评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,081评论 1 291
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,099评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,071评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,990评论 3 417
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,832评论 0 273
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,274评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,488评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,649评论 1 347
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,378评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,979评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,625评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,796评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,643评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,545评论 2 352