Cómo implementar la representación del lado del servidor en su aplicación React en tres simples pasos

Por Rohit Kumar

Esto es lo que crearemos en este tutorial: una bonita tarjeta React como esta.

En este tutorial, usaremos la representación del lado del servidor para entregar una respuesta HTML cuando un usuario o un rastreador acceda a la URL de una página. Manejaremos las últimas solicitudes del lado del cliente.

¿Por qué lo necesitamos?

Déjame guiarte hasta la respuesta.

¿Cuál es la diferencia entre la representación del lado del cliente y la representación del lado del servidor?

En la representación del lado del cliente, su navegador descarga una página HTML mínima. Renderiza JavaScript y rellena el contenido.

La renderización del lado del servidor, por otro lado, renderiza los componentes de React en el servidor. La salida es contenido HTML.

Puede combinar estos dos para crear una aplicación isomorfa.

Contras de renderizar React en el servidor

  • SSR puede mejorar el rendimiento si su aplicación es pequeña. Pero también puede degradar el rendimiento si es pesado.
  • Aumenta el tiempo de respuesta (y puede ser peor si el servidor está ocupado).
  • Aumenta el tamaño de la respuesta, lo que significa que la página tarda más en cargarse.
  • Aumenta la complejidad de la aplicación.

¿Cuándo debería utilizar la representación del lado del servidor?

A pesar de estas consecuencias de SSR, hay algunas situaciones en las que puede y debe usarlo.

1. SEO

Todos los sitios web quieren aparecer en las búsquedas. Corrígeme si estoy equivocado.

Desafortunadamente, los rastreadores de motores de búsqueda aún no comprenden / procesan JavaScript.

Esto significa que ven una página en blanco, sin importar cuán útil sea su sitio.

Mucha gente dice que el rastreador de Google ahora procesa JavaScript.

Para probar esto, implementé la aplicación en Heroku. Esto es lo que vi en Google Search Console:

Una página en blanco.

Esta fue la principal razón por la que exploré el renderizado del lado del servidor. Especialmente cuando se trata de una página fundamental, como una página de destino, un blog, etc.

Para verificar si Google renderiza su sitio, visite:

Panel de control de Search Console> Rastrear> Explorar como Google. Ingrese la URL de la página o déjela vacía para la página de inicio.

Seleccione FETCH AND RENDER. Una vez completado, haga clic para ver el resultado.

2. Mejorar el rendimiento

En SSR, el rendimiento de la aplicación depende de los recursos del servidor y la velocidad de la red del usuario. Esto lo hace muy útil para sitios con mucho contenido.

Por ejemplo , digamos que tiene un teléfono móvil de precio medio con una velocidad de Internet lenta. Intenta acceder a un sitio que descarga 4 MB de datos antes de que pueda ver nada.

¿Podrías ver algo en tu pantalla en 2 a 4 segundos?

¿Visitarías ese sitio de nuevo?

No creo que lo harías.

Otra mejora importante es el tiempo de interacción del primer usuario. Esta es la diferencia en el tiempo desde que un usuario accede a la URL hasta que ve el contenido.

Aquí está la comparación. Lo probé en una Mac de desarrollo.

Reaccionar renderizado en el servidor

El primer tiempo de interacción es de 300 ms. Hidratar acabados a 400ms. El evento de carga sale a los 500ms aproximadamente. Puede ver esto mirando la imagen de arriba.

Reaccionar renderizado en el navegador del cliente

El primer tiempo de interacción es de 400 ms. El evento de carga finaliza a 470 ms.

El resultado habla por sí mismo. Hay una diferencia de 100 ms en el tiempo de interacción del primer usuario para una aplicación tan pequeña.

¿Como funciona? - (4 pasos simples)

  • Cree una nueva tienda Redux en cada solicitud.
  • Opcionalmente, envíe algunas acciones.
  • Saque el estado de la Tienda y realice SSR.
  • Envía el estado obtenido en el paso anterior junto con la respuesta.

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.