Як реалізувати рендеринг на стороні сервера у вашому додатку React за три простих кроки

Рохіт Кумар

Ось що ми створимо в цьому підручнику: гарну картку React, подібну до цієї.

У цьому підручнику ми використовуватимемо рендеринг на стороні сервера, щоб надати відповідь HTML, коли користувач або сканер натискає URL-адресу сторінки. Ми будемо обробляти останні запити на стороні клієнта.

Навіщо нам це потрібно?

Дозвольте мені направити вас до відповіді.

У чому різниця між візуалізацією на стороні клієнта та рендерингу на стороні сервера?

У візуалізації на стороні клієнта ваш браузер завантажує мінімальну сторінку HTML. Він відображає JavaScript і заповнює вміст.

Натомість рендеринг на стороні сервера відображає компоненти React на сервері. Результатом є вміст HTML.

Ви можете поєднати ці два для створення ізоморфного додатка.

Мінуси від надання React на сервері

  • SSR може покращити продуктивність, якщо ваша програма невелика. Але це також може погіршити продуктивність, якщо вона важка.
  • Це збільшує час відгуку (і це може бути гірше, якщо сервер зайнятий).
  • Це збільшує розмір відповіді, а це означає, що сторінка завантажується довше.
  • Це збільшує складність програми.

Коли слід використовувати візуалізацію на стороні сервера?

Незважаючи на ці наслідки РСР, є деякі ситуації, коли ви можете і повинні використовувати його.

1. SEO

Кожен веб-сайт хоче відображатися під час пошуку. Виправте мене, якщо я помиляюся.

На жаль, сканери пошукових систем ще не розуміють / не відображають JavaScript.

Це означає, що вони бачать порожню сторінку, незалежно від того, наскільки корисний ваш сайт.

Багато людей кажуть, що сканер Google тепер відображає JavaScript.

Щоб перевірити це, я розгорнув додаток на Heroku. Ось, що я побачив на Google Search Console:

Порожня сторінка.

Це була найбільша причина, через яку я дослідив рендеринг на стороні сервера. Особливо, коли це наріжна сторінка, така як цільова сторінка, блог тощо.

Щоб перевірити, чи відображає Google ваш сайт, відвідайте:

Інформаційна панель Search Console> Сканування> Отримати як Google. Введіть URL-адресу сторінки або залиште її порожньою для домашньої сторінки.

Виберіть FETCH AND RENDER. Після завершення натисніть, щоб побачити результат.

2. Підвищення продуктивності

У SSR продуктивність програми залежить від ресурсів сервера та швидкості мережі користувача. Це робить його дуже корисним для сайтів із великим вмістом.

Наприклад , скажімо, що у вас є мобільний телефон середньої ціни з повільною швидкістю Інтернету. Ви намагаєтесь зайти на сайт, який завантажує 4 Мб даних, перш ніж щось побачити.

Чи змогли б ви побачити що-небудь на своєму екрані протягом 2–4 секунд?

Чи не відвідали б ви цей сайт ще раз?

Я не думаю, що ви б.

Ще одне суттєве покращення - час взаємодії з першим користувачем. Це різниця у часі від того, коли користувач натискає URL-адресу, до того, коли бачить вміст.

Ось порівняння. Я протестував його на розробці Mac.

Реагування, відтворене на сервері

Перший час взаємодії становить 300 мс. Гідрат закінчується на 400 мс. Подія навантаження закінчується приблизно на 500 мс. Ви можете переконатися в цьому, перевіривши зображення вище.

Реагування, надане в браузері клієнта

Перший час взаємодії - 400 мс. Подія навантаження закінчується на 470 мс.

Результат говорить сам за себе. У такому невеликому додатку час взаємодії першого користувача становить 100 мс.

Як це працює? - (4 простих кроки)

  • Створюйте свіжий магазин Redux на кожен запит.
  • За бажанням надішліть деякі дії.
  • Витягніть стан із магазину та виконайте SSR.
  • Надішліть стан, отриманий на попередньому кроці, разом із відповіддю.

We will use the state passed in the response for creating the initial state on client-side.

Before you get started, clone/download the complete example from Github and use it for reference.

Getting Started by Setting up our App

First, open your favourite editor and shell. Create a new folder for your application. Let’s start.

npm init --yes

Fill in the details. After package.json is created, copy the dependencies and scripts below into it.

Install all dependencies by running:

npm install

You need to configure Babel and webpack for our build script to work.

Babel transforms ESM and react into Node and browser-understood code.

Create a new file .babelrc and put the line below in it.

{ "presets": ["@babel/env", "@babel/react"] } 

webpack bundles our app and its dependencies into a single file. Create another file webpack.config.js with the following code in it:

const path = require('path');module.exports = { entry: { client: './src/client.js', bundle: './src/bundle.js' }, output: { path: path.resolve(__dirname, 'assets'), filename: "[name].js" }, module: { rules: [ { test: /\.js$/, exclude: /node_modules/, loader: "babel-loader" } ] } }

The build process output’s two files:

  1. assets/bundle.js — pure client side app.
  2. assets/client.js — client side companion for SSR.

The src/ folder contains the source code. The Babel compiled files go into views/. views directory will be created automatically if not present.

Why do we need to compile source files?

The reason is the syntax difference between ESM & CommonJS. While writing React and Redux, we heavily use import and export in all files.

Unfortunately, they don’t work in Node. Here comes Babel to rescue. The script below tells Babel to compile all files in the src directory and put the result in views.

"babel": "babel src -d views",

Now, Node can run them.

Copy Precoded & Static files

If you have already cloned the repository, copy from it. Otherwise download ssr-static.zip file from Dropbox. Extract it and keep these three folders inside your app directory. Here’s what they contain.

  1. React App and components resides in src/components.
  2. Redux files in src/redux/.
  3. assets/ & media/: Contain static files such as style.css and images.

Server Side

Create two new files named server.js and template.js inside the src/ folder.

1. src/server.js

Magic happens here. This is the code you’ve been searching for.

import React from 'react'; import { renderToString } from 'react-dom/server'; import { Provider } from 'react-redux'; import configureStore from './redux/configureStore'; import App from './components/app'; module.exports = function render(initialState) { // Model the initial state const store = configureStore(initialState); let content = renderToString(); const preloadedState = store.getState(); return { content, preloadedState }; };

Instead of rendering our app, we need to wrap it into a function and export it. The function accepts the initial state of the application.

Here’s how it works.

  1. Pass initialState to configureStore(). configureStore()returns a new Store instance. Hold it inside the store variable.
  2. Call renderToString() method, providing our App as input. It renders our app on the server and returns the HTML produced. Now, the variable content stores the HTML.
  3. Get the state out of Redux Store by calling getState() on store. Keep it in a variable preloadedState.
  4. Return the content and preloadedState. We will pass these to our template to get the final HTML page.

2. src/template.js

template.js exports a function. It takes title, state and content as input. It injects them into the template and returns the final HTML document.

To pass along the state, the template attaches state to window.__STATE__ inside a pt> tag.

Now you can read state on the client side by accessing window.__STATE__.

We also include the SSR companion assets/client.js client-side application in another script tag.

If you request the pure client version, it only puts assets/bundle.js inside the script tag.

The Client Side

The client side is pretty straightforward.

1. src/bundle.js

This is how you write the React and Redux Provider wrap. It is our pure client-side app. No tricks here.

import React from 'react'; import { render } from 'react-dom'; import { Provider } from 'react-redux'; import configureStore from './redux/configureStore'; import App from './components/app'; const store = configureStore(); render(   , document.querySelector('#app') );

2. src/client.js

Looks familiar? Yeah, there is nothing special except window.__STATE__. All we need to do is grab the initial state from window.__STATE__ and pass it to our configureStore() function as the initial state.

Let’s take a look at our new client file:

import React from 'react'; import { hydrate } from 'react-dom'; import { Provider } from 'react-redux'; import configureStore from './redux/configureStore'; import App from './components/app'; const state = window.__STATE__; delete window.__STATE__; const store = configureStore(state); hydrate(   , document.querySelector('#app') );

Let’s review the changes:

  1. Replace render() with hydrate(). hydrate() is the same as render() but is used to hydrate elements rendered by ReactDOMServer. It ensures that the content is the same on the server and the client.
  2. Read the state from the global window object window.__STATE__. Store it in a variable and delete the window.__STATE__.
  3. Create a fresh store with state as initialState.

All done here.

Putting it all together

Index.js

This is the entry point of our application. It handles requests and templating.

It also declares an initialState variable. I have modelled it with data in the assets/data.json file. We will pass it to our ssr() function.

Note: While referencing a file that is inside src/ from a file outside src/ , use normal require() and replace src/ by views/. You know the reason (Babel compile).

Routing

  1. /: By default server-rendered homepage.
  2. /client: Pure client-side rendering example.
  3. /exit: Server stop button. Only available in development.

Build & Run

It’s time to build and run our application. We can do this with a single line of code.

npm run build && npm run start

Now, the application is running at //localhost:3000.

Ready to become a React Pro?

I am starting a new series from next Monday to get your React skills blazing, immediately.

Original text


Thank you for reading this.

If you like it and find it useful, follow me on Twitter & Webflow.