ReactApp项目构建流程【2】

React服务端渲染

• 为什么会有服务端渲染？
  • webapp开发模式很多框架都由浏览器渲染HTML内容，而seo抓取url内容时并不会执行js代码，抓取webapp时得到的是一个HTML[空内容]+js[内容写在js中],seo难以进行推广
  • 并且由浏览器渲染的webapp HTML内容必须等到js文件加载完成，首次请求时等待时间会比较长，体验差
  • React团队运用nodejs,使得用react构建的app能够在nodejs环境中进行渲染，以得到内容，再返回给浏览器，此时的HTML就能够被seo以及爬虫抓取，用户等待时间也会变短

服务端渲染准备

工具 react-dom下的server模块

 reat-dom是React专门为web端开发的渲染工具。
 
 在客户端，我们可以使用react-dom的render方法渲染组件
 
 在服务端，react-dom/server提供我们将react组件渲染成HTML的方法

基础配置

• 打开我们之前做好的项目，这里是之前的项目链接，未上传至github

• 首先打开app.js，发现之前是将<App />这个JSX标签render(中文：传递)到document.body中的，而问题是在服务端中并没有浏览器环境，自然也就没有document这个dom对象

  • 同级目录下新建server-entry.js,将需要服务端渲染的内容export出去
    import React from 'react' //用到了JSX就需要import 'react'
    import App from './App.jsx' //需要添加 [./],因为默认的import目录是node_modules
    export default <App /> //返回的应该是jsx语法再转义
    至此一个简单的server-entry.js文件就写好了
    该文件的作用：在服务端渲染时使用该文件，要把该文件单独打包出来，因为是JSX语法，需要用babel

  • 与webpack.config.js同级建立webpack.config.server.js
    内容拷贝自webpack.config.js，与entry选项同级添加

     target:"node",
         //指定webpack打包出来的文件是使用在哪个执行环境中的，选项有且不仅有web/node/...
     
     entry中的app修改为server-entry.js
     
     output中的filename修改为'server-entry.js'而非hash化文件名
         //此项可用于输出版本号用于缓存更新，而服务端无浏览器缓存概念，并且这会加大import难度
         并且添加一项libraryTarget:"commonjs2" 
             //打包出js时使用的模块方案，有多种global/cmd/amd/umd/commjs/...，commonjs2适用于node端
     
     删除plugins：[new HTMLPlugin()]，
         同时删除其引用const HTMLPlugin=require('html-webpack-plugin')
         因为服务端负责渲染而非输出HTML文件
    

• 配置完上步之后就可以把上部分的js打包出来，为方便后续打包，修改下package.json配置

       * 删除`scripts`下的`test`，当前暂时用不到
           "test": "echo \"Error: no test specified\" && exit 1",
           
       * 为分别build`客户端`和`服务端`以及区分不同端文件，在`scripts`添加两个`script`并修改`build`用于，将`webpack.config.js`修改为下端代码中的文件名
           "build:client":"webpack --config webpack.config.client.js",
           "build:server":"webpack --config webpack.config.server.js",
           "clear":"rimraf dist",
           //用于每次build时覆盖dist目录，该包专门用于删除文件夹，需要安装[该段第五步]
           "build":"npm run clear && npm run build:client && npm run build:server"
           //使用npm 按顺序 run clear，build:client 和build:server 脚本
           
           $npm i rimraf -D
           //安装完会自动更新package.json文件依赖关系
  

写到这里我们可以发现npm run这个命令其实是是运行package.json中的scripts中相应的script片段的key-value中的value,比如npm run clear实际是运行npm run rimraf dist

• npm run build
  编译后可以在output目录dist中，分别看到客户端js文件[name].[hash].js以及服务端js文件server-entry.js
  对比可以发现server-entry.js在顶部使用了module.exports这一node语法，因此可以发现是可以被node执行各种操作包括渲染的

• 在root下newserver文件夹用于添加node server，用到express，需要安装，$npm i express -S，因为该服务是正常服务中需要用到的，所以要使用-S安装到依赖模块当中
  ```
  安装好后在server文件夹内新建server.js并加入以下代码

  const express=require('express');                //node方式引入expeess
  const ReactSSR=require('react-dom/server');      //node方式引入react-dom/serve
  const serverEntry=require('../dist/server-entry').default;
  //此处为何需要添加.default呢，因为如果不添加default时，下面的打印说明了问题
  const app=express();
  console.log(serverEntry);
  /*会发现打印出来的是这么个东西，其中default中的东西才是nodeServer需要渲染的东西
  { __esModule: true,
       default:
           { 
              '$$typeof': Symbol(react.element),
              type: [Function: App],
              key: null,
              ref: null,
              props: {},
               _owner: null,
              _store: {} 
             }
    }
  */
  因为当前使用的是commonjs2模块方案，而commonjs2默认使用export.default来export模块，
  可以回到server-entry.js看下代码
  
  export default <APP /> 对应的引入方法 import app from './App.jsx'】
  export const app=App   对应的引入方法 import {app} from '..'     】->ES6中解构的写法
  node中使用的是require引入，require默认不会读取default内容
               
   app.get('*',function (req,res) {
          const appString=ReactSSR.renderToString(serverEntry);
          res.send(appString)
       });
            
       app.listen(3000,function () {         //监听端口，成功函数
           console.log('server is listening')
       })
  

• $npm start
  ```
  进入http://localhost:3000端口，打开network查看Headers以及Response

  至此最简单的服务端渲染已经完成，此时的返回内容html少以及未引用客户端的业务代码js
  为解决该问题，需要把服务端渲染出来的内容（当前为server-entry.js）插入到index.html
  (html-webpack-plugin插件通过编译成的HTML)的body当中并整体返回body，这才算打通一个整的
  服务端渲染过程
  

• 添加模板文件template.html以及修改webpack.config.client.js配置

  在client目录下新建`template.html`,在body中添加以下代码
  
  <div id="root"><app></app></div>
  //这个名为root的div就可以替代之前app.js中App组件挂载的document.body了，而内部的app标签则是用于覆盖，下面讲怎么覆盖
  
  在webpack.config.client.js的HTMLPlugin中添加刚才新建的template模板
       {
         template：path.join(__dirname,'../client/template.html')
       }
       
   app.js中之前挂载的document.body修改为document.getElementById('root')
   ReactDOM.render(<App />,document.body)
   ->
   ReactDOM.render(<App />,document.getElementById('root'))
   //把渲染出来的内容render到root节点中
  
  

• 配置好template后，在server.js中读取template.html并且替换掉<app>标签

  const fs=require('fs')            //node文件模块
  const path=require('path')        //node路径模块
  const template=fs.readFileSync(path.join(__dirname,'../client/template.html'),'utf-8')    
  //同步读取绝对路径文件，并且以utf-8格式输出，不指定的话回默认输出buffer格式
             
  //修改app的get方法
  app.get('*',function (req,res) {
         const appString=ReactSSR.renderToString(serverEntry);
         res.send(template.replace('<app></app>',appString));//修改用于替换掉<app>标签
  });
  
  

• $npm run build ->$npm start

  进入http://localhost:3000，成功，但是network时发现请求localhost和请求js文件时返回结果一样，
  也就是说有资源被重复返回的情况出现
  因为我们的服务接受到的所有请求都会返回服务端渲染的内容
  针对此问题，需要添加配置以确定哪些是不需要多次返回的静态资源文件
                  
  app.use('/public',express.static(path.join(__dirname,'../dist')));
  //express中为我们提供的专门处理此问题的模块，用于确定哪些文件夹下的资源是静态文件
  因为我们的client下的所有内容都在webpack.config.client.js中配置编译到dist(output->path)下，
  所以此处的静态文件路径就join dist，其中的publicPath在上次在跟走代码时置为空了，现在重新加回去，
  webpack.config.server.js中也需要加回去
                  
  #我们可以在编译好的index.html中查看资源路径是否正确
  
           
  

• $npm run build ->$npm start

  浏览器查看，无异常，但是有个warning
      app.cad52c1053474fca53c1.js:14238 Warning: render(): Calling ReactDOM.render() to 
  hydrate server-rendered markup will stop working in React v17. Replace the ReactDOM.render() 
  call with ReactDOM.hydrate() if you want React to attach to the server HTML
              
  这是在react16中，原本是使用ReactDom.render方法去渲染，新加了一个方法，如果我们使用了服务端渲染，那么需要使用hydrate()在客户端的js中去渲染客户端中的内容，因为react会比对server和client生成的代码。如果有差别，则会使用客户端的代码
              
  替换app.js中的render为hydrate()
      ReactDOM.render(<App />,document.getElementById('root'));
      ->
      ReactDOM.hydrate(<App />,document.getElementById('root'));
           
  

小结

有时间再写吧
问题：
    * 每次修改client后，都需要 npm run build
    * 每次修改server后，都需要npm start
    * 下篇文章再接触此内容