API 参考

createRenderer

使用(可选的)选项创建一个 Renderer 实例。

const { createRenderer } = require('vue-server-renderer')
const renderer = createRenderer({ /* 选项 */ })

createBundleRenderer

使用 server bundle 和(可选的)选项创建一个 BundleRenderer 实例。

const { createBundleRenderer } = require('vue-server-renderer')
const renderer = createBundleRenderer(serverBundle, { /* 选项 */ })

serverBundle 参数可以是以下之一:

  • 绝对路径,指向一个已经构建好的 bundle 文件(.js.json)。必须以 / 开头才会被识别为文件路径。

  • 由 webpack + vue-server-renderer/server-plugin 生成的 bundle 对象。

  • JavaScript 代码字符串(不推荐)。

更多细节请查看 Server Bundle 指引构建配置

Class: Renderer

renderer.renderToString

函数签名:

renderer.renderToString(vm, context?, callback?): ?Promise<string>

将 Vue 实例渲染为字符串。上下文对象(context object)可选。回调函数是典型的 Node.js 风格回调,其中第一个参数是可能抛出的错误,第二个参数是渲染完毕的字符串。

在 2.5.0+ 版本中,此 callback 回调函数是可选项。在不传递 callback 时,此方法返回一个 Promise 对象,在其 resolve 后返回最终渲染的 HTML。

renderer.renderToStream

函数签名:

renderer.renderToStream(vm[, context]): stream.Readable

将 Vue 实例渲染为一个 Node.js 可读流。上下文对象(context object)可选。更多细节请查看流式渲染

Class: BundleRenderer

bundleRenderer.renderToString

函数签名:

bundleRenderer.renderToString([context, callback]): ?Promise<string>

将 bundle 渲染为字符串。上下文对象(context object)可选。回调是一个典型的 Node.js 风格回调,其中第一个参数是可能抛出的错误,第二个参数是渲染完毕的字符串。

在 2.5.0+ 版本中,此 callback 回调函数是可选项。在不传递 callback 时,此方法返回一个 Promise 对象,在其 resolve 后返回最终渲染的 HTML。

bundleRenderer.renderToStream

函数签名:

bundleRenderer.renderToStream([context]): stream.Readable

将 bundle 渲染为一个 Node.js 可读流。上下文对象(context object)可选。更多细节请查看流式渲染

Renderer 选项

template

为整个页面的 HTML 提供一个模板。此模板应包含注释 <!--vue-ssr-outlet-->,作为渲染应用程序内容的占位符。

模板还支持使用渲染上下文(render context)进行基本插值:

  • 使用双花括号(double-mustache)进行 HTML 转义插值(HTML-escaped interpolation);
  • 使用三花括号(triple-mustache)进行 HTML 不转义插值(non-HTML-escaped interpolation)。

当在渲染上下文(render context)上存在一些特定属性时,模板会自动注入对应的内容:

  • context.head:(字符串)将会被作为 HTML 注入到页面的头部(head)里。

  • context.styles:(字符串)内联 CSS,将以 style 标签的形式注入到页面头部。注意,如过你使用了 vue-loader + vue-style-loader 来处理组件 CSS,此属性会在构建过程中被自动生成。

  • context.state:(对象)初始 Vuex store 状态,将以 window.__INITIAL_STATE__ 的形式内联到页面。内联的 JSON 将使用 serialize-javascript 自动清理,以防止 XSS 攻击。

    在 2.5.0+ 版本中,嵌入式 script 也可以也可以在生产模式(production mode)下自行移除。

此外,当提供 clientManifest 时,模板会自动注入以下内容:

  • 渲染当前页面所需的最优客户端 JavaScript 和 CSS 资源(支持自动推导异步代码分割所需的文件);
  • 为要渲染页面提供最佳的 <link rel="preload/prefetch"> 资源提示(resource hints)。

你也可以通过将 inject: false 传递给 renderer,来禁用所有自动注入。

具体查看:

clientManifest

通过此选项提供一个由 vue-server-renderer/client-plugin 生成的客户端构建 manifest 对象(client build manifest object)。此对象包含了 webpack 整个构建过程的信息,从而可以让 bundle renderer 自动推导需要在 HTML 模板中注入的内容。更多详细信息,请查看生成 clientManifest

inject

控制使用 template 时是否执行自动注入。默认是 true

参考:手动资源注入(Manual Asset Injection)

shouldPreload

一个函数,用来控制什么文件应该生成 <link rel="preload"> 资源预加载提示(resource hints)。

默认情况下,只有 JavaScript 和 CSS 文件会被预加载,因为它们是启动应用时所必需的。

对于其他类型的资源(如图像或字体),预加载过多可能会浪费带宽,甚至损害性能,因此预加载什么资源具体依赖于场景。你可以使用 shouldPreload 选项精确控制预加载资源:

const renderer = createBundleRenderer(bundle, {
  template,
  clientManifest,
  shouldPreload: (file, type) => {
    // 基于文件扩展名的类型推断。
    // https://fetch.spec.whatwg.org/#concept-request-destination
    if (type === 'script' || type === 'style') {
      return true
    }
    if (type === 'font') {
      // 只预加载 woff2 字体
      return /\.woff2$/.test(file)
    }
    if (type === 'image') {
      // 只预加载重要 images
      return file === 'hero.jpg'
    }
  }
})

shouldPrefetch

  • 2.5.0+

一个函数,用来控制对于哪些文件,是需要生成 <link rel="prefetch"> 资源提示。

默认情况下,异步 chunk 中的所有资源都将被预取,因为这是低优先级指令; 然而,为了更好地控制带宽使用情况,你也可以自定义要预取的资源。此选项具有与 shouldPreload 相同的函数签名。

runInNewContext

  • 只用于 createBundleRenderer
  • 期望值:boolean | 'once''once' 只在 2.3.1+ 支持)

默认情况下,对于每次渲染,bundle renderer 将创建一个新的 V8 上下文并重新执行整个 bundle。这具有一些好处 - 例如,应用程序代码与服务器进程隔离,我们无需担心文档中提到的状态单例问题。然而,这种模式有一些相当大的性能开销,因为重新创建上下文并执行整个 bundle 还是相当昂贵的,特别是当应用很大的时候。

出于向后兼容的考虑,此选项默认为 true,但建议你尽可能使用 runInNewContext: falserunInNewContext: 'once'

在 2.3.0 中,此选项有一个 bug,其中 runInNewContext: false 仍然使用独立的全局上下文(separate global context)执行 bundle。以下信息假定版本为 2.3.1+。

使用 runInNewContext: false,bundle 代码将与服务器进程在同一个 global 上下文中运行,所以请留意在应用程序代码中尽量避免修改 global

使用 runInNewContext: 'once' (2.3.1+),bundle 将在独立的全局上下文(separate global context)取值,然而只在启动时取值一次。这提供了一定程度的应用程序代码隔离,因为它能够防止 bundle 中的代码意外污染服务器进程的 global 对象。注意事项如下:

  1. 在此模式下,修改 global(例如,polyfill)的依赖模块必须被打包进 bundle,不能被外部化 (externalize);
  2. 从 bundle 执行返回的值将使用不同的全局构造函数,例如,在服务器进程中捕获到 bundle 内部抛出的错误,使用的是 bundle 上下文中的 Error 构造函数,所以它不会是服务器进程中 Error 的一个实例。

参考:源码结构

basedir

  • 只用于 createBundleRenderer

显式地声明 server bundle 的运行目录。运行时将会以此目录为基准来解析 node_modules 中的依赖模块。只有在所生成的 bundle 文件与外部的 NPM 依赖模块放置在不同位置,或者 vue-server-renderer 是通过 NPM link 链接到当前项目中时,才需要配置此选项。

cache

提供组件缓存具体实现。缓存对象必须实现以下接口(使用 Flow 语法表示):

type RenderCache = {
  get: (key: string, cb?: Function) => string | void;
  set: (key: string, val: string) => void;
  has?: (key: string, cb?: Function) => boolean | void;
};

典型用法是传入 lru-cache

const LRU = require('lru-cache')

const renderer = createRenderer({
  cache: LRU({
    max: 10000
  })
})

请注意,缓存对象应至少要实现 getset。此外,如果 gethas 接收第二个参数作为回调,那 gethas 也可以是可选的异步函数。这允许缓存使用异步 API,例如,一个 Redis 客户端:

const renderer = createRenderer({
  cache: {
    get: (key, cb) => {
      redisClient.get(key, (err, res) => {
        // 处理任何错误
        cb(res)
      })
    },
    set: (key, val) => {
      redisClient.set(key, val)
    }
  }
})

directives

对于自定义指令,允许提供服务器端实现:

const renderer = createRenderer({
  directives: {
    example (vnode, directiveMeta) {
      // 基于指令绑定元数据(metadata)转换 vnode
    }
  }
})

例如,请查看 v-show 的服务器端实现

webpack 插件

webpack 插件作为独立文件提供,并且应当直接 require:

const VueSSRServerPlugin = require('vue-server-renderer/server-plugin')
const VueSSRClientPlugin = require('vue-server-renderer/client-plugin')

生成的默认文件是:

  • vue-ssr-server-bundle.json 用于服务器端插件;
  • vue-ssr-client-manifest.json 用于客户端插件。

创建插件实例时可以自定义文件名:

const plugin = new VueSSRServerPlugin({
  filename: 'my-server-bundle.json'
})

更多信息请查看构建配置