So implementieren Sie das serverseitige Rendern in Ihrer React-App in drei einfachen Schritten

Von Rohit Kumar

Folgendes werden wir in diesem Tutorial erstellen: eine schöne React-Karte wie diese.

In diesem Tutorial verwenden wir serverseitiges Rendering, um eine HTML-Antwort zu liefern, wenn ein Benutzer oder Crawler eine Seiten-URL trifft. Wir werden die letzteren Anfragen auf der Client-Seite bearbeiten.

Warum brauchen wir es?

Lassen Sie sich von mir zur Antwort führen.

Was ist der Unterschied zwischen clientseitigem und serverseitigem Rendering?

Beim clientseitigen Rendern lädt Ihr Browser eine minimale HTML-Seite herunter. Es rendert das JavaScript und füllt den Inhalt darin.

Beim serverseitigen Rendern werden die React-Komponenten auf dem Server gerendert . Die Ausgabe ist HTML-Inhalt.

Sie können diese beiden kombinieren, um eine isomorphe App zu erstellen.

Nachteile des Renderns Reagieren Sie auf dem Server

  • SSR kann die Leistung verbessern, wenn Ihre Anwendung klein ist. Es kann aber auch die Leistung beeinträchtigen, wenn es schwer ist.
  • Dies erhöht die Antwortzeit (und es kann schlimmer sein, wenn der Server ausgelastet ist).
  • Dies erhöht die Antwortgröße, was bedeutet, dass das Laden der Seite länger dauert.
  • Dies erhöht die Komplexität der Anwendung.

Wann sollten Sie Server Side Rendering verwenden?

Trotz dieser Konsequenzen von SSR gibt es einige Situationen, in denen Sie es verwenden können und sollten.

1. SEO

Jede Website möchte in Suchanfragen erscheinen. Korrigiere mich, wenn ich falsch liege.

Leider verstehen / rendern Suchmaschinen-Crawler JavaScript noch nicht.

Dies bedeutet, dass sie eine leere Seite sehen, egal wie hilfreich Ihre Website ist.

Viele Leute sagen, dass Googles Crawler jetzt JavaScript rendert.

Um dies zu testen, habe ich die App auf Heroku bereitgestellt. Folgendes habe ich in der Google Search Console gesehen:

Eine leere Seite.

Dies war der Hauptgrund, warum ich mich mit serverseitigem Rendern befasst habe. Besonders wenn es sich um eine Eckpfeilerseite wie eine Zielseite, ein Blog usw. handelt.

Um zu überprüfen, ob Google Ihre Website rendert, besuchen Sie:

Suchkonsolen-Dashboard> Crawlen> Als Google abrufen. Geben Sie die Seiten-URL ein oder lassen Sie sie für die Startseite leer.

Wählen Sie FETCH AND RENDER. Wenn Sie fertig sind, klicken Sie auf, um das Ergebnis anzuzeigen.

2. Verbessern Sie die Leistung

In SSR hängt die Anwendungsleistung von den Ressourcen des Servers und der Netzwerkgeschwindigkeit des Benutzers ab. Dies macht es sehr nützlich für inhaltsintensive Websites.

Angenommen , Sie haben ein Mobiltelefon mit mittlerem Preis und langsamer Internetgeschwindigkeit. Sie versuchen, auf eine Site zuzugreifen, die 4 MB Daten herunterlädt, bevor Sie etwas sehen können.

Könnten Sie innerhalb von 2 bis 4 Sekunden etwas auf Ihrem Bildschirm sehen?

Würden Sie diese Seite wieder besuchen?

Ich glaube nicht, dass du es tun würdest.

Eine weitere wichtige Verbesserung ist die Interaktionszeit für den ersten Benutzer. Dies ist der Zeitunterschied zwischen dem Aufrufen der URL durch einen Benutzer und dem Anzeigen von Inhalten.

Hier ist der Vergleich. Ich habe es auf einem Entwicklungs-Mac getestet.

Auf dem Server gerenderte Reaktion

Die erste Interaktionszeit beträgt 300 ms. Hydrat endet bei 400ms. Das Ladeereignis wird ungefähr nach 500 ms beendet. Sie können dies sehen, indem Sie das Bild oben überprüfen.

Im Browser des Kunden gerenderte Reaktion

Die erste Interaktionszeit beträgt 400 ms. Das Ladeereignis wird bei 470 ms beendet.

Das Ergebnis spricht für sich. Bei einer so kleinen App gibt es einen Unterschied von 100 ms in der ersten Benutzerinteraktionszeit.

Wie funktioniert es? - (4 einfache Schritte)

  • Erstellen Sie bei jeder Anfrage einen neuen Redux Store.
  • Versenden Sie optional einige Aktionen.
  • Holen Sie sich den Status aus dem Store und führen Sie SSR durch.
  • Senden Sie den im vorherigen Schritt erhaltenen Status zusammen mit der Antwort.

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.