AI 助理
备案控制台
开发者社区 开发与运维 文章 正文

webpack开发环境

2023-12-12 58
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： webpack开发环境

前言

hello world欢迎来到前端的新世界

😜当前文章系列专栏：webpack

🐱‍👓博主在前端领域还有很多知识和技术需要掌握，正在不断努力填补技术短板。(如果出现错误，感谢大家指出)🌹

💖感谢大家支持！您的观看就是作者创作的动力

webpack.config.js

在开始前，我们先将 mode 设置为 ‘development’，并将 title 设置为 ‘Development’。


const path = require('path');
 const HtmlWebpackPlugin = require('html-webpack-plugin');
 module.exports = {
+  mode: 'development',
   entry: {
     index: './src/index.js',
     print: './src/print.js',
   },
   plugins: [
     new HtmlWebpackPlugin({
-      title: 'Output Management',
+      title: 'Development',
     }),
   ],
   output: {
     filename: '[name].bundle.js',
     path: path.resolve(__dirname, 'dist'),
     clean: true,
   },
 };

使用 source map

当 webpack打包源代码时，可能会很难追踪到 error(错误) 和 warning(警告) 在源代码中的原始位置。例如，如果将三个源文件（a.js, b.js 和 c.js）打包到一个 bundle（bundle.js）中，而其中一个源文件包含一个错误，那么堆栈跟踪就会直接指向到 bundle.js。你可能需要准确地知道错误来自于哪个源文件，所以这种提示这通常不会提供太多帮助。


为了更容易地追踪error和 warning，JavaScript 提供了 source maps 功能，可以将编译后的代码映射回原始源代码。如果一个错误来自于 b.js，source map 就会明确的告诉你。


source map 有许多 可用选项，请务必仔细阅读它们，以便可以根据需要进行配置。


对于本指南，我们将使用 inline-source-map 选项，这有助于解释说明示例意图（此配置仅用于示例，不要用于生产环境）


webpack.config.js

const path = require('path');
 const HtmlWebpackPlugin = require('html-webpack-plugin');
 module.exports = {
   mode: 'development',
   entry: {
     index: './src/index.js',
     print: './src/print.js',
   },
+  devtool: 'inline-source-map',
   plugins: [
     new HtmlWebpackPlugin({
       title: 'Development',
     }),
   ],
   output: {
     filename: '[name].bundle.js',
     path: path.resolve(__dirname, 'dist'),
     clean: true,
   },
 };


现在，让我们来做一些调试，在 print.js 文件中生成一个错误：


src/print.js


export default function printMe() {
-  console.log('I get called from print.js!');
+  cosnole.log('I get called from print.js!');
 }


...
[webpack-cli] Compilation finished
asset index.bundle.js 1.38 MiB [emitted] (name: index)
asset print.bundle.js 6.25 KiB [emitted] (name: print)
asset index.html 272 bytes [emitted]
runtime modules 1.9 KiB 9 modules
cacheable modules 530 KiB
  ./src/index.js 406 bytes [built] [code generated]
  ./src/print.js 83 bytes [built] [code generated]
  ./node_modules/lodash/lodash.js 530 KiB [built] [code generated]
webpack 5.4.0 compiled successfully in 706 ms


现在，在浏览器中打开生成的 index.html 文件，点击按钮，并且在控制台查看显示的错误。错误应该如下：


Uncaught ReferenceError: cosnole is not defined
   at HTMLButtonElement.printMe (print.js:2)


我们可以看到，此错误包含有发生错误的文件（print.js）和行号（2）的引用。这是非常有帮助的，因为现在我们可以确切地知道，所要解决问题的位置。


选择一个开发工具


Warning

某些文本编辑器具有 “safe write(安全写入)” 功能，可能会干扰下面一些工具。阅读 调整文本编辑器 以解决这些问题。

在每次编译代码时，手动运行 npm run build 会显得很麻烦。


webpack 提供几种可选方式，帮助你在代码发生变化后自动编译代码：


  1. webpack’s Watch Mode
  2. webpack-dev-server
  3. webpack-dev-middleware


多数场景中，你可能需要使用 webpack-dev-server，但是不妨探讨一下以上的所有选项。


使用 watch mode(观察模式)


你可以指示 webpack “watch” 依赖图中所有文件的更改。如果其中一个文件被更新，代码将被重新编译，所以你不必再去手动运行整个构建。


我们添加一个用于启动 webpack watch mode 的 npm scripts：


package.json


{
   "name": "webpack-demo",
   "version": "1.0.0",
   "description": "",
   "private": true,
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
+    "watch": "webpack --watch",
     "build": "webpack"
   },
   "keywords": [],
   "author": "",
   "license": "ISC",
   "devDependencies": {
     "html-webpack-plugin": "^4.5.0",
     "webpack": "^5.4.0",
     "webpack-cli": "^4.2.0"
   },
   "dependencies": {
     "lodash": "^4.17.20"
   }
 }


现在，你可以在命令行中运行 npm run watch，然后就会看到 webpack 是如何编译代码。 然而，你会发现并没有退出命令行。这是因为此 script 当前还在 watch 你的文件。


现在，webpack 观察文件的同时，先移除我们之前加入的错误：

src/print.js


export default function printMe() {
-  cosnole.log('I get called from print.js!');
+  console.log('I get called from print.js!');
 }


使用 webpack-dev-server


webpack-dev-server 为你提供了一个基本的 web server，并且具有 live reloading(实时重新加载) 功能。设置如下：


npm install --save-dev webpack-dev-server


修改配置文件，告知 dev server，从什么位置查找文件：


const path = require('path');
 const HtmlWebpackPlugin = require('html-webpack-plugin');
 module.exports = {
   mode: 'development',
   entry: {
     index: './src/index.js',
     print: './src/print.js',
   },
   devtool: 'inline-source-map',
+  devServer: {
+    static: './dist',
+  },
   plugins: [
     new HtmlWebpackPlugin({
       title: 'Development',
     }),
   ],
   output: {
     filename: '[name].bundle.js',
     path: path.resolve(__dirname, 'dist'),
     clean: true,
   },
+  optimization: {
+    runtimeChunk: 'single',
+  },
 };


以上配置告知 webpack-dev-server，将 dist 目录下的文件 serve 到 localhost:8080 下。（译注：serve，将资源作为 server 的可访问文件）


webpack.config.js


Tip

因为在这个示例中单个 HTML 页面有多个入口，所以添加了 optimization.runtimeChunk: 'single' 配置。没有这个配置的话，我们可能会遇到 这个问题。 查看 代码分割 章节获取更多细节。


Tip

webpack-dev-server 会从output.path中定义的目录中的 bundle 文件提供服务，即文件将可以通过 http://[devServer.host]:[devServer.port]/[output.publicPath]/[output.filename] 进行访问。


Warning

webpack-dev-server 在编译之后不会写入到任何输出文件。而是将 bundle 文件保留在内存中，然后将它们 serve 到 server 中，就好像它们是挂载在 server 根路径上的真实文件一样。如果你的页面希望在其他不同路径中找到 bundle 文件，则可以通过dev server配置中的 devMiddleware.publicPath 选项进行修改。


我们添加一个可以直接运行 dev server 的 script：


package.json

{
   "name": "webpack-demo",
   "version": "1.0.0",
   "description": "",
   "private": true,
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
     "watch": "webpack --watch",
+    "start": "webpack serve --open",
     "build": "webpack"
   },
   "keywords": [],
   "author": "",
   "license": "ISC",
   "devDependencies": {
     "html-webpack-plugin": "^4.5.0",
     "webpack": "^5.4.0",
     "webpack-cli": "^4.2.0",
     "webpack-dev-server": "^3.11.0"
   },
   "dependencies": {
     "lodash": "^4.17.20"
   }
 }


现在，在命令行中运行 npm start，我们会看到浏览器自动加载页面。如果你更改任何源文件并保存它们，web server 将在编译代码后自动重新加载。试试看！


webpack-dev-server 具有许多可配置的选项。关于其他更多配置，请查看 配置文档。


Tip

现在，server 正在运行，你可能需要尝试 模块热替换(hot module replacement)！


使用 webpack-dev-middleware


webpack-dev-middleware 是一个封装器(wrapper)，它可以把 webpack 处理过的文件发送到一个 server。webpack-dev-server 在内部使用了它，然而它也可以作为一个单独的 package 来使用，以便根据需求进行更多自定义设置。下面是一个webpack-dev-middleware配合 express server 的示例。


首先，安装 express 和 webpack-dev-middleware：


npm install --save-dev express webpack-dev-middleware


现在，我们需要调整 webpack 配置文件，以确保 middleware(中间件) 功能能够正确启用：


webpack.config.js

const path = require('path');
 const HtmlWebpackPlugin = require('html-webpack-plugin');
 module.exports = {
   mode: 'development',
   entry: {
     index: './src/index.js',
     print: './src/print.js',
   },
   devtool: 'inline-source-map',
   devServer: {
     static: './dist',
   },
   plugins: [
     new HtmlWebpackPlugin({
       title: 'Development',
     }),
   ],
   output: {
     filename: '[name].bundle.js',
     path: path.resolve(__dirname, 'dist'),
     clean: true,
+    publicPath: '/',
   },
 };


我们将会在 server 脚本使用 publicPath，以确保文件资源能够正确地 serve 在 http://localhost:3000 下，稍后我们会指定 port number(端口号)。接下来是设置自定义 express server：


project

webpack-demo
  |- package.json
  |- package-lock.json
  |- webpack.config.js
+ |- server.js
  |- /dist
  |- /src
    |- index.js
    |- print.js
  |- /node_modules


server.js


const express = require('express');
const webpack = require('webpack');
const webpackDevMiddleware = require('webpack-dev-middleware');
const app = express();
const config = require('./webpack.config.js');
const compiler = webpack(config);
// 告知 express 使用 webpack-dev-middleware，
// 以及将 webpack.config.js 配置文件作为基础配置。
app.use(
  webpackDevMiddleware(compiler, {
    publicPath: config.output.publicPath,
  })
);
// 将文件 serve 到 port 3000。
app.listen(3000, function () {
  console.log('Example app listening on port 3000!\n');
});


现在，添加一个 npm script，以使我们更方便地运行 server：


package.json

{
   "name": "webpack-demo",
   "version": "1.0.0",
   "description": "",
   "private": true,
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
     "watch": "webpack --watch",
     "start": "webpack serve --open",
+    "server": "node server.js",
     "build": "webpack"
   },
   "keywords": [],
   "author": "",
   "license": "ISC",
   "devDependencies": {
     "express": "^4.17.1",
     "html-webpack-plugin": "^4.5.0",
     "webpack": "^5.4.0",
     "webpack-cli": "^4.2.0",
     "webpack-dev-middleware": "^4.0.2",
     "webpack-dev-server": "^3.11.0"
   },
   "dependencies": {
     "lodash": "^4.17.20"
   }
 }


现在，添加一个 npm script，以使我们更方便地运行 server：


package.json

{
   "name": "webpack-demo",
   "version": "1.0.0",
   "description": "",
   "private": true,
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
     "watch": "webpack --watch",
     "start": "webpack serve --open",
+    "server": "node server.js",
     "build": "webpack"
   },
   "keywords": [],
   "author": "",
   "license": "ISC",
   "devDependencies": {
     "express": "^4.17.1",
     "html-webpack-plugin": "^4.5.0",
     "webpack": "^5.4.0",
     "webpack-cli": "^4.2.0",
     "webpack-dev-middleware": "^4.0.2",
     "webpack-dev-server": "^3.11.0"
   },
   "dependencies": {
     "lodash": "^4.17.20"
   }
 }


现在，添加一个 npm script，以使我们更方便地运行 server：


package.json

{
   "name": "webpack-demo",
   "version": "1.0.0",
   "description": "",
   "private": true,
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
     "watch": "webpack --watch",
     "start": "webpack serve --open",
+    "server": "node server.js",
     "build": "webpack"
   },
   "keywords": [],
   "author": "",
   "license": "ISC",
   "devDependencies": {
     "express": "^4.17.1",
     "html-webpack-plugin": "^4.5.0",
     "webpack": "^5.4.0",
     "webpack-cli": "^4.2.0",
     "webpack-dev-middleware": "^4.0.2",
     "webpack-dev-server": "^3.11.0"
   },
   "dependencies": {
     "lodash": "^4.17.20"
   }
 }


现在，在 terminal(终端) 中执行 npm run server，将会有类似如下信息输出：


Example app listening on port 3000!
...
<i> [webpack-dev-middleware] asset index.bundle.js 1.38 MiB [emitted] (name: index)
<i> asset print.bundle.js 6.25 KiB [emitted] (name: print)
<i> asset index.html 274 bytes [emitted]
<i> runtime modules 1.9 KiB 9 modules
<i> cacheable modules 530 KiB
<i>   ./src/index.js 406 bytes [built] [code generated]
<i>   ./src/print.js 83 bytes [built] [code generated]
<i>   ./node_modules/lodash/lodash.js 530 KiB [built] [code generated]
<i> webpack 5.4.0 compiled successfully in 709 ms
<i> [webpack-dev-middleware] Compiled successfully.
<i> [webpack-dev-middleware] Compiling...
<i> [webpack-dev-middleware] assets by status 1.38 MiB [cached] 2 assets
<i> cached modules 530 KiB (javascript) 1.9 KiB (runtime) [cached] 12 modules
<i> webpack 5.4.0 compiled successfully in 19 ms
<i> [webpack-dev-middleware] Compiled successfully.


现在，在 terminal(终端) 中执行 npm run server，将会有类似如下信息输出：


Example app listening on port 3000!
...
<i> [webpack-dev-middleware] asset index.bundle.js 1.38 MiB [emitted] (name: index)
<i> asset print.bundle.js 6.25 KiB [emitted] (name: print)
<i> asset index.html 274 bytes [emitted]
<i> runtime modules 1.9 KiB 9 modules
<i> cacheable modules 530 KiB
<i>   ./src/index.js 406 bytes [built] [code generated]
<i>   ./src/print.js 83 bytes [built] [code generated]
<i>   ./node_modules/lodash/lodash.js 530 KiB [built] [code generated]
<i> webpack 5.4.0 compiled successfully in 709 ms
<i> [webpack-dev-middleware] Compiled successfully.
<i> [webpack-dev-middleware] Compiling...
<i> [webpack-dev-middleware] assets by status 1.38 MiB [cached] 2 assets
<i> cached modules 530 KiB (javascript) 1.9 KiB (runtime) [cached] 12 modules
<i> webpack 5.4.0 compiled successfully in 19 ms
<i> [webpack-dev-middleware] Compiled successfully.


现在，打开浏览器，访问 http://localhost:3000。应该看到 webpack 应用程序已经运行！


调整文本编辑器


使用自动编译代码时，可能会在保存文件时遇到一些问题。某些编辑器具有 “safe write(安全写入)” 功能，会影响重新编译。


在一些常见的编辑器中禁用此功能，查看以下列表：


  • Sublime Text 3：在用户首选项(user preferences)中添加 atomic_save: ‘false’。
  • JetBrains IDEs (e.g. WebStorm)：在 Preferences > Appearance & Behavior > System Settings 中取消选中 “Use safe write”。
  • Vim：在设置(settings)中增加 :set backupcopy=yes。


后言

创作不易，要是本文章对广大读者有那么一点点帮助 不妨三连支持一下，您的鼓励就是博主创作的动力


文章标签：
前端开发
开发工具
安全
中间件
关键词：
Webpack开发环境
鋜斗
目录
相关文章
卡尔特斯
|
JavaScript 测试技术
Webpack - Vue 配置开发环境与正式环境
Webpack - Vue 配置开发环境与正式环境
卡尔特斯
125 1
java冯坚持
|
1月前
|
JavaScript
webpack学习五：webpack的配置文件webpack.config.js分离，分离成开发环境配置文件和生产环境配置文件
这篇文章介绍了如何将webpack的配置文件分离成开发环境和生产环境的配置文件，以提高打包效率。
java冯坚持
46 1
webpack学习五：webpack的配置文件webpack.config.js分离，分离成开发环境配置文件和生产环境配置文件
卡尔特斯
|
JavaScript
Webpack 配置开发环境与正式环境
Webpack 配置开发环境与正式环境
卡尔特斯
87 0
憧憬blog
|
6月前
|
编解码 资源调度 前端开发
Webpack+Babel手把手带你搭建开发环境(内附配置文件)
Webpack+Babel手把手带你搭建开发环境(内附配置文件)
憧憬blog
85 0
小周不摆烂
|
缓存 前端开发 JavaScript
学会用Webpack搭建开发环境并打包代码
学会用Webpack搭建开发环境并打包代码
小周不摆烂
140 0
学会用Webpack搭建开发环境并打包代码
Eric_见嘉
|
JavaScript 中间件 开发工具
Webpack5 系列（三）：开发环境的设置2
Webpack5 系列（三）：开发环境的设置2
Eric_见嘉
183 0
Webpack5 系列（三）：开发环境的设置2
憧憬sBlog
|
编解码 资源调度 前端开发
Webpack+Babel手把手带你搭建开发环境(内附配置文件)
Webpack+Babel手把手带你搭建开发环境(内附配置文件)
憧憬sBlog
128 0
Eric_见嘉
|
开发者
Webpack5 系列（三）：开发环境的设置1
Webpack5 系列（三）：开发环境的设置
Eric_见嘉
75 0
海底烧烤店ai
webpack 开发环境的基本配置
webpack 开发环境的基本配置
海底烧烤店ai
211 0
webpack 开发环境的基本配置
赵小左
|
资源调度 前端开发 JavaScript
Webpack之知识初探索，搭建一个简单的webpack开发环境
Webpack之知识初探索，搭建一个简单的webpack开发环境
赵小左
106 0

热门文章

最新文章

  • 1
    Webpack构建library时的踩坑经历
  • 2
    webpack window 使用sass来编译css样式
  • 3
    vue之webpack打包原理和用法详解
  • 4
    2.2.3 使用webpack loader
  • 5
    wp2vite的妙用，让webpack项目支持vite
  • 6
    你真的理解 Webpack？请回答下列问题
  • 7
    UniApp 解决 Error: Cannot find module ‘webpack/lib/RuleSet‘
  • 8
    【网络安全】WebPack源码（前端源码）泄露 + jsmap文件还原
  • 9
    webpack指南-webpack介绍-代码分割 - CSS
  • 10
    深入了解Webpack：前端模块打包工具
  • 1
    webpack【实用教程】
    41
  • 2
    webpack 和 babel 实用教程【前端必备】
    46
  • 3
    AxiosError: Network Error at XMLHttpRequest.handleError (webpack-internal:///./node_modules/axio
    517
  • 4
    Vue 开发中的一些问题简单记录，Cannot find module ‘webpack/lib/RuleSet‘
    268
  • 5
    文本,Pinia的使用，(0 , _stores_token_js__WEBPACK_IMPORTED_MODULE_1__.useTokenStore),接口中必须用引入store.js文件
    49
  • 6
    Vue学习：webpack-dev-server和nginx问答
    54
  • 7
    vue 配置【详解】 vue.config.js （ 含 webpack 配置 ）
    68
  • 8
    Webpack整合TypeScript
    30
  • 9
    webpack配置中的3种hash值
    226
  • 10
    webpack快速入门
    25

    • 相关课程

    更多
  • 前端自动化构建工具 Webpack
  • Python Web 框架 Django 快速入门
  • Python Web 框架 Flask 快速入门
  • Java Web开发-Web应用、Tomcat、HTTP请求与响应
  • 企业Web常用架构LAMP-LNMP实战

    • 相关电子书

    更多
  • 基于webpack和npm的前端组件化实践
  • 从Web到Cloud App
  • 从Web到Cloud App——YunOS Web App 开发经验分享

    • 相关实验场景

    更多
  • Html5和Webpack3：Webpack5的常见用法
  • Html5和Webpack2：Webpack5打包JS和样式表
  • Html5和Webpack1：Webpack5打包工具介绍
  • 前端开发基础6：Node.js和LESS预编译工具
  • WEB网页编程实战
  • Web Terminal环境使用指南
    • 下一篇
    阿里云OSS设置跨域访问