千家信息网

React服务端渲染和同构怎么实现

发表于:2025-01-19 作者:千家信息网编辑
千家信息网最后更新 2025年01月19日,这篇文章主要讲解了"React服务端渲染和同构怎么实现",文中的讲解内容简单清晰,易于学习与理解,下面请大家跟着小编的思路慢慢深入,一起来研究和学习"React服务端渲染和同构怎么实现"吧!背景第一阶
千家信息网最后更新 2025年01月19日React服务端渲染和同构怎么实现

这篇文章主要讲解了"React服务端渲染和同构怎么实现",文中的讲解内容简单清晰,易于学习与理解,下面请大家跟着小编的思路慢慢深入,一起来研究和学习"React服务端渲染和同构怎么实现"吧!

    背景

    第一阶段

    很久以前, 一个网站的开发还是前端和服务端在一个项目来维护, 可能是用php+jquery.
    那时候的页面渲染是放在服务端的, 也就是用户访问一个页面a的时候, 会直接访问服务端路由, 由服务端来渲染页面然后返回给浏览器。

    也就是说网页的所有内容都会一次性被写在html里, 一起送给浏览器。
    这时候你右键点击查看网页源代码, 可以看到所有的代码; 或者你去查看html请求, 查看"预览", 会发现他就是一个完整的网页。

    第二阶段

    但是慢慢的人们觉得上面这种方式前后端协同太麻烦, 耦合太严重, 严重影响开发效率和体验
    于是随着vue/react的横空出世, 人们开始习惯了纯客户端渲染的spa.

    这时候的html中只会写入一些主脚本文件, 没有什么实质性的内容. 等到html在浏览器端解析后, 执行js文件, 才逐步把元素创建在dom上。
    所以你去查看网页源代码的时候, 发现根本没什么内容, 只有各种脚本的链接。

    第三阶段

    后来人们又慢慢的觉得, 纯spa对SEO非常不友好, 并且白屏时间很长。
    对于一些活动页, 白屏时间长代表了什么? 代表了用户根本没有耐心去等待页面加载完成.

    所以人们又想回到服务端渲染, 提高SEO的效果, 尽量缩短白屏时间.

    那难道我们又要回到阶段一那种人神共愤的开发模式吗? 不, 我们现在有了新的方案, 新的模式, 叫做同构

    所谓的同构理解为:同种结构的不同表现形态, 同一份react代码, 分别在两端各执行一遍

    创建一个服务端渲染应用

    renderToString

    首先来看看他是个什么东西

    它可以渲染一个react元素/组件到页面中,而且只能用到服务端
    所以spa react-dom -> render 相对应的就是spa react-dom/server -> renderToString整一个Hello World

    //MyServer.jsconst { renderToString } = require('react-dom/server');const React = require('react');const express = require('express');//commonJS方式引入var app = express();const PORT = 3000;const App = class extends React.PureComponent {    render(){        return React.createElement('h2',null,'Hello World!');    }}app.get('/',function(req,res){    const content = renderToString(React.createElement(App));//渲染成HTML    res.send(content);//返回结果})app.listen(PORT,() => {    console.log(`server is listening on ${PORT}`);})

    启动服务端之后,手动网页访问本地对应的端口

    可以看到,返回的就是hello world,这就是一个服务端应用!

    webpack配置

    应用写好之后,需要浏览器端的webpack配置

    const path = require('path');const nodeExternals = require('webpack-node-externals');//打包的时候不打包node_modulesconst CopyWebpackPlugin = require('copy-webpack-plugin');module.exports = {  entry:{    index:path.resolve(__dirname,'../server.js')  },  mode:'development',  target:'node',//不将node自带的诸如path、fs这类的包打进去,一定要是node  devtool: 'cheap-module-eval-source-map',//source-map配置相关,这块可以理解为提供更快的打包性能  output:{    filename:'[name].js',    path:path.resolve(__dirname,'../dist/server')//常用输出路径  },  externals:[nodeExternals()], //不将node_modules里面的包打进去   resolve:{    alias:{      '@':path.resolve(__dirname,'../src')    },    extensions:['.js']  },  module:{//babel转化配置    rules:[{      test:/\.js$/,      use:'babel-loader',      exclude:/node_modules/    }]  },  plugins: [//一般应用都会有的public目录,直接拷贝到dist目录下    new CopyWebpackPlugin([{      from:path.resolve(__dirname,'../public'),      to:path.resolve(__dirname,'../dist')    }])  ]}

    cli用习惯了,写配置有点折磨,写好之后要怎么去使用呢?package.json配置运行脚本:

    "scripts": {    "build:server": "webpack --config build/webpack-server.config.js --watch",    "server": "nodemon dist/server/index.js"  }

    那么,先打个包

    可以看到,已经打包出来了一大堆看不懂的东西
    这个时候,运行起来即可
    到现在写了这么多配置,其实只是为了让服务端支持一下浏览器端基本的运行配置/环境

    给h2标签绑定一个click事件

    import React from 'react';import {renderToString} from 'react-dom/server';const express = require('express');const app = express();const App = class extends React.PureComponent{  handleClick=(e)=>{    alert(e.target[xss_clean]);  }  render(){    return 

    Hello World!

    ; }};app.get('/',function(req,res){ const content = renderToString(); console.log(content); res.send(content);});app.listen(3000);

    这个时候如果你去跑一下,会发现点击的时候,根 本 没 反 应 !
    这个时候稍微想一下,renderToString是把元素转成字符串而已, 事件什么的根本没有绑定

    这个时候同构就来了!

    那么同构就是:
    同一份代码, 在服务端跑一遍, 就生成了html
    同一份代码, 在客户端跑一遍, 就能响应各种用户操作
    所以需要将App单独提取出来

    src/app.js

    import React from 'react';class App extends React.PureComponent{    handleClick=(e)=>{        alert(e.target[xss_clean]);    }    render(){        return 

    Hello World!

    ; }};export default App;

    src/index.js

    就跟正常spa应用一样的写法

    import React from 'react';import {render} from 'react-dom';import App from './app';render(,document.getElementById("root"));

    build/webpack-client.config.js

    处理客户端代码的打包逻辑

    const path = require('path');module.exports = {  entry:{    index:path.resolve(__dirname,'../src/index.js')//路径修改  },  mode:'development',  /*target:'node',客户端不需要此配置了昂*/  devtool: 'cheap-module-eval-source-map',  output:{    filename:'[name].js',    path:path.resolve(__dirname,'../dist/client')//路径修改  },  resolve:{    alias:{      '@':path.resolve(__dirname,'../src')    },    extensions:['.js']  },  module:{    rules:[{      test:/\.js$/,      use:'babel-loader',      exclude:/node_modules/    }]  }}

    运行脚本也给他添加一下

    "build:client": "webpack --config build/webpack-client.config.js --watch"

    运行一下

    npm run build:client

    server引用打包好的客户端资源

    import express from 'express';import React from 'react';import {renderToString} from 'react-dom/server';import App from  './src/app';const app = express();app.use(express.static("dist"))app.get('/',function(req,res){  const content = renderToString();  res.send(`                            ssr                            
    ${content}
    `);//手动创建根节点,把App标签内容引进来});app.listen(3000);

    再来测试一下,这时候发现页面渲染没问题, 并且也能响应用户操作, 比如点击事件了.

    hydrate
    经过上面的5步, 看起来没问题了, 但是我们的控制台会输出一些warnning

    Warning: render(): Calling ReactDOM.render() to hydrate server-rendered markup will stop working in React v18. Replace the ReactDOM.render() call with ReactDOM.hydrate() if you want React to attach to the server HTML.

    ReactDOM.hydrate()和ReactDOM.render()的区别就是:

    ReactDOM.render()会将挂载dom节点的所有子节点全部清空掉,再重新生成子节点

    ReactDOM.hydrate()则会复用挂载dom节点的子节点,并将其与react的virtualDom关联上。

    也就是说ReactDOM.render()会将服务端做的工作全部推翻重做,而ReactDOM.hydrate()在服务端做的工作基础上再进行深入的操作.

    所以我们修改一下客户端的入口文件src/index.js, 将render修改为hydrate

    import React from 'react';import { hydrate } from 'react-dom';import App from './app';hydrate(,document.getElementById("root"));

    同构流程总结

    • 服务端根据React代码生成html

    • 客户端发起请求, 收到服务端发送的html, 进行解析和展示

    • 客户端加载js等资源文件

    • 客户端执行js文件, 完成hydrate操作

    • 客户端接管整体应用

    路由

    客户端渲染时, React提供了BrowserRouter和HashRouter来供我们处理路由, 但是他们都依赖window对象, 而在服务端是没有window的。
    但是react-router提供了StaticRouter, 为我们的服务端渲染做服务。
    接下来我们模拟添加几个页面, 实现一下路由的功能。

    构造Login和User两个页面

    //src/pages/login/index.jsimport React from 'react';export default class Login extends React.PureComponent{  render(){    return 
    登陆
    }}
    //src/pages/user/index.jsimport React from 'react';export default class User extends React.PureComponent{  render(){    return 
    用户
    }}

    添加服务端路由

    //server.jsimport express from 'express';import React from 'react';import {renderToString} from 'react-dom/server';import {StaticRouter,Route} from 'react-router';//服务端使用静态路由import Login from '@/pages/login';import User from '@/pages/user';const app = express();app.use(express.static("dist"))app.get('*',function(req,res){    const content = renderToString(
    ); res.send(` ssr
    ${content}
    `);});app.listen(3000);

    这个时候会发现一个现象,在页面上通过url修改路由到Login的时候,界面上登录两个字一闪即逝,这是为啥呢?
    因为虽然服务端路由配置好了,也确实模块嵌入进来了,但是!!!客户端还没有进行处理

    添加客户端路由

    //src/index.jsimport React from 'react';import { hydrate } from 'react-dom';import App from './app';import { BrowserRouter as Router, Route } from 'react-router-dom';import User from './pages/user';import Login from './pages/login';hydrate(                                  ,  document.getElementById("root"));

    分别访问一下/user和/login,发现已经可以正常渲染了,但是!!!明明是一样的映射规则,只是路由根组件不一样,还要写两遍也太折磨了,于是有了接下来的路由同构

    路由同构

    既要在客户端写一遍路由, 也要在服务端写一遍路由, 有没有什么方法能只写一遍? 就像app.js一样?
    所以我们先找一下两端路由的异同:

    • 共同点:路径和组件的映射关系是相同的

    • 不同点:路由引用的组件不一样, 或者说实现的方式不一样

    路径和组件之间的关系可以用抽象化的语言去描述清楚,也就是我们所说路由配置化。
    最后我们提供一个转换器,可以根据我们的需要去转换成服务端或者客户端路由。

    //新建src/pages/notFound/index.jsimport React from 'react';export default ()=> 
    404

    路由配置文件

    //src/router/routeConfig.jsimport Login from '@/pages/login';import User from '@/pages/user';import NotFound from '@/pages/notFound';export default [{  type:'redirect',//触发重定向时,统一回到user  exact:true,  from:'/',  to:'/user'},{  type:'route',  path:'/user',  exact:true,  component:User},{  type:'route',  path:'/login',  exact:true,  component:Login},{  type:'route',  path:'*',  component:NotFound}]

    router转换器

    import React from 'react';import { createBrowserHistory } from "history";import {Route,Router,StaticRouter,Redirect,Switch} from 'react-router';import routeConfig from  './routeConfig';const routes = routeConfig.map((conf,index)=>{//路由分发,遍历路由,判断type走对应的逻辑  const {type,...otherConf} = conf;  if(type==='redirect'){    return ;  }else if(type ==='route'){    return ;  }});export const createRouter = (type)=>(params)=>{//区分server/client,因为创建方式不一样//params用以处理重定向问题  if(type==='client'){    const history = createBrowserHistory();    return               {routes}            }else if(type==='server'){    // const {location} = params;    return                {routes}            }}

    客户端入口

    //src/index.jsimport React from 'react';import { hydrate } from 'react-dom';import App from './app';hydrate(  ,  document.getElementById("root"));

    客户端 app.js

    //src/app.jsimport React from 'react';import { createRouter } from './router'class App extends React.PureComponent{    render(){        return createRouter('client')();    }};export default App;

    服务端入口

    //server.jsimport express from 'express';import React from 'react';import {renderToString} from 'react-dom/server';import { createRouter } from './src/router'const app = express();app.use(express.static("dist"))app.get('*',function(req,res){  const content = renderToString(createRouter('server')({location:req.url}) );  res.send(`                            ssr                            
    ${content}
    `);});app.listen(3000);

    重定向问题

    这里我们从/重定向到/user的时候, 可以看到html返回的内容和实现页面渲染的内容是不一样的。
    这代表重定向操作是客户端来完成的, 而我们期望的是先访问index.html请求, 返回302, 然后出现一个新的user.html请求
    https://v5.reactrouter.com/web/api/StaticRouter react提供了一种重定向的处理方式

    import express from 'express';import React from 'react';import {renderToString} from 'react-dom/server';import { createRouter } from './src/router'const app = express();app.use(express.static("dist"))app.get('*',function(req,res){  const context = {};  const content = renderToString(createRouter('server')({location:req.url, context}) );  //当Redirect被使用时,context.url将包含重新向的地址  if(context.url){    //302    res.redirect(context.url);  }else{    res.send(`                            ssr                            
    ${content}
    `); }});app.listen(3000);

    这时候我们再测试一下, 就会发现符合预期, 出现了两个请求, 一个302, 一个user.html

    404问题

    我们随便输入一个不存在的路由, 发现内容是如期返回了404, 但是请求确实200的, 这是不对的.

    //server.jsimport express from 'express';import React from 'react';import {renderToString} from 'react-dom/server';import { createRouter } from './src/router'const app = express();app.use(express.static("dist"))app.get('*',function(req,res){  const context = {};  const content = renderToString(createRouter('server')({location:req.url, context}) );  //当Redirect被使用时,context.url将包含重新向的地址  if(context.url){    //302    res.redirect(context.url);  }else{    if(context.NOT_FOUND) res.status(404);//判断是否设置状态码为404    res.send(`                            ssr                            
    ${content}
    `); }});app.listen(3000);

    routeConfig.js

    //routeConfig.jsimport React from 'react';//改造前component:NotFound//改造后render:({staticContext})=>{//接收并判断属性,决定是否渲染404页面    if (staticContext) staticContext.NOT_FOUND = true;    return }

    感谢各位的阅读,以上就是"React服务端渲染和同构怎么实现"的内容了,经过本文的学习后,相信大家对React服务端渲染和同构怎么实现这一问题有了更深刻的体会,具体使用情况还需要大家实践验证。这里是,小编将为大家推送更多相关知识点的文章,欢迎关注!

    0