vue-cli3.0如何使用prerender-spa-plugin插件預渲染

更新時間：2026年02月07日 09:21:49 作者：深夜程序員

這篇文章主要介紹了vue-cli3.0如何使用prerender-spa-plugin插件預渲染，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教

如何使用prerender-spa-plugin插件預渲染

vue-cli3.0版本

1.安裝

cnpm install prerender-spa-plugin --save

2.vue-config.js中增加

const PrerenderSPAPlugin = require('prerender-spa-plugin');
const Renderer = PrerenderSPAPlugin.PuppeteerRenderer;
const path = require('path');
module.exports = {
    configureWebpack: config => {
        if (process.env.NODE_ENV !== 'production') return;
        return {
            plugins: [
                new PrerenderSPAPlugin({
                    // 生成文件的路徑，也可以與webpakc打包的一致。
                    // 下面這句話非常重要！?。?
                    // 這個目錄只能有一級，如果目錄層次大于一級，在生成的時候不會有任何錯誤提示，在預渲染的時候只會卡著不動。
                    staticDir: path.join(__dirname,'dist'),
                    // 對應自己的路由文件，比如a有參數(shù)，就需要寫成 /a/param1。
                    routes: ['/', '/product','/about'],
                    // 這個很重要，如果沒有配置這段，也不會進行預編譯
                    renderer: new Renderer({
                        inject: {
                            foo: 'bar'
                        },
                        headless: false,
                        // 在 main.js 中 document.dispatchEvent(new Event('render-event'))，兩者的事件名稱要對應上。
                        renderAfterDocumentEvent: 'render-event'
                    })
                }),
            ],
        };
    }
}

3.在main.js中增加

new Vue({
  router,
  store,
  render: h => h(App),
  mounted () {
    document.dispatchEvent(new Event('render-event'))
  }
}).$mount('#app')

4.router.js 中設置mode: “history”

5.運行npm run build，看一下生成的 dist 的目錄里是不是有每個路由名稱對應的文件夾。然后找個目錄里的 index.html 用IDE打開，看文件內容里是否有該文件應該有的內容。有的話，就設置成功了

預渲染 prerender-spa-plugin嘗試

背景：想給項目做一些優(yōu)化，想嘗試預渲染和SSR

這里說一下SSR
使用的技術棧是VUE
預渲染使用的是 prerender-spa-plugin 這個包

先說一下效果吧

這個感覺就是類似高級的骨架屏，不過他是一個真正的頁面，只是沒有數(shù)據(jù)，或者數(shù)據(jù)驅動渲染的一切。

使用這個插件配置好幾個預渲染的頁面會在build時提前講這些頁面渲染成瀏覽器可以直接打開的html文件。這樣你在瀏覽器輸入地址后，會直接得到這樣一個頁面，省去了渲染出頁面的時間，因為在打包時這個頁面就渲染完了，也就是我們提前預渲染了。

不好用的地方

說一些不好用的地方，比如我們我們做的是類似管理后臺的頁面，無論你進入什么也都需要先登陸，那么這個效果就會打折扣，畢竟無論預渲染了什么頁面都會被重定向到登錄頁。

使用

1、安裝如果不行可能需要找一些鏡像包試試

npm i prerender-spa-plugin -S

2、配置 vue.config.js

module.exports = {
	...,
	plugins: [
        staticDir: path.join(__dirname, 'dist'),
        routes:['/home'],
        renderer: new Renderer({
          inject: {
            foo: 'bar'
          },
          renderAfterDocumentEvent: 'render-event'
        })
	],
	// 另一種寫法   
	// config.pludaasdfgins.push(
      // new PrerenderSPAPlugin({
        // staticDir: path.join(__dirname, 'dist'),
        // indexPath: path.join(__dirname, 'dist', 'index.html'),
        // routes:['/home'],
        // renderer: new Renderer({
          // inject: {
          //   foo: 'bar'
          // },
          // headless: true,
          // renderAfterDocumentEvent: 'render-event'
        // })
      // })
    // )
}

prerender-spa-plugin 還有很多參數(shù) 具體可以去官網看

3、打包