Koa2+Vue SSR+webpack热更新的详细配置

Koa2+Vue SSR+webpack热更新的详细配置

由于最近做博客前台需要改界面,不能每次修改就重新打包一次吧,太费时费力了,索性我就花了2天时间,研究了一下基于koa2的webpack热更新。

本文主要讲解setup-dev-middleware.js的配置和使用

需要用到的第三方依赖包

  • Koa-webpack-dev-middleware

  • koa-webpack-hot-middleware

  • koa-convert

    koa-convert是必须的,因为Koa-webpack-dev-middlewarekoa-webpack-hot-middleware是koa1的插件,需要进行转换

配置koa版本的setup-dev-middleware.js

  • 定义服务器端bundle和浏览器端manifest

      let bundle;
      let template = fs.readFileSync(templatePath, 'utf-8');
      let clientManifest;
      //update检测到有更新后,调用传递过来的回调函数,一般是createBundleRenderer这个函数。
      const update = () => {
        if (bundle && clientManifest) {
          callback(bundle, {
            template,
            clientManifest
          })
        }
      }
    
  • 修改client端入口配置文件,注意配置文件需要

      clientConfig.entry.app = ['webpack-hot-middleware/client?path=/__webpack_hmr&timeout=2000&reload=true', clientConfig.entry.app]
      clientConfig.output.filename = '[name].js'
      clientConfig.plugins.push(
        new webpack.HotModuleReplacementPlugin(),
        new webpack.NoEmitOnErrorsPlugin()
      )
    
  • 配置koa-webpack-dev-middleware,这里需要传递浏览器端的Compiler

    注意:这里使用devMiddleware的时候需要先调用convert()把koa1的包转成koa2可以用的包

    const clientCompiler = webpack(clientConfig)
    const devMiddleware = webpackDevMiddleware(clientCompiler, {
      publicPath: clientConfig.output.publicPath,//必选参数,定义启动后的默认访问路径,填错可导致404
      noInfo: true,//可选
      stats: {//可选
        colors: true,
        modules: false,
      },
    })
    app.use(convert(devMiddleware))
    
  • 配置订阅热更新

    注意:这里使用webpackHotMiddleware也需要包裹convert()

      // hot update
      clientCompiler.plugin('done', stats => {
        stats = stats.toJson()
        stats.errors.forEach(err => console.error(err))
        stats.warnings.forEach(err => console.warn(err))
        if (stats.errors.length) return
        
        console.log('\nclient-dev...\n')
        clientManifest = JSON.parse(readFile(
          devMiddleware.fileSystem,
          'vue-ssr-client-manifest.json'
        ))
        update()
      })
      // hot middleware
      app.use(convert(webpackHotMiddleware(clientCompiler)))
    
  • 配置服务端热更新

      const serverCompiler = webpack(serverConfig)
      const mfs = new MFS()
      serverCompiler.outputFileSystem = mfs
      serverCompiler.watch({}, (err, stats) => {
        if (err) throw err
        stats = stats.toJson()
        if (stats.errors.length) return
        console.log('server-dev...')
        bundle = JSON.parse(readFile(mfs, 'vue-ssr-server-bundle.json'))
        update()
      })
    

完整代码

const path = require('path')
const MFS = require('memory-fs')
const webpack = require('webpack')
const clientConfig = require('./webpack.client.config')
const serverConfig = require('./webpack.server.config')
const webpackDevMiddleware = require('koa-webpack-dev-middleware')
const webpackHotMiddleware = require('koa-webpack-hot-middleware')
const convert = require('koa-convert')
const fs = require('fs');
const opn = require('opn')
const readFile = (fs, file) => fs.readFileSync(path.join(clientConfig.output.path, file), 'utf-8')

module.exports = function setupDevServer(app, uri, callback) {
  let bundle;
  let template = fs.readFileSync(uri, 'utf-8')
  let clientManifest
  const update = () => {
    if (bundle && clientManifest) {
      callback(bundle, {
        template,
        clientManifest
      })
    }
  }

  //  client
  clientConfig.entry.app = ['webpack-hot-middleware/client?path=/__webpack_hmr&timeout=2000&reload=true', clientConfig.entry.app]
  clientConfig.output.filename = '[name].js'
  clientConfig.plugins.push(
    new webpack.HotModuleReplacementPlugin(),
    new webpack.NoEmitOnErrorsPlugin()
  )

  // webpack config
  const clientCompiler = webpack(clientConfig)
  // dev middleware
  const devMiddleware = webpackDevMiddleware(clientCompiler, {
    publicPath: clientConfig.output.publicPath,
    noInfo: true,
    stats: {
      colors: true,
      modules: false,
    },
  })
  app.use(convert(devMiddleware))

  // hot update
  clientCompiler.plugin('done', stats => {
    stats = stats.toJson()
    stats.errors.forEach(err => console.error(err))
    stats.warnings.forEach(err => console.warn(err))
    if (stats.errors.length) return
    
    console.log('\nclient-dev...\n')
    clientManifest = JSON.parse(readFile(
      devMiddleware.fileSystem,
      'vue-ssr-client-manifest.json'
    ))
    update()
  })

  // hot middleware
  app.use(convert(webpackHotMiddleware(clientCompiler)))

  // server
  const serverCompiler = webpack(serverConfig)
  const mfs = new MFS()
  serverCompiler.outputFileSystem = mfs
  serverCompiler.watch({}, (err, stats) => {
    if (err) throw err
    stats = stats.toJson()
    if (stats.errors.length) return
    console.log('server-dev...')
    bundle = JSON.parse(readFile(mfs, 'vue-ssr-server-bundle.json'))
    update()
  })

  devMiddleware.waitUntilValid(() => {
    console.log('\n> Listening at http://localhost:3001' + '' + '\n')
    opn('http://localhost:3001/');
  })
}

调用setup-dev-middleware

const setupDevServer = require('./build/setup-dev-middleware');
let renderer;
setupDevServer(app, './template.html', (bundle, options) => {
    try {
        renderer = createBundleRenderer(bundle, options)
    } catch (e) {
        console.log('\nbundle errorasdasd', e)
    }
})
const renderData = (ctx, renderer) => {
    const context = {
        url: ctx.url
    }
    return new Promise((resolve, reject) => {
        renderer.renderToString(context, (err, html) => {
            if (err) {
                return reject(err)
            }
            resolve(html)
        })
    })
}
app.use(async (ctx, next) => {
    let html, status;
    try {
        status = 200
        html = await renderData(ctx, renderer)
    } catch (e) {
        console.log('\ne', e)
        if (e.code === 404) {
            status = 404
            html = '404 | Not Found'
        } else {
            status = 500
            html = '500 | Internal Server Error'
        }
    }
    ctx.type = 'html'
    ctx.status = status ? status : ctx.status
    ctx.body = html
})

有疑问可以在下方评论或者联系我哈!

下一片预告:《使用tocbot根据html生成目录文档toc优化文章阅读效果(html由markdown生成)》

欢迎关注我的个人博客,第一时间发布最新内容:小新的个人博客,完整源码在我的github:完整源码

Koa2+Vue SSR+webpack热更新的详细配置

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

推荐阅读更多精彩内容