快捷導(dǎo)航

詳解超簡(jiǎn)單的react服務(wù)器渲染(ssr)入坑指南

更新時(shí)間：2019年02月28日 09:54:41 作者：饅頭

這篇文章主要介紹了詳解超簡(jiǎn)單的react服務(wù)器渲染(ssr)入坑指南，小編覺(jué)得挺不錯(cuò)的，現(xiàn)在分享給大家，也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧

前言

本文是基于react ssr的入門(mén)教程，在實(shí)際項(xiàng)目中使用還需要做更多的配置和優(yōu)化，比較適合第一次嘗試react ssr的小伙伴們。技術(shù)涉及到 koa2 + react，案例使用create-react-app創(chuàng)建

SSR 介紹

Server Slide Rendering，縮寫(xiě)為 ssr 即服務(wù)器端渲染，這個(gè)要從SEO說(shuō)起，目前react單頁(yè)應(yīng)用HTML代碼是下面這樣的

<!DOCTYPE html>
<html lang="en">
 <head>
  <meta charset="utf-8" />
  <link rel="shortcut icon" href="favicon.ico" rel="external nofollow" />
  <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"/>
  <meta name="theme-color" content="#000000" />
  <title>React App</title>
 </head>
 <body>
  <noscript>You need to enable JavaScript to run this app.</noscript>
  <div id="root"></div>
  <script src="/js/main.js"></script>
 </body>
</html>

如果main.js 加載比較慢，會(huì)出現(xiàn)白屏一閃的現(xiàn)象。
傳統(tǒng)的搜索引擎爬蟲(chóng)因?yàn)椴荒茏トS生成后的內(nèi)容，遇到單頁(yè)web項(xiàng)目，抓取到的內(nèi)容啥也沒(méi)有。在SEO上會(huì)吃很多虧，很難排搜索引擎到前面去。

React SSR（react服務(wù)器渲染）正好解決了這2個(gè)問(wèn)題。

React SSR介紹

這里通過(guò)一個(gè)例子來(lái)帶大家入坑！先使用create-react-app創(chuàng)建一個(gè)react項(xiàng)目。因?yàn)橐薷膚ebpack，這里我們使用react-app-rewired啟動(dòng)項(xiàng)目。根目錄創(chuàng)建一個(gè)server目錄存放服務(wù)端代碼，服務(wù)端代碼我們這里使用koa2。目錄結(jié)構(gòu)如下：

這里先來(lái)看看react ssr是怎么工作的。

這個(gè)業(yè)務(wù)流程圖比較清晰了，服務(wù)端只生成HTML代碼，實(shí)際上前端會(huì)生成一份main.js提供給服務(wù)端的HTML使用。這就是react ssr的工作流程。有了這個(gè)圖會(huì)更好的理解，如果這個(gè)業(yè)務(wù)沒(méi)理解清楚，后面的估計(jì)很難理解。

react提供的SSR方法有兩個(gè)renderToString 和 renderToStaticMarkup，區(qū)別如下：

renderToString 方法渲染的時(shí)候帶有 data-reactid 屬性. 在瀏覽器訪問(wèn)頁(yè)面的時(shí)候，main.js能識(shí)別到HTML的內(nèi)容，不會(huì)執(zhí)行React.createElement二次創(chuàng)建DOM。
renderToStaticMarkup 則沒(méi)有 data-reactid 屬性，頁(yè)面看上去干凈點(diǎn)。在瀏覽器訪問(wèn)頁(yè)面的時(shí)候，main.js不能識(shí)別到HTML內(nèi)容，會(huì)執(zhí)行main.js里面的React.createElement方法重新創(chuàng)建DOM。

實(shí)現(xiàn)流程

好了，我們都知道原理了，可以開(kāi)始coding了,目錄結(jié)構(gòu)如下：

create-react-app 的demo我沒(méi)動(dòng)過(guò)，直接用這個(gè)做案例了，前端項(xiàng)目基本上就沒(méi)改了,等會(huì)兒我們服務(wù)器端要使用這個(gè)模塊。代碼如下：

 render() {
  return (
   <div className="App">
    <header className="App-header">
     <img src={logo} className="App-logo" alt="logo" />
     <p>
      Edit <code>src/App.js</code> and save to reload.
     </p>
     <a
      className="App-link"
       rel="external nofollow" 
      target="_blank"
      rel="noopener noreferrer"
     >
      Learn React
     </a>
    </header>
   </div>
  );
 }
}

export default App;

在項(xiàng)目中新建server目錄，用于存放服務(wù)端代碼。為了簡(jiǎn)化，我這里只有2個(gè)文件，項(xiàng)目中我們用的ES6，所以還要配置下.babelrc

.babelrc 配置，因?yàn)橐褂玫紼S6

{
  "presets": [
    "env",
    "react"
  ],
  "plugins": [
    "transform-decorators-legacy",
    "transform-runtime",
    "react-hot-loader/babel",
    "add-module-exports",
    "transform-object-rest-spread",
    "transform-class-properties",
    [
      "import",
      {
        "libraryName": "antd",
        "style": true
      }
    ]
  ]
}

index.js 項(xiàng)目入口做一些預(yù)處理，使用asset-require-hook過(guò)濾掉一些類(lèi)似 import logo from "./logo.svg"; 這樣的資源代碼。因?yàn)槲覀兎?wù)端只需要純的HTML代碼，不過(guò)濾掉會(huì)報(bào)錯(cuò)。這里的name，我們是去掉了hash值的

require("asset-require-hook")({
 extensions: ["svg", "css", "less", "jpg", "png", "gif"],
 name: '/static/media/[name].[ext]'
});
require("babel-core/register")();
require("babel-polyfill");
require("./app");

public/index.html html模版代碼要做個(gè)調(diào)整，{{root}} 這個(gè)可以是任何可以替換的字符串，等下服務(wù)端會(huì)替換這段字符串。

<!DOCTYPE html>
<html lang="en">
 <head>
  <meta charset="utf-8" />
  <link rel="shortcut icon" href="%PUBLIC_URL%/favicon.ico" rel="external nofollow" />
  <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"/>
  <meta name="theme-color" content="#000000" />
  <link rel="manifest" href="%PUBLIC_URL%/manifest.json" rel="external nofollow" />
  <title>React App</title>
 </head>
 <body>
  <noscript>You need to enable JavaScript to run this app.</noscript>
  <div id="root">{{root}}</div>
 </body>
</html>

app.js 服務(wù)端渲染的主要代碼，加載App.js，使用renderToString 生成html代碼，去替換掉 index.html 中的 {{root}} 部分

import App from '../src/App';
import Koa from 'koa';
import React from 'react';
import Router from 'koa-router';
import fs from 'fs';
import koaStatic from 'koa-static';
import path from 'path';
import { renderToString } from 'react-dom/server';

// 配置文件
const config = {
 port: 3030
};

// 實(shí)例化 koa
const app = new Koa();

// 靜態(tài)資源
app.use(
 koaStatic(path.join(__dirname, '../build'), {
  maxage: 365 * 24 * 60 * 1000,
  index: 'root' 
  // 這里配置不要寫(xiě)成'index'就可以了，因?yàn)樵谠L問(wèn)localhost:3030時(shí)，不能讓服務(wù)默認(rèn)去加載index.html文件，這里很容易掉進(jìn)坑。
 })
);

// 設(shè)置路由
app.use(
 new Router()
  .get('*', async (ctx, next) => {
   ctx.response.type = 'html'; //指定content type
   let shtml = '';
   await new Promise((resolve, reject) => {
    fs.readFile(path.join(__dirname, '../build/index.html'), 'utfa8', function(err, data) {
     if (err) {
      reject();
      return console.log(err);
     }
     shtml = data;
     resolve();
    });
   });
   // 替換掉 {{root}} 為我們生成后的HTML
   ctx.response.body = shtml.replace('{{root}}', renderToString(<App />));
  })
  .routes()
);

app.listen(config.port, function() {
 console.log('服務(wù)器啟動(dòng)，監(jiān)聽(tīng) port： ' + config.port + ' running~');
});

config-overrides.js 因?yàn)槲覀冇玫氖莄reate-react-app，這里使用react-app-rewired去改下webpack的配置。因?yàn)閳?zhí)行npm run build的時(shí)候會(huì)自動(dòng)給資源加了hash值，而這個(gè)hash值，我們?cè)赼sset-require-hook的時(shí)候去掉了hash值，配置里面需要改下，不然會(huì)出現(xiàn)圖片不顯示的問(wèn)題，這里也是一個(gè)坑，要注意下。

module.exports = {
 webpack: function(config, env) {
  // ...add your webpack config
  // console.log(JSON.stringify(config));
  // 去掉hash值，解決asset-require-hook資源問(wèn)題
  config.module.rules.forEach(d => {
   d.oneOf &&
    d.oneOf.forEach(e => {
     if (e && e.options && e.options.name) {
      e.options.name = e.options.name.replace('[hash:8].', '');
     }
    });
  });
  return config;
 }
};

好了，所有的代碼就這些了，是不是很簡(jiǎn)單了？我們koa2讀取的靜態(tài)資源是 build目錄下面的。先執(zhí)行npm run build打包項(xiàng)目，再執(zhí)行node ./server 啟動(dòng)服務(wù)端項(xiàng)目。看下http://localhost:3030頁(yè)面的HTML代碼檢查下：