vue项目中使用 prerender-spa-plugin进行预渲染

最近在研究服务端渲染(SSR) nuxt.js框架,(中文文档 https://www.nuxtjs.cn/api 及自己的测试demo https://github.com/have-not-BUG/nuxt.js-demo),顺便试了一下预渲染插件prerender-spa-plugin,关于他们两的区别和优劣势我就不赘述了,可以看下vue的官方文档。这里主要讲一下使用prerender-spa-plugin主要步骤及一些坑:
1、安装时一定要记得使用cnpm安装Puppeteer后再cnpm安装 prerender-spa-plugin,否则安装会失败
2、配置vue.config.js

const PrerenderSPAPlugin = require('prerender-spa-plugin');
const Renderer = PrerenderSPAPlugin.PuppeteerRenderer;
const path = require('path');
module.exports = {
    // publicPath: process.env.NODE_ENV == "production" ? "././" : './',
    publicPath: '/',
    assetsDir: "./dist",
    configureWebpack: config => {
        if (process.env.NODE_ENV === "production") {
            console.log('生产模式启用了')
        return {
            plugins: [
                new PrerenderSPAPlugin({
                    // 生成文件的路径,也可以与webpakc打包的一致。
                    // 这个目录只能有一级,如果目录层次大于一级,在生成的时候不会有任何错误提示,在预渲染的时候只会卡着不动。
                    staticDir: path.join(__dirname,'dist'),
                    // 对应自己的路由文件,比如a有参数,就需要写成 /a/param1。
                    // routes: ['/', '/contact','/demo','/dev','/footer','/header','/home','/news','/scheme'],
                    routes: ['/','/autoRouter/one','/autoRouter/two','/autoRouter/zero'],
                    // 这个很重要,如果没有配置这段,也不会进行预编译
                    renderer: new Renderer({
                        injectProperty: '__PRERENDER_INJECTED',
                        inject: {
                            foo: 'bar'
                        },
                        headless: true,
                        // 在 main.js 中 document.dispatchEvent(new Event('render-event')),两者的事件名称要对应上。
                        renderAfterDocumentEvent: 'render-event'
                    })
                }),
            ],
            // // 这里是配置第三方的插件的
            // externals : {
            //     AMap: "AMap",
            // }
        };
        }
    }
};

3、配置main.js

new Vue({
  render: h => h(App),
  router,
  // 延迟5s 保证页面请求和内容全部能够加载渲染完成
// 或者使用 renderAfterTime: 5000 或renderAfterElementExists:'my-app-element'配置

  mounted () {
    setTimeout(() => {
      console.log("dispatch event");
      window.document.dispatchEvent(new Event("render-event"));
    }, 5000);
  }
  }).$mount("#app");

4、配置路由模式为mode: "history"且不得使用路由懒加载的方式或者使用 renderAfterTime: 5000配置
5、build构建即可看到最终的预渲染的html页面
two组件里的ip数据是走接口请求到的,预渲染html文件也展示出来了。

最终页面

目录结构

我的demo代码:
https://github.com/have-not-BUG/prerender-demo

其他可能的坑,见
1、https://huzizi.com/vue-cli-3-0-shi-yong-prerender-spa-plugin-yu-xuan-ran-yu-dao-de-mo-ming-qi-miao-de-keng/
2、https://blog.csdn.net/weixin_34137872/article/details/112070362
3、http://blog.ideacome.com/2020/03/31/vue-prerendercai-keng-bi-ji/
4、https://blog.csdn.net/qq_37564189/article/details/106090414

为什么说是“莫名其妙”的坑,因为在这项目的前几天,使用预渲染的方式都非常正常,可以正常打包,输出静态文件。但是这个时候就抽风了,开发环境完全相同,当下有点摸不着头脑的感觉。
当然,遇坑则填坑,看终端打印的信息,分析可能有以下原因:

  • puppeteet 无法启动 chromium,权限不足?
  • puppeteet 下载的 chromium 版本错误?
  • puppeteet 下载的 chromium 文件损坏?

针对权限疑惑,检查了项目目录的相关权限,未发现有问题;接着到 chromium 站点下载 Win 64位的 r662092 版本包,重新覆盖 \node_modules\puppeteer\.local-chromium\win64-662092\chrome-win下的所有文件,重新 build,依旧输出同样错误。
解决不了,只有 Google 大法了,寻寻觅觅一圈依旧没有找到解决方法。当看到 Puppeteer Api 文档时,它提供一个属性 executablePath 人为指定运行绑定的 Chromium 版本默认情况下,Puppeteer 下载并使用特定版本的 Chromium 以及其 API 保证开箱即用。 如果要将 Puppeteer 与不同版本的 chrome 或 chromium 一起使用,在创建Browser实例时传入 chromium 可执行文件的路径即可。 如同看到了希望一样,回到 vue.config.js 文件中,添加 executablePath属性

module.exports = {    configureWebpack: () => {    if (process.env.NODE_ENV === "production") {      return {        plugins: [          new PrerenderSPAPlugin({            // 【必须】生成文件的路径,也可以与webpakc打包的一致            staticDir: path.join(__dirname, "dist"),            // 【必须】对应自己的路由文件,如路由有参数,则需写成 /a/param1            routes: ["/", "/about", "/news", "/contact"],            //【可选】服务器端口配置            server: {              port: 8188            },            // 这个很重要,如果没有配置这段,也不会进行预编译            renderer: new Renderer({              inject: {                foo: "bar"              },              headless: false,              // 对应 src/main.js 中 document.dispatchEvent(new Event('custom-render-trigger')),两者的事件名称要相同              renderAfterDocumentEvent: "custom-render-trigger",              // 更改运行绑定的 Chromium 版本,即:使用本机 chrome 来执行预渲染操作,注意 win、mac、linux 不同环境的路径指定              executablePath: 'Your/Path/Google/Chrome/Application/chrome.exe'            })          })        ]      };    }  }}

5、npm config set puppeteer_download_host=https://npm.taobao.org/mirrors

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

推荐阅读更多精彩内容