webpack-dev-middleware解读

  1. 简单介绍
    webpack-dev-middleware,作用就是,生成一个与webpack的compiler绑定的中间件,然后在express启动的服务app中调用这个中间件。
    这个中间件的作用呢,简单总结为以下三点:通过watch mode,监听资源的变更,然后自动打包(如何实现,见下文详解);快速编译,走内存;返回中间件,支持express的use格式。特别注明:webpack明明可以用watch mode,可以实现一样的效果,但是为什么还需要这个中间件呢?
    答案就是,第二点所提到的,采用了内存方式。如果,只依赖webpack的watch mode来监听文件变更,自动打包,每次变更,都将新文件打包到本地,就会很慢。

  2. 实践出真知
    webpack-dev-middleware 使用配置很简单,只需几步,就可以。项目代码,参考源码;

    step1: 配置publicPath.

    publicPath,熟悉webpack的同学都知道,这是生成的新文件所指向的路径,可以模拟CDN资源引用。那么跟此处的主角webpack-dev-middleware什么关系呢,关系就是,此处采用内存的方式,内存中采用的文件存储write path就是此处的publicPath,因此,这里的配置publicPath需要使用相对路径。

    let path = require('path');
    
    module.exports = {
        entry: './app.js',
        output: {
            publicPath: "/assets/",
            filename: 'bundle.js',
            //path: '/'   //只使用 dev-middleware 可以忽略本属性
        },
    };
    
    

    step2: express server中引入中间件。

    const path = require('path');
    const express = require("express");
    var ejs = require('ejs');
    const app = express();
    const webpack = require('webpack');
    const webpackMiddleware = require("webpack-dev-middleware");
    let webpackConf = require('./webpack.config.js');
    
    app.engine('html', ejs.renderFile);
    app.set('views', path.join(__dirname, 'src/html'));
    app.set("view engine", "html");
    
    var compiler = webpack(webpackConf);
    
    app.use(webpackMiddleware(compiler, {
        publicPath: webpackConf.output.publicPath,
    }));
    
    app.get("/", function(req, res) {
        res.render("index");
    });
    
    app.listen(3333);
    

    通过step1以及step2,就能看到webpack的热加载效果了,效果展示。

    效果展示
  3. 源码分析。

    step1:首先看webpack-dev-middleware包,项目目录结构为:

    项目结构

    step2:逐一破解:

    middleware.js分析:
    line 6, var require("./lib/GetFilenameFromUrl");引入通过url得到fileName的方法;
    line 11,方法入口,引入compiler以及option配置,可以看到这是常规的结构方法,引入option,然后定义默认值(line 13),处理默认逻辑(line 22).
    line 22, 初始化的处理,我们进入shared.js文件,深入分析一下。

    shared.js分析:
    share结构:

    对象结构

    line 223,share.setOptions(context.options);,此时的options是我们配置中的

    {
        publicPath: webpackConf.output.publicPath,
    }
    

    line 9~36,定义了setOptions方法,简单一撇,重新定义了options的reporter方法,watchOptions.aggregateTimeout,options的stats(统计信息对象),mimeTypes定义。(配置信息不熟悉的可以参考官方github仓库中的example

    line 224, share.setFs(context.compiler);

    可以看到,setFs方法做了两件事,检查compiler.outputPath是否为绝对路径(默认为process.cwd()),如果为相对路径,抛出错误;定义compiler.outputFileSystem = new MemoryFileSystem();这就是webpack-dev-middleware的精髓所在了,使用内存文件系统,而不是硬盘中的文件,这样能够提升编译的速度(稍后详细分析这个玩意儿)。

    line 226, context.compiler.plugin('done', share.compilerDone);

    定义了一个done事件钩子函数,该函数内主要是reporter编译的信息以及执行context.callbacks回调函数。

    line 227,228,229,源码:

    context.compiler.plugin("invalid", share.compilerInvalid);
    context.compiler.plugin("watch-run", share.compilerInvalid);
    context.compiler.plugin("run", share.compilerInvalid);
    

    定义了一个invalid事件(监控的编译变无效后),watch-run(watch后开始编译之前),run(读取记录之前)的回调,都是share.compilerInvalid方法,该方法主要还是根据state状态,report编译的状态信息。

    line 231,share.startWatch(),开始监控.可以看到主要逻辑在compiler.watch();纳尼?绕了一圈还是调用了compiler的原型方法watch。瞅一瞅,webpack/lib/compiler.js文件的line 216,

    Compiler.prototype.watch = function(watchOptions, handler) {
       this.fileTimestamps = {};
       this.contextTimestamps = {};
       var watching = new Watching(this, watchOptions, handler);
       return watching;
    };
    

    同理,看到 webpack/lib/webpack.js的42行,可以看到,当webpack命令时,若有--watch,实际同样是调用的compiler.watch方法。

    至此,回到middleware.js的line22. 也就是重点了,webpackDevMiddleware中间件函数。

    dev-middleware中间件函数

    line 26~35定义了goNext()方法,该方法首先判断是否服务器端渲染,如果不是,直接next()处理,否则,调用了shared的ready()方法(根据state状态,处理逻辑)。

    line 36~38,非get请求,直接goNext()。

    line 40~41,找不到请求的文件,直接goNext()。

    line 43~78,处理逻辑,可以看到精简后结构。

    也就是调用shared.handleRequest方法处理,深入该方法,也即是shared.js的line 189~201,主要逻辑为:判断是否lazy模式而且没有定义filename,如果是的话,rebuild(),也就是重新编译,这就是lazy模式只有在浏览器重新刷新请求的时候才会编译的原因;如果不是lazy模式,如果所寻找的filename存在(注意此处是通过内存fs查找),那么调用processRequest()处理。

    line 45~76,是processRequest()的逻辑,主要是express()的res处理逻辑了,简单明了。

    line 85,可以看到return webpackDevMiddleware,最终返回了express的中间件。

    至此,game over!

  4. 延伸扩展;

    lazy模式下什么表现呢???深入shared.js会发现,当lazy为true(shared.js文件line 169~175)时,npm run test并不会执行编译,而是当浏览器发出请求req时,在shared.js的handleRequest方法(line 191)的194行执行了rebuild()方法,在rebuild方法的180行执行了context.compiler.run()进行了编译。在修改后,webpack不会立即执行编译,而是等到req再次请求时编译。也就是在lazy模式下,每次只有在浏览器请求时,才执行一次compile,watch并没有什么卵用啊。

    正常模式呢?表现是怎么样?正常模式,npm run test时,代码运行到startWatch(),也就是执行到compiler的watch()方法,深入compiler源码可以看到,Compiler.js文件的114行,执行到invalidate()方法,判断是否已经running,如果为false,进入_go()方法,执行了compile()逻辑。也就是说,在没有浏览器请求时,就已经执行了编译。然后在修改了entry相关的文件后,watch会执行编译,同时会触发compiler的invalid事件(在Compiler.js的watch方法的116行可以看到)也就是会执行到Shared.js的229行,执行compilerInvalid方法,打印compiling信息。

    总结就是,lazy模式只有在浏览器请求时,才会执行compile编译,而正常模式下,则是改变后,立即执行compile过程。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,454评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,553评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,921评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,648评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,770评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,950评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,090评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,817评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,275评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,592评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,724评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,409评论 4 333
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,052评论 3 316
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,815评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,043评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,503评论 2 361
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,627评论 2 350

推荐阅读更多精彩内容