基于webpack搭建前端工程解决方案探索

Dear 丶 2022-08-09 06:15 181阅读 0赞

## 关于前端工程 ##

下面是百科关于“[软件工程][Link 1]”的名词解释：

> 软件工程是一门研究用工程化方法构建和维护有效的、实用的和高质量的软件的学科。

其中，工程化是方法，是将软件研发的各个链路串接起来的工具。

有IDE的支持，负责初始化工程、工程结构组织、debug、编译、打包等工作对于软件“工程化”，个人以为至少应当有如下特点：

*  有固定或者约定的工程结构，规定软件所依赖的不同类别的资源的存放路径甚至代码的写法等
 *  软件依赖的资源可能来自软件开发者，也有可能是第三方，工程化需要集成对资源的获取、打包、发布、版本管理等能力
 *  和其他系统的集成，如CI系统、运维系统、监控系统等

广泛意义上讲，前端也属于软件工程的范畴。

但前端没有Eclipse、Visual Studio等为特定语言量身打造的IDE。因为前端不需要编译，即改即生效，在开发和调试时足够方便，只需要打开个浏览器即可完成，所以前端一般不会扯到“工程”这个概念。

在很长一段时间里，前端很简单，比如下面简单的几行代码就能够成一个可运行前端应用：

<!DOCTYPE html>
    <html>
    <head>
        <title>webapp</title>
        <link rel="stylesheet" href="app.css">
    </head>
    <body>
        <h1>app title</h1>
        <script src="app.js"></script>
    </body>
    </html>

但随着webapp的复杂程度不断在增加，前端也在变得很庞大和复杂，按照传统的开发方式会让前端失控：代码庞大难以维护、性能优化难做、开发成本变高。

感谢Node.js，使得JavaScript这门前端的主力语言突破了浏览器环境的限制可以独立运行在OS之上，这让JavaScript拥有了文件IO、网络IO的能力，前端可以根据需要任意定制研发辅助工具。

一时间出现了以Grunt、Gulp为代表的一批前端构建工具，“前端工程”这个概念逐渐被强调和重视。但是由于前端的复杂性和特殊性，前端工程化一直很难做，构建工具有太多局限性。

诚如张云龙[@fouber][fouber]所言：

> 前端是一种特殊的GUI软件，它有两个特殊性：一是前端由三种编程语言组成，二是前端代码在用户端运行时增量安装。

html、css和js的配合才能保证webapp的运行，增量安装是按需加载的需要。开发完成后输出三种以上不同格式的静态资源，静态资源之间有可能存在互相依赖关系，最终构成一个复杂的资源依赖树（甚至网）。

所以，前端工程，最起码需要解决以下问题：

*  提供开发所需的一整套运行环境，这和IDE作用类似
 *  资源管理，包括资源获取、依赖处理、实时更新、按需加载、公共模块管理等
 *  打通研发链路的各个环节，debug、mock、proxy、test、build、deploy等

其中，资源管理是前端最需要也是最难做的一个环节。

注：个人以为，与前端工程化对应的另一个重要的领域是前端组件化，前者属于工具，解决研发效率问题，后者属于前端生态，解决代码复用的问题，本篇对于后者不做深入。

## 前端工程化的探索 ##

前端工程化的建设，早前的做法是使用Grunt、Gulp等构建工具。但本质上它们只是一个任务调度器，将功能独立的任务拆解出来，按需组合运行任务。如果要完成前端工程化，这两者配置门槛很高，每一个任务都需要开发者自行使用插件解决，而且对于资源的依赖管理能力太弱。

在国内，百度出品的[fis][]也是一种不错的工程化工具的选择，fis内部也解决了资源依赖管理的问题。因笔者没有在项目中实践过fis，所以不进行更多的评价。

webpack以一种非常优雅的方式解决了前端资源依赖管理的问题，它在内部已经集成了许多资源依赖处理的细节，但是对于使用者而言只需要做少量的配置，再结合构建工具，很容易搭建一套前端工程解决方案。

基于webpack的前端自动化工具，可以自由组合各种开源技术栈（Koa/Express/其他web框架、webpack、Sass/Less/Stylus、Gulp/Grunt等），没有复杂的资源依赖配置，工程结构也相对简单和灵活。

在此以开发一个多页面型webapp为例，给出上面所提出的问题的解决方案。

## 前端开发环境搭建 ##

### 主要目录结构 ###

- webapp/               # webapp根目录
      - src/                # 开发目录
        + css/              # sass生成的css资源目录
        + img/              # webapp图片资源目录
        - js/               # webapp js&jsx资源目录
          - components/     # 标准组件存放目录
              - foo/        # 组件foo
                + css/      # 组件foo的样式
                + js/       # 组件foo的逻辑
                + tmpl/     # 组件foo的模板
                index.js    # 组件foo的入口
              + bar/        # 组件bar
          + lib/            # 第三方纯js库
          ...               # 根据项目需要任意添加的代码目录
        + tmpl/             # webapp前端模板资源目录
        a.html              # webapp入口文件a
        b.html              # webapp入口文件b
      - assets/             # 编译输出目录，即发布目录
        + js/               # 编译输出的js目录
        + img/              # 编译输出的图片目录
        + css/              # 编译输出的css目录
        a.html              # 编译输出的入口a
        b.html              # 编译处理后的入口b
      + mock/               # 假数据目录
      app.js                # 本地server入口
      routes.js             # 本地路由配置
      webpack.config.js     # webpack配置文件
      gulpfile.js           # gulp任务配置
      package.json          # 项目配置
      README.md             # 项目说明

这是个经典的前端项目目录结构，项目目结构在一定程度上约定了开发规范。业务开发的同学只需关注`src`目录即可，开发时尽可能最小化模块粒度，这是异步加载的需要。`assets`是整个工程的产出，无需关注里边的内容是什么，至于怎么打包和解决资源依赖的，往下看。

### 本地开发环境 ###

我们使用开源web框架搭建一个webserver，便于本地开发和调试，以及灵活地处理前端路由，以`koa`为例，主要代码如下：

// app.js
    var http = require('http');
    var koa = require('koa');
    var serve = require('koa-static');
    
    var app = koa();
    var debug = process.env.NODE_ENV !== 'production';
    // 开发环境和生产环境对应不同的目录
    var viewDir = debug ? 'src' : 'assets';
    
    // 处理静态资源和入口文件
    app.use(serve(path.resolve(__dirname, viewDir), {
        maxage: 0
    }));
    
    app = http.createServer(app.callback());
    
    app.listen(3005, '0.0.0.0', function() { 
        console.log('app listen success.');
    });

运行`node app`启动本地server，浏览器输入`http://localhost:8080/a.html`即可看到页面内容，最基本的环境就算搭建完成。

如果只是处理静态资源请求，可以有很多的替代方案，如Fiddler替换文件、本地起Nginx服务器等等。搭建一个Web服务器，它能够非常灵活地配置路由和处理动态请求，可以任意定制开发环境的个性化需求用于提升开发效率，总之local webserver拥有无限的可能。

### 定制动态请求 ###

我们的local server是`localhost`域，在ajax请求时为了突破前端同源策略的限制，本地server需支持代理其他域下的api的功能，即proxy。同时还要支持对未完成的api进行mock的功能。

// app.js
    var router = require('koa-router')();
    var routes = require('./routes');
    routes(router, app);
    app.use(router.routes());
     ```
    
    ``` js
    // routes.js
    var proxy = require('koa-proxy');
    var list = require('./mock/list');
    module.exports = function(router, app) {
        // mock api
        // 可以根据需要任意定制接口的返回
        router.get('/api/list', function*() {
            var query = this.query || {};
            var offset = query.offset || 0;
            var limit = query.limit || 10;
            var diff = limit - list.length;
    
            if(diff <= 0) {
                this.body = {code: 0, data: list.slice(0, limit)};
            } else {
                var arr = list.slice(0, list.length);
                var i = 0;
                while(diff--) arr.push(arr[i++]);
                this.body = {code: 0, data: arr};
            }
        });
        // proxy api
        router.get('/api/foo/bar', proxy({url: 'http://foo.bar.com'}));
    }

## webpack资源管理 ##

### 资源的获取 ###

ECMAScript 6之前，前端的模块化一直没有统一的标准，仅前端包管理系统就有好几个。所以任何一个库实现的loader都不得不去兼容基于多种模块化标准开发的模块。

webpack同时提供了对CommonJS、AMD和ES6模块化标准的支持，对于非前三种标准开发的模块，webpack提供了[shimming modules][]的功能。

受Node.js的影响，越来越多的前端开发者开始采用CommonJS作为模块开发标准，`npm`已经逐渐成为前端模块的托管平台，这大大降低了前后端模块复用的难度。

在webpack配置项里，可以把node\_modules路径添加到resolve search root列表里边，这样就可以直接load npm模块了：

// webpack.config.js
    resolve: {
        root: [process.cwd() + '/src', process.cwd() + '/node_modules'],
        alias: {},
        extensions: ['', '.js', '.css', '.scss', '.ejs', '.png', '.jpg']
    },
    
    <div class="se-preview-section-delimiter"></div>
    $ npm install jquery react --save
    
    <div class="se-preview-section-delimiter"></div>
    // page-x.js
    import $ from 'jquery';
    import React from 'react';

### 资源引用 ###

根据webpack的设计理念，所有资源都是“模块”，webpack内部实现了一套资源加载机制，这与Requirejs、Sea.js、Browserify等实现有所不同，除了借助插件体系加载不同类型的资源文件之外，webpack还对输出结果提供了非常精细的控制能力，开发者只需要根据需要调整参数即可：

// webpack.config.js
    // webpack loaders的配置示例
    ...
    loaders: [
        {
            test: /\.(jpe?g|png|gif|svg)$/i,
            loaders: [
                'image?{bypassOnDebug: true, progressive:true, \
                    optimizationLevel: 3, pngquant:{quality: "65-80"}}',
                'url?limit=10000&name=img/[hash:8].[name].[ext]',
            ]
        },
        {
            test: /\.(woff|eot|ttf)$/i,
            loader: 'url?limit=10000&name=fonts/[hash:8].[name].[ext]'
        },
        {test: /\.(tpl|ejs)$/, loader: 'ejs'},
        {test: /\.js$/, loader: 'jsx'},
        {test: /\.css$/, loader: 'style!css'},
        {test: /\.scss$/, loader: 'style!css!scss'},
    ]
    ...

简单解释下上面的代码，`test`项表示匹配的资源类型，`loader`或`loaders`项表示用来加载这种类型的资源的loader，loader的使用可以参考[using loaders][]，更多的loader可以参考[list of loaders][]。

对于开发者来说，使用loader很简单，最好先配置好特定类型的资源对应的loaders，在业务代码直接使用webpack提供的`require（source path）`接口即可：

// a.js
    // 加载css资源
    require('../css/a.css');
    
    // 加载其他js资源
    var foo = require('./widgets/foo');
    var bar = require('./widgets/bar');
    
    // 加载图片资源
    var loadingImg = require('../img/loading.png');
    
    var img = document.createElement('img');
    
    img.src = loadingImg;

注意，`require()`还支持在资源path前面指定loader，即`require(![loaders list]![source path])`形式：

require("!style!css!less!bootstrap/less/bootstrap.less");
    // “bootstrap.less”这个资源会先被"less-loader"处理，
    // 其结果又会被"css-loader"处理，接着是"style-loader"
    // 可类比pipe操作

require()时指定的loader会覆盖配置文件里对应的loader配置项。

### 资源依赖处理 ###

通过loader机制，可以不需要做额外的转换即可加载浏览器不直接支持的资源类型，如`.scss`、`.less`、`.json`、`.ejs`等。

但是对于css、js和图片，采用webpack加载和直接采用标签引用加载，有何不同呢？

运行webpack的打包命令，可以得到`a.js`的输出的结果：

webpackJsonp([0], {
        /***/0:
        /***/function(module, exports, __webpack_require__) {
    
            __webpack_require__(6);
    
            var foo = __webpack_require__(25);
            var bar = __webpack_require__(26);
    
            var loadingImg = __webpack_require__(24);
            var img = document.createElement('img');
    
            img.src = loadingImg;
        },
    
        /***/6:
        /***/function(module, exports, __webpack_require__) {
            ...
        },
    
        /***/7:
        /***/function(module, exports, __webpack_require__) {
            ...
        },
    
        /***/24:
        /***/function(module, exports) {
            ...
        },
    
        /***/25:
        /***/function(module, exports) {
            ...
        },
    
        /***/26:
        /***/function(module, exports) {
            ...
        }
    });

从输出结果可以看到，webpack内部实现了一个全局的`webpackJsonp()`用于加载处理后的资源，并且webpack把资源进行重新编号，每一个资源成为一个模块，对应一个id，后边是模块的内部实现，而这些操作都是webpack内部处理的，使用者无需关心内部细节甚至输出结果。

上面的输出代码，因篇幅限制删除了其他模块的内部实现细节，完整的输出请看[a.out.js][]，来看看图片的输出：

/***/24:
    /***/function(module, exports) {
    
        module.exports = "data:image/png;base64,...";
    
        /***/
    }

注意到图片资源的loader配置：

{
        test: /\.(jpe?g|png|gif|svg)$/i,
        loaders: [
            'image?...',
            'url?limit=10000&name=img/[hash:8].[name].[ext]',
        ]
    }

意思是，图片资源在加载时先压缩，然后当内容size小于~10KB时，会自动转成base64的方式内嵌进去，这样可以减少一个HTTP的请求。当图片大于10KB时，则会在`img/`下生成压缩后的图片，命名是`[hash:8].[name].[ext]`的形式。`hash:8`的意思是取图片内容hushsum值的前8位，这样做能够保证引用的是图片资源的最新修改版本，保证浏览器端能够即时更新。

对于css文件，默认情况下webpack会把css content内嵌到js里边，运行时会使用`style`标签内联。如果希望将css使用`link`标签引入，可以使用`ExtractTextPlugin`插件进行提取。

### 资源的编译输出 ###

webpack的三个概念：模块（module）、入口文件（entry）、分块（chunk）。

其中，module指各种资源文件，如js、css、图片、svg、scss、less等等，一切资源皆被当做模块。

webpack编译输出的文件包括以下2种：

*  entry：入口，可以是一个或者多个资源合并而成，由html通过script标签引入
 *  chunk：被entry所依赖的额外的代码块，同样可以包含一个或者多个文件

下面是一段entry和output项的配置示例：

entry: {
        a: './src/js/a.js'
    },
    output: {
        path: path.resolve(debug ? '__build' : './assets/'),
        filename: debug ? '[name].js' : 'js/[chunkhash:8].[name].min.js',
        chunkFilename: debug ? '[chunkhash:8].chunk.js' : 'js/[chunkhash:8].chunk.min.js',
        publicPath: debug ? '/__build/' : ''
    }

其中`entry`项是入口文件路径映射表，`output`项是对输出文件路径和名称的配置，占位符如`[id]`、`[chunkhash]`、`[name]`等分别代表编译后的模块id、chunk的hashnum值、chunk名等，可以任意组合决定最终输出的资源格式。hashnum的做法，基本上弱化了版本号的概念，版本迭代的时候chunk是否更新只取决于chnuk的内容是否发生变化。

细心的同学可能会有疑问，entry表示入口文件，需要手动指定，那么chunk到底是什么，chunk是怎么生成的？

在开发webapp时，总会有一些功能是使用过程中才会用到的，出于性能优化的需要，对于这部分资源我们希望做成异步加载，所以这部分的代码一般不用打包到入口文件里边。

对于这一点，webpack提供了非常好的支持，即[code splitting][]，即使用`require.ensure()`作为代码分割的标识。

例如某个需求场景，根据url参数，加载不同的两个UI组件，示例代码如下：

url分别输入不同的参数后得到瀑布图：

![code_splitting1.jpg][]

![code_splitting2.jpg][]

webpack将`require.ensure()`包裹的部分单独打包了，即图中看到的`[hash].chunk.js`，既解决了异步加载的问题，又保证了加载到的是最新的chunk的内容。

假设app还有一个入口页面`b.html`，那麽就需要相应的再增加一个入口文件`b.js`，直接在`entry`项配置即可。多个入口文件之间可能公用一个模块，可以使用`CommonsChunkPlugin`插件对指定的chunks进行公共模块的提取，下面代码示例演示提取所有入口文件公用的模块，将其独立打包：

var chunks = Object.keys(entries);
    
    plugins: [
        new CommonsChunkPlugin({
            name: 'vendors', // 将公共模块提取，生成名为`vendors`的chunk
            chunks: chunks,
            minChunks: chunks.length // 提取所有entry共同依赖的模块
        })
    ],

### 资源的实时更新 ###

引用模块，webpack提供了`require()` API（也可以通过添加bable插件来支持ES6的`import`语法）。但是在开发阶段不可能改一次编译一次，webpack提供了强大的热更新支持，即[HMR(hot module replace)][HMR_hot module replace]。

HMR简单说就是webpack启动一个本地webserver（webpack-dev-server），负责处理由webpack生成的静态资源请求。注意webpack-dev-server是把所有资源存储在内存的，所以你会发现在本地没有生成对应的chunk访问却正常。

下面这张来自webpack官网的图片，可以很清晰地说明`module`、`entry`、`chunk`三者的关系以及webpack如何实现热更新的：

![hmr.jpg][]

enter0表示入口文件，chunk1~4分别是提取公共模块所生成的资源块，当模块4和9发生改变时，因为模块4被打包在chunk1中，模块9打包在chunk3中，所以HMR runtime会将变更部分同步到chunk1和chunk3中对应的模块，从而达到hot replace。

webpack-dev-server的启动很简单，配置完成之后可以通过cli启动，然后在页面引入入口文件时添加webpack-dev-server的host即可将HMR集成到已有服务器：

...
    <body>
        ...
        <script src="http://localhost:8080/__build/vendors.js"></script>
        <script src="http://localhost:8080/__build/a.js"></script>
    </body>
    ...

因为我们的local server就是基于Node.js的webserver，这里可以更进一步，将webpack开发服务器以中间件的形式集成到local webserver，不需要cli方式启动（少开一个cmd tab）：

// app.js
    var webpackDevMiddleware = require('koa-webpack-dev-middleware');
    var webpack = require('webpack');
    var webpackConf = require('./webpack.config');
    
    app.use(webpackDevMiddleware(webpack(webpackConf), {
        contentBase: webpackConf.output.path,
        publicPath: webpackConf.output.publicPath,
        hot: true,
        stats: webpackConf.devServer.stats
    }));

启动HMR之后，每次保存都会重新编译生成新的chnuk，通过控制台的log，可以很直观地看到这一过程：

![hmr_build.png][]

### 公用代码的处理：封装组件 ###

webpack解决了资源依赖的问题，这使得封装组件变得很容易，例如：

// js/components/component-x.js
    require('./component-x.css');
    
    // @see https://github.com/okonet/ejs-loader
    var template = require('./component-x.ejs');
    var str = template({foo: 'bar'});
    
    function someMethod() {}
    
    exports.someMethod = someMethod;

使用：

// js/a.js
    import {someMethod} from "./components/component-x";
    someMethod();

正如开头所说，将三种语言、多种资源合并成js来管理，大大降低了维护成本。

对于新开发的组件或library，建议推送到`npm`仓库进行共享。如果需要支持其他加载方式（如RequireJS或标签直接引入），可以参考webpack提供的[externals][]项。

### 资源路径切换 ###

由于入口文件是手动使用script引入的，在webpack编译之后入口文件的名称和路径一般会改变，即开发环境和生产环境引用的路径不同：

// 开发环境
    // a.html
    <script src="/__build/vendors.js"></script>
    <script src="/__build/a.js"></script>
    
    // 生产环境
    // a.html
    <script src="http://cdn.site.com/js/460de4b8.vendors.min.js"></script>
    <script src="http://cdn.site.com/js/e7d20340.a.min.js"></script>

webpack提供了`HtmlWebpackPlugin`插件来解决这个问题，HtmlWebpackPlugin支持从模板生成html文件，生成的html里边可以正确解决js打包之后的路径、文件名问题，配置示例：

// webpack.config.js
    plugins: [
        new HtmlWebpackPlugin({
            template: './src/a.html',
            filename: 'a',
            inject: 'body',
            chunks: ['vendors', 'a']
        })
    ]

这里资源根路径的配置在`output`项：

// webpack.config.js
    output: {
        ...
        publicPath: debug ? '/__build/' : 'http://cdn.site.com/'
    }

其他入口html文件采用类似处理方式。

## 辅助工具集成 ##

local server解决本地开发环境的问题，webpack解决开发和生产环境资源依赖管理的问题。在项目开发中，可能会有许多额外的任务需要完成，比如对于使用compass生成sprites的项目，因目前webpack还不直接支持sprites，所以还需要compass watch，再比如工程的远程部署等，所以需要使用一些构建工具或者脚本的配合，打通研发的链路。

因为每个团队在部署代码、单元测试、自动化测试、发布等方面做法都不同，前端需要遵循公司的标准进行自动化的整合，这部分不深入了。

附上笔者根据本篇的理论所完成的一个前端自动化解决方案项目模板：  
[webpack-bootstrap][]

（完）。

## 参考文章 ##

*  [http://webpack.github.io/docs/][http_webpack.github.io_docs]
 *  [https://github.com/petehunt/webpack-howto][https_github.com_petehunt_webpack-howto]
 *  [http://christianalfoni.github.io/javascript/2014/12/13/did-you-know-webpack-and-react-is-awesome.html][http_christianalfoni.github.io_javascript_2014_12_13_did-you-know-webpack-and-react-is-awesome.html]
 *  [https://github.com/webpack/react-starter/blob/master/make-webpack-config.js][https_github.com_webpack_react-starter_blob_master_make-webpack-config.js]

--------------------

[Link 1]: http://baike.baidu.com/link?url=8KWAhpkQgUuyqAdcnb0Y380yJ5Ol8pY1-cGPR_iegeVsmnskjrZPiTLsVavNguvCSwBzhLFpUMFtOK0EiQtmAcGQRREMQa6PqF-4L62jQqC
[fouber]: https://github.com/fouber
[fis]: http://fis.baidu.com/
[shimming modules]: http://webpack.github.io/docs/shimming-modules.html
[using loaders]: http://webpack.github.io/docs/using-loaders.html
[list of loaders]: http://webpack.github.io/docs/list-of-loaders.html
[a.out.js]: http://www.infoq.com/cn/articles/a.out.js
[code splitting]: http://webpack.github.io/docs/code-splitting.html
[code_splitting1.jpg]: http://cdn4.infoqstatic.com/statics_s1_20151006-0049u2/resource/articles/frontend-engineering-webpack/zh/resources/code_splitting1.jpg
[code_splitting2.jpg]: http://cdn4.infoqstatic.com/statics_s1_20151006-0049u2/resource/articles/frontend-engineering-webpack/zh/resources/code_splitting2.jpg
[HMR_hot module replace]: http://webpack.github.io/docs/hot-module-replacement-with-webpack.html
[hmr.jpg]: http://cdn4.infoqstatic.com/statics_s1_20151006-0049u2/resource/articles/frontend-engineering-webpack/zh/resources/hmr.jpg
[hmr_build.png]: http://cdn4.infoqstatic.com/statics_s1_20151006-0049u2/resource/articles/frontend-engineering-webpack/zh/resources/hmr_build.png
[externals]: http://webpack.github.io/docs/configuration.html#externals
[webpack-bootstrap]: https://github.com/chemdemo/webpack-bootstrap
[http_webpack.github.io_docs]: http://webpack.github.io/docs/
[https_github.com_petehunt_webpack-howto]: https://github.com/petehunt/webpack-howto
[http_christianalfoni.github.io_javascript_2014_12_13_did-you-know-webpack-and-react-is-awesome.html]: http://christianalfoni.github.io/javascript/2014/12/13/did-you-know-webpack-and-react-is-awesome.html
[https_github.com_webpack_react-starter_blob_master_make-webpack-config.js]: https://github.com/webpack/react-starter/blob/master/make-webpack-config.js