Vue项目预渲染机制引入实践

news/2024/7/10 0:54:41 标签: vue, 预渲染

文章目录

    • 1. 简介与使用场景
    • 2. 安装配置
      • 2.1 安装
      • 2.2 前端配置
      • 2.3 nginx配置

周末想顺便把已经做好静态页面的webApp项目做一下SEO优化,由于不想写蹩脚的 SSR代码,所以准备采用预渲染,本来想着网上有这么多 预渲染的文章,随便找个来跟着做不就完了嘛,结果年轻的我付出了整个周末… 这篇文章就记录一下最后是怎么配置的 T.T

声明:

  1. 以下配置只保留有必要的
  2. 生成目录这里使用base代替,请自行修改
  3. vue-cli模板使用webpack,其他模板类推
  4. webApp - 在线预览
  5. Github - 配置了预渲染的demo

感兴趣的同学可以加文末的微信群,一起讨论吧~

1. 简介与使用场景

我们知道SPA有很多优点,不过一个缺点就是对(不是Google的)愚蠢的搜索引擎的SEO不友好,为了照顾这些引擎,目前主要有两个方案:服务端渲染(Server Side Rendering)、预渲染(Prerending)。

如果你只需要改善少数页面(例如 /, /about, /contact 等)的 SEO,那么你可能需要预渲染。无需使用 web 服务器实时动态编译 HTML (服务端渲染, SSR),而是使用预渲染方式,在构建时(build time)简单地生成针对特定路由的静态 HTML 文件。它主要使用 prerender-spa-plugin 插件,其与SSR一样都可以加快页面的加载速度,并且侵入性更小,在已上线的项目稍加改动也可以轻松引入预渲染机制,而SSR方案则需要将整个项目结构推翻;

访问预渲染出来的页面在访问时与SSR一样快,并且它将服务端编译HTML的时机提前到了构建时,因此也降低了服务端的压力,如果你的服务器跟我的一样买的 1M1G1核 的小水管服务器 ( 穷 ),那么预渲染可能更适合你。不过SSR和预渲染的使用场景还是有较明显的区别的。预渲染的使用场景更多是简单的静态页面。服务端渲染适用于复杂、较大型、与服务端交互频繁的功能型网站,比如电商网站。

2. 安装配置

首先来看看相关技术栈:vue2.5.2、vue-router3.0.1、vue-cli2.9.6、webpack3.6.0、prerender-spa-plugin^3.3.0

2.1 安装

安装跟其他库一样

# Yarn
$ yarn add prerender-spa-plugin -D
# or NPM
$ npm install prerender-spa-plugin --save-dev

2.2 前端配置

首先看看文件结构,用的是vue-cli2的webpack模板生成的文件结构

│  .babelrc
│  index.html
│  package.json
│  README.md
├─build
│      build.js
│      check-versions.js
│      utils.js
│      vue-loader.conf.js
│      webpack.base.conf.js
│      webpack.dev.conf.js
│      webpack.prod.conf.js
├─config
│      dev.env.js
│      index.js
│      prod.env.js
├─src
│  │  App.vue
│  │  main.js
│  │ 
│  ├─assets
│  ├─components
│  ├─router
│  │      index.js
│  ├─styles
│  ├─utils
│  └─views
│          BigData.vue
│          CompanyHonor.vue

然后是router/index.js的配置,预渲染要求是histroy模式,有的文章说不需要history模式,这是错的,否则生成的页面都是同一个html。另外注意加上base否则如果你希望跳转到二级页面的localhost/base/home时候,在页面中点击<router-link to="/home">home</router-link>的时候会跳转localhost/home

// src/router/index.js

import Vue from 'vue'
import Router from 'vue-router'
 
 
Vue.use(Router)
 
 
export default new Router({
  mode: 'history',
  base: '/base/',
  routes: [...]
})

然后是config,这里注意assetsPublicPath不是./,

// config/index.js

const path = require("path")
 
module.exports = {
  build: {
    index: path.resolve(__dirname, "../base/index.html"),
    assetsRoot: path.resolve(__dirname, ".."),
    assetsSubDirectory: "base/static",
    assetsPublicPath: "/",
  }
}

然后是插件的配置,是放在prod中的,因为只有build的时候会用

// build/webpack.prod.conf.js

const path = require('path')
const config = require('../config')
const PrerenderSPAPlugin = require('prerender-spa-plugin')
const Renderer = PrerenderSPAPlugin.PuppeteerRenderer
 
const webpackConfig = merge(baseWebpackConfig, {
  new PrerenderSPAPlugin({
   staticDir: config.build.assetsRoot,
   outputDir: path.join(config.build.assetsRoot, 'base'),
   indexPath: config.build.index,
 
   // 对应路由文件的path
   routes: [
     '/',
     '/BigData',
     '/CompanyHonor'
   ],
 
   renderer: new Renderer({
     headless: false,            // 无桌面系统去掉
     renderAfterDocumentEvent: 'render-event'
   })
  })
})

注意了,如果你的项目是部署在linux/centOS之类没有桌面的系统,需要把headless: false去掉,如果centOS报没有找到lib的错,请参考 issue-200 的解决办法。

另外注意上面一个renderAfterDocumentEvent: 'render-event'了么,这个意思是在render-event事件触发之后执行prerender,这个事件我们在main.js中mounted钩子触发

// src/main.js

import Vue from 'vue'
import App from './App'
 
new Vue({
  el: '#app',
  render: h => h(App),
  mounted() {
    document.dispatchEvent(new Event('render-event'))
  }
})

还有个配置要注意下在 build/utils.js 中的 ExtractTextPlugin.extractpublicPath ,否则一些vue中引用的资源会找不到

// build/utils.js

ExtractTextPlugin.extract({
  use: loaders,
  fallback: 'vue-style-loader',
  // publicPath: '../../'
})

这时候执行npm run build就可以生成刚刚配置在PrerenderSPAPlugin插件中routes中的页面html了,这过程中会一闪而过的短暂打开chromium浏览器,不用管。

最后生成的目录树:

│  index.html
├─BigData
│      index.html
├─CompanyHonor
│      index.html
└─static
    ├─css
    ├─fonts
    ├─img
    └─js

最后如果希望进一步优化生成出来页面的SEO,可以配合 vue-meta-info 这个网上有很多文章,就不赘述了

2.3 nginx配置

顺便贴一下nginx配置

server {
        listen 80;
        server_name localhost;
        root /nginx-1.14.0/html;

        error_page 500 502 503 504 /50x.html;
        
        location ~ ^/base/ {
          try_files $uri $uri/ /base/index.html;
        }
        location = /50x.html {
            root html;
        }
}

网上的帖子大多深浅不一,甚至有些前后矛盾,在下的文章都是学习过程中的总结,如果发现错误,欢迎留言指出~

参考:

  1. Vue.js 服务器端渲染指南
  2. Vue 服务端渲染 & 预渲染
  3. vue-cli v3, can’t get it to work… issue #215
  4. unable to start Puppeteer. Failed to launch … issue #200
  5. When assetsPublicPath is set, the… issue #176
  6. vue.js vue-router history模式路由,域名二级目录子目录nginx配置
  7. 处理 Vue 单页面 Meta SEO的另一种思路

PS:欢迎大家关注我的公众号【前端下午茶】,一起加油吧~

另外可以加入「前端下午茶交流群」微信群,长按识别下面二维码即可加我好友,备注加群,我拉你入群~


http://www.niftyadmin.cn/n/718393.html

相关文章

刷题总结——分配笔名(51nod1526 trie树)

题目&#xff1a; 班里有n个同学。老师为他们选了n个笔名。现在要把这些笔名分配给每一个同学&#xff0c;每一个同学分配到一个笔名&#xff0c;每一个笔名必须分配给某个同学。现在定义笔名和真名之间的相关度是他们之间的最长公共前缀。设笔名为a&#xff0c;真名为b&#x…

java8实战三:函数式数据处理--流

函数式数据处理(一)–流 引入流 集合是Java中使用最多的API。要是没有集合&#xff0c;还能做什么呢&#xff1f;几乎每个Java应用程序都会制 造和处理集合。集合对于很多编程任务来说都是非常基本的&#xff1a;它们可以让你把数据分组并加以处 理。 很多业务逻辑都涉及类…

在一个IIS上同时运行两个版本ASP.NET报错的

在Windows 2003 server IIS 6.0上运行一个ASP.NET 2.0网站时出现报错&#xff1a;服务器应用程序不可用 您试图在此 Web 服务器上访问的 Web 应用程序当前不可用。请点击 Web 浏览器中的“刷新”按钮重试您的请求。 管理员注意事项: 详述此特定请求失败原因的错误信息可在 Web …

微软虚拟学院MVA 字幕获取方法

微软虚拟学院&#xff08;MVA&#xff09;上有一些不错的视频教程&#xff0c;但是&#xff0c;蛋疼的一点那就是视频要不就慢&#xff0c;要不就卡&#xff0c;总之当你的思维跟着视频深入的时候&#xff0c;duang~&#xff0c;卡一下&#xff0c;说不定就要重头开始&#xff…

前端 Web Workers 到底是什么

以前我们总说&#xff0c;JS是单线程没有多线程&#xff0c;当JS在页面中运行长耗时同步任务的时候就会导致页面假死影响用户体验&#xff0c;从而需要设置把任务放在任务队列中&#xff1b;执行任务队列中的任务也并非多线程进行的&#xff0c;然而现在HTML5提供了我们前端开发…

c# 规范用户输入控件

MaskedTextBox控件是一种特殊的文本框&#xff0c;它可以通过Mask属性设置格式标记符。在应用程序运行后&#xff0c;用户只能输入Mask属性允许的内容&#xff0c;列入日期。电话等 在“输入掩码”对话框的右下角有一个“使用Validation Type”的复选框&#xff0c;其实&#x…

java8实战四:使用流--Stream

使用流 在本章中,你将会看到许多Stream API支持的许多操作.这些操作能让你快速完成许多复杂的查询.如筛选、切片、映射、查找、匹配和归约。 接下来,我们会看到一些特殊的流:数值流,来自文件和数组等多种来源的流,最后是无限流. 1 筛选和切片 在本节中&#xff0c;我们来看…

浏览器缓存机制全攻略

最近在项目中遇到了 IE浏览器因缓存问题未能成功向后端发送 GET类型请求 的bug&#xff0c;然后顺藤摸瓜顺便看了看缓存的知识&#xff0c;觉得有必要总结跟大家分享一下。 在前端开发中&#xff0c;性能一直都是被大家所重视的一点&#xff0c;然而判断一个网站的性能最直观的…