# Server-side render

Support in 2.8.0+

# Introduction

# What is server-side render?

Server-Side Render means that a single-page application (SPA) is rendered as an HTML fragment on the server side, sent to the browser, and then bound to the state and events to become a fully interactive page. the process of.

uml diagram

# Differences from CSR(Client-Side render)

Subsequently referred to as server-side render as SSR, client-side render as CSR

As shown below:

uml diagram

Compare SPA Site with SSR Site in SEO difference:


The advantages of SSR are:

  • More friendly SEO : The crawler can directly grab the rendered page. The first time the CSR returns the HTML document, it is an empty node (root) and contains no content. The SSR returns the HTML fragment after rendering, the content is complete, so it can be better analyzed and indexed by the crawler.
  • Faster first screen loading speed: Show content without waiting for JavaScript to complete the download and execution, and see the fully rendered page faster. Have a better user experience.
  • Requires server support: Umijs focuses on application UI layer rendering, and SSR requires server (eg Node.js) support.

# Umi SSR features

  • Server framework is not relevant
  • Support CSS Modules
  • Support TypeScript
  • Support local development HMR
  • Support dva
  • Support Serverless

# Usage

# Umi Configuration

Turn on ssr: true in config file, more Configuration:

export default {
  ssr: true,

After enable, running umi build will generate the following files:

├── dist
│   ├── index.html
│   ├── ssr-client-mainifest.json
│   ├── umi.css
│   ├── umi.js
│   └── umi.server.js

# Server-Side

Regardless of the server-side framework, Umijs focuses on application UI layer rendering, which is not coupled to the server-side framework.

In order to reduce the server framework access threshold, Umi provides umi-server and uses the common Node.js server framework (Koajs, Express, Egg.js), for example, give specific access methods.

# Use http module

Use the Node.js native http module to do server-side rendering.

// bar.js
const server = require('umi-server');
const http = require('http');
const { createReadStream } = require('fs');
const { join, extname } = require('path');

const root = join(__dirname, 'dist');
const render = server({
const headerMap = {
  '.js': 'text/javascript',
  '.css': 'text/css',
  '.jpg': 'image/jpeg',
  '.png': 'image/jpeg',

http.createServer(async (req, res) => {
  const ext = extname(req.url);
  const header = {
    'Content-Type': headerMap[ext] || 'text/html'
  res.writeHead(200, header);

  if (!ext) {
    // url render
    const ctx = {
    const { ssrHtml } = await render(ctx);
  } else {
    // static file url
    const path = join(root, req.url);
    const stream = createReadStream(path);
    stream.on('error', (error) => {
      res.writeHead(404, 'Not Found');



Running node bar.js and accessing http://localhost:3000 is a simple example of server-side rendering. learn more examples/normal


# Koa.js

refer to examples/koajs

# Egg.js

refer to examples/eggjs

# Pre Render

Pre Render performs rendering at build time, and renders the rendered HTML snippet into a static html file. No need to use a web server to dynamically compile HTML in real time, for static sites.

Umi provides the @umijs/plugin-prerender plugin to help users pre-render the page at build time. For more usage, please refer to documentation.

export default {
  plugins: [['@umijs/plugin-prerender', options]],

# Problems

see FAQ