详解超简单的react服务器渲染(ssr)入坑指南


Posted in Javascript onFebruary 28, 2019

前言

本文是基于react ssr的入门教程,在实际项目中使用还需要做更多的配置和优化,比较适合第一次尝试react ssr的小伙伴们。技术涉及到 koa2 + react,案例使用create-react-app创建

SSR 介绍

Server Slide Rendering,缩写为 ssr 即服务器端渲染,这个要从SEO说起,目前react单页应用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>
  1. 如果main.js 加载比较慢,会出现白屏一闪的现象。
  2. 传统的搜索引擎爬虫因为不能抓取JS生成后的内容,遇到单页web项目,抓取到的内容啥也没有。在SEO上会吃很多亏,很难排搜索引擎到前面去。

React SSR(react服务器渲染)正好解决了这2个问题。

React SSR介绍

这里通过一个例子来带大家入坑!先使用create-react-app创建一个react项目。因为要修改webpack,这里我们使用react-app-rewired启动项目。根目录创建一个server目录存放服务端代码,服务端代码我们这里使用koa2。目录结构如下:

详解超简单的react服务器渲染(ssr)入坑指南

这里先来看看react ssr是怎么工作的。

详解超简单的react服务器渲染(ssr)入坑指南

这个业务流程图比较清晰了,服务端只生成HTML代码,实际上前端会生成一份main.js提供给服务端的HTML使用。这就是react ssr的工作流程。有了这个图会更好的理解,如果这个业务没理解清楚,后面的估计很难理解。

react提供的SSR方法有两个renderToString 和 renderToStaticMarkup,区别如下:
  • renderToString 方法渲染的时候带有 data-reactid 属性. 在浏览器访问页面的时候,main.js能识别到HTML的内容,不会执行React.createElement二次创建DOM。
  • renderToStaticMarkup 则没有 data-reactid 属性,页面看上去干净点。在浏览器访问页面的时候,main.js不能识别到HTML内容,会执行main.js里面的React.createElement方法重新创建DOM。

实现流程

好了,我们都知道原理了,可以开始coding了,目录结构如下:

详解超简单的react服务器渲染(ssr)入坑指南

create-react-app 的demo我没动过,直接用这个做案例了,前端项目基本上就没改了,等会儿我们服务器端要使用这个模块。代码如下:

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"
      href="https://reactjs.org" rel="external nofollow" 
      target="_blank"
      rel="noopener noreferrer"
     >
      Learn React
     </a>
    </header>
   </div>
  );
 }
}

export default App;

在项目中新建server目录,用于存放服务端代码。为了简化,我这里只有2个文件,项目中我们用的ES6,所以还要配置下.babelrc

详解超简单的react服务器渲染(ssr)入坑指南

.babelrc 配置,因为要使用到ES6
{
  "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 项目入口做一些预处理,使用asset-require-hook过滤掉一些类似 import logo from "./logo.svg"; 这样的资源代码。因为我们服务端只需要纯的HTML代码,不过滤掉会报错。这里的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模版代码要做个调整,{{root}} 这个可以是任何可以替换的字符串,等下服务端会替换这段字符串。
<!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 服务端渲染的主要代码,加载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
};

// 实例化 koa
const app = new Koa();

// 静态资源
app.use(
 koaStatic(path.join(__dirname, '../build'), {
  maxage: 365 * 24 * 60 * 1000,
  index: 'root' 
  // 这里配置不要写成'index'就可以了,因为在访问localhost:3030时,不能让服务默认去加载index.html文件,这里很容易掉进坑。
 })
);

// 设置路由
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('服务器启动,监听 port: ' + config.port + ' running~');
});
config-overrides.js 因为我们用的是create-react-app,这里使用react-app-rewired去改下webpack的配置。因为执行npm run build的时候会自动给资源加了hash值,而这个hash值,我们在asset-require-hook的时候去掉了hash值,配置里面需要改下,不然会出现图片不显示的问题,这里也是一个坑,要注意下。
module.exports = {
 webpack: function(config, env) {
  // ...add your webpack config
  // console.log(JSON.stringify(config));
  // 去掉hash值,解决asset-require-hook资源问题
  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;
 }
};

好了,所有的代码就这些了,是不是很简单了?我们koa2读取的静态资源是 build目录下面的。先执行npm run build打包项目,再执行node ./server 启动服务端项目。看下http://localhost:3030页面的HTML代码检查下:

详解超简单的react服务器渲染(ssr)入坑指南

详解超简单的react服务器渲染(ssr)入坑指南
没有{{root}}了,服务器渲染成功!

总结

相信这篇文章是最简单的react服务器渲染案例了,这里交出github地址https://github.com/mtsee/react-koa2-ssr

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持三水点靠木。

Javascript 相关文章推荐
javascript new一个对象的实质
Jan 07 Javascript
jquery表单验证框架提供的身份证验证方法(示例代码)
Dec 27 Javascript
用jQuery toggleClass 实现鼠标移上变色
May 14 Javascript
jquery动态加载js/css文件方法(自写小函数)
Oct 11 Javascript
浅析Node.js中使用依赖注入的相关问题及解决方法
Jun 24 Javascript
解决angular的post请求后SpringMVC后台接收不到参数值问题的方法
Dec 10 Javascript
如何使用AngularJs打造权限管理系统【简易型】
May 09 Javascript
vue2的todolist入门小项目的详细解析
May 11 Javascript
利用node实现一个批量重命名文件的函数
Dec 21 Javascript
如何在JavaScript中优雅的提取循环内数据详解
Mar 04 Javascript
详解mpvue中使用vant时需要注意的onChange事件的坑
May 16 Javascript
使用vue判断当前环境是安卓还是IOS
Apr 12 Vue.js
JS浅拷贝和深拷贝原理与实现方法分析
Feb 28 #Javascript
微信小程序搜索功能(附:小程序前端+PHP后端)
Feb 28 #Javascript
详解写好JS条件语句的5条守则
Feb 28 #Javascript
JS判断两个数组或对象是否相同的方法示例
Feb 28 #Javascript
jQuery.parseJSON()函数详解
Feb 28 #jQuery
js获取form表单中name属性的值
Feb 27 #Javascript
用VueJS写一个Chrome浏览器插件的实现方法
Feb 27 #Javascript
You might like
PHP 向右侧拉菜单实现代码,测试使用中
2009/11/03 PHP
php实现的仿阿里巴巴实现同类产品翻页
2009/12/11 PHP
php根据isbn书号查询amazon网站上的图书信息的示例
2014/02/13 PHP
PHP实现上传文件并存进数据库的方法
2015/07/16 PHP
PHP读取PPT文件的方法
2015/12/10 PHP
[原创]php常用字符串输出方法分析(echo,print,printf及sprintf)
2016/07/09 PHP
浅析PHP数据导出知识点
2018/02/17 PHP
javascript 构建一个xmlhttp对象池合理创建和使用xmlhttp对象
2010/01/15 Javascript
Javascript 通过json自动生成Dom的代码
2010/04/01 Javascript
JS实现div内部的文字或图片自动循环滚动代码
2013/04/19 Javascript
jquery ajax 调用失败的原因示例介绍
2013/09/27 Javascript
js操作滚动条事件实例
2015/01/29 Javascript
详解AngularJS Filter(过滤器)用法
2015/12/28 Javascript
用vscode开发vue应用的方法步骤
2019/05/06 Javascript
vue-cli在 history模式下的配置详解
2019/11/26 Javascript
html2canvas属性和使用方法以及如何使用html2canvas将HTML内容写入Canvas生成图片
2020/01/12 Javascript
[01:12:40]DOTA2-DPC中国联赛 正赛 DLG vs XG BO3 第三场 1月25日
2021/03/11 DOTA
关于Python元祖,列表,字典,集合的比较
2017/01/06 Python
python控制windows剪贴板,向剪贴板中写入图片的实例
2018/05/31 Python
详解pandas安装若干异常及解决方案总结
2019/01/10 Python
django页面跳转问题及注意事项
2019/07/18 Python
python 字典访问的三种方法小结
2019/12/05 Python
Python绘制数码晶体管日期
2021/02/19 Python
python的scipy.stats模块中正态分布常用函数总结
2021/02/19 Python
Html5页面上如何禁止手机虚拟键盘弹出
2020/03/19 HTML / CSS
挪威手表购物网站:Klokker
2016/09/19 全球购物
Asics日本官网:鬼冢八喜郎创立的跑鞋运动品牌
2017/10/18 全球购物
爷爷追悼会答谢词
2014/01/24 职场文书
2014年公司植树节活动方案
2014/03/04 职场文书
全运会口号
2014/06/20 职场文书
党的群众路线对照检查材料
2014/08/27 职场文书
个人工作表现评价材料
2014/09/21 职场文书
全国法院系统开展党的群众路线教育实践活动综述(全文)
2014/10/25 职场文书
喜迎建国70周年:有关爱国的名言名句
2019/09/24 职场文书
Python利器openpyxl之操作excel表格
2021/04/17 Python
「偶像大师 MILLION LIVE!」七尾百合子手办开订
2022/03/21 日漫