詳解webpack中四個基礎概念

前面的話

　　webpack是當下最熱門的前端資源模組化管理與包裝工具。它可以將許多鬆散的模組按照依賴和規則打包成符合生產環境部署的前端資源。當webpack處理應用程式時，它會遞歸地建立一個依賴關係圖表(dependency graph)，其中包含應用程式所需的每個模組，然後將所有這些模組打包成少量的bundle(通常只有一個)，由瀏覽器載入.它是高度可配置的，在開始前需要先理解四個核心概念：入口(entry)、輸出(output)、載入器(loader)、插件(plugins)。本文將詳細介紹webpack的這四個基礎概念

 

入口

#　　webpack將建立所有應用程式的依賴關係圖表。圖表的起點稱為入口起點(entry point)。入口起點告訴 webpack 從哪裡開始，並遵循著依賴關係圖表知道要打包什麼。可以將應用程式的入口起點認為是根上下文或app 第一個啟動檔案

　　類比類比於requirejs中的入口檔案main.js，最後使用r.js打包時，都會打包在main.js裡

　　在webpack中，使用webpack配置物件中的entry屬性來定義入口，包含以下多種方式

【單一入口（簡寫）語法】

　　用法：entry : string|Array

　　[注意]在設定entry屬性時，如果是目前頁面，一定要在屬性值前面設定為'./'，否則無法辨識

//webpack.config.jsvar config = {
  entry: './path/to/my/entry/file.js'};

　　entry屬性的單一入口語法，是下面的簡寫：

//webpack.config.jsvar config = {
  entry: {
    main: './path/to/my/entry/file.js'
  }
};

　　向entry傳入一個陣列時，將建立「多個主入口(multi-main entry)」

entry:['./entry1','./entry2']

【物件語法】

　　用法：entry: {[entryChunkName: string]: string|Array}

#

//webpack.config.jsvar config = {
  entry: {
    app: './src/app.js',
    vendors: './src/vendors.js'
  }
};

　　物件語法會比較繁瑣。然而，這是應用程式中定義入口的最可擴展的方式

　　從上面的程式碼可知，webpack從app.js和vendors.js開始建立依賴圖表。這些圖表是彼此完全分離、互相獨立的。這種方式比較常見於，只有一個入口起點(不包括vendor)的單頁應用程式(single page application)中

 

出口

　　將所有的資源(assets)歸攏在一起後，還需要告訴webpack在哪裡打包應用程式。 webpack的output屬性描述如何處理歸攏在一起的程式碼(bundled code)

//webpack.config.jsvar path = require('path');
module.exports = {
  entry: './path/to/my/entry/file.js',
  output: {
    path: path.resolve(__dirname, 'dist'),
    filename: 'my-first-webpack.bundle.js'
  }
};

　　在上面的程式碼中，我們透過output.filename和output.path屬性，來告訴webpack bundle的名稱，以及我們想要產生(emit)到哪裡

　　[注意]即使可以存在多個入口起點，但只指定一個輸出配置，如下所示output的filename必須為[name]或其類似，不能為確定的名稱，否則會提示Conflict: Multiple assets emit to the same filename bundle.js，翻譯過來是多入口不能指定出口檔案中同樣的filename名稱

  entry: {'main': './entry.js','hello':'./hello.js'
  },
  output: {
    path: __dirname,//出口路径filename: '[name].js'//出口名称
  }

　

【用法(Usage)】

　　在webpack中配置output屬性，需要將它的值設為一個對象，並包含filename和path屬性這兩個必選項

　　filename:編譯檔案的檔案名，首選推薦：//main.js||bundle.js||index.js

　　path:對應一個絕對路徑，此路徑是希望一次打包的目錄

 config ='bundle.js''/home/proj/public/assets'

【選項(Options)】

output.chunkFilename

　　非入口的chunk(non-entry chunk)的檔名，路徑相對於output.path目錄

[id] 被chunk的id替换
[name] 被chunk的name替换（或者，在chunk没有name时使用id替换）
[hash] 被compilation生命周期的hash替换
[chunkhash] 被chunk的hash替换

#output.crossOriginLoading

　　此選項可以啟用跨網域載入(cross -origin loading)chunk，可選的值有：

false - 禁用跨域加载(默认值)"anonymous" - 启用跨域加载。当使用 anonymous 时，发送不带凭据(credential)的请求。"use-credentials" - 启用跨域加载。发送带凭据(credential)的请求

#output.devtoolLineToLine

　　所有/指定模組啟用行到行映射( line-to-line mapped)模式。行到行映射模式使用一個簡單的SourceMap，也就是產生資源(generated source)的每一行都會對應到原始資源(original source)的同一行。這是一個可做效能優化之處。當需要更好的效能，並且只要確保輸入行(input line)和生成行(generated line)匹配時，才會考慮啟用

<span style="color: #0000ff;">true</span><span style="color: #000000;"> 在所有模块启用（不推荐）
{test, include, exclude} 对象，对特定文件启用（类似于 module.loaders）<br>默认值：</span><span style="color: #0000ff;">false</span>

output.filename

　　指定硬碟每個輸出檔案的名稱。這裡不能指定為絕對路徑。 output.path選項規定了檔案被寫入硬碟的位置。 filename僅用於命名每個檔案

//单个入口{
  entry: './src/app.js',
  output: {
    filename: 'bundle.js',
    path: __dirname + '/build'
  }
}

//多个入口{
  entry: {
    app: './src/app.js',
    search: './src/search.js'
  },
  output: {
    filename: '[name].js',//被 chunk 的 name 替换path: __dirname + '/build'
  }
}

#output.hotUpdateChunkFilename

##　　熱更新chunk(Hot Update Chunk )的檔名。它們在output.path目錄中

[id] 被chunk的id替换
[hash] 被compilation生命周期的hash替换。（最后一个hash存储在记录中）
默认值："[id].[hash].hot-update.js?1.1.11"

output.hotUpdateFunction

　　webpack中用於異步載入(async load)熱更新(hot update )chunk的JSONP函數

默认值："webpackHotUpdate"

output.hotUpdateMainFilename

　　热更新主文件(hot update main file)的文件名

[hash] 被compilation生命周期的hash替换。（最后一个hash存储在记录中）
默认值："[hash].hot-update.json"

output.jsonpFunction

　　webpack中用于异步加载(async loading)chunk的JSONP函数

　　较短的函数可能会减少文件大小。当单页有多个webpack实例时，请使用不同的标识符(identifier)

默认值："webpackJsonp"

output.library

　　如果设置此选项，会将bundle导出为library。output.library是library的名称。

　　如果正在编写library，并且需要将其发布为单独的文件，请使用此选项

output.libraryTarget

　　library的导出格式

"var" - 导出为一个变量： Library ="this" - 导出为  的一个属性：["Library"] ="commonjs" - 导出为 exports 的一个属性：exports["Library"] ="commonjs2" - 通过 module.exports：module.exports ="amd" - 导出为 AMD（可选命名 -"umd" -

　　如果output.library未设置，但是output.libraryTarget被设置为var以外的值，则「所导出对象」的每个属性都被复制到「对应的被导出对象」上（除了amd，commonjs2和umd）

output.publicPath

　　一般地，publicPath用于设置上线地址，在开发过程中，该值不需要设置

output: {
    filename:'main.js'path: "/home/proj/public/assets",
    publicPath: "http://cdn.com"}

　　以上面代码为例，最终main.js的线上地址是'http://cdn.com/home/proj/public/assets/main.js'

output.path

　　导出目录为绝对路径（必选项）

//config.jsoutput: {
    path: "/home/proj/public/assets",
    publicPath: "/assets/"}//index.html<head>
  <link href="/assets/spinner.gif"/>
</head>

//config.jsoutput: {
    path: "/home/proj/cdn/assets/[hash]",
    publicPath: "http://cdn.example.com/assets/[hash]/"}

　　[注意]在编译时不知道最终输出文件的 publicPath 的情况下，publicPath 可以留空，并且在入口起点文件运行时动态设置。如果你在编译时不知道 publicPath，你可以先忽略它，并且在入口起点设置 __webpack_public_path__

 __webpack_public_path__ = myRuntimePublicPath

output.sourceMapFilename

　　JavaScript 文件的 SourceMap 的文件名

[file] 被 JavaScript 文件的文件名替换
默认值："[file].map"

 

加载器

　　webpack的目标是，让webpack聚焦于项目中的所有资源(asset)，而浏览器不需要关注考虑这些。webpack把每个文件(.css,.html,.scss,.jpg,etc.)都作为模块处理。然而webpack只理解JavaScript。webpack loader会将这些文件转换为模块，而转换后的文件会被添加到依赖图表中

　　loader可以使你在require()或"加载"模块时预处理文件。因此，loader类似于其他构建工具中“任务(task)”，并提供了处理前端构建步骤的强大方法

　　webpack的配置要能识别出(identify)应该被对应的loader进行转换(transform)的那些文件。由于进行过文件转换，所以能够将被转换的文件添加到依赖图表(并且最终添加到bundle中)(use属性)

var path = require('path');var config = {
  entry: './path/to/my/entry/file.js',
  output: {
    path: path.resolve(__dirname, 'dist'),
    filename: 'my-first-webpack.bundle.js'
  },
  module: {
    rules: [
      {test: /\.(js|jsx)$/, use: 'babel-loader'}
    ]
  }
};
module.exports = config;

　　以上配置中，对一个单独的module对象定义了rules属性，里面包含两个必须属性：test和use。相当于告诉webpack compiler，碰到「在require()/import语句中被解析为'.js'或'.jsx'的路径」时，在把它们添加并打包之前，要先使用babel-loader去转换”

　　[注意]在webpack配置中定义loader时，要定义在module.rules中，而不是rules。在定义错误时webpack会给出严重的警告

【示例】

　　例如，使用loader加载CSS文件，或将TypeScript转为JavaScript。首先，安装对应的loader：

npm install --save-dev css-loader
npm install --save-dev ts-loader

　　其次，配置webpack.config.js，对每个.css文件使用css-loader，然后类似地，对每个.ts文件使用ts-loader：

//webpack.config.jsmodule.exports = {
  module: {
    rules: [
      {test: /\.css$/, use: 'css-loader'},
      {test: /\.ts$/, use: 'ts-loader'}
    ]
  }
};

　　[注意]根据配置选项，下面的规范定义了同等的loader用法：

{test: /\.css$/, loader: 'css-loader'}// 等同于{test: /\.css$/, use: 'css-loader'}// 等同于{test: /\.css$/, use: {
  loader: 'css-loader',
  options: {}
}}

【配置】

　　在应用程序中，有三种使用 loader 的方式：1、通过配置；2、在 require 语句中显示使用；3、通过 CLI

通过配置

　　module.rules允许在webpack配置中指定几个loader。 这是展示loader的一种简明的方式，并且有助于使代码变得简洁。而且对每个相应的loader有一个完整的概述

module: {
  rules: [
    {
      test: /\.css$/,
      use: [
        { loader: 'style-loader'},
        {
          loader: 'css-loader',
          options: {
            modules: true  }
        }
      ]
    }
  ]
}

通过require

　　可以在require语句（或define,require.ensure,等语句）中指定loader。使用!将资源中的loader分开。分开的每个部分都相对于当前目录解析

require('style-loader!css-loader?modules!./styles.css');

　　通过前置所有规则及使用!，可以对应覆盖到配置中的任意loader

　　选项可以传递查询参数，就像在web中那样（?key=value&foo=bar）。也可以使用JSON对象（?{"key":"value","foo":"bar"}）

通过CLI

webpack --module-bind jade-loader --module-bind 'css=style-loader!css-loader'

　　这会对 .jade 文件使用 jade-loader，对 .css 文件使用 style-loader 和 css-loader

【特性】

　　loader 支持链式传递。能够对资源使用流水线(pipeline)。loader 链式地按照先后顺序进行编译。loader 链中的第一个 loader 返回值给下一个 loader。在最后一个 loader，返回 webpack 所预期的 JavaScript

　　loader 可以是同步或异步函数。loader 运行在 Node.js 中，并且能够执行任何可能的操作

　　loader 接收查询参数。用于 loader 间传递配置。loader 也能够使用 options 对象进行配置

　　除了使用 package.json 常见的 main 属性，还可以将普通的 npm 模块导出为 loader，做法是在 package.json 里定义一个 loader 字段

　　插件(plugin)可以为 loader 带来更多特性。loader 能够产生额外的任意文件。

　　loader 通过（loader）预处理函数，为 JavaScript 生态系统提供了更多有力功能。用户现在可以更加灵活的引入细粒度逻辑，例如压缩(compression)、打包(package)、语言翻译(language translation)和其他更多

【解析】

　　loader 遵循标准的模块解析。多数情况下，loader 将从模块路径（通常将模块路径认为是 npm install, node_modules）解析。

　　loader 模块需要导出为一个函数，并且使用 Node.js 兼容的 JavaScript 编写。在通常情况下，可以使用 npm 来管理 loader，也可以将 loader 模块作为应用程序中的文件。按照约定，loader 通常被命名为 xxx-loader（例如 json-loader）

 

插件

　　插件是wepback的支柱功能。在使用webpack配置时，webpack自身也构建于同样的插件系统上。插件目的在于解决loader无法实现的其他事情。由于loader仅在每个文件的基础上执行转换，而插件(plugins)最常用于（但不限于）在打包模块的“compilation”和“chunk”生命周期执行操作和自定义功能。webpack的插件系统极其强大和可定制化。

　　想要使用一个插件，只需要require()它，然后把它添加到plugins数组中。多数插件可以通过选项(option)自定义。也可以在一个配置文件中因为不同目的而多次使用同一个插件，需要使用new创建实例来调用它

【剖析】

　　webpack插件是一个具有apply属性的JavaScript对象。apply属性会被webpack compiler调用，并且compiler对象可在整个compilation生命周期访问

//ConsoleLogOnBuildWebpackPlugin.jsfunction ConsoleLogOnBuildWebpackPlugin() {

};
ConsoleLogOnBuildWebpackPlugin.prototype.apply = function(compiler) {
  compiler.plugin('run', function(compiler, callback) {
    console.log("webpack 构建过程开始！！！");

    callback();
  });
};

【用法】

　　由于plugin可以携带参数/选项，必须在wepback配置中，向plugins属性传入new实例

var HtmlWebpackPlugin = require('html-webpack-plugin'); //通过 npm 安装var webpack = require('webpack'); //访问内置的插件var path = require('path');var config = {
  entry: './path/to/my/entry/file.js',
  output: {
    filename: 'my-first-webpack.bundle.js',
    path: path.resolve(__dirname, 'dist')
  },
  module: {
    loaders: [
      {
        test: /\.(js|jsx)$/,
        loader: 'babel-loader'  }
    ]
  },
  plugins: [new webpack.optimize.UglifyJsPlugin(),new HtmlWebpackPlugin({template: './src/index.html'})
  ]
};
module.exports = config;

 

以上是詳解webpack中四個基礎概念的詳細內容。更多資訊請關注PHP中文網其他相關文章！