欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

webpack4.x笔记-配置基本的前端开发环境(一)

程序员文章站 2022-06-03 09:33:47
webpack的基本使用 webpack 本质上是一个打包工具,它会根据代码的内容解析模块依赖,帮助我们把多个模块的代码打包。借用 webpack 官网的图片: 虽然webpack4.x的版本可以零配置开始构建,但是在实际的项目中需要其它的一些功能,还是需要一个配置文件。 安装 下面一步一步讲解配置 ......

webpack的基本使用

webpack 本质上是一个打包工具,它会根据代码的内容解析模块依赖,帮助我们把多个模块的代码打包。借用 webpack 官网的图片:

webpack4.x笔记-配置基本的前端开发环境(一)

虽然webpack4.x的版本可以零配置开始构建,但是在实际的项目中需要其它的一些功能,还是需要一个配置文件。

安装

下面一步一步讲解配置一个基本的前端开发环境过程。

首先自己环境中安装了有node(自带npm)。如果你的项目中没有package.json,那么需要使用npm init。

会在项目下生成一个package.json文件,其中会有如下代码:

{
  "name": "test",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"error: no test specified\" && exit 1"
  },
  "author": "",
  "license": "isc"
}

我们现在来使用npm来安装webpack,可以作为一个全局的命令来使用:

npm install webpack webpack-cli -g 

其中是使用webpack的命令行工具。在 4.x 版本之后不再作为 webpack 的依赖了,我们使用时需要单独安装这个工具。

更多的时候我们是把webpack作为项目的依赖来安装使用的。

npm install webpack webpack-cli -d 

package.json文件就会多了如下配置:

"devdependencies": {
    "webpack": "^4.27.1",
    "webpack-cli": "^3.1.2"
  }

我们在package.json中添加一个npm scripts:

代码如下:

"scripts": {
    "build": "webpack --mode production"
  },
  "devdependencies": {
    "webpack": "^4.27.1",
    "webpack-cli": "^3.1.2"
  }

然后我们创建一个'./src/index.js',其中index.js中的代码任意写,如:

export default {
    a:'字符串'
}

然后执行npm run build后会在项目下增加了一个dist文件夹,里面存放了webpack构建好的main.js文件。

因为是作为项目依赖进行安装,所以不会有全局的命令,npm 会帮助我们在当前项目依赖中寻找对应的命令执行,如果是全局安装的 webpack,直接执行webpack --mode production就可以。

webpack重要的几个概念

webpack 的几个重要的概念:入口,loader,plugin,输出。

入口

所谓入口,就是webpack的构建入口。webpack会读取这个文件,并从它这儿开始解析依赖,然后进行打包。如上面操作,一开始webpack默认的构建入口就是'./src/index.js'

在我们的项目中,如果是单页面应用,一般就只有一个入口;如果是多页面,那么就会配置成一个页面一个构建入口。

入口可以使用entry字段来设置,webpack支持配置多个入口进行构建打包:

module.exports = {
  entry: './src/index.js' 
}

// 上述配置等同于
module.exports = {
  entry: {
    main: './src/index.js'
  }
}

// 或者配置多个入口
module.exports = {
  entry: {
    foo: './src/page-foo.js',
    bar: './src/page-bar.js', 
    // ...
  }
}

// 使用数组来对多个文件进行打包
module.exports = {
  entry: {
    main: [
      './src/foo.js',
      './src/bar.js'
    ]
  }
}

最后的例子,可以理解为多个文件作为一个入口,webpack 会解析两个文件的依赖后进行打包。

loader

webpack 中提供一种处理多种文件格式的机制,便是使用 loader。我们可以把 loader 理解为是一个转换器,负责把某种文件格式的内容转换成 webpack 可以支持打包的模块。

举个例子,比如你的入口文件index.js引入了css样式,那么构建的时候就需要用css-loader来处理这些.css文件,同时还需要style-loader。最终打包的结果就是把不同类型的文件都解析成js代码,以便在打包后能在浏览器中运行。

当我们需要使用不同的 loader 来解析处理不同类型的文件时,我们可以在module.rules字段下配置相关的规则,比如使用babel来转化js代码:

module: {
  // ...
  rules: [
    {
      test: /\.jsx?/, // 匹配文件路径的正则表达式,通常我们都是匹配文件类型后缀
      include: [
        path.resolve(__dirname, 'src') // 指定哪些路径下的文件需要经过 loader 处理
      ],
      use: 'babel-loader', // 指定使用的 loader
    },
  ],
}

后面有笔记会详细记录下loader的使用以及怎样开发loader。

plugin

在webpack的构建工作中,除了用loader来处理模块代码的转换,剩下的工作就是用plugin来完成,下面列举常用的几个:

  • 压缩js代码:uglifyjs-webpack-plugin
  • 关联js生成html页面:html-webpack-plugin
  • 生成css文件: extract-text-webpack-plugin
  • 定义环境变量:defineplugin

js代码压缩配置如下:

const uglifyplugin = require('uglifyjs-webpack-plugin')

module.exports = {
  plugins: [
    new uglifyplugin()
  ],
}

输出

webpack 的输出即指 webpack 最终构建出来的静态文件。构建结果的文件名、路径等都是可以配置的,使用output字段:

module.exports = {
  // ...
  output: {
    path: path.resolve(__dirname, 'dist'),
    filename: 'bundle.js',
  },
}

// 或者多个入口生成不同文件
module.exports = {
  entry: {
    foo: './src/foo.js',
    bar: './src/bar.js',
  },
  output: {
    filename: '[name].js',
    path: __dirname + '/dist',
  },
}

// 路径中使用 hash,每次构建时会有一个不同 hash 值,避免发布新版本时线上使用浏览器缓存
module.exports = {
  // ...
  output: {
    filename: '[name].js',
    path: __dirname + '/dist/[hash]',
  },
}

我们刚开始构建的webpack,默认的构建结果就是'./dist/main.js'

一个简单的webpack配置例子

上面总结了几个webpack的重要概念后,来看一个简单的配置例子,webpack运行时默认读取项目下的webpack.config.js文件作为配置,那么我们现在就在项目下创建一个webpack.config.js文件:

const path = require('path')
const uglifyplugin = require('uglifyjs-webpack-plugin') //js压缩插件

module.exports = {
    entry:'./src/index.js',
    
    output:{
        path:path.resolve(__dirname,'dist'),
        filename:'bundle.js'
    },
    
    module:{
        rules:[
            {
                test:/\.jsx?/,//匹配js,jsx文件
                include:[
                    path.resolve(__dirname,'src')
                ],
                use:'babel-loader'
            }
        ]
    },
    
    // 代码模块路径解析的配置
    resolve: {
        modules: [
          "node_modules",
          path.resolve(__dirname, 'src')
        ],

        extensions: [".wasm", ".mjs", ".js", ".json", ".jsx"],
    },
    
    plugins:[
        new uglifyplugin() //使用uglifyjs-webpack-plugin压缩js代码
        //根据上面第一次的构建,你会发现webpack默认使用了js的代码压缩插件
        //这其实也是命令中的 --mode production的效果
    ]
}

当你直接运行npm run build命令的时候,会报错cannot find module 'uglifyjs-webpack-plugin'。这儿你需要安装如下内容:

  • 1.npm install uglifyjs-webpack-plugin --save-dev
  • 2.npm install -d babel-loader@7 babel-core babel-preset-env webpack
  • 3.最后执行npm run build能看到在dist文件夹下生成了一个bundle.js构建完成的文件。

vue脚手架vue-cli的webpack配置

vue-cli 使用 webpack 模板生成的项目文件中,webpack 相关配置存放在 build 目录下。现在的脚手架vue-cli的webpack好像还是用的webpack3.x版本,要注意下版本区别。

构建基本的前端开发环境

 我们构建基本的前端开发环境需要做哪些事情:

  • 构建我们发布需要的 html、css、js 文件
  • 使用 css 预处理器来编写样式
  • 处理和压缩图片
  • 使用 babel 来支持 es 新特性
  • 本地提供静态服务以方便开发调试

下面围绕这些要求要构建开发环境。

js关联html页面html-webpack-plugin

当我们构建打包完成生成了js文件,怎样把js文件跟html页面相关联呢,也就是html怎样引入js文件。当然可以使用script标签引入js文件,但是如果打包构建的js路径变化或者使用了hash命名,那么直接引入js文件就不合理了,这时就需要使用

把html-webpack-plugin安装到项目依赖中去:

npm install html-webpack-plugin -d 

首先自己按照下列目录创建模板html文件,‘./src/assets/index.html’,html内容随便写,如下:

<!doctype html>
<html>
    <head>
        <meta charset="utf-8">
        <title>这是构建的第一个web页面</title>
    </head>
    <body>
    </body>
</html>

将html-webpack-plugin配置到webpack.config.js中的plugins列表中:

module.exports = {
  // ...
  plugins: [
    new htmlwebpackplugin({
      filename: 'index.html', // 配置输出文件名和路径
      template: 'assets/index.html', // 配置文件模板
    }),
  ],
}

这样,通过 html-webpack-plugin 就可以将我们的页面和构建 js 关联起来,这样将会产生一个包含以下内容的文件dist/index.html。打开index.html可以看到构建后的代码如下:

<!doctype html>
<html>
    <head>
        <meta charset="utf-8">
        <title>这是构建的第一个web页面</title>
    </head>
    <body>
    <script type="text/javascript" src="bundle.js"></script></body>
</html>

详细了解可参考文档, 官网提供的例子

 构建css

我们构建css需要使用css-loader和style-loader。

module.exports = {
  module: {
    rules: [
      // ...
      {
        test: /\.css/,
        include: [
          path.resolve(__dirname, 'src'),
        ],
        use: [
          'style-loader',
          'css-loader',
        ],
      },
    ],
  }
}

注:style-loader 和 css-loader 都是单独的 node package,需要安装。

我们创建一个index.css,在index.js中引入:

import './index.css'

index.css里面随便编写一段css代码:

.title{
    font-weight: bold;
    font-size:20px;
    color:red;
}

模板index.html改成如下:

<!doctype html>
<html>
    <head>
        <meta charset="utf-8">
        <title><%= htmlwebpackplugin.options.title %></title>
    </head>
    <body>
        <div class="title">这是一个主题</div>
    </body>
</html>

安装style-loader与css-loader:

npm install style-loader css-loader --save-dev

现在执行npm run build,然后去看生成的index.html,效果有了,css样式添加上了。但是并没有生成css文件。

解释下css-loader跟style-loader的作用:

  • css-loader 负责解析 css 代码,主要是为了处理 css 中的依赖,例如@importurl()等引用外部文件的声明;
  • style-loader 会将 css-loader 解析的结果转变成 js 代码,运行时动态插入style标签来让 css 代码生效。

如果需要单独把 css 文件分离出来,我们需要使用

由于webpack4.x的extract-text-webpack-plugin版本还没有发布正式版,安装的时候需要指定使用它的 alpha 版本:

npm install extract-text-webpack-plugin@next -d

配置:

const extracttextplugin = require('extract-text-webpack-plugin')

module.exports = {
  // ...
  module: {
    rules: [
      {
        test: /\.css$/,
        // 因为这个插件需要干涉模块转换的内容,所以需要使用它对应的 loader
        use: extracttextplugin.extract({ 
          fallback: 'style-loader',
          use: 'css-loader',
        }), 
      },
    ],
  },
  plugins: [
    // 引入插件,配置文件名,这里同样可以使用 [hash]
    new extracttextplugin('index.css'),
  ],
}

然后就会在dist文件夹下多生成一个index.css文件。详细可参考:

css 预处理器

通常我们在编写css的时候,经常使用less或者sass等css预处理器,我们以less为例,我们把index.css改成index.less如下:

@fontsize:20px;
.title{
    font-weight: bold;
    font-size:@fontsize;
    color:red;
}

安装less-loader,官网文档对应:

npm install --save-dev less-loader less

 对应的配置文件修改为:

module.exports = {
  // ...
  module: {
    rules: [
      {
        test: /\.less$/,
        // 因为这个插件需要干涉模块转换的内容,所以需要使用它对应的 loader
        use: extracttextplugin.extract({ 
          fallback: 'style-loader',
          use: [
            'css-loader', 
            'less-loader',
          ],
        }), 
      },
    ],
  },
  // ...
}

 处理图片文件file-loader及增强版url-loader

file-loader

虽然css-loader会解析样式中用url()引用的文件路径,但是图片有jpg/png/gif格式,webpack处理不了,需要使用一个loader配置才行,这就用到了file-loader。

file-loader 可以用于处理很多类型的文件,它的主要作用是直接输出文件,把构建后的文件路径返回。

配置如下:

module.exports = {
  // ...
  module: {
    rules: [
      {
        test: /\.(png|jpg|gif)$/,
        use: [
          {
            loader: 'file-loader',
            options: {},
          },
        ],
      },
    ],
  },
}

安装file-loader,官方文档:

npm install --save-dev file-loader

我在index.js引入一张图片:

import '../assets/a.jpg'

运行结果默认在dist目录下生成了78414f2de9fc47d29f335727a717bc3d.jpg。默认情况下,生成的文件的文件名就是文件内容的 md5 哈希值并会保留所引用资源的原始扩展名。

当然也可以配置输出路径,文件名称等,如下:

{
    test:/\.(jpg|png|gif)$/,
    use:[
        {
            loader:'file-loader',
            options:{
                name: '[path][name].[ext]',
                outputpath: 'images/'
            }
        }
    ]
}        

url-loader

 安装url-loader,详细文档请参考官网:

url-loader功能类似于file-loader,但是在文件大小(单位 byte)低于指定的限制时,可以返回一个 dataurl。

npm install --save-dev url-loader

配置:

module.exports = {
  module: {
    rules: [
      {
        test: /\.(png|jpg|gif)$/i,
        use: [
          {
            loader: 'url-loader',
            options: {
              limit: 8192
            }
          }
        ]
      }
    ]
  }
}

使用 babel

babel是一个让我们能够使用 es 新特性的 js 编译工具,我们可以在 webpack 中配置 babel,以便使用 es6、es7 标准来编写 js 代码。

前面已经写过配置了,代码如下:

module.exports = {
  // ...
  module: {
    rules: [
      {
        test: /\.jsx?/, // 支持 js 和 jsx
        include: [
          path.resolve(__dirname, 'src'), // src 目录下的才需要经过 babel-loader 处理
        ],
        loader: 'babel-loader',
      },
    ],
  },
}

babel 的相关配置可以在目录下使用 .babelrc 文件来处理,详细参考 babel 官方文档 .babelrc

使用 webpack-dev-server启动静态服务

我们可以使用 在本地开启一个简单的静态服务来进行开发。

安装webpack-dev-server:

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

然后添加启动命令到 package.json 中:

"scripts": {
  "build": "webpack --mode production",
  "start": "webpack-dev-server --mode development"
}

然后运行npm run start,然后就可以访问 http://localhost:8080/ 来查看你的页面了。默认是访问 index.html,如果是其他页面要注意访问的 url 是否正确。

总结

根据上面的配置,我们已经完成了配置一个简单的前端开发环境,实现了:构建 html、css、js 文件、使用 css 预处理器来编写样式、处理和压缩图片、使用 babel、方便开发调试的静态服务。下面的笔记会记录webpack的一些细节来更好的了解webpack。