文章目录

一、Vue SSR 介绍
- 1.1 Vue SSR 是什么
- 1.2 使用场景
- 1.3 如何实现 Vue SSR
二、Vue SSR 基本使用
- 2.1 渲染一个 Vue 实例
- 2.2 与服务器集成
- 2.3 使用一个页面模板
- 2.4 在模板中使用外部数据
三、构建同构渲染 - 构建流程
四、构建同构渲染 - 源码结构
- 4.1 App.vue
- 4.2 app.js
- 4.3 entry-client.js
- 4.4 entry-server.js
五、构建同构渲染 - 构建配置
- 5.1 安装依赖
- 5.2 配置文件及打包命令
- 5.3 启动应用
- 5.4 解析渲染流程
六、构建同构渲染 - 构建配置开发模式
- 6.1 基本思路
- 6.2 提取处理模块
- 6.3 update 更新函数
- 6.4 处理模版文件
- 6.5 服务端监视打包
- 6.6 把数据写入内存中
- 6.7 客户端构建
- 6.8 热更新
七、编写通用应用注意事项
- 7.1 服务器上的数据响应
- 7.2 组件生命周期钩子函数
- 7.3 访问特定平台(Platform-Specific) API
- 7.4 自定义指令
- 7.5 区分运行环境
八、路由处理
- 8.1 配置 VueRouter - router
- 8.2 将路由注册到根实例
- 8.3 适配服务端入口
- 8.4 服务端适配
- 8.5 适配客户端入口
- 8.6 根组件
- 8.7 处理完成
九、管理页面 Head
十、数据预取和状态管理
- 10.1 思路分析
- 10.2 数据预取
- 10.3 将预取数据同步到客户端

一、Vue SSR 介绍

1.1 Vue SSR 是什么

官方文档
Vue SSR（Vue.js Server-Side Rendering）是 Vue.js 官方提供的一个服务端渲染（同构应用）解决方案
使用它可以构建同构应用
还是基于原有的 Vue.js 技术栈

官方文档的解释：Vue.js 是构建客户端应用程序的框架。默认情况下，可以在浏览器中输出 Vue 组件，进行生成 DOM 和操作 DOM。然而，也可以将同一个组件渲染为服务器端的 HTML 字符串，将它们直接发送到浏览器，最后将这些静态标记"激活"为客户端上完全可交互的应用程序

服务器渲染的 Vue.js 应用程序也可以被认为是"同构"或"通用"，因为应用程序的大部分代码都可以在服务器和客户端上运行

1.2 使用场景

在对你的应用程序使用服务器端渲染 (SSR) 之前，你应该问的第一个问题是，是否真的需要它

技术层面
- 更快的首屏渲染速度
- 更好的 SEO
业务层面
- 不适合管理系统
- 适合门户资讯类网站，例如企业官网、知乎、简书等
- 适合移动网站

1.3 如何实现 Vue SSR

基于 Vue SSR 官方文档提供的解决方案

官方方案具有更直接的控制应用程序的结构，更深入底层，更加灵活，同时在使用官方方案的过程中，也会对 Vue SSR 有更加深入的了解
该方式需要你熟悉 Vue.js 本身，并且具有 Node.js 和 webpack 的相当不错的应用经验

Nuxt.js 开发框架

NUXT 提供了平滑的开箱即用的体验，它建立在同等的 Vue 技术栈之上，但抽象出很多模板，并提供了一些额外的功能，例如静态站点生成
通过 Nuxt.js 可以快速的使用 Vue SSR 构建同构应用

二、Vue SSR 基本使用

2.1 渲染一个 Vue 实例

了解如何使用 Vue SSR 将一个 Vue 实例渲染为 HTML 字符串

初始化一个项目文件

mkdir vue-ssrcd vue-ssrnpm init -ynpm i vue vue-server-renderer

// 第 1 步：创建一个 Vue 实例
const Vue = require("vue");
// 第 2 步：创建一个 renderer
const renderer = require("vue-server-renderer").createRenderer();
const app = new Vue({template: `<div id="app"><h1>{{ message }}</h1></div>`,data: {message: "akang",},
});// 第 3 步：将 Vue 实例渲染为 HTML
renderer.renderToString(app, (err, html) => {if (err) throw err;console.log(html);
});

运行

node server.js

2.2 与服务器集成

在 Node.js 服务器中使用时相当简单直接，例如 Express

首先安装 Express 到项目中

npm i express

使用 Express 创建一个基本的 Web 服务

const Vue = require("vue");
const express = require("express");
const renderer = require("vue-server-renderer").createRenderer();
const server = express();
server.get("/", (req, res) => {const app = new Vue({template: `<div id="app"><h1>{{ message }}</h1></div>`,data: {message: "卷不动了",},});renderer.renderToString(app, (err, html) => {if (err) {return res.status(500).end("Internal Server");}res.end(html);});
});
server.listen(3000, () => {console.log("server running at port 3000");
});

启动 Web 服务

nodemon server.js

访问 http://localhost:3000/，发现会出现乱码

解决编码问题（建议二者均设置）

renderer.renderToString(app, (err, html) => {...res.setHeader("Content-Type", "text/html; charset=utf-8"); // 设置1res.end(`<!DOCTYPE html><html lang="en"><head><title>Hello</title><meta charset="UTF-8"></head><body>${html}</body></html>
`}); // 设置2

2.3 使用一个页面模板

server.js

...
const fs = require("fs");
const renderer = require("vue-server-renderer").createRenderer({template: fs.readFileSync("./index.template.html", "utf-8"),
});
...
res.end(html);

根目录新建一个模版文件 index.template.html

<!DOCTYPE html>
<html lang="en"><head><title>Hello</title><meta charset="UTF-8" /></head><!-- body 里面的这个注释必须写，不能带有空格 --><body><!--vue-ssr-outlet--></body>
</html>

2.4 在模板中使用外部数据

server.js

...
renderer.renderToString(app， {title: '卷起来',meta: `<meta name="description" content="卷起来">`
}, (err, html) => {...
})
...

index.template.html

<!DOCTYPE html>
<html lang="en"><head><title>{{ title }}</title>{{ meta }}<meta charset="UTF-8" /></head><!-- body 里面的这个注释必须写，不能带有空格 --><body><!--vue-ssr-outlet--></body>
</html>

重启服务

nodemon server.js

如果 meta 使用三个大括号，vue 不会对其进行处理，会原文输出

<!DOCTYPE html>
<html lang="en"><head><title>{{ title }}</title>{{{ meta }}}<meta charset="UTF-8" /></head><!-- body 里面的这个注释必须写，不能带有空格 --><body><!--vue-ssr-outlet--></body>
</html>

三、构建同构渲染 - 构建流程

左边为应用的源代码 Source，中间为 Webpack，右边为 Node Server 服务端
在我们的应用当中，目前只有 Server entry 服务端入口来处理服务端渲染，如果我们希望服务端渲染的内容拥有客户端动态交互的能力的话，还需要有一个客户端脚本的入口 Client entry，它专门来处理客户端渲染，也就是去接管服务端渲染的内容把它激活为一个动态页面
有了这两个入口之后需要 Webpack 对它们进行打包编译构建：对于 Server entry 最终要打包为一个 ServerBundle 来做服务端渲染，同样的对于客户端入口 Client entry 来说最终要打包为一个 ClientBundle 来接管服务端渲染好的静态页面对它进行激活

四、构建同构渲染 - 源码结构

我们需要使用 webpack 来打包我们的 Vue 应用程序。事实上，我们可能需要在服务器上使用 webpack 打包 Vue 应用程序，因为：

通常 Vue 应用程序是由 webpack 和 vue-loader 构建，并且许多 webpack 特定功能不能直接在 Node.js 中运行（例如通过 file-loader 导入文件，通过 css-loader 导入 CSS）
尽管 Node.js 最新版本能够完全支持 ES2015 特性，我们还是需要转译客户端代码以适应老版浏览器，这也会涉及到构建步骤
所以基本看法是，对于客户端应用程序和服务器应用程序，我们都要使用 webpack 打包 - 服务器需要「服务器 bundle」然后用于服务器端渲染(SSR)，而「客户端 bundle」会发送给浏览器，用于混合静态标记
现在我们正在使用 webpack 来处理服务器和客户端的应用程序，大部分源码可以使用通用方式编写，可以使用 webpack 支持的所有功能

一个基本项目可能像是这样：

src
├── components
│ ├── Foo.vue
│ ├── Bar.vue
│ └── Baz.vue
├── App.vue
├── app.js # 通用 entry(universal entry)
├── entry-client.js # 仅运行于浏览器
└── entry-server.js # 仅运行于服务器

4.1 App.vue

<template><div id="app"><h1>{{ message }}</h1><h2>客户端动态交互</h2><div><input v-model="message" /></div><div><button @click="onClick">点击测试</button></div></div>
</template><script>
export default {name: "App",data() {return {message: "卷起来",};},methods: {onClick() {console.log("Hello World!");},},
};
</script><style>
</style>

4.2 app.js

app.js 是我们应用程序的「通用 entry」。在纯客户端应用程序中，我们将在此文件中创建根 Vue 实例，并直接挂载到 DOM。但是，对于服务器端渲染(SSR)，责任转移到纯客户端 entry 文件。 app.js 简单地使用 export 导出一个 createApp 函数

/*** 通用启动入口*/
import Vue from 'vue'
import App from './App.vue'// 导出一个工厂函数，用于创建新的应用程序、router、store实例
export function createApp () {const app = new Vue({// 根实例简单的渲染应用程序render: h => h(App)})return { app }
}

4.3 entry-client.js

客户端 entry 只需创建应用程序，并且将其挂载到 DOM 中

/*** 客户端入口*/
import { createApp } from './app'// 客户端特定引导逻辑……const { app } = createApp()// 这里假定 App.vue 模板中根元素具有 `id="app"`
app.$mount('#app')

4.4 entry-server.js

服务器 entry 使用 default export 导出函数，并在每次渲染中重复调用此函数。此时，除了创建和返回应用程序实例之外，它不会做太多事情 - 但是稍后我们将在此执行服务器端路由匹配 (server-sideroute matching) 和数据预取逻辑 (data pre-fetching logic)

/*** 服务端启动入口*/
import { createApp } from './app'export default context => {const { app } = createApp()// 服务端路由处理，数据预取...return app
}

五、构建同构渲染 - 构建配置

5.1 安装依赖

安装生产依赖

npm i vue vue-server-renderer express cross-env

包	说明
vue	Vue.js 核心库
vue-server-renderer	Vue 服务端渲染工具
express	基于 Node 的 Web 服务框架
cross-env	通过 npm scripts 设置跨平台环境变量

安装开发依赖

npm i -D webpack webpack-cli webpack-merge webpack-node-externals @babel/core @babel/plugin-transform-runtime @babel/preset-env babel-loader css-loader url-loader file-loader rimraf vue-loader vue-template-compiler friendly-errors-webpack-plugin

包	说明
webpack	webpack 核心包
webpack-cli	webpack 的命令行工具
webpack-merge	webpack 配置信息合并工具
webpack-node-externals	排除 webpack 中的 Node 模块
rimraf	基于 Node 封装的一个跨平台 rm -rf 工具
friendly-errors-webpack-plugin	友好的 webpack 错误提示
@babel/core	Babel 相关工具
@babel/plugin-transform-runtime	Babel 相关工具
@babel/preset-env babel-loader	Babel 相关工具
vue-loader	处理 .vue 资源
vue-template-compiler	处理 .vue 资源
file-loader	处理字体资源
css-loader	处理 CSS 资源
url-loader	处理图片资源

5.2 配置文件及打包命令

初始化 webpack 打包配置文件

build
├── webpack.base.config.js # 公共配置
├── webpack.client.config.js # 客户端打包配置文件
└── webpack.server.config.js # 服务端打包配置文件

webpack.base.config.js

/*** 公共配置*/
const VueLoaderPlugin = require('vue-loader/lib/plugin')
const path = require('path')
const FriendlyErrorsWebpackPlugin = require('friendly-errors-webpack-plugin')
const resolve = file => path.resolve(__dirname, file)const isProd = process.env.NODE_ENV === 'production'module.exports = {mode: isProd ? 'production' : 'development',output: {path: resolve('../dist/'),publicPath: '/dist/',filename: '[name].[chunkhash].js'},resolve: {alias: {// 路径别名，@ 指向 src'@': resolve('../src/')},// 可以省略的扩展名// 当省略扩展名的时候，按照从前往后的顺序依次解析extensions: ['.js', '.vue', '.json']},devtool: isProd ? 'source-map' : 'cheap-module-eval-source-map',module: {rules: [// 处理图片资源{test: /\.(png|jpg|gif)$/i,use: [{loader: 'url-loader',options: {limit: 8192,},},],},// 处理字体资源{test: /\.(woff|woff2|eot|ttf|otf)$/,use: ['file-loader',],},// 处理 .vue 资源{test: /\.vue$/,loader: 'vue-loader'},// 处理 CSS 资源// 它会应用到普通的 `.css` 文件// 以及 `.vue` 文件中的 `<style>` 块{test: /\.css$/,use: ['vue-style-loader','css-loader']},// CSS 预处理器，参考：https://vue-loader.vuejs.org/zh/guide/pre-processors.html// 例如处理 Less 资源// {//   test: /\.less$/,//   use: [//     'vue-style-loader',//     'css-loader',//     'less-loader'//   ]// },]},plugins: [new VueLoaderPlugin(),new FriendlyErrorsWebpackPlugin()]
}

webpack.client.config.js

/*** 客户端打包配置*/
const { merge } = require('webpack-merge')
const baseConfig = require('./webpack.base.config.js')
const VueSSRClientPlugin = require('vue-server-renderer/client-plugin')module.exports = merge(baseConfig, {entry: {app: './src/entry-client.js'},module: {rules: [// ES6 转 ES5{test: /\.m?js$/,exclude: /(node_modules|bower_components)/,use: {loader: 'babel-loader',options: {presets: ['@babel/preset-env'],cacheDirectory: true,plugins: ['@babel/plugin-transform-runtime']}}},]},// 重要信息：这将 webpack 运行时分离到一个引导 chunk 中，// 以便可以在之后正确注入异步 chunk。optimization: {splitChunks: {name: "manifest",minChunks: Infinity}},plugins: [// 此插件在输出目录中生成 `vue-ssr-client-manifest.json`。new VueSSRClientPlugin()]
})

webpack.server.config.js

/*** 服务端打包配置*/
const { merge } = require('webpack-merge')
const nodeExternals = require('webpack-node-externals')
const baseConfig = require('./webpack.base.config.js')
const VueSSRServerPlugin = require('vue-server-renderer/server-plugin')module.exports = merge(baseConfig, {// 将 entry 指向应用程序的 server entry 文件entry: './src/entry-server.js',// 这允许 webpack 以 Node 适用方式处理模块加载// 并且还会在编译 Vue 组件时，// 告知 `vue-loader` 输送面向服务器代码(server-oriented code)。target: 'node',output: {filename: 'server-bundle.js',// 此处告知 server bundle 使用 Node 风格导出模块(Node-style exports)libraryTarget: 'commonjs2'},// 不打包 node_modules 第三方包，而是保留 require 方式直接加载externals: [nodeExternals({// 白名单中的资源依然正常打包allowlist: [/\.css$/]})],plugins: [// 这是将服务器的整个输出构建为单个 JSON 文件的插件。// 默认文件名为 `vue-ssr-server-bundle.json`new VueSSRServerPlugin()]
})

在 npm scripts 中配置打包命令（package.json）

"scripts": {"build:client": "cross-env NODE_ENV=production webpack --config build/webpack.client.config.js","build:server": "cross-env NODE_ENV=production webpack --config build/webpack.server.config.js","build": "rimraf dist && npm run build:client && npm run build:server"
}

运行测试

npm run build:clientnpm run build:servernpm run build

5.3 启动应用

server.js

const Vue = require("vue");
const express = require("express");
const fs = require("fs");const serverBundle = require("./dist/vue-ssr-server-bundle.json");
const template = fs.readFileSync("./index.template.html", "utf-8");
const clientManifest = require("./dist/vue-ssr-client-manifest.json");
const renderer = require("vue-server-renderer").createBundleRenderer(serverBundle,{template,clientManifest,}
);const server = express();server.use("/dist", express.static("./dist"));server.get("/", (req, res) => {renderer.renderToString({title: "卷起来",meta: `<meta name="description" content="卷起来">`,},(err, html) => {if (err) {res.status(500).end("Internal Server Error.");}res.setHeader("Content-Type", "text/html; charset=utf-8");res.end(html);});
});server.listen(3000, () => {console.log("server runing at port 3000.");
});

启动项目

nodemon server.js

5.4 解析渲染流程

服务端渲染

renderer.renderToString 渲染了什么？
renderer 是如何拿到 entry-server 模块的？
- createBundleRenderer 中的 serverBundle
server Bundle 是 Vue SSR 构建的一个特殊的 JSON 文件
- entry：入口
- files：所有构建结果资源列表
- maps：源代码 source map 信息
server-bundle.js 就是通过 server.entry.js 构建出来的结果文件
最终把渲染结果注入到模板中

客户端渲染

vue-ssr-client-manifest.json
- publicPath：访问静态资源的根相对路径，与 webpack 配置中的 publicPath 一致
- all：打包后的所有静态资源文件路径
- initial：页面初始化时需要加载的文件，会在页面加载时配置到 preload 中
- async：页面跳转时需要加载的文件，会在页面加载时配置到 prefetch 中
- modules：项目的各个模块包含的文件的序号，对应 all 中文件的顺序；moduleIdentifier 和 all 数组中文件的映射关系（modules 对象是我们查找文件引用的重要数据）

六、构建同构渲染 - 构建配置开发模式

我们现在已经实现同构应用的基本功能了，但是这对于一个完整的应用来说还远远不够，例如如何处理同构应用中的路由、如何在服务端渲染中进行数据预取等功能

这些功能我们都会去对它进行实现，但是在实现它们之前我们要先来解决一个关于打包的问题：

每次写完代码，都要重新打包构建
重新启动 Web 服务
很麻烦…

所以下面我们来实现项目中的开发模式构建，也就是我们希望能够实现：

写完代码，自动构建
自动重启 Web 服务
自动刷新页面内容
…

6.1 基本思路

renderer 是通过打包的结果调用 createBundleRenderer 创建出来的。在生产模式下它是直接基于打包的结果创建的，但是在开发模式下 renderer 需要不断更新渲染

生产模式
- npm run build 构建
- node server.js 启动应用
开发模式
- 监视代码变动自动构建，热更新等功能
- node server.js 启动应用

package.json

"scripts": {..."start": "cross-env NODE_ENV=production node server.js","dev": "node server.js"
}

server.js

const Vue = require('vue')
const express = require('express')
const fs = require('fs')const isProd = process.env.NODE_ENV === 'production'let renderer
if (isProd) {const serverBundle = require('./dist/vue-ssr-server-bundle.json')const template = fs.readFileSync('./index.template.html', 'utf-8')const clientManifest = require('./dist/vue-ssr-client-manifest.json')renderer = require('vue-server-renderer').createBundleRenderer(serverBundle, {template,clientManifest})
} else {// 开发模式 -> 监视打包构建 -> 重新生成 Renderer 渲染器
}const server = express()server.use('/dist', express.static('./dist'))const render = (req, res) => {renderer.renderToString({title: '卷起来',meta: `<meta name="description" content="卷起来">`}, (err, html) => {if (err) {res.status(500).end('Internal Server Error.')}res.setHeader('Content-Type', 'text/html; charset=utf-8')res.end(html)})
}server.get('/', isProd? render: (req, res) => {// 等待有了 Renderer 渲染器以后，调用 render 进行渲染render()})server.listen(3000, () => {console.log('server runing at port 3000.')
})

6.2 提取处理模块

server.js

const Vue = require('vue')
const express = require('express')
const fs = require('fs')
const { createBundleRenderer } = require('vue-server-renderer')
const setupDevServer = require('./build/setup-dev-server')const isProd = process.env.NODE_ENV === 'production'
const server = express()let renderer
let onReady
if (isProd) {const serverBundle = require('./dist/vue-ssr-server-bundle.json')const template = fs.readFileSync('./index.template.html', 'utf-8')const clientManifest = require('./dist/vue-ssr-client-manifest.json')renderer = createBundleRenderer(serverBundle, {template,clientManifest})
} else {// 开发模式 -> 监视打包构建 -> 重新生成 Renderer 渲染器onReady = setupDevServer(server, (serverBundle, template, clientManifest) => {renderer = createBundleRenderer(serverBundle, {template,clientManifest})})
}server.use('/dist', express.static('./dist'))const render = (req, res) => {renderer.renderToString({title: '卷起来',meta: `<meta name="description" content="卷起来">`}, (err, html) => {if (err) {res.status(500).end('Internal Server Error.')}res.setHeader('Content-Type', 'text/html; charset=utf-8')res.end(html)})
}server.get('/', isProd? render: async (req, res) => {// 等待有了 Renderer 渲染器以后，调用 render 进行渲染await onReadyrender(req, res)})server.listen(3000, () => {console.log('server runing at port 3000.')
})

build/setup-dev-server.js

module.exports = (server, callback) => {const onReady = new Promise()// 监视构建 -> 更新 Rendererreturn onReady
}

6.3 update 更新函数

build/setup-dev-server.js

module.exports = (server, callback) => {let readyconst onReady = new Promise(r => ready = r)// 监视构建 -> 更新 Rendererlet templatelet serverBundlelet clientManifestconst update = () => {if (template && serverBundle && clientManifest) {ready()callback(serverBundle, template, clientManifest)}}// 监视构建 template -> 调用 update -> 更新 Renderer 渲染器// 监视构建 serverBundle -> 调用 update -> 更新 Renderer 渲染器// 监视构建 clientManifest -> 调用 update -> 更新 Renderer 渲染器return onReady
}

6.4 处理模版文件

npm install chokidar

build/setup-dev-server.js

const fs = require('fs')
const path = require('path')
const chokidar = require('chokidar')module.exports = (server, callback) => {...const update = ......// 监视构建 template -> 调用 update -> 更新 Renderer 渲染器const templatePath = path.resolve(__dirname, '../index.template.html')template = fs.readFileSync(templatePath, 'utf-8')update()// 监视模板文件// fs.watch、fs.watchFilechokidar.watch(templatePath).on('change', () => {template = fs.readFileSync(templatePath, 'utf-8')update()})// 监视构建 serverBundle -> 调用 update -> 更新 Renderer 渲染器// 监视构建 clientManifest -> 调用 update -> 更新 Renderer 渲染器return onReady
}

6.5 服务端监视打包

build/setup-dev-server.js

...
const webpack = require('webpack')const resolve = file => path.resolve(__dirname, file)module.exports = (server, callback) => {...// 监视构建 template -> 调用 update -> 更新 Renderer 渲染器...// 监视构建 serverBundle -> 调用 update -> 更新 Renderer 渲染器const serverConfig = require('./webpack.server.config')const serverCompiler = webpack(serverConfig)serverCompiler.watch({}, (err, stats) => {if (err) throw errif (stats.hasErrors()) returnserverBundle = JSON.parse(fs.readFileSync(resolve('../dist/vue-ssr-server-bundle.json'), 'utf-8'))update()})// 监视构建 clientManifest -> 调用 update -> 更新 Renderer 渲染器return onReady
}

6.6 把数据写入内存中

webpack 默认会把构建结果存储到磁盘中，对于生产模式构建来说是没有问题的；但是我们在开发模式中会频繁的修改代码触发构建，也就意味着要频繁的操作磁盘数据，而磁盘数据操作相对于来说是比较慢的，所以我们有一种更好的方式，就是把数据存储到内存中，这样可以极大的提高构建的速度

方案一：自己配置 memfs

memfs 是一个兼容 Node 中 fs 模块 API 的内存文件系统，通过它我们可以轻松的实现把 webpack 构建结果输出到内存中进行管理

方案二：使用 webpack-dev-middleware

webpack-dev-middleware 作用是，以监听模式启动 webpack，将编译结果输出到内存中，然后将内存文件输出到 Express 服务中
安装依赖

npm i -D webpack-dev-middleware

配置到构建流程中 build/setup-dev-server.js

...
const devMiddleware = require('webpack-dev-middleware')...module.exports = (server, callback) => {...// 监视构建 template -> 调用 update -> 更新 Renderer 渲染器...// 监视构建 serverBundle -> 调用 update -> 更新 Renderer 渲染器const serverConfig = require('./webpack.server.config')const serverCompiler = webpack(serverConfig)// serverCompiler.watch({}, (err, stats) => {//   if (err) throw err//   if (stats.hasErrors()) return//   serverBundle = JSON.parse(//     fs.readFileSync(resolve('../dist/vue-ssr-server-bundle.json'), 'utf-8')//   )//   update()// })const serverDevMiddleware = devMiddleware(serverCompiler, {logLevel: 'silent' // 关闭日志输出，由 FriendlyErrorsWebpackPlugin 处理})// 每当编译结束，触发钩子serverCompiler.hooks.done.tap('server', () => {serverBundle = JSON.parse(// fileSystem 获取内部操作文件系统的对象 类似 NodeJS 的 fsserverDevMiddleware.fileSystem.readFileSync(resolve('../dist/vue-ssr-server-bundle.json'), 'utf-8'))update()})// 监视构建 clientManifest -> 调用 update -> 更新 Renderer 渲染器return onReady
}

6.7 客户端构建

build/setup-dev-server.js

...
module.exports = (server, callback) => {...// 监视构建 template -> 调用 update -> 更新 Renderer 渲染器...// 监视构建 serverBundle -> 调用 update -> 更新 Renderer 渲染器...// 监视构建 clientManifest -> 调用 update -> 更新 Renderer 渲染器const clientConfig = require('./webpack.client.config')const clientCompiler = webpack(clientConfig)const clientDevMiddleware = devMiddleware(clientCompiler, {publicPath: clientConfig.output.publicPath, // 构建输出当中的请求前缀路径logLevel: 'silent' // 关闭日志输出，由 FriendlyErrorsWebpackPlugin 处理})// 每当编译结束，触发钩子clientCompiler.hooks.done.tap('client', () => {clientManifest = JSON.parse(// fileSystem 获取内部操作文件系统的对象 类似 NodeJS 的 fsclientDevMiddleware.fileSystem.readFileSync(resolve('../dist/vue-ssr-client-manifest.json'), 'utf-8'))update()})// 重要！！！将 clientDevMiddleware 挂载到 Express 服务中，提供对其内部内存中数据的访问server.use(clientDevMiddleware)return onReady
}

server.js

// express.static 处理的是物理磁盘的资源文件
server.use('/dist', express.static('./dist'))

build/setup-dev-server.js

...
// 重要！！！将 clientDevMiddleware 挂载到 Express 服务中，提供对其内部内存中数据的访问
server.use(clientDevMiddleware)

6.8 热更新

热更新功能需要使用到 webpack-hot-middleware 工具包

工作原理

中间件将自身安装为 webpack 插件，并侦听编译器事件
每个连接的客户端都有一个 Server Sent Events 连接，服务器将在编译器事件上向连接的客户端发布通知
- MDN - 使用服务器发送事件
- Server-Sent Events 教程
当客户端收到消息时，它将检查本地代码是否为最新。如果不是最新版本，它将触发 webpack 热模块重新加载

安装依赖

npm install --save-dev webpack-hot-middleware

build/setup-dev-server.js

...
const hotMiddleware = require('webpack-hot-middleware')...module.exports = (server, callback) => {...// 监视构建 template -> 调用 update -> 更新 Renderer 渲染器...// 监视构建 serverBundle -> 调用 update -> 更新 Renderer 渲染器...// 监视构建 clientManifest -> 调用 update -> 更新 Renderer 渲染器const clientConfig = require('./webpack.client.config')clientConfig.plugins.push(new webpack.HotModuleReplacementPlugin())clientConfig.entry.app = ['webpack-hot-middleware/client?quiet=true&reload=true', // 和服务端交互处理热更新一个客户端脚本clientConfig.entry.app // 原本的入口]clientConfig.output.filename = '[name].js' // 热更新模式下确保一致的 hashconst clientCompiler = webpack(clientConfig)const clientDevMiddleware = devMiddleware(clientCompiler, {publicPath: clientConfig.output.publicPath, // 构建输出当中的请求前缀路径logLevel: 'silent' // 关闭日志输出，由 FriendlyErrorsWebpackPlugin 处理})// 每当编译结束，触发钩子clientCompiler.hooks.done.tap('client', () => {clientManifest = JSON.parse(// fileSystem 获取内部操作文件系统的对象 类似 NodeJS 的 fsclientDevMiddleware.fileSystem.readFileSync(resolve('../dist/vue-ssr-client-manifest.json'), 'utf-8'))update()})server.use(hotMiddleware(clientCompiler, {log: false // 关闭热更新本身的日志输出}))// 重要！！！将 clientDevMiddleware 挂载到 Express 服务中，提供对其内部内存中数据的访问server.use(clientDevMiddleware)return onReady
}

七、编写通用应用注意事项

我们现在终于把实现 Vue SSR 同构应用的基础环境搭建起来了，虽然还有很多不足之处，但是也能满足我们当前的基本使用了，所以接下来我们就要把内容的核心转移到 Vue SSR 本身上了，那首先我们来了解一下编写通用应用的注意事项，通过了解这些注意事项对于如何正确的使用 Vue SSR 是非常有帮助的。在这些注意事项中，有些其实已经在前面的学习过程中了解过了，而有些还没有接触过，所以在这里通过官方文档做一个简单的总结

7.1 服务器上的数据响应

在纯客户端应用程序 (client-only app) 中，每个用户会在他们各自的浏览器中使用新的应用程序实例。对于服务器端渲染，我们也希望如此：每个请求应该都是全新的、独立的应用程序实例，以便不会有交叉请求造成的状态污染 (cross-request state pollution)

app.js

// 导出一个工厂函数，用于创建新的应用程序、router、store实例
export function createApp () {const app = new Vue({// 根实例简单的渲染应用程序render: h => h(App)})return { app }
}// const app = new Vue({//   // 根实例简单的渲染应用程序
//   render: h => h(App)
// })

因为实际的渲染过程需要确定性，所以我们也将在服务器上“预取”数据 (“pre-fetching” data) - 这意味着在我们开始渲染时，我们的应用程序就已经解析完成其状态。也就是说，将数据进行响应式的过程在服务器上是多余的，所以默认情况下禁用。禁用响应式数据，还可以避免将「数据」转换为「响应式对象」的性能开销

7.2 组件生命周期钩子函数

由于没有动态更新，所有的生命周期钩子函数中，只有 beforeCreate 和 created 会在服务器端渲染(SSR) 过程中被调用。这就是说任何其他生命周期钩子函数中的代码（例如 beforeMount 或 mounted ），只会在客户端执行
此外还需要注意的是，你应该避免在 beforeCreate 和 created 生命周期时产生全局副作用的代码，例如在其中使用 setInterval 设置 timer。在纯客户端 (client-side only) 的代码中，我们可以设置一个 timer，然后在 beforeDestroy 或 destroyed 生命周期时将其销毁。但是，由于在 SSR 期间并不会调用销毁钩子函数，所以 timer 将永远保留下来。为了避免这种情况，请将副作用代码移动到 beforeMount 或 mounted 生命周期中

7.3 访问特定平台(Platform-Specific) API

通用代码不可接受特定平台的 API，因此如果你的代码中，直接使用了像 window 或 document ，这种仅浏览器可用的全局变量，则会在 Node.js 中执行时抛出错误，反之也是如此
对于共享于服务器和客户端，但用于不同平台 API 的任务(task)，建议将平台特定实现包含在通用 API 中，或者使用为你执行此操作的 library。例如，axios 是一个 HTTP 客户端，可以向服务器和客户端都暴露相同的 API
对于仅浏览器可用的 API，通常方式是，在「纯客户端 (client-only)」的生命周期钩子函数中惰性访问(lazily access) 它们
请注意，考虑到如果第三方 library 不是以上面的通用用法编写，则将其集成到服务器渲染的应用程序中，可能会很棘手。你可能要通过模拟 (mock) 一些全局变量来使其正常运行，但这只是 hack 的做法，并且可能会干扰到其他 library 的环境检测代码

7.4 自定义指令

大多数自定义指令直接操作 DOM，因此会在服务器端渲染 (SSR) 过程中导致错误。有两种方法可以解决这个问题：

推荐使用组件作为抽象机制，并运行在「虚拟 DOM 层级(Virtual-DOM level)」（例如，使用渲染函数(render function)）
如果你有一个自定义指令，但是不是很容易替换为组件，则可以在创建服务器 renderer 时，使用 directives 选项所提供"服务器端版本(server-side version)"

7.5 区分运行环境

参考：https://webpack.docschina.org/plugins/define-plugin/

new webpack.DefinePlugin({'process.client': true,'process.server': false
})

八、路由处理

8.1 配置 VueRouter - router

官方文档给出的解决方案肯定还是使用 vue-router，整体使用方式和纯客户端的使用方式基本一致，只需要在少许的位置做一些配置就可以了。文档中已经把配置的方式描述的很清楚了，建议大家认真看一下文档，下面我把具体的实现来演示一下

router/index.js

import Vue from 'vue'
import VueRouter from 'vue-router'
import Home from '@/pages/Home'Vue.use(VueRouter)export const createRouter = () => {const router = new VueRouter({mode: 'history', // 同构应用不能使用 hash 路由，应该使用 history 模式routes: [{path: '/',name: 'home',component: Home},{path: '/about',name: 'about',component: () => import('@/pages/About')},{path: '*',name: 'error404',component: () => import('@/pages/404')}]})return router
}

8.2 将路由注册到根实例

app.js

/*** 通用启动入口*/
import Vue from 'vue'
import App from './App.vue'
import { createRouter } from './router'// 导出一个工厂函数，用于创建新的应用程序、router、store实例
export function createApp () {const router = createRouter()const app = new Vue({router, // 把路由挂载到 Vue 根实例中// 根实例简单的渲染应用程序render: h => h(App)})return { app, router }
}

8.3 适配服务端入口

entry-server.js

/*** 服务端启动入口 */
import { createApp } from './app'export default async context => {// 因为有可能会是异步路由钩子函数或组件，所以我们将返回一个 Promise，// 以便服务器能够等待所有的内容在渲染前，就已经准备就绪。const { app, router } = createApp()// 设置服务器端 router 的位置router.push(context.url)// 等到 router 将可能的异步组件和钩子函数解析完await new Promise(router.onReady.bind(router))return app
}

8.4 服务端适配

server.js

...const render = async (req, res) => {try {const html = await renderer.renderToString({title: '卷起来',meta: `<meta name="description" content="卷起来">`,url: req.url})res.setHeader('Content-Type', 'text/html; charset=utf-8')res.end(html)} catch (err) {res.status(500).end('Internal Server Error.')}
}// 服务端路由设置为 *，意味着所有的路由都会进入这里
server.get('*', isProd? render: async (req, res) => {// 等待有了 Renderer 渲染器以后，调用 render 进行渲染await onReadyrender(req, res)}
)...

8.5 适配客户端入口

entry-client.js

/*** 客户端入口*/
import { createApp } from './app'// 客户端特定引导逻辑……const { app, router } = createApp()router.onReady(() => {// 这里假定 App.vue 模板中根元素具有 `id="app"`app.$mount('#app')
})

8.6 根组件

App.vue

<template><div id="app"><ul><li><router-link to="/">Home</router-link></li><li><router-link to="/about">About</router-link></li></ul><!-- 路由出口 --><router-view/></div>
</template>

8.7 处理完成

当你首次访问页面的时候，它是通过服务端渲染出来的，服务端渲染拥有了更快的渲染速度以及更好的 SEO，当服务端渲染的内容来到客户端以后被客户端 Vue 结合 Vue Router 激活，摇身一变成为了一个客户端 SPA 应用，之后的页面导航也不需要重新刷新整个页面。这样我们的网站就既拥有了更好的渲染速度，也拥有了更好的用户体验
除此之外，我们在路由中配置的异步组件（也叫路由懒加载）也是非常有意义，它们会被分割为独立的 chunk（也就是单独的文件），只有在需要的时候才会进行加载。这样就能够避免在初始渲染的时候客户端加载的脚本过大导致激活速度变慢的问题。关于它也可以来验证一下，通过 npm run build 打包构建，我们发现它们确实被分割成了独立的 chunk。然后再来看一下在运行期间这些 chunk 文件是如何加载的
你会发现除了 app 主资源外，其它的资源也被下载下来了，你是不是要想说：不是应该在需要的时候才加载吗？为什么一上来就加载了
原因是在页面的头部中的带有 preload 和 prefetch 的 link 标签
我们期望客户端 JavaScript 脚本尽快加载尽早的接管服务端渲染的内容，让其拥有动态交互能力，但是如果你把 script 标签放到这里的话，浏览器会去下载它，然后执行里面的代码，这个过程会阻塞页面的渲染
所以看到真正的 script 标签是在页面的底部的。而这里只是告诉浏览器可以去预加载这个资源。但是不要执行里面的代码，也不要影响网页的正常渲染。直到遇到真正的 script 标签加载该资源的时候才会去执行里面的代码，这个时候可能已经预加载好了，直接使用就可以了，如果没有加载好，也不会造成重复加载，所以不用担心这个问题
而 prefetch 资源是加载下一个页面可能用到的资源，浏览器会在空闲的时候对其进行加载，所以它并不一定会把资源加载出来，而 preload 一定会预加载。所以你可以看到当我们去访问 about 页面的时候，它的资源是通过 prefetch 预取过来的，提高了客户端页面导航的响应速度

九、管理页面 Head

无论是服务端渲染还是客户端渲染，它们都使用的同一个页面模板
页面中的 body 是动态渲染出来的，但是页面的 head 是写死的，也就说我们希望不同的页面可以拥有自己的 head 内容，例如页面的 title、meta 等内容，所以下面我们来了解一下如何让不同的页面来定制自己的 head 头部内容
官方文档这里专门描述了关于页面 Head 的处理，相对于来讲更原生一些，使用比较麻烦
这里主要给大家介绍一个第三方解决方案：vue-meta
- Vue Meta 是一个支持 SSR 的第三方 Vue.js 插件，可让你轻松的实现不同页面的 head 内容管理
- 使用它的方式非常简单，而只需在页面组件中使用 metaInfo 属性配置页面的 head 内容即可

安装

npm i vue-meta

在通用入口 app.js 中通过插件的方式将 vue-meta 注册到 Vue 中

import Vue from 'vue'
import VueMeta from 'vue-meta'Vue.use(VueMeta)Vue.mixin({metaInfo: {titleTemplate: '%s - 卷起来'}
})
...

然后在服务端渲染入口模块中适配 vue-meta

// entry-server.js
import { createApp } from './app'export default async context => {...const meta = app.$meta()// 设置服务器端 router 的位置router.push(context.url)context.meta = meta...
}

最后在模板页面 index.template.html 中注入 meta 信息

<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"><meta name="viewport" content="width=device-width, initial-scale=1.0">{{{ meta.inject().title.text() }}}{{{ meta.inject().meta.text() }}}
</head><body><!--vue-ssr-outlet-->
</body></html>

下面就是直接在组件中使用即可

export default {...metaInfo: {title: '首页'}
}

十、数据预取和状态管理

10.1 思路分析

我们这里通过一个实际的业务需求来引入这个话题

我们的需求就是：

已知有一个数据接口，接口返回一个文章列表数据
我们想要通过服务端渲染的方式来把异步接口数据渲染到页面中

也就是说我们要在服务端获取异步接口数据，交给 Vue 组件去渲染
在组件中添加生命周期钩子，beforeCreate 和 created，服务端渲染仅支持这两个钩子函数的调用
然后下一个问题是如何在服务端发送请求？依然使用 axios，axios 既可以运行在客户端也可以运行在服务端，因为它对不同的环境做了适配处理，在客户端是基于浏览器的XMLHttpRequest 请求对象，在服务端是基于 Node.js 中的 http 模块实现，无论是底层是什么，上层的使用方式都是一样的

Post.vue

<template><div><h1>Post List</h1><ul><li v-for="post in posts" :key="post.id">{{ post.title }}</li></ul></div>
</template>

router/index.vue

{path: '/posts',name: 'post-list',component: () => import('@/pages/Posts')
}

App.vue

<li><router-link to="/posts">Posts</router-link>
</li>

安装 axios

npm install axios

Post.vue

<script>
import axios from 'axios'export default {name: 'PostList',metaInfo: {title: 'Posts'},data () {return {posts: []}},// 服务端渲染//     只支持 beforeCreate 和 created//     不会等待 beforeCreate 和 created 中的异步操作//     不支持响应式数据// 所有这种做法在服务端渲染中是不会工作的！！！async created () {console.log('Posts Created Start')const { data } = await axios({method: 'GET',url: 'https://cnodejs.org/api/v1/topics'})this.posts = data.dataconsole.log('Posts Created End')}
}
</script>

注意：这个内容并不是通过服务端渲染过来，而是通过客户端渲染而来的！

10.2 数据预取

通过官方文档我们可以看到，它的核心思路就是把在服务端渲染期间获取的数据存储到 Vuex 容器中，然后把容器中的数据同步到客户端，这样就保持了前后端渲染的数据状态同步，避免了客户端重新渲染的问题

通过 Vuex 创建容器实例，并挂载到 Vue 根实例

安装 Vuex

npm i vuex

创建 Vuex 容器 store/index.js

import Vue from 'vue'
import Vuex from 'vuex'
import axios from 'axios'Vue.use(Vuex)export const createStore = () => {return new Vuex.Store({state: () => ({posts: []}),mutations: {setPosts (state, data) {state.posts = data}},actions: {// 在服务端渲染期间务必让 action 返回一个 Promiseasync getPosts ({ commit }) {// return new Promise()const { data } = await axios.get('https://cnodejs.org/api/v1/topics')commit('setPosts', data.data)}}})
}

app.js

/*** 通用启动入口*/
import Vue from 'vue'
import App from './App.vue'
import { createRouter } from './router'
import VueMeta from 'vue-meta'
import { createStore } from './store'Vue.use(VueMeta)Vue.mixin({metaInfo: {titleTemplate: '%s - 卷起来'}
})// 导出一个工厂函数，用于创建新的应用程序、router、store实例
export function createApp () {const router = createRouter()const store = createStore()const app = new Vue({router, // 把路由挂载到 Vue 根实例中store, // 把容器挂载到 Vue 根实例中// 根实例简单的渲染应用程序render: h => h(App)})return { app, router, store }
}

在组件中使用 serverPrefetch 触发容器中的 action

Post.vue

<script>
import { mapState, mapActions } from 'vuex'export default {name: 'PostList',metaInfo: {title: 'Posts'},data () {return {// posts: []}},computed: {...mapState(['posts'])},// Vue SSR 特殊为服务端渲染提供的一个生命周期钩子函数serverPrefetch () {// 发起 action，返回 Promise// return this.$store.dispatch('getPosts')return this.getPosts()},methods: {...mapActions(['getPosts'])}
}
</script>

此时我们拿到的数据只是存储在了服务端的 Vuex 容器当中了，我们也应该把数据同步到客户端的 Vuex 容器当中
否则就会出现两个端数据不同步的问题，就会导致合并失败从而使得客户端重新渲染

10.3 将预取数据同步到客户端

在服务端渲染应用入口中将容器状态序列化到页面中

接下来我们要做的就是把在服务端渲染期间所获取填充到容器中的数据同步到客户端容器中，从而避免两个端状态不一致导致客户端重新渲染的问题

将容器中的 state 转为 JSON 格式字符串
生成代码： window.__INITIAL__STATE = 容器状态 语句插入模板页面中
客户端通过 window.__INITIAL__STATE 获取该数据

entry-server.js

// entry-server.js
import { createApp } from './app'export default async context => {// 因为有可能会是异步路由钩子函数或组件，所以我们将返回一个 Promise，// 以便服务器能够等待所有的内容在渲染前，就已经准备就绪。const { app, router, store } = createApp()...context.rendered = () => {// Renderer 会把 context.state 数据对象内联到页面模板中// 最终发送给客户端的页面中会包含一段脚本：window.__INITIAL_STATE__ = context.state// 客户端就要把页面中的 window.__INITIAL_STATE__ 拿出来填充到客户端 store 容器中context.state = store.state}return app
}

最后，在客户端渲染入口中把服务端传递过来的状态数据填充到客户端 Vuex 容器中

/*** 客户端入口*/
import { createApp } from './app'// 客户端特定引导逻辑……const { app, router, store } = createApp()if (window.__INITIAL_STATE__) {store.replaceState(window.__INITIAL_STATE__)
}...

Vue.js 框架源码与进阶 - 搭建自己的SSR相关推荐

Vue.js 框架源码与进阶 - Vue.js 源码剖析 - 响应式原理
文章目录一.准备工作 1.1 Vue 源码的获取 1.2 源目录结构 1.3 了解 Flow 1.4 调试设置 1.5 Vue 的不同构建版本 1.6 寻找入口文件 1.7 从入口开始二.Vue ...
vue事件总线_[面试] 聊聊你对 Vue.js 框架的理解
作者:yacan8 https://github.com/yacan8/blog/issues/26 本文为一次前端技术分享的演讲稿,所以尽力不贴 Vue.js 的源码,因为贴代码在实际分享中,比较枯 ...
js中立即执行函数会预编译吗_面试官：聊聊对Vue.js框架的理解
作者:yacan8 https://github.com/yacan8/blog/issues/26 本文为一次前端技术分享的演讲稿,所以尽力不贴 Vue.js 的源码,因为贴代码在实际分享中,比较枯 ...
面试官：聊聊对Vue.js框架的理解
作者:yacan8 https://github.com/yacan8/blog/issues/26 本文为一次前端技术分享的演讲稿,所以尽力不贴 Vue.js 的源码,因为贴代码在实际分享中,比较枯 ...
js 获得明天0点时间戳_Python 3+Django 3 结合Vue.js框架构建前后端分离Web开发平台实战...
点击上方"测试开发技术",选择设为"设为星标" 优质文章,第一时间送达! 学习全文大概需要 12分钟,内容实战性较强. 1. 前言本篇将基于Python 3. ...
知乎问答：一年内的前端看不懂前端框架源码怎么办？
知乎问答:一年内的前端看不懂前端框架源码怎么办?以下是我的回答,阅读量 1000+.现在转载到微信公众号中.链接:https://www.zhihu.com/question/350289336/an ...
Vue.js 框架从入门到精通，只需要它！
点击蓝字关注我们你还在一行一行低效代码吗?你还在不停地操作 DOM 吗?你的代码还会频繁出现 CSS.Javascript 配置文件冲突吗? Vue3 框架快速解决你的代码低效问题! 01 Vue ...
从零吃透 Vue.js 框架，这里全部有！
点击蓝字关注我们你还在一行一行低效代码吗?你还在不停地操作 DOM 吗?你的代码还会频繁出现 CSS.Javascript 配置文件冲突吗? Vue3 框架快速解决你的代码低效问题! 01 Vue ...
php 公众号框架知乎,知乎问答：一年内的前端看不懂前端框架源码怎么办？
知乎问答:一年内的前端看不懂前端框架源码怎么办?以下是我的回答,阅读量 1000+.现在转载到微信公众号中.链接:https://www.zhihu.com/question/350289336/an ...

Vue.js 框架源码与进阶 - 搭建自己的SSR

文章目录

一、Vue SSR 介绍

1.1 Vue SSR 是什么

1.2 使用场景

1.3 如何实现 Vue SSR

二、Vue SSR 基本使用

2.1 渲染一个 Vue 实例

2.2 与服务器集成

2.3 使用一个页面模板

2.4 在模板中使用外部数据

三、构建同构渲染 - 构建流程

四、构建同构渲染 - 源码结构

4.1 App.vue

4.2 app.js

4.3 entry-client.js

4.4 entry-server.js

五、构建同构渲染 - 构建配置

5.1 安装依赖

5.2 配置文件及打包命令

5.3 启动应用

5.4 解析渲染流程

六、构建同构渲染 - 构建配置开发模式

6.1 基本思路

6.2 提取处理模块

6.3 update 更新函数

6.4 处理模版文件

6.5 服务端监视打包

6.6 把数据写入内存中

6.7 客户端构建

6.8 热更新

七、编写通用应用注意事项

7.1 服务器上的数据响应

7.2 组件生命周期钩子函数

7.3 访问特定平台(Platform-Specific) API

7.4 自定义指令

7.5 区分运行环境

八、路由处理

8.1 配置 VueRouter - router

8.2 将路由注册到根实例

8.3 适配服务端入口

8.4 服务端适配

8.5 适配客户端入口

8.6 根组件

8.7 处理完成

九、管理页面 Head

十、数据预取和状态管理

10.1 思路分析

10.2 数据预取

10.3 将预取数据同步到客户端

Vue.js 框架源码与进阶 - 搭建自己的SSR相关推荐

最新文章

热门文章