Detailed explanation of SSR function in Vue3: implementing server-side rendering-Vue.js-php.cn

Detailed explanation of SSR function in Vue3: implementing server-side rendering

WBOY

Release： 2023-06-18 09:04:08

Original

5566 people have browsed it

With the continuous development of front-end technology, more and more websites are beginning to try to use server-side rendering (SSR) to speed up page response speed and improve SEO effects. As one of the most popular front-end frameworks at the moment, Vue3 has also added full support for SSR in its latest version. This article will provide a detailed analysis and explanation of the SSR function in Vue3.

1. What is SSR?

Before formally introducing the SSR function in Vue3, we need to first understand what server-side rendering (SSR) is. Simply put, SSR renders the Vue component into an HTML string on the server side, and then sends the HTML string to the browser for display. Compared with the traditional client-side rendering (CSR) method, SSR can increase the speed of first-screen rendering, improve SEO effects and user experience.

2. SSR functions in Vue3

Vue3 provides a set of functions for SSR, including createSSRApp, createRenderer and renderToString.

createSSRApp

createSSRApp is a function specifically used to create SSR applications in Vue3. The difference from createApp is that this function returns an application instance relative to the server, and when creating this application instance, you need to introduce a so-called context context object. This object contains rendering-related content, such as page URL, request headers, etc.

createRenderer

createRenderer is a function used to create a renderer and can accept a parameter, which is a RenderOptions object. This object encapsulates the relevant configuration of the renderer, such as passing the application instance here to start, how to handle different types of vnodes respectively, etc.

renderToString

renderToString is the render function corresponding to this SSR application. This function only accepts one Vue application instance as a parameter. If you want to render multiple application instances, you need to call them sequentially. The return value of this function is the rendered result string.

3. Implement server-side rendering

The above three functions are the core functions used to support SSR in Vue3. Next, we will use a simple example to show how to use them to implement the server. side rendering.

We assume we have a simple Vue component as follows:

<template>
  <div>
    {{ message }}
  </div>
</template>

<script>
export default {
  data() {
    return {
      message: 'Hello, Vue3 SSR!'
    }
  }
}
</script>

Copy after login

We need to modify the entry file first and use the createSSRApp function to create our application instance:

import { createSSRApp } from 'vue'
import App from './App.vue'

export function createApp() {
  const app = createSSRApp(App)
  return { app }
}

Copy after login

Then We need to create a renderer to render the Vue instance:

import { createRenderer } from 'vue'
import { createMemoryHistory, createRouter, RouterView } from 'vue-router'
import { renderToString } from '@vue/server-renderer'
import { createApp } from './main'

const renderer = createRenderer({
  history: createMemoryHistory(),
  renderOptions: {
    head: `
      <meta charset="utf-8">
      <meta name="viewport" content="width=device-width, initial-scale=1">
    `
  }
})

const router = createRouter({
  history: createMemoryHistory(),
  routes: [{ path: '/', component: RouterView }]
})

async function render() {
  const { app } = await createApp()
  const html = await renderer.renderToString(router)
  return `<html><body>${html}</body></html>`
}

Copy after login

We introduced the createRenderer function in vue-server-renderer and created a router instance. Next, we need to pre-fill the data in the App.vue file to ensure that the HTML string data rendered on the server side is the same as when rendered on the client side. We can write the previously rendered results to the page when making a request on the server side, and then pass it to the client for rendering.

import { createSSRApp } from 'vue'
import App from './App.vue'

export function createApp() {
  const app = createSSRApp(App)
  const initialState = window.__INITIAL_STATE__
  if (initialState) {
    app.$data = initialState
  }
  return { app }
}

Copy after login

Finally, we return the rendered HTML string to the client.

import express from 'express'
import { render } from './server'

const app = express()

app.get('*', async (req, res) => {
  const html = await render(req.url)
  res.send(html)
})

const PORT = 3000
app.listen(PORT, () => {
  console.log(`Server running at http://localhost:${PORT}`)
})

Copy after login

The above is a simple implementation example of Vue3 server-side rendering.

4. Summary

This article introduces the SSR functions in Vue3, and uses a simple example to introduce how to use these functions to implement server-side rendering. I believe that through the introduction of this article, readers can already have a clearer understanding of the SSR functions in Vue3, and can use them to implement their own server-side rendering applications.

The above is the detailed content of Detailed explanation of SSR function in Vue3: implementing server-side rendering. For more information, please follow other related articles on the PHP Chinese website!