详解React服务端渲染从入门到精通

程序员文章站 2023-11-12 17:55:04

前言这篇文章是我自己在搭建个人网站的过程中，用到了服务端渲染，看了一些教程，踩了一些坑。想把这个过程分享出来。我会尽力把每个步骤讲明白，将我理解的全部讲出来。...

前言

这篇文章是我自己在搭建个人网站的过程中，用到了服务端渲染，看了一些教程，踩了一些坑。想把这个过程分享出来。
我会尽力把每个步骤讲明白，将我理解的全部讲出来。

文中的示例代码来自于这个，也是我正在搭建的个人网站，大家可以一起交流一下。示例代码因为简化，与仓库代码有些许出入

本文中用到的技术
react v16 | react-router v4 | redux | redux-thunk | express

react 服务端渲染

服务端渲染的基本套路就是用户请求过来的时候，在服务端生成一个我们希望看到的网页内容的html字符串，返回给浏览器去展示。

浏览器拿到了这个html之后，渲染出页面，但是并没有事件交互，这时候浏览器发现html中加载了一些js文件（也就是浏览器端渲染的js），就直接去加载。

加载好并执行完以后，事件就会被绑定上了。这时候页面被浏览器端接管了。也就是到了我们熟悉的js渲染页面的过程。

需要实现的目标：

react组件服务端渲染
路由的服务端渲染
保证服务端和浏览器的数据唯一
css的服务端渲染（样式直出）

一般的渲染方式

服务端渲染：服务端生成html字符串，发送给浏览器进行渲染。
浏览器端渲染：服务端返回空的html文件，内部加载js完全由js与css，由js完成页面的渲染

优点与缺点

服务端渲染解决了首屏加载速度慢以及seo不友好的缺点（google已经可以检索到浏览器渲染的网页，但不是所有搜索引擎都可以）

但增加了项目的复杂程度，提高维护成本。

如果非必须，尽量不要用服务端渲染

整体思路

需要两个端：服务端、浏览器端（浏览器渲染的部分）

第一：打包浏览器端代码

第二：打包服务端代码并启动服务

第三：用户访问，服务端读取浏览器端打包好的index.html文件为字符串，将渲染好的组件、样式、数据塞入html字符串，返回给浏览器

第四：浏览器直接渲染接收到的html内容，并且加载打包好的浏览器端js文件，进行事件绑定，初始化状态数据，完成同构

react组件的服务端渲染

让我们来看一个最简单的react服务端渲染的过程。

要进行服务端渲染的话那必然得需要一个根组件，来负责生成html结构

import react from 'react';
import reactdom from 'react-dom';

reactdom.hydrate(<container />, document.getelementbyid('root'));

当然这里用reactdom.render也是可以的，只不过hydrate会尽量复用接收到的服务端返回的内容，

来补充事件绑定和浏览器端其他特有的过程

引入浏览器端需要渲染的根组件，利用react的 rendertostring api进行渲染

import { rendertostring } from 'react-dom/server'
import container from '../containers'
// 产生html
const content = rendertostring(<container/>)
const html = `
  <html>
   <body>${content}</body>
  </html>
`
res.send(html)

在这里，rendertostring也可以替换成rendertonodestream，区别在于前者是同步地产生html，也就是如果生成html用了1000毫秒，

那么就会在1000毫秒之后才将内容返回给浏览器，显然耗时过长。而后者则是以流的形式，将渲染结果塞给response对象，就是出来多少就

返回给浏览器多少，可以相对减少耗时

路由的服务端渲染

一般场景下，我们的应用不可能只有一个页面，肯定会有路由跳转。我们一般这么用：

import { browserrouter, route } from 'react-router-dom'
const app = () => (
  <browserrouter>
    {/*...routes*/}
  <browserrouter/>
)

但这是浏览器端渲染时候的用法。在做服务端渲染时，需要使用将browserrouter 替换为 staticrouter
区别在于，browserrouter 会通过html5 提供的 history api来保持页面与url的同步，而staticrouter
则不会改变url

import { createserver } from 'http'
import { staticrouter } from 'react-router-dom'
createserver((req, res) => {
  const html = rendertostring(
    <staticrouter
      location={req.url}
      context={{}}
    >
      <container />
    <staticrouter/>)

})

这里，staticrouter要接收两个属性:

location: staticrouter 会根据这个属性，自动匹配对应的react组件，所以才会实现刷新页面，服务端返回的对应路由的组与浏览器端保持一致
context: 一般用来传递一些数据，相当于一个载体，之后讲到样式的服务端渲染的时候会用到

redux同构

数据的预获取以及脱水与注水我认为是服务端渲染的难点。

这是什么意思呢？也就是说首屏渲染的网页一般要去请求外部数据，我们希望在生成html之前，去获取到这个页面需要的所有数据，然后塞到页面中去，这个过程，叫做“脱水”（dehydrate），生成html返回给浏览器。浏览器拿到带着数据的html，去请求浏览器端js，接管页面，用这个数据来初始化组件。这个过程叫“注水”（hydrate）。完成服务端与浏览器端数据的统一。

为什么要这么做呢？试想一下，假设没有数据的预获取，直接返回一个没有数据，只有固定内容的html结构，会有什么结果呢？

第一：由于页面内没有有效信息，不利于seo。

第二：由于返回的页面没有内容，但浏览器端js接管页面后回去请求数据、渲染数据，页面会闪一下，用户体验不好。

我们使用redux来管理状态，因为有服务端代码和浏览器端代码，那么就分别需要两个store来管理服务端和浏览器端的数据。

组件的配置

组件要在服务端渲染的时候去请求数据，可以在组件上挂载一个专门发异步请求的方法，这里叫做loaddata，接收服务端的store作为参数，然后store.dispatch去扩充服务端的store。

class home extends react.component {
  componentdidmount() {
    this.props.callapi()
  }
  render() {
    return <div>{this.props.state.name}</div>
  }
}
home.loaddata = store => {
 return store.dispatch(callapi())
}
const mapstate = state => state
const mapdispatch = {callapi}
export default connect(mapstate, mapdispatch)(home)

路由的改造

因为服务端要根据路由判断当前渲染哪个组件，可以在这个时候发送异步请求。所以路由也需要配置一下来支持loaddata方法。服务端渲染的时候，路由的渲染可以使用react-router-config这个库，用法如下(重点关注在路由上挂载loaddata方法):

import { browserrouter } from 'react-router-dom'
import { renderroutes } from 'react-router-config'
import home from './home'
export const routes = [
 {
  path: '/',
  component: home,
  loaddata: home.loaddata,
  exact: true,
 }
]
const routers = <browserrouter>
  {renderroutes(routes)}
<browserrouter/>

服务端获取数据

到了服务端，需要判断匹配的路由内的所有组件各自都有没有loaddata方法，有就去调用，传入服务端的store，去扩充服务端的store。同时还要注意到，一个页面可能是由多个组件组成的，会发各自的请求，也就意味着我们要等所有的请求都发完，再去返回html。

import express from 'express'
import serverrender from './render'
import { matchroutes } from 'react-router-config'
import { routes } from '../routes'
import serverstore from "../store/serverstore"

const app = express()
app.get('*', (req, res) => {
 const context = {css: []}
 const store = serverstore()
 // 用matchroutes方法获取匹配到的路由对应的组件数组
 const matchedroutes = matchroutes(routes, req.path)
 const promises = []
 for (const item of matchedroutes) {
  if (item.route.loaddata) {
   const promise = new promise((resolve, reject) => {
    item.route.loaddata(store).then(resolve).catch(resolve)
   })
   promises.push(promise)
  }
 }
 // 所有请求响应完毕，将被html内容发送给浏览器
 promise.all(promises).then(() => {
  // 将生成html内容的逻辑封装成了一个函数，接收req, store, context
  res.send(serverrender(req, store, context))
 })
})

细心的同学可能注意到了上边我把每个loaddata都包了一个promise。

const promise = new promise((resolve, reject) => {
 item.route.loaddata(store).then(resolve).catch(resolve)
 console.log(item.route.loaddata(store));
})
promises.push(promise)

这是为了容错，一旦有一个请求出错，那么下边promise.all方法则不会执行，所以包一层promise的目的是即使请求出错，也会resolve，不会影响到promise.all方法，也就是说只有请求出错的组件会没数据，而其他组件不会受影响。

注入数据

我们请求已经发出去了，并且在组件的loaddata方法中也扩充了服务端的store，那么可以从服务端的数据取出来注入到要返回给浏览器的html中了。

来看 serverrender 方法

const serverrender = (req, store, context) => {
 // 读取客户端生成的html
 const template = fs.readfilesync(process.cwd() + '/public/static/index.html', 'utf8')
 const content = rendertostring(
  <provider store={store}>
   <staticrouter location={req.path} context={context}>
    <container/>
   </staticrouter>
  </provider>
 )
 // 注入数据
 const initialstate = `<script>
  window.context = {
   initial_state: ${json.stringify(store.getstate())}
  }
</script>`
 return template.replace('<!--app-->', content)
  .replace('<!--initial-state-->', initialstate)
}

浏览器端用服务端获取到的数据初始化store

经过上边的过程，我们已经可以从window.context中拿到服务端预获取的数据了，此时需要做的事就是用这份数据去初始化浏览器端的store。保证两端数据的统一。

import { createstore, applymiddleware, compose } from 'redux'
import thunk from 'redux-thunk'
import rootreducer from '../reducers'

const defaultstore = window.context && window.context.initial_state
const clientstore = createstore(
 rootreducer,
 defaultstore,// 利用服务端的数据初始化浏览器端的store
 compose(
  applymiddleware(thunk),
  window.devtoolsextension ? window.devtoolsextension() : f=>f
 )
)

至此，服务端渲染的数据统一问题就解决了，再来回顾一下整个流程：

用户访问路由，服务端根据路由匹配出对应路由内的组件数组
循环数组，调用组件上挂载的loaddata方法，发送请求，扩充服务端store
所有请求完成后，通过store.getstate，获取到服务端预获取的数据，注入到window.context中
浏览器渲染返回的html，加载浏览器端js，从window.context中取数据来初始化浏览器端的store，渲染组件

这里还有个点，也就是当我们从路由进入到其他页面的时候，组件内的loaddata方法并不会执行，它只会在刷新，服务端渲染路由的时候执行。

这时候会没有数据。所以我们还需要在componentdidmount中去发请求，来解决这个问题。因为componentdidmount不会在服务端渲染执行，所以不用担心请求重复发送。

样式的服务端渲染

以上我们所做的事情只是让网页的内容经过了服务端的渲染，但是样式要在浏览器加载css后才会加上，所以最开始返回的网页内容没有样式，页面依然会闪一下。为了解决这个问题，我们需要让样式也一并在服务端渲染的时候返回。

首先，服务端渲染的时候，解析css文件，不能使用style-loader了，要使用isomorphic-style-loader。

{
  test: /\.css$/,
  use: [
    'isomorphic-style-loader',
    'css-loader',
    'postcss-loader'
  ],
}

但是，如何在服务端获取到当前路由内的组件样式呢？回想一下，我们在做路由的服务端渲染时，用到了staticrouter，它会接收一个context对象，这个context对象可以作为一个载体来传递一些信息。我们就用它！

思路就是在渲染组件的时候，在组件内接收context对象，获取组件样式，放到context中，服务端拿到样式，插入到返回的html中的style标签中。

来看看组件是如何读取样式的吧:

import style from './style/index.css'
class index extends react.component {
  componentwillmount() {
   if (this.props.staticcontext) {
    const css = styles._getcss()
    this.props.staticcontext.css.push(css)
   }
  }
}

在路由内的组件可以在props里接收到staticcontext，也就是通过staticrouter传递过来的context，
isomorphic-style-loader 提供了一个 _getcss() 方法，让我们能读取到css样式，然后放到staticcontext里。
不在路由之内的组件，可以通过父级组件，传递props的方法，或者用react-router的withrouter包裹一下

其实这部分提取css的逻辑可以写成高阶组件，这样就可以做到复用了

import react, { component } from 'react'

export default (decoratedcomponent, styles) => {
 return class newcomponent extends component {
  componentwillmount() {
   if (this.props.staticcontext) {
    const css = styles._getcss()
    this.props.staticcontext.css.push(css)
   }
  }
  render() {
   return <decoratedcomponent {...this.props}/>
  }
 }
}

在服务端，经过组件的渲染之后，context中已经有内容了，我们这时候把样式处理一下，返回给浏览器，就可以做到样式的服务端渲染了

const serverrender = (req, store) => {
 const context = {css: []}
 const template = fs.readfilesync(process.cwd() + '/public/static/index.html', 'utf8')
 const content = rendertostring(
  <provider store={store}>
   <staticrouter location={req.path} context={context}>
    <container/>
   </staticrouter>
  </provider>
 )
 // 经过渲染之后，context.css内已经有了样式
 const cssstr = context.css.length ? context.css.join('\n') : ''
 const initialstate = `<script>
  window.context = {
   initial_state: ${json.stringify(store.getstate())}
  }
</script>`
 return template.replace('<!--app-->', content)
  .replace('server-render-css', cssstr)
  .replace('<!--initial-state-->', initialstate)
}

至此，服务端渲染就全部完成了。

总结

react的服务端渲染，最好的解决方案就是next.js。如果你的应用没有seo优化的需求，又或者不太注重首屏渲染的速度，那么尽量就不要用服务端渲染。

因为会让项目变得复杂。此外，除了服务端渲染，seo优化的办法还有很多，比如预渲染（pre-render）。

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持。

上一篇：兼职妹妹利用社交APP软件营销的成功案例

下一篇： win10的流媒体怎样启用?Win10启用流媒体的方法

详解React服务端渲染从入门到精通