1. 概述

服务端渲染也就是常说的SSR,相信很多同学都听过这个概念,这里还是要简单说一下,为了文章前面的概念对齐。

1. 客户端渲染

在近十年的前端开发领域,逐渐向着客户算渲染迁移也就是CSR(Client Side Rendering),对于新入行的前端同学可能一开始接触的就是客户端渲染。尤其是在React, Vue,Angular大行其道的今天。用户在浏览器输入URL地址,浏览器加载到页面的html,js,css,再通过ajax将数据请求得到绘制页面布局,最后将页面显示出来。可以发现页面整体布局第一次渲染的这个过程是在客户端进行的。假设浏览器禁止了页面js执行你会发现html将是一个没有内容的空body结构。

客户端渲染可以说是前后端分离的产物,也是ajax发展的最佳实践产物,但同时他也存在两个问题,一个是SEO并不友好,搜索引擎在抓取页面的时候是不会去执行js的,会通过拿到的html内容对网站进行分析,显然拿到的空body导致html没有任何内容,也就没办法给网站定位排名。第二个问题是白屏时间,网站最开始给用户显示的是一个空白页面,当数据加载出来之后会重新绘制页面,这个加载的过程需要时间,而且取决于接口的速度和页面渲染速度。如果接口过慢页面白屏时间就会很长。

2. 服务端渲染

服务端渲染简称SSR(Server Side Rendering),也就是服务端进行页面的首屏渲染,数据获取和HTML的构建全都放在服务器中,这样客户端浏览器得到的直接就是一个完整结构的html。SEO可以抓取到更多的信息,浏览器也就渲染也会加快,比较网络请求回来的数据直接进行渲染就可以了,避免了空白的等待时间。

服务端渲染可能是个新概念,但背后的原理其实很古老。在web初代前后端分工不明朗的时期就是这样的开发方式。现如今的一些老系统中肯定也有这样的代码在。

目前主流的服务器端渲染框架有针对于Vue的Nuxt.js和针对React的Next.js这两个。这里并不是介绍这两个框架的使用方式,而是从零开始完整搭建一套SSR框架,来熟悉他的底层原理。让你能更好的了解到底什么是服务端渲染。

2. 演示环境搭建

首先初始化一个项目然后安装react,express,webpack,webpack-cli,webpack-node-externals install babel-loader babel-core babel-preset-react babel-preset-stage-0 babel-preset-env等项目依赖。

npm react,express,webpack,webpack-cli,webpack-node-externals install babel-loader babel-core babel-preset-react babel-preset-stage-0 babel-preset-env --save

1. 配置webpack

安装完成之后配置webpack.server.js文件。

这里的这个webpack是运行在服务端也就是node端的,需要添加一个target为node的键值对。

众所周知在服务器端如果使用path路径是不需要打包到js中的,如果在浏览器端使用了path是需要打包到js中的,所以在服务器端和在浏览器端需要编译出来的js是完全不同的。所以这里在打包的时候要告诉webpack打包的是服务器端的代码还是浏览器端的代码,使用webpack-node-externals模块来标识。

entry入口文件就是node的启动文件,这里写成./src/server/index.js,输出的output文件名称为bundle,目录在跟目录的build文件夹中。

const Path = require('path');
const NodeExternals = require('webpack-node-externals'); // 服务端运行webpack需要运行NodeExternals, 他的作用是将express这类node模块不被打包到js里。

module.exports = {
    target: 'node',
    mode: 'development',
    entry: './src/server/index.js',
    output: {
        filename: 'bundle.js',
        path: Path.resolve(__dirname, 'build')
    },
    externals: [NodeExternals()],
    module: {
        rules: [
            {
                test: /.js?$/,
                loader: 'babel-loader',
                exclude: /node_modules/,
                options: {
                    presets: ['react', 'stage-0', ['env', {
                        targets: {
                            browsers: ['last 2 versions']
                        }
                    }]]
                }
            }
        ]
    }
}

2. 编写入口文件

接着基于express模块来编写一个简单的服务。./src/server/index.js

创建了一个端口为3000的express服务,并且引入了一个React组件Home,引入这个组件的目的是为了让他参与编译,但是并没有让他参与渲染。

var express = require('express');
var app = express();
const Home = require('../Components/Home');
app.get('*', function(req, res) {
    res.send(`<h1>hello</h1>`);
})
var server = app.listen(3000);

3. 编写第一个组件

编写.src/components/Home/index.js组件

import React from 'react';

const Home = () => {
    return <div>home</div>
}

export default Home;

4. 编译运行

通过上面webpack.server.js的入口文件知道,这个js包含了一个React组件,一个端口为3000的express服务器,运行webpack打包的时候,他编译出来的js文件就具备这样的功能。

webpack --config webpack.server.js

打包之后在目录下会出现一个bundle.js,这个js就是打包生成的最终可以运行的代码。可以使用node运行这个文件, 这样就启动了一个3000端口的服务器。访问127.0.0.1:3000可以访问这个服务,当你访问的时候会看到浏览器输出Hello了。也就是express服务器send的内容。

node ./build/bundle.js

5. 渲染React组件

在/src/server/index.js中可以使用Home组件,这里首先需要安装react-dom,借助renderToString方法将Home组件转换为标签字符串,当然这里需要依赖React所以需要引入React。

import express from 'express';
import Home from '../Components/Home';
import React from 'react';
import { renderToString } from 'react-dom/server';

const app = express();
const content = renderToString(<Home />);
app.get('*', function(req, res) {
    res.send(`
        <html>
            <body>${content}</body>
        </html>
    `);
})

var server = app.listen(3000);

重新打包运行

# 重新打包
webpack --config webpack.server.js
# 运行服务
node ./build/bundle.js

这时候页面就显示出了React组件的代码。

6. 配置启动命令

React的服务端渲染是建立在虚拟DOM上的服务器端渲染,而且服务端渲染会让页面的首屏渲染速度大大加快。不过服务端渲染也有弊端,客户端渲染React代码在浏览器端执行,他消耗的是用户浏览器端的性能,但是服务器端渲染消耗的是服务器端的性能,因为React代码在服务器上运行。极大的消耗了服务器的性能,因为React代码是很消耗计算性能的。

如果你的项目完全没有必要使用SEO优化并且你的项目访问速度已经很快了的情况下,建议还是不要使用SSR的技术了,因为他的成本开销还是比较大的。

上面的代码每次修改之后都需要重新执行webpack打包和启动服务器,这样调试起来太过麻烦,为了解决这个问题,需要做一下webpack的自动打包和node的重启。在package.json中加入build命令,并且通过--watch监听文件变化进行自动打包。

{
    ...
    "scripts": {
        "build": "webpack --config webpack.server.js --watch"
    }
    ...
}

仅仅重新打包还不够,还需要重启node服务器,这里需要借助nodemon模块,全局安装nodemon, 在package.json文件中添加一个start命令来启动node服务器。使用nodemon监听build文件并且发生改变之后重新exec运行"node ./build/bundle.js", 这里需要保留双引号,转译一下就好了。

{
    ...
    "scripts": {
        "start": "nodemon --watch build --exec node \"./build/bundle.js\"",
        "build": "webpack --config webpack.server.js --watch"
    }
    ...
}

启动服务器,这里需要在两个窗口运行下面的命令,因为build后不允许再输入其他命令了。

npm run build
npm run start

修改代码之后页面就会自动更新了。

但是上面的流程还是有些麻烦,需要两个窗口来执行命令,想要一个窗口将两个命令执行完毕,需要借助一个第三方模块npm-run-all,可以全局安装这个模块。然后再package.json中来修改一下。

打包和调试应该是在开发环境,这里需要创建一个dev命令, 里面执行npm-run-all, --parallel表示并行执行, 执行dev:开头的所有命令。将start和build前面追加一个dev:,这个时候我想启动服务器同时监听文件改变运行npm run dev就可以了。

{
    ...
    "scripts": {
        "dev": "npm-run-all --parallel dev:**",
        "dev:start": "nodemon --watch build --exec node \"./build/bundle.js\"",
        "dev:build": "webpack --config webpack.server.js --watch"
    }
    ...
}

3. 项目结构

1. SSR同构

同构指的是代码复用. 即实现客户端和服务器端最大程度的代码复用,可以简单的理解同构就是让服务端和客户端执行一套代码,而不是分别针对两端写两套代码。

比如下面的代码,给div绑定一个click事件,希望点击的时候可以弹出click提示。但是运行之后会发现这个事件并没有被绑定上,因为html是在服务器端渲染的,而服务端没办法绑定事件毕竟绑定事件是dom行为。

src/components/Home/index.js

import React from 'react';

const Home = () => {
    return <div onClick={() => { alert('click'); }}>home</div>
}

export default Home;

一般的做法是先将页面渲染出来,然后将相同的代码在浏览器端像传统的React项目一样再去运行一遍,这样的话这个点击事件就有了。

这就衍生出一个同构的概念,我的理解是一套React代码在服务器端执行一次,在客户端再执行一次。

同构就可以解决点击事件无效的问题,首先服务器端执行一次能够正常的展示页面,客户端再执行一次就可以绑定上事件。

可以在页面渲染的时候加载一个index.js, 使用app.use创建静态文件的访问路径, 这样访问的index.js就会请求到/public/index.js文件中。

app.use(express.static('public'));

app.get('/', function(req, res) {
    res.send(`
        <html>
            <body>
                <div id="root">${content}</div>
                <script src="/index.js"></script>
            </body>
        </html>
    `);
})

public/index.js编写。

console.log('public');

基于这种情况可以将React代码在浏览器中执行一次,新建一个/src/client/index.js。将客户端执行的代码帖进去。同构代码使用hydrate代替render。

import React from 'react';
import ReactDOM from 'react-dom';

import Home from '../Components/Home';

ReactDOM.hydrate(<Home />, document.getElementById('root'));

2. 客户端配置

还需要在根目录创建一个webpack.client.js文件。入口文件为./src/client/index.js,出口文件到public/index.js

const Path = require('path');

module.exports = {
    mode: 'development',
    entry: './src/client/index.js',
    output: {
        filename: 'index.js',
        path: Path.resolve(__dirname, 'public')
    },
    module: {
        rules: [
            {
                test: /.js?$/,
                loader: 'babel-loader',
                exclude: /node_modules/,
                options: {
                    presets: ['react', 'stage-0', ['env', {
                        targets: {
                            browsers: ['last 2 versions']
                        }
                    }]]
                }
            }
        ]
    }
}

package.json文件中添加一条打包client目录的命令

{
    ...
    "scripts": {
        "dev": "npm-run-all --parallel dev:**",
        "dev:start": "nodemon --watch build --exec node \"./build/bundle.js\"",
        "dev:build": "webpack --config webpack.server.js --watch",
        "dev:build": "webpack --config webpack.client.js --watch",
    }
    ...
}

这样启动的时候会编译client运行的文件。再去访问页面的时候就可以绑定好事件了。

3. webpack整理

对上面工程的代码进行整理,上面webpack.server.js和webpack.client.js文件有很多重复的地方,使用webpack-merge插件对内容进行合并。

webpack.base.js

module.exports = {
    module: {
        rules: [
            {
                test: /.js?$/,
                loader: 'babel-loader',
                exclude: /node_modules/,
                options: {
                    presets: ['react', 'stage-0', ['env', {
                        targets: {
                            browsers: ['last 2 versions']
                        }
                    }]]
                }
            }
        ]
    }
}

webpack.server.js

const Path = require('path');
const NodeExternals = require('webpack-node-externals'); // 服务端运行webpack需要运行NodeExternals, 他的作用是将express这类node模块不被打包到js里。

const merge = require('webpack-merge');
const config = require('./webpack.base.js');

const serverConfig = {
    target: 'node',
    mode: 'development',
    entry: './src/server/index.js',
    output: {
        filename: 'bundle.js',
        path: Path.resolve(__dirname, 'build')
    },
    externals: [NodeExternals()],
}

module.exports = merge(config, serverConfig);

webpack.client.js

const Path = require('path');
const merge = require('webpack-merge');
const config = require('./webpack.base.js');

const clientConfig = {
    mode: 'development',
    entry: './src/client/index.js',
    output: {
        filename: 'index.js',
        path: Path.resolve(__dirname, 'public')
    }
};

module.exports = merge(config, clientConfig);

src/server中放置的是服务端运行的代码,src/client放置的是浏览器端运行的js。

4. 目录说明

package.json # 项目管理文件
webpack.base.js # webpack 公共部分
webpack.server.js # 服务端webpack配置
webpack.client.js # 客户端webpack配置
src/  # 开发文件夹
    components/ # React 组件文件夹
    server/index.js # 服务端运行代码
    client/index.js # 客户端运行代码
    Routes/index.js # 路由配置
build/ # 编译后文件夹
public/ # 前端静态文件夹,用于存放浏览器执行的js代码

4. 服务器端渲染路由

首先浏览器向服务器发送请求,服务器返回一个空的html,浏览器再请求js,加载到js后会执行react代码,react代码接管页面执行流程,这个时候可以根据浏览器的地址展示页面内容。

做重构的时候需要让路由代码在浏览器和服务端分别执行一次,浏览器执行的流程和原本一模一样没有任何区别但是服务器端有一些区别,这里要使用StaticRouter组件替代浏览器的browserRouter。

1. 配置路由模块

npm install react-router-dom --save

创建src/Routes.js配置路由。

import React from 'react';
import { Route } from 'react-router-dom';
import Home from './components/Home';

export default (
    <div>
        <Route path="/" exact component={Home}></Route>
    </div>
);

2. 配置客户端代码

src/client/index.js这里使用BrowserRouter包裹住之前定义的Routes。

import React from 'react';
import ReactDOM from 'react-dom';
import { BrowserRouter } from 'react-router-dom';
import Routes from '../Routes';

const App = () => {
    return (
        <BrowserRouter>
            {Routes}
        </BrowserRouter>
    )
}

ReactDOM.hydrate(<App />, document.getElementById('root'));

3. 配置服务端代码

src/server/index.js,同样使用StaticRouter来渲染Routes。context是StaticRouter做数据传递的,这里先写一个空对象。

StaticRouter是不知道请求路径是什么的,因为他运行在服务器端,所以这是他不如BrowserRouter的地方,他需要在请求体重获取到路径传递给他, 这里需要将content写在请求里面。将location的值赋为req.path。

import express from 'express';
import React from 'react';
import { renderToString } from 'react-dom/server';

import { StaticRouter } from 'react-router-dom';
import Routes from '../Routes';

const app = express();

app.use(express.static('public'));

app.get('*', function(req, res) {
    const content = renderToString((
        <StaticRouter location={req.path} context={{}}>
            <Routes />
        </StaticRouter>
    ));
    res.send(`
        <html>
            <body>
                <div id="root">${content}</div>
                <script src="/index.js"></script>
            </body>
        </html>
    `);
})

var server = app.listen(3000);

4. 增加页面组件用于测试路由

增加一个页面,实现多页面的路由跳转。当用户访问login路径的时候返回一个Login组件。

src/Routes.js

import React from 'react';
import { Route } from 'react-router-dom';
import Home from './components/Home';
import Login from './components/Login';

export default (
    <div>
        <Route path="/" exact component={Home}></Route>
        <Route path="/login" exact component={Login}></Route>
    </div>
);

src/components/Login/index.js

import React from 'react';

const Login = () => {
    return <div>Login</div>
}

export default Login;

整理一下代码,新建一个utils文件将通用方法抽离出来。

src/server/utils.js

import React from 'react';
import { renderToString } from 'react-dom/server';
import { StaticRouter } from 'react-router-dom';
import Routes from '../Routes';
export const render = (req) => {
    const content = renderToString((
        <StaticRouter location={req.path} context={{}}>
            <Routes />
        </StaticRouter>
    ));
    return `
        <html>
            <body>
                <div id="root">${content}</div>
                <script src="/index.js"></script>
            </body>
        </html>
    `;
}

src/server/index.js,使用render函数。

import express from 'express';
import { render } from './utils';

const app = express();
app.use(express.static('public'));

app.get('*', function(req, res) {
    res.send(render(req));
})
var server = app.listen(3000);

使用Link标签串联起整个路由的工作流程。创建一个公共组件src/components/Header/index.js

import React from 'react';

const Header = () => {
    return <div>header</div>
}

export default Header;

src/components/Home/index.js组件中引入Header组件。

import React from 'react';
import Header from '../Header';

const Home = () => {
    return <div>
        <Header>
        Home
        <button onClick={() => { alert('click1'); }>按钮</button>
    </div>
}

export default Home;

src/components/Login/index.js

import React from 'react';
import Header from '../Header';

const Login = () => {
    return <div><Header />Login</div>
}

export default Login;

在Header中引入Link, 并且使用他跳转至Home和Login。

src/components/Header/index.js

import React from 'react';
import { Link } from 'react-router-dom';

const Header = () => {
    return <div>
        <Link to="/">Home</Link>
        <br />
        <Link to="/login">Login</Link>
    </div>
}

export default Header;

在做页面同构的时候,服务器端渲染只会在第一次进入页面的时候进行,后面使用Link的跳转都是浏览器端的跳转,不会再去加载页面的资源文件。

所以服务器端渲染不是每个页面都做服务器端渲染,而是只访问的第一个页面具有服务端渲染的特性,其他的页面仍旧是React的路由机制。

5. 什么是中间层?

做服务端渲染的时候经常能听到中间层这个名词。做服务端渲染的时候浏览器请求服务器也就是node-server,服务器会将页面数据返回给浏览器。但是当做大型项目的时候,获取页面内容的时候会涉及到数据库查询或者说数据的计算,一般在做服务端渲染的时候架构层会将数据库的查询或者复杂的计算放在java,c++等服务器去做,而不会放在node中。

因为相对于Node来说,Java或者C++计算性能要更高一些。

这种架构有一个好处,java服务只需要专注数据的获取数据的计算就可以了,node服务器专注生成页面的内容,负责将从java服务器中获取的数据生成页面结构。所以node-server只是一个中间层,负责页面的拼装。

react计算还是很消耗性能的,当访问量过多的时候node可能会承受不住,这个时候可以单独去增加node服务器的数量来提高负载瓶颈,这种架构在线上还是具备很大的便捷性的。

不过他的缺点也是比较明显的,增加了前端的复杂度,在关心页面渲染的同时还要维护服务器,关心项目架构。

6. 引入Redux

如果我想在项目中使用redux我需要在server端和client端都使用redux,首先需要安装redux。react-redux可以方便开发者在react中去使用redux。redux-thunk是redux的一个中间件也安装一下。

npm install redux react-redux redux-thunk --save

1. 客户端配置

src/client/index.js,引入createStore来创建store。不了解redux的同学可以参考我之前写的《redux设计模式》一文。

import React from 'react';
import ReactDOM from 'react-dom';
import { BrowserRouter } from 'react-router-dom';
import Routes from '../Routes';
import { createStore } from 'redux';
import { Provider } from 'react-redux';

const reducer = (state = { name: 'yd'}, action) => {
    return state;
}
const store = createStore(reducer);

const App = () => {
    return (
        <Provider store={store}>
            <BrowserRouter>
                {Routes}
            </BrowserRouter>
        </Provider>
    )
}

ReactDOM.hydrate(<App />, document.getElementById('root'));

在src/components/Home/index.js组件中中使用redux。

import React from 'react';
import Header from '../Header';
import { connect } from 'react-redux';

const Home = (props) => {
    return <div>
        <Header>
        <div>{props.name}</div>
        <div>Home</div>
        <button onClick={() => { alert('click1'); }>按钮</button>
    </div>
}

const mapStatetoProps = state => ({
    name: state.name
});

export default connect(mapStatetoProps, null)(Home);

2. 服务端配置

src/server/utils.js

import React from 'react';
import { renderToString } from 'react-dom/server';
import { StaticRouter } from 'react-router-dom';
import Routes from '../Routes';
import { createStore } from 'redux';
import { Provider } from 'react-redux';

export const render = (req) => {

    const reducer = (state = { name: 'yd'}, action) => {
        return state;
    }
    const store = createStore(reducer);

    const content = renderToString((
        <Provider store={store}>
            <StaticRouter location={req.path} context={{}}>
                <Routes />
            </StaticRouter>
        </Provider>
    ));
    return `
        <html>
            <body>
                <div id="root">${content}</div>
                <script src="/index.js"></script>
            </body>
        </html>
    `;
}

使用redux的时候使用一些中间件,可以在src/server/utils.js演示。

import React from 'react';
import { renderToString } from 'react-dom/server';
import { StaticRouter } from 'react-router-dom';
import Routes from '../Routes';
import { createStore, applyMiddleware } from 'redux';
import { Provider } from 'react-redux';
import thunk from 'redux-thunk';

export const render = (req) => {

    const reducer = (state = { name: 'yd'}, action) => {
        return state;
    }
    const store = createStore(reducer, applyMiddleware(thunk));

    const content = renderToString((
        <Provider store={store}>
            <StaticRouter location={req.path} context={{}}>
                <Routes />
            </StaticRouter>
        </Provider>
    ));
    return `
        <html>
            <body>
                <div id="root">${content}</div>
                <script src="/index.js"></script>
            </body>
        </html>
    `;
}

src/client/index.js

import React from 'react';
import ReactDOM from 'react-dom';
import { BrowserRouter } from 'react-router-dom';
import Routes from '../Routes';
import { createStore, applyMiddleware } from 'redux';
import { Provider } from 'react-redux';
import thunk from 'redux-thunk';

const reducer = (state = { name: 'yd'}, action) => {
    return state;
}
const store = createStore(reducer, applyMiddleware(thunk));

const App = () => {
    return (
        <Provider store={store}>
            <BrowserRouter>
                {Routes}
            </BrowserRouter>
        </Provider>
    )
}

ReactDOM.hydrate(<App />, document.getElementById('root'));

client和server中都会用到store,可以将他们抽离出来不要每个位置都写一遍。

要注意一下,在render方法中每个用户访问都会使用store,但是在服务器上这个store只定义了一次,并不是每次调用render都会创建,所以共享了store,这样是不对的,每个用户都应该有自己的store。这里导出一个创建Store的方法,在使用的位置创建store。

src/store/index.js

import { createStore, applyMiddleware } from 'redux';
import thunk from 'redux-thunk';
const reducer = (state = { name: 'yd'}, action) => {
    return state;
}

const getStore = () => {
    return createStore(reducer, applyMiddleware(thunk));
}
export default getStore;

src/client/index.js也要加一下。

import React from 'react';
import ReactDOM from 'react-dom';
import { BrowserRouter } from 'react-router-dom';
import Routes from '../Routes';
import getStore from '../store'; // 使用store
import { Provider } from 'react-redux';

const App = () => {
    return (
        <Provider store={getStore()}>
            <BrowserRouter>
                {Routes}
            </BrowserRouter>
        </Provider>
    )
}

ReactDOM.hydrate(<App />, document.getElementById('root'));

src/server/utils.js

import React from 'react';
import { renderToString } from 'react-dom/server';
import { StaticRouter } from 'react-router-dom';
import Routes from '../Routes';
import getStore from '../store'; // 使用store
import { Provider } from 'react-redux';

export const render = (req) => {

    const content = renderToString((
        <Provider store={getStore()}>
            <StaticRouter location={req.path} context={{}}>
                <Routes />
            </StaticRouter>
        </Provider>
    ));
    return `
        <html>
            <body>
                <div id="root">${content}</div>
                <script src="/index.js"></script>
            </body>
        </html>
    `;
}

规范一下redux项目代码的结构。希望访问根目录的时候页面显示一个列表。

首先修改首页src/components/Home/store/reducer.js初始化创建一些数据并且处理actions变化数据的变化。

import { CHANGE_LIST } from './constants';
const defaultState = {
    newsList: []
}
export default (state = defaultState, action) => {
    switch (action.type) {
        case CHANGE_LIST:
            return {
                ...state,
                newsList: action.list
            };
        default:
            return state;
    }
}

接着在全局的store中,这里面应该对所有的reducer做一个组合。

src/store/index.js

import { createStore, applyMiddleware, combineReducers } from 'redux';
import thunk from 'redux-thunk';
import { reducer as homeReducer} from '../components/Home/store';

const reducer = combineReducers({
    home: homeReducer
});

const getStore = () => {
    return createStore(reducer, applyMiddleware(thunk));
}
export default getStore;

src/components/Home/store/index.js

import reducer from './reducer';

export { reducer };

src/components/Home/index.js, 希望在这个文件中发一个请求去展示列表,这里改造成一个类式组件。

借助dispatch的能力,在getHomeList中发送一个异步请求。这里dispatch需要使用action

import React, { Component } from 'react';
import Header from '../Header';
import { connect } from 'react-redux';
import { getHomeList } from './store/actions';

class Home extends Component {

    getList() {
        const { list } = this.props;
        return this.props.list.map(item => <div key={item.id}>{item.title}</div>)
    }
    render() {
        return <div>
            <Header>
            <div>Home</div>
            {this.getList()}
            <button onClick={() => { alert('click1'); }>按钮</button>
        </div>
    }

    componentDidMount() {
        this.props.getHomeList();
    }
}

const mapStatetoProps = state => ({
    list: state.home.newsList
});

const mapDispatchToProps = dispatch => ({
    getHomeList() {
        dispatch(getHomeList());
    }
})

export default connect(mapStatetoProps, mapDispatchToProps)(Home);

定义一个函数,这个函数可以返回一个对象作为action也可以返回一个函数来做异步的操作,这是redux-thunk带来的能力。

src/components/Home/store/actions.js

import axios from 'axios';
import { CHANGE_LIST } from './constants';

const changeList = (list) => {
    type: CHANGE_LIST,
    list
}

export const getHomeList = () => {
    return (dispatch) => {
        return axios.get('http://127.0.0.1:3000/getlist').then(res => {
            const list = res.data.data;
            dispatch(changeList(list));
        })
    }
}

src/components/Home/store/constants.js 存储常量。

export const CHANGE_LIST = 'HOME/CHANGE_LIST';

这样redux的结构就创建好了,但是我们发现项目可以正常运行但是页面渲染的结构中并没有这段列表的结构。这是因为服务器端运行的时候componentDidMount并不会执行,所以列表是空的,所以列表的内容并没有生成,用户看到的列表是客户端客户端运行的时候执行的,所以列表是客户端渲染出来的。

在服务器端的时候也要执行componentDidMount获取到数据。将页面结构渲染出来。

src/components/Home/index.js, 在Home组件中添加一个静态方法Home.loadData, 这个函数负责在服务端渲染之前把这个路由需要的数据提前加载好。

import React, { Component } from 'react';
import Header from '../Header';
import { connect } from 'react-redux';
import { getHomeList } from './store/actions';

class Home extends Component {

    getList() {
        const { list } = this.props;
        return this.props.list.map(item => <div key={item.id}>{item.title}</div>)
    }
    render() {
        return <div>
            <Header>
            <div>Home</div>
            {this.getList()}
            <button onClick={() => { alert('click1'); }>按钮</button>
        </div>
    }

    componentDidMount() {
        this.props.getHomeList();
    }
}

Home.loadData = (store) => {
    // 执行action,扩充store。
    return store.dispatch(getHomeList());
}

const mapStatetoProps = state => ({
    list: state.home.newsList
});

const mapDispatchToProps = dispatch => ({
    getHomeList() {
        dispatch(getHomeList());
    }
})

export default connect(mapStatetoProps, mapDispatchToProps)(Home);

其实componentDidMount在服务端是不会执行的,

src/server/utils.js中拿到的store是空的,可以让store在渲染时拿到真实的数据就可以了。这里需要知道当前路由加载哪些组件的数据。所以这里还需要改造一下路由配置,根据路由来判断加载的数据。

loadData是加载组件之前执行的方法,这里写成Home.loadData, Login组件不需要加载任何数据,所以不定义就可以了。

src/Routes.js

import React from 'react';
import Home from './components/Home';
import Login from './components/Login';

export default [
    {
        path: '/',
        component: Home,
        exact: true,
        key: 'home',
        loadData: Home.loadData
    },
    {
        path: '/login',
        component: Login,
        key: 'login',
        exact: true
    }
]

因为路由的机构改变了,所以这里使用Router.js的地方也要修改。Router已经不是组件而是数组了,需要修改一下。

src/client/index.js注意需要使用div包裹一下所有Route,否则会报错。因为react-route-dom要求route成组出现。

import React from 'react';
import ReactDOM from 'react-dom';
import { BrowserRouter, Route } from 'react-router-dom';
import routes from '../Routes';
import getStore from '../store'; // 使用store
import { Provider } from 'react-redux';

const App = () => {
    return (
        <Provider store={getStore()}>
            <BrowserRouter>
                <div>
                    {
                        routes.map(route => (
                            <Route {...route} />
                        ))
                    }
                </div>
            </BrowserRouter>
        </Provider>
    )
}

ReactDOM.hydrate(<App />, document.getElementById('root'));

src/server/utils.js这里除了修改routes以外还要判断当前访问的路径是什么,然后将对应需要加载的数据提前放在store里面,需要借助matchRoute方法。他是react-router-config插件提供的。matchRoute可以匹配二级路由,react-router-dom自带的matchPath只能匹配一级路由。

这里的render方法需要多接收一个res,用于返回给浏览器的send调用。因为请求函数是异步的,所以需要在回调结束后返回。

import React from 'react';
import { renderToString } from 'react-dom/server';
import { StaticRouter, Route } from 'react-router-dom';
import routes from '../Routes';
import getStore from '../store'; // 使用store
import { Provider } from 'react-redux';
import { matchRoute } from 'react-router-config';

export const render = (req, res) => {
    const store = getStore();
    // 可以拿到store填充到store中。
    // 根据路由的路径向store里面添加数据,需要借助matchRoute,返回值是一个数组,里面是匹配到的每级路由。
    const matchedRoutes = matchRoute(routes, req,path);
    // 让matchRoutes里面所有的组件对应的loadData方法都执行一次
    // item.route.loadData返回的是一个promise等待promise执行完毕再向下,所以使用Promise.all,请求响应后返回给浏览器数据。
    const promises = [];
    matchedRoutes.forEach(item => {
        if (item.route.loadData) {
            promises.push(item.route.loadData(store));
        }
    });
    Promise.all(promises).then(() => {
        const content = renderToString((
            <Provider store={store}>
                <StaticRouter location={req.path} context={{}}>
                    <div>
                        {
                            routes.map(route => (
                                <Route {...route} />
                            ))
                        }
                    </div>
                </StaticRouter>
            </Provider>
        ));
        res.send(`
            <html>
                <body>
                    <div id="root">${content}</div>
                    <script src="/index.js"></script>
                </body>
            </html>
        `);
    })
}

src/server/index.js也需要修改一下。将req和res都传递进去,然后在render方法里面去返回响应。

import express from 'express';
import { render } from './utils';

const app = express();
app.use(express.static('public'));

app.get('*', function(req, res) {
    render(req, res)
})
var server = app.listen(3000);

注意浏览器会自动请求一个favicon文件,造成代码重复执行,可以在public文件夹中加入这个图片解决该问题。

这样访问浏览器就可以发现页面结构已经渲染出来了,并且是服务端渲染的而不是浏览器渲染的。

整理一下这些代码。

src/server/index.js当接收到用户请求的时候将store的创建移动到这里,保持render函数干净。

import express from 'express';
import { matchRoute } from 'react-router-config';
import { render } from './utils';
import getStore from '../store'; // 使用store
import routes from '../Routes';

const app = express();
app.use(express.static('public'));

app.get('*', function(req, res) {
    const store = getStore();
    const matchedRoutes = matchRoute(routes, req,path);
    const promises = [];
    matchedRoutes.forEach(item => {
        if (item.route.loadData) {
            promises.push(item.route.loadData(store));
        }
    });
    Promise.all(promises).then(() => {
        res.send(render(store, routes, req)); 
    })
})
var server = app.listen(3000);

src/server/utils.js

import React from 'react';
import { renderToString } from 'react-dom/server';
import { StaticRouter, Route } from 'react-router-dom';
import { Provider } from 'react-redux';

export const render = (store, routes, req) => {
    const content = renderToString((
        <Provider store={store}>
            <StaticRouter location={req.path} context={{}}>
                <div>
                    {
                        routes.map(route => (
                            <Route {...route} />
                        ))
                    }
                </div>
            </StaticRouter>
        </Provider>
    ));
    return `
        <html>
            <body>
                <div id="root">${content}</div>
                <script src="/index.js"></script>
            </body>
        </html>
    `;
}

总结一下服务器端渲染的流程。

当用户请求网页的时候首先服务端创建了一个空的store,然后根据请求路径和路由项做匹配,来判断用户当前访问的路径对应的加载项有哪些,所以matchedRoutes中放置的就是要展示的组件。循环matchedRoutes判断组件里面是否存在loadData,如果有就说明他需要加载一些数据,所以把loadData执行以下,将请求放在Promise的数组里面,等所有组件对应的Promose都执行完成之后就说明这一个路径要展示的组件依赖数据已经准备好了,那么结合展示好了的数据和路由和请求数据最终生成一段html内容返回给用户。这段html就包含了用户需要的所有信息。

不过这里还有一个问题,当加载页面之后页面会闪动一下,因为这是js执行的时候会清空页面再展示页面。因为客户端一开始store也是空的,是请求结束之后才有数据的。

这里需要用到一个概念叫做脱水和注水,首先找到src/server/utils.js, 在渲染页面的时候可以在页面底部加一个script标签, 在这个标签里面写上渲染的数据。

src/server/utils.js

import React from 'react';
import { renderToString } from 'react-dom/server';
import { StaticRouter, Route } from 'react-router-dom';
import { Provider } from 'react-redux';

export const render = (store, routes, req) => {
    const content = renderToString((
        <Provider store={store}>
            <StaticRouter location={req.path} context={{}}>
                <div>
                    {
                        routes.map(route => (
                            <Route {...route} />
                        ))
                    }
                </div>
            </StaticRouter>
        </Provider>
    ));
    return `
        <html>
            <body>
                <div id="root">${content}</div>
                <script>
                    window.context = {
                        state: ${JSON.stringfiy(store.getState())}
                    }
                </script>
                <script src="/index.js"></script>
            </body>
        </html>
    `;
}

打开src/store/index.js, 在里面新增一个方法getClientStore。

import { createStore, applyMiddleware, combineReducers } from 'redux';
import thunk from 'redux-thunk';
import { reducer as homeReducer} from '../components/Home/store';

const reducer = combineReducers({
    home: homeReducer
});

export const getStore = () => {
    return createStore(reducer, applyMiddleware(thunk));
}

export const getClientStore = () => {
    const defaultState = window.context.state;
    // defaultState作为默认值
    return createStore(reducer, defaultState, applyMiddleware(thunk));
}

src/server/index.js修改store获取方式

import express from 'express';
import { matchRoute } from 'react-router-config';
import { render } from './utils';
import { getStore } from '../store'; // 使用store
import routes from '../Routes';

const app = express();
app.use(express.static('public'));

app.get('*', function(req, res) {
    const store = getStore();
    const matchedRoutes = matchRoute(routes, req,path);
    const promises = [];
    matchedRoutes.forEach(item => {
        if (item.route.loadData) {
            promises.push(item.route.loadData(store));
        }
    });
    Promise.all(promises).then(() => {
        res.send(render(store, routes, req)); 
    })
})
var server = app.listen(3000);

然后打开src/client/index.js这里的getStore换成getClientStore, 客户端的store要使用服务端给我的store。

import React from 'react';
import ReactDOM from 'react-dom';
import { BrowserRouter, Route } from 'react-router-dom';
import routes from '../Routes';
import { getClientStore } from '../store'; // 使用store
import { Provider } from 'react-redux';

const store = getClientStore();
const App = () => {
    return (
        <Provider store={store}>
            <BrowserRouter>
                <div>
                    {
                        routes.map(route => (
                            <Route {...route} />
                        ))
                    }
                </div>
            </BrowserRouter>
        </Provider>
    )
}

ReactDOM.hydrate(<App />, document.getElementById('root'));

但是这样componentDidMount中获取数据的方法是不是可以删掉了?其实不可以,因为路由跳转的时候被加载的组件仍旧需要执行改方法。前面说过服务端渲染只会加载第一个页面的内容,后面路由加载的内容并不会全部展示出来。

可以判断一下数据是否存在,如果不存在就请求,存在就不请求。

src/components/Home/index.js

import React, { Component } from 'react';
import Header from '../Header';
import { connect } from 'react-redux';
import { getHomeList } from './store/actions';

class Home extends Component {

    getList() {
        const { list } = this.props;
        return this.props.list.map(item => <div key={item.id}>{item.title}</div>)
    }
    render() {
        return <div>
            <Header>
            <div>Home</div>
            {this.getList()}
            <button onClick={() => { alert('click1'); }>按钮</button>
        </div>
    }

    componentDidMount() {
        if (!this.props.list.length) {
            this.props.getHomeList();
        }
    }
}

Home.loadData = (store) => {
    // 执行action,扩充store。
    return store.dispatch(getHomeList());
}

const mapStatetoProps = state => ({
    list: state.home.newsList
});

const mapDispatchToProps = dispatch => ({
    getHomeList() {
        dispatch(getHomeList());
    }
})

export default connect(mapStatetoProps, mapDispatchToProps)(Home);

7. 中间层能力

之前说过浏览器和服务端通信的时候,node作为中间层负责渲染页面,数据从真正的数据服务器中获取。

来分析一下前面的代码是否实现了中间层的概念。前面存储的src/public/index.js就是客户端要运行的代码,可以发现这里请求服务的接口请求的是java接口,这就违背了中间层的概念,这里请求的接口也应该是中间层的接口,这方便排查错误。

只需要让node-server变成一个代理服务器就可以了,也就是一个proxy的功能,这里依赖一个express-http-proxy包协助。

npm install express-http-proxy --save

src/server/index.js修改store获取方式

import express from 'express';
import proxy from 'express-http-proxy';
import { matchRoute } from 'react-router-config';
import { render } from './utils';
import { getStore } from '../store'; // 使用store
import routes from '../Routes';

const app = express();
app.use(express.static('public'));

app.use('/api', proxy('xx.xx.xx.xx', {
    proxyReqPathResolver: (req) => { // 转发到哪个路径
        return req.url;
    }
}))

app.get('*', function(req, res) {
    const store = getStore();
    const matchedRoutes = matchRoute(routes, req,path);
    const promises = [];
    matchedRoutes.forEach(item => {
        if (item.route.loadData) {
            promises.push(item.route.loadData(store));
        }
    });
    Promise.all(promises).then(() => {
        res.send(render(store, routes, req)); 
    })
})
var server = app.listen(3000);

src/components/Home/store/actions.js, 删除请求的域名。

import axios from 'axios';
import { CHANGE_LIST } from './constants';

const changeList = (list) => {
    type: CHANGE_LIST,
    list
}

export const getHomeList = (server) => {
    let url = '';
    if (server) { // 服务端环境使用真实地址
        url = 'xx.xx.xx.xx/api/getlist'
    } else { // 浏览器环境使用相对地址,做转发
        url = '/api/getlist'
    }
    return (dispatch) => {
        return axios.get(url).then(res => {
            const list = res.data.data;
            dispatch(changeList(list));
        })
    }
}

src/components/Home/index.js

import React, { Component } from 'react';
import Header from '../Header';
import { connect } from 'react-redux';
import { getHomeList } from './store/actions';

class Home extends Component {

    getList() {
        const { list } = this.props;
        return this.props.list.map(item => <div key={item.id}>{item.title}</div>)
    }
    render() {
        return <div>
            <Header>
            <div>Home</div>
            {this.getList()}
            <button onClick={() => { alert('click1'); }>按钮</button>
        </div>
    }

    componentDidMount() {
        if (!this.props.list.length) {
            this.props.getHomeList();
        }
    }
}

Home.loadData = (store) => {
    // 执行action,扩充store。
    return store.dispatch(getHomeList(false));
}

const mapStatetoProps = state => ({
    list: state.home.newsList
});

const mapDispatchToProps = dispatch => ({
    getHomeList() {
        dispatch(getHomeList(true));
    }
})

export default connect(mapStatetoProps, mapDispatchToProps)(Home);

8. withExtraArgument

上面的代码通过传递布尔值来确定请求路径还是比较麻烦的,使用withExtraArgument整理一下。

src/components/Home/index.js

import React, { Component } from 'react';
import Header from '../Header';
import { connect } from 'react-redux';
import { getHomeList } from './store/actions';

class Home extends Component {

    getList() {
        const { list } = this.props;
        return this.props.list.map(item => <div key={item.id}>{item.title}</div>)
    }
    render() {
        return <div>
            <Header>
            <div>Home</div>
            {this.getList()}
            <button onClick={() => { alert('click1'); }>按钮</button>
        </div>
    }

    componentDidMount() {
        if (!this.props.list.length) {
            this.props.getHomeList();
        }
    }
}

Home.loadData = (store) => {
    // 执行action,扩充store。
    return store.dispatch(getHomeList());
}

const mapStatetoProps = state => ({
    list: state.home.newsList
});

const mapDispatchToProps = dispatch => ({
    getHomeList() {
        dispatch(getHomeList());
    }
})

export default connect(mapStatetoProps, mapDispatchToProps)(Home);

src/components/Home/store/actions.js

import { CHANGE_LIST } from './constants';

const changeList = (list) => {
    type: CHANGE_LIST,
    list
}

export const getHomeList = (server) => {
    return (dispatch, getState, axiosInstance) => {
        return axiosInstance.get(url).then(res => {
            const list = res.data.data;
            dispatch(changeList(list));
        })
    }
}

src/store/index.js

import { createStore, applyMiddleware, combineReducers } from 'redux';
import thunk from 'redux-thunk';
import { reducer as homeReducer} from '../components/Home/store';
import clientAxios from '../client/request';
import serverAxios from '../server/request';

const reducer = combineReducers({
    home: homeReducer
});

export const getStore = () => {
    return createStore(reducer, applyMiddleware(thunk.withExtraArgument(serverAxios)));
}

export const getClientStore = () => {
    const defaultState = window.context.state;
    // defaultState作为默认值
    return createStore(reducer, defaultState, applyMiddleware(thunk.withExtraArgument(clientAxios)));
}

src/client/request.js

import axios from 'axios';

const instance = axios.create({
    baseURL: '/'
})

src/server/request.js

import axios from 'axios';

const instance = axios.create({
    baseURL: 'xx.xx.xx.xx'
})

9. 渲染路由

src/App.js

import React from 'react';
import Header from './component/Header';
import { renderRoutes } from 'react-router-config';

const App = (props) => {
    return (<div>
        <Header />
        {renderRoutes(props.route.routes)}
    </div>)
}

export default App;

希望用户无论如何访问都显示App组件。

src/Routes.js

import React from 'react';
import App from './App';
import Home from './components/Home';
import Login from './components/Login';

export default [{
    path: '/',
    component: App,
    routes: [
        {
            path: '/',
            component: Home,
            exact: true,
            key: 'home',
            loadData: Home.loadData
        },
        {
            path: '/login',
            component: Login,
            key: 'login',
            exact: true
        }
    ]
}]

这里构建了一个二级路由,当用户访问跟目录的时候可以匹配到App组件,当访问/login路径的时候, 会匹配到App和Login两个组件。

src/server/utils.js

import React from 'react';
import { renderToString } from 'react-dom/server';
import { StaticRouter, Route } from 'react-router-dom';
import { renderRoutes } from 'react-router-config';
import { Provider } from 'react-redux';

export const render = (store, routes, req) => {
    const content = renderToString((
        <Provider store={store}>
            <StaticRouter location={req.path} context={{}}>
                <div>
                {renderRoutes(routes)}
                </div>
            </StaticRouter>
        </Provider>
    ));
    return `
        <html>
            <body>
                <div id="root">${content}</div>
                <script>
                    window.context = {
                        state: ${JSON.stringfiy(store.getState())}
                    }
                </script>
                <script src="/index.js"></script>
            </body>
        </html>
    `;
}

src/components/Home/index.js

import React, { Component } from 'react';
import { connect } from 'react-redux';
import { getHomeList } from './store/actions';

class Home extends Component {

    getList() {
        const { list } = this.props;
        return this.props.list.map(item => <div key={item.id}>{item.title}</div>)
    }
    render() {
        return <div>
            <div>Home</div>
            {this.getList()}
            <button onClick={() => { alert('click1'); }>按钮</button>
        </div>
    }

    componentDidMount() {
        if (!this.props.list.length) {
            this.props.getHomeList();
        }
    }
}

Home.loadData = (store) => {
    // 执行action,扩充store。
    return store.dispatch(getHomeList());
}

const mapStatetoProps = state => ({
    list: state.home.newsList
});

const mapDispatchToProps = dispatch => ({
    getHomeList() {
        dispatch(getHomeList());
    }
})

export default connect(mapStatetoProps, mapDispatchToProps)(Home);

src/components/Login/index.js

import React from 'react';

const Login = () => {
    return <div>Login</div>
}

export default Login;

src/client/index.js

import React from 'react';
import ReactDOM from 'react-dom';
import { BrowserRouter, Route } from 'react-router-dom';
import { renderRoutes } from 'react-router-config';
import routes from '../Routes';
import { getClientStore } from '../store'; // 使用store
import { Provider } from 'react-redux';

const store = getClientStore();
const App = () => {
    return (
        <Provider store={store}>
            <BrowserRouter>
                <div>
                    {renderRoutes(routes)}
                </div>
            </BrowserRouter>
        </Provider>
    )
}

ReactDOM.hydrate(<App />, document.getElementById('root'));

10. 请求失败处理

如果action中的请求失败了,会触发catch而不会触发then,这样会导致网站卡住,不会响应。因为server/index.js中的promise集合会失败,永远也不会返回成功。

Promise.all(promises).then(() => {
    res.send(render(store, routes, req)); 
})

所以可以在这里面加一个catch。

Promise.all(promises).then(() => {
    res.send(render(store, routes, req)); 
}).catch(() => {
    res.end('sorry');
})

这样页面可以展示出来,但是问题是我们并不知道哪里出了问题,或者说当有多个组件渲染时,我们希望接口正常的组件可以正常返回。

可以在loadData外层包裹一层新的Promise, 无论loadData成功还是失败,都调用resolve,这样就可以确保所有请求都完成。Promise.all就可以正常执行了。

src/server/index.js

import express from 'express';
import proxy from 'express-http-proxy';
import { matchRoute } from 'react-router-config';
import { render } from './utils';
import { getStore } from '../store'; // 使用store
import routes from '../Routes';

const app = express();
app.use(express.static('public'));

app.use('/api', proxy('xx.xx.xx.xx', {
    proxyReqPathResolver: (req) => { // 转发到哪个路径
        return req.url;
    }
}))

app.get('*', function(req, res) {
    const store = getStore();
    const matchedRoutes = matchRoute(routes, req,path);
    const promises = [];
    matchedRoutes.forEach(item => {
        if (item.route.loadData) {
            const promise = new Promise((resolve, reject) => {
                item.route.loadData(store).then(resolve).catch(resolve);
            })
            promises.push(promise);
        }
    });
    Promise.all(promises).then(() => {
        res.send(render(store, routes, req)); 
    })
})
var server = app.listen(3000);

11. 如何支持CSS样式修饰

首先需要webpack编译css文件。

webpack.server.js服务端要使用isomorphic-style-loader替代客户端的style-loader。

const Path = require('path');
const NodeExternals = require('webpack-node-externals'); // 服务端运行webpack需要运行NodeExternals, 他的作用是将express这类node模块不被打包到js里。

const merge = require('webpack-merge');
const config = require('./webpack.base.js');

const serverConfig = {
    target: 'node',
    mode: 'development',
    entry: './src/server/index.js',
    output: {
        filename: 'bundle.js',
        path: Path.resolve(__dirname, 'build')
    },
    externals: [NodeExternals()],
    module: {
        rules: [
            {
                test: /\.css?$/,
                use: ['isomorphic-style-loader', {
                    loader: 'css-loader',
                    options: {
                        importLoaders: 1,
                        modules: true,
                        localIdentName: '[name]_[local]_[hase:base64:5]'
                    }
                }]
            }
        ]
    }
}

module.exports = merge(config, serverConfig);

webpack.client.js客户端使用style-loader加载。

const Path = require('path');
const merge = require('webpack-merge');
const config = require('./webpack.base.js');

const clientConfig = {
    mode: 'development',
    entry: './src/client/index.js',
    output: {
        filename: 'index.js',
        path: Path.resolve(__dirname, 'public')
    },
    module: {
        rules: [
            {
                test: /\.css?$/,
                use: ['style-loader', {
                    loader: 'css-loader',
                    options: {
                        importLoaders: 1,
                        modules: true,
                        localIdentName: '[name]_[local]_[hase:base64:5]'
                    }
                }]
            }
        ]
    }
};

module.exports = merge(config, clientConfig);

src/components/Home/style.css

body {
    background: green;
}
.test {
    background: red;
}

src/components/Home/index.js

import React, { Component } from 'react';
import { connect } from 'react-redux';
import { getHomeList } from './store/actions';
import styles from './style.css';

class Home extends Component {
    componentWillMount() { // 处理样式
        if (this.props.staticContext) { // 服务端运行存在,客户端运行不存在。所以客户端不要执行。将样式存储在context中。
            this.props.staticContext.css = styles._getCss();
        }
    }

    getList() {
        const { list } = this.props;
        return this.props.list.map(item => <div key={item.id}>{item.title}</div>)
    }
    render() {
        return <div className={styles.test}>
            <div>Home</div>
            {this.getList()}
            <button onClick={() => { alert('click1'); }>按钮</button>
        </div>
    }

    componentDidMount() {
        if (!this.props.list.length) {
            this.props.getHomeList();
        }
    }
}

Home.loadData = (store) => {
    // 执行action,扩充store。
    return store.dispatch(getHomeList());
}

const mapStatetoProps = state => ({
    list: state.home.newsList
});

const mapDispatchToProps = dispatch => ({
    getHomeList() {
        dispatch(getHomeList());
    }
})

export default connect(mapStatetoProps, mapDispatchToProps)(Home);

src/server/index.js在render方法里面对样式进行处理。

import express from 'express';
import proxy from 'express-http-proxy';
import { matchRoute } from 'react-router-config';
import { render } from './utils';
import { getStore } from '../store'; // 使用store
import routes from '../Routes';

const app = express();
app.use(express.static('public'));

app.use('/api', proxy('xx.xx.xx.xx', {
    proxyReqPathResolver: (req) => { // 转发到哪个路径
        return req.url;
    }
}))

app.get('*', function(req, res) {
    const store = getStore();
    const matchedRoutes = matchRoute(routes, req,path);
    const promises = [];
    matchedRoutes.forEach(item => {
        if (item.route.loadData) {
            const promise = new Promise((resolve, reject) => {
                item.route.loadData(store).then(resolve).catch(resolve);
            })
            promises.push(promise);
        }
    });
    Promise.all(promises).then(() => {
        const html = render(store, routes, req, context)
        res.send(html); 
    })
})
var server = app.listen(3000);

src/server/utils.js

import React from 'react';
import { renderToString } from 'react-dom/server';
import { StaticRouter, Route } from 'react-router-dom';
import { renderRoutes } from 'react-router-config';
import { Provider } from 'react-redux';

export const render = (store, routes, req, context) => {
    const content = renderToString((
        <Provider store={store}>
            <StaticRouter location={req.path} context={{}}>
                <div>
                {renderRoutes(routes)}
                </div>
            </StaticRouter>
        </Provider>
    ));

    const cssStr = context.css ? context.css : '';
    return `
        <html>
            <head>
                <style>${cssStr}</style>
            </head>
            <body>
                <div id="root">${content}</div>
                <script>
                    window.context = {
                        state: ${JSON.stringfiy(store.getState())}
                    }
                </script>
                <script src="/index.js"></script>
            </body>
        </html>
    `;
}

多个组件的样式如何整合。可以使用一个数组来存储css样式。

src/server/utils.js

import React from 'react';
import { renderToString } from 'react-dom/server';
import { StaticRouter, Route } from 'react-router-dom';
import { renderRoutes } from 'react-router-config';
import { Provider } from 'react-redux';

export const render = (store, routes, req, context) => {
    const content = renderToString((
        <Provider store={store}>
            <StaticRouter location={req.path} context={{}}>
                <div>
                {renderRoutes(routes)}
                </div>
            </StaticRouter>
        </Provider>
    ));

    const cssStr = context.css.length ? context.css.join('\n') : '';
    return `
        <html>
            <head>
                <style>${cssStr}</style>
            </head>
            <body>
                <div id="root">${content}</div>
                <script>
                    window.context = {
                        state: ${JSON.stringfiy(store.getState())}
                    }
                </script>
                <script src="/index.js"></script>
            </body>
        </html>
    `;
}

src/components/Home/index.js

import React, { Component } from 'react';
import { connect } from 'react-redux';
import { getHomeList } from './store/actions';
import styles from './style.css';

class Home extends Component {
    componentWillMount() { // 处理样式
        if (this.props.staticContext) { // 服务端运行存在,客户端运行不存在。所以客户端不要执行。将样式存储在context中。
            this.props.staticContext.css.push(styles._getCss());
        }
    }

    getList() {
        const { list } = this.props;
        return this.props.list.map(item => <div key={item.id}>{item.title}</div>)
    }
    render() {
        return <div className={styles.test}>
            <div>Home</div>
            {this.getList()}
            <button onClick={() => { alert('click1'); }>按钮</button>
        </div>
    }

    componentDidMount() {
        if (!this.props.list.length) {
            this.props.getHomeList();
        }
    }
}

Home.loadData = (store) => {
    // 执行action,扩充store。
    return store.dispatch(getHomeList());
}

const mapStatetoProps = state => ({
    list: state.home.newsList
});

const mapDispatchToProps = dispatch => ({
    getHomeList() {
        dispatch(getHomeList());
    }
})

export default connect(mapStatetoProps, mapDispatchToProps)(Home);

src/server/index.js在render方法里面对样式进行处理。

import express from 'express';
import proxy from 'express-http-proxy';
import { matchRoute } from 'react-router-config';
import { render } from './utils';
import { getStore } from '../store'; // 使用store
import routes from '../Routes';

const app = express();
app.use(express.static('public'));

app.use('/api', proxy('xx.xx.xx.xx', {
    proxyReqPathResolver: (req) => { // 转发到哪个路径
        return req.url;
    }
}))

app.get('*', function(req, res) {
    const store = getStore();
    const matchedRoutes = matchRoute(routes, req,path);
    const promises = [];
    matchedRoutes.forEach(item => {
        if (item.route.loadData) {
            const promise = new Promise((resolve, reject) => {
                item.route.loadData(store).then(resolve).catch(resolve);
            })
            promises.push(promise);
        }
    });
    Promise.all(promises).then(() => {
        const context = { css: [] };
        const html = render(store, routes, req, context)
        res.send(html); 
    })
})
var server = app.listen(3000);

其实上面代码还有一个问题。Home组件上挂载了一个loadData的方法,但是Home文件导出的并不是Home组件,而是connect包装过后的组件,所以导出的是另一个组件。不过幸好connect会分析原组件有哪些属性,并且再挂载到当前输出的内容上,所以后面使用Home组件的时候仍旧可以调用loadData方法。不过这样并不太好,最好还是直接声明一下,避免代码使用混乱。

将loadData挂载到ExportHome上。

src/components/Home/index.js

...

// Home.loadData = (store) => {
//     // 执行action,扩充store。
//     return store.dispatch(getHomeList());
// }

const mapStatetoProps = state => ({
    list: state.home.newsList
});

const mapDispatchToProps = dispatch => ({
    getHomeList() {
        dispatch(getHomeList());
    }
})

const ExportHome = connect(mapStatetoProps, mapDispatchToProps)(Home);

ExportHome.loadData = (store) => {
    // 执行action,扩充store。
    return store.dispatch(getHomeList());
}

export default ExportHome

12. 使用高阶组件精简代码

上面的样式编写太麻烦了,首先需要使用componentWillMount生命周期,让后将它的样式注入到context之中。所以每一个组件都需要这样一段代码。这样的设计时并不合理的。可以整理一下。使用高阶组件。

src/withStyle.js创建这个高阶组件函数。这个函数返回一个组件。其实这个函数是生成高阶组件的函数,而返回的组件叫做高阶组件,他的工作是渲染前push样式。

这个函数要接收样式文件styles,因为组件并不知道styles在哪。还要接收原本要渲染的组件DecoratedComponent,在高阶组件中渲染出来,并且将参数传递进去。

import React, { Component } from 'react';

export default (DecoratedComponent, styles) => {
    return class NewComponent extends Component {
        componentWillMount() {
            if (this.props.staticContext) {
                this.props.staticContext.css.push(styles._getCss());
            }
        }
        render() {
            return <DecoratedComponent {...this.props}/>
        }
    }
}

这样高阶组件就写完了,接着改造一下Home组件。

src/components/Home/index.js,这里可以删掉自身的componentWillMount了,引入withStyle函数,然后再底部导出的时候使用withStyle包裹住Home组件,再传入styles样式就可以了。withStyle(Home, styles);

import React, { Component } from 'react';
import { connect } from 'react-redux';
import { getHomeList } from './store/actions';
import styles from './style.css';
import withStyle from '../../withStyle';

class Home extends Component {
    getList() {
        const { list } = this.props;
        return this.props.list.map(item => <div key={item.id}>{item.title}</div>)
    }
    render() {
        return <div className={styles.test}>
            <div>Home</div>
            {this.getList()}
            <button onClick={() => { alert('click1'); }>按钮</button>
        </div>
    }

    componentDidMount() {
        if (!this.props.list.length) {
            this.props.getHomeList();
        }
    }
}

const mapStatetoProps = state => ({
    list: state.home.newsList
});

const mapDispatchToProps = dispatch => ({
    getHomeList() {
        dispatch(getHomeList());
    }
})

const ExportHome = connect(mapStatetoProps, mapDispatchToProps)(withStyle(Home, styles));

ExportHome.loadData = (store) => {
    // 执行action,扩充store。
    return store.dispatch(getHomeList());
}

export default ExportHome

13. 加入SEO优化

SEO优化也叫搜索引擎优化。

title和description对搜索引擎优化基本没什么帮助,他们只是网站的描述。百度的搜索会根据网站所有文本的内容进行匹配,给网站进行分类。所以很多时候搜索出来的网站和需要的内容一致,但是搜索出来的网站titile中并不包含搜索的关键词。

一个网站是由文字,多媒体,链接三部分组成。

在当今的互联网,内容需要原创,原创作品会得到更多的流量,SEO会分析内容的原创性。所以文字可以增加原创属性。

链接到的网站内容和当前网站的内容要相关,相关性越强SEO权重越高。

多媒体也需要原创。

14. React-Helmet组件

React-Helmet可以定制页面的title和meta

import React, { Component, Fragment } from 'react';
import { Helmet } from 'react-helmet';

class Home extends Component {
    render() {
        return <Fragment>
            <Helmet>
                <title>这是Helmet定义的title</title>
                <meta name="description" content="这是Helmet定义的description" />
            </Helmet>
            <div>Home</div>
            {this.getList()}
            <button onClick={() => { alert('click1'); }>按钮</button>
        </Fragment>
    }
}

上面的代码只是客户端的渲染,服务器短的渲染有一点不一样,不过也很简单,修改一下utils.js

src/server/utils.js

...

import { Helmet } from 'react-helmet';

export const render = (store, routes, req, context) => {
    ...

    const helmet = Helmet.renderStatic();
    return `
        <html>
            <head>
                ${helmet.title.toString()}
                ${helmet.meta.toString()}
                <style>${cssStr}</style>
            </head>
            <body>
                <div id="root">${content}</div>
                <script>
                    window.context = {
                        state: ${JSON.stringfiy(store.getState())}
                    }
                </script>
                <script src="/index.js"></script>
            </body>
        </html>
    `;
}

至此服务端渲染的原理就分析完了,这里不建议你将上面的代码直接用于生产环境,这里只是分析原理,如果项目需要更推荐你选用成熟的服务端渲染框架,毕竟那个学习和使用成本更低。

15. 最后不建议服务端渲染

服务端渲染成本较高,非必须情况下不建议服务端渲染,如果仅仅为了SEO优化,可以换一个思路。搭建一台预渲染服务器。

可以在网站外层架设一层nginx,如果访问是个蜘蛛就将请求转发给预渲染服务器,如果是用户就将请求转发给真实的服务器。

prerender模块提供这样的功能,当访问他的时候,他会运行一个微型浏览器,将网页内容加载之后响应给请求,这样请求就拿到了页面的结构。

const prerender = require('prerender');
const server = prerender({
    port: 8000
});

server.start();

这样访问到的url内容中就存在了页面元素。

localhost:8000/render?url=http://localhost:3000/

转载须知

如转载必须标明文章出处文章名称文章作者,格式如下:

转自:【致前端 - zhiqianduan.com】 服务端渲染原理  "隐冬"
请输入评论...