[译]利用React Router4实现的服务端直出渲染(SSR)

时间  2019-11-08
标签 利用 react router4 router 实现 服务 渲染 ssr 栏目 React 繁體版
原文   原文链接

原文javascript

咱们已经熟悉React 服务端渲染（SSR）的基本步骤，如今让咱们更进一步利用 React RouterV4 实现客户端和服务端的同构。毕竟大多数的应用都须要用到web前端路由器，因此要让SSR可以正常的运行，了解路由器的设置是十分有必要的html

基本步骤

路由器配置

前言已经简单的介绍了React SSR，首先咱们须要添加ReactRouter4到咱们的项目中前端

$ yarn add react-router-dom

# or, using npm
$ npm install react-router-dom

接着咱们会描述一个简单的场景，其中组件是静态的且不须要去获取外部数据。咱们会在这个基础之上去了解如何完成取到数据的服务端渲染。java

在客户端，咱们只需像之前同样将咱们的的App组件经过ReactRouter的BrowserRouter来包起来。react

src/index.jsweb

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

import App from './App';

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

在服务端咱们将采起相似的方式，可是改成使用无状态的 StaticRouterexpress

server/index.jsnpm

app.get('/*', (req, res) => {
  const context = {};
  const app = ReactDOMServer.renderToString(
    <StaticRouter location={req.url} context={context}>
      <App />
    </StaticRouter>
  );

  const indexFile = path.resolve('./build/index.html');
  fs.readFile(indexFile, 'utf8', (err, data) => {
    if (err) {
      console.error('Something went wrong:', err);
      return res.status(500).send('Oops, better luck next time!');
    }

    return res.send(
      data.replace('<div id="root"></div>', `<div id="root">${app}</div>`)
    );
  });
});

app.listen(PORT, () => {
  console.log(`😎 Server is listening on port ${PORT}`);
});

StaticRouter组件须要 location和context属性。咱们传递当前的url（Express req.url）给location，设置一个空对象给context。context对象用于存储特定的路由信息，这个信息将会以staticContext的形式传递给组件json

运行一下程序看看结果是否咱们所预期的，咱们给App组件添加一些路由信息redux

src/App.js

import React from 'react';
import { Route, Switch, NavLink } from 'react-router-dom';
import Home from './Home';
import Posts from './Posts';
import Todos from './Todos';
import NotFound from './NotFound';

export default props => {
  return (
    <div>
      <ul>
        <li>
          <NavLink to="/">Home</NavLink>
        </li>
        <li>
          <NavLink to="/todos">Todos</NavLink>
        </li>
        <li>
          <NavLink to="/posts">Posts</NavLink>
        </li>
      </ul>

      <Switch>
        <Route
          exact
          path="/"
          render={props => <Home name="Alligator.io" {...props} />}
        />
        <Route path="/todos" component={Todos} />
        <Route path="/posts" component={Posts} />
        <Route component={NotFound} />
      </Switch>
    </div>
  );
};

如今若是你运行一下程序($ yarn run dev)，咱们的路由在服务端被渲染，这是咱们所预期的。

利用404状态来处理未找到资源的网络请求

咱们作一些改进，当渲染NotFound组件时让服务端使用404HTTP状态码来响应。首先咱们将一些信息放到NotFound组件的staticContext

import React from 'react';

export default ({ staticContext = {} }) => {
  staticContext.status = 404;
  return <h1>Oops, nothing here!</h1>;
};

而后在服务端，咱们能够检查context对象的status属性是不是404，若是是404，则以404状态响应服务端请求。

server/index.js

// ...

app.get('/*', (req, res) => {
  const context = {};
  const app = ReactDOMServer.renderToString(
    <StaticRouter location={req.url} context={context}>
      <App />
    </StaticRouter>
  );

  const indexFile = path.resolve('./build/index.html');
  fs.readFile(indexFile, 'utf8', (err, data) => {
    if (err) {
      console.error('Something went wrong:', err);
      return res.status(500).send('Oops, better luck next time!');
    }

    if (context.status === 404) {
      res.status(404);
    }

    return res.send(
      data.replace('<div id="root"></div>', `<div id="root">${app}</div>`)
    );
  });
});

// ...

重定向

补充一下，咱们能够作一些相似重定向的工做。若是咱们有使用Redirect组件，ReactRouter会自动添加剧定向的url到context对象的属性上。

server/index.js (部分)

if (context.url) {
  return res.redirect(301, context.url);
}

读取数据

有时候咱们的服务端渲染应用须要数据呈现，咱们须要用一种静态的方式来定义咱们的路由而不是只涉及到客户端的动态的方式。失去定义动态路由的定义是服务端渲染最适合所须要的应用的缘由（译者注：这句话的意思应该是SSR不容许路由是动态定义的）。

咱们将使用fetch在客户端和服务端，咱们增长isomorphic-fetch到咱们的项目。同时咱们也增长serialize-javascript这个包，它能够方便的序列化服务器上获取到的数据。

$ yarn add isomorphic-fetch serialize-javascript

# or, using npm:
$ npm install isomorphic-fetch serialize-javascript

咱们定义咱们的路由信息为一个静态数组在routes.js文件里

src/routes.js

import App from './App';
import Home from './Home';
import Posts from './Posts';
import Todos from './Todos';
import NotFound from './NotFound';

import loadData from './helpers/loadData';

const Routes = [
  {
    path: '/',
    exact: true,
    component: Home
  },
  {
    path: '/posts',
    component: Posts,
    loadData: () => loadData('posts')
  },
  {
    path: '/todos',
    component: Todos,
    loadData: () => loadData('todos')
  },
  {
    component: NotFound
  }
];

export default Routes;

有一些路由配置如今有一个叫loadData的键，它是一个调用loadData函数的函数。这个是咱们的loadData函数的实现

helpers/loadData.js

import 'isomorphic-fetch';

export default resourceType => {
  return fetch(`https://jsonplaceholder.typicode.com/${resourceType}`)
    .then(res => {
      return res.json();
    })
    .then(data => {
      // only keep 10 first results
      return data.filter((_, idx) => idx < 10);
    });
};

咱们简单的使用fetch来从REST API 获取数据

在服务端咱们将使用ReactRouter的matchPath去寻找当前url所匹配的路由配置并判断它有没有loadData属性。若是是这样，咱们调用loadData去获取数据并把数据放到全局window对象中在服务器的响应中

server/index.js

import React from 'react';
import express from 'express';
import ReactDOMServer from 'react-dom/server';
import path from 'path';
import fs from 'fs';
import serialize from 'serialize-javascript';
import { StaticRouter, matchPath } from 'react-router-dom';
import Routes from '../src/routes';

import App from '../src/App';

const PORT = process.env.PORT || 3006;
const app = express();

app.use(express.static('./build'));

app.get('/*', (req, res) => {
  const currentRoute =
    Routes.find(route => matchPath(req.url, route)) || {};
  let promise;

  if (currentRoute.loadData) {
    promise = currentRoute.loadData();
  } else {
    promise = Promise.resolve(null);
  }

  promise.then(data => {
    // Lets add the data to the context
    const context = { data };

    const app = ReactDOMServer.renderToString(
      <StaticRouter location={req.url} context={context}>
        <App />
      </StaticRouter>
    );

    const indexFile = path.resolve('./build/index.html');
    fs.readFile(indexFile, 'utf8', (err, indexData) => {
      if (err) {
        console.error('Something went wrong:', err);
        return res.status(500).send('Oops, better luck next time!');
      }

      if (context.status === 404) {
        res.status(404);
      }
      if (context.url) {
        return res.redirect(301, context.url);
      }

      return res.send(
        indexData
          .replace('<div id="root"></div>', `<div id="root">${app}</div>`)
          .replace(
            '</body>',
            `<script>window.__ROUTE_DATA__ = ${serialize(data)}</script></body>`
          )
      );
    });
  });
});

app.listen(PORT, () => {
  console.log(`😎 Server is listening on port ${PORT}`);
});

请注意，咱们添加组件的数据到context对象。在服务端渲染中咱们将经过staticContext来访问它。

如今咱们能够在须要加载时获取数据的组件的构造函数和componentDidMount方法里添加一些判断

src/Todos.js

import React from 'react';
import loadData from './helpers/loadData';

class Todos extends React.Component {
  constructor(props) {
    super(props);

    if (props.staticContext && props.staticContext.data) {
      this.state = {
        data: props.staticContext.data
      };
    } else {
      this.state = {
        data: []
      };
    }
  }

  componentDidMount() {
    setTimeout(() => {
      if (window.__ROUTE_DATA__) {
        this.setState({
          data: window.__ROUTE_DATA__
        });
        delete window.__ROUTE_DATA__;
      } else {
        loadData('todos').then(data => {
          this.setState({
            data
          });
        });
      }
    }, 0);
  }

  render() {
    const { data } = this.state;
    return <ul>{data.map(todo => <li key={todo.id}>{todo.title}</li>)}</ul>;
  }
}

export default Todos;

工具类

ReactRouterConfig是由ReactRouter团队提供和维护的包。它提供了两个处理ReactRouter和SSR更便捷的工具matchRoutes和renderRoutes。

matchRoutes

前面的例子都很是简单都，都没有嵌套路由。有时在多路由的状况下，使用matchPath是行不通的，由于它只能匹配一条路由。matchRoutes是一个能帮助咱们匹配多路由的工具。

这意味着在匹配路由的过程当中咱们能够往一个数组里存放promise，而后调用promise.all去解决全部匹配到的路由的取数逻辑。

import { matchRoutes } from 'react-router-config';

// ...

const matchingRoutes = matchRoutes(Routes, req.url);

let promises = [];

matchingRoutes.forEach(route => {
  if (route.loadData) {
    promises.push(route.loadData());
  }
});

Promise.all(promises).then(dataArr => {
  // render our app, do something with dataArr, send response
});

// ...

renderRoutes

renderRoutes接收咱们的静态路由配置对象并返回所需的Route组件。为了matchRoutes能适当的工做renderRoutes应该被使用。

经过使用renderRoutes，咱们的程序改为了一个更简洁的形式。

src/App.js

import React from 'react';
import { renderRoutes } from 'react-router-config';
import { Switch, NavLink } from 'react-router-dom';

import Routes from './routes';

import Home from './Home';
import Posts from './Posts';
import Todos from './Todos';
import NotFound from './NotFound';

export default props => {
  return (
    <div>
      {/* ... */}

      <Switch>
        {renderRoutes(Routes)}
      </Switch>
    </div>
  );
};

译者注

  • SSR服务端React组件的生命周期不会运行到componentDidMount,componentDidMount只有在客户端才会运行。
  • React16再也不推荐使用componentWillMount方法，应使用constructor来代替。
  • staticContext的实现应该跟redux的高阶组件connect相似，也是经过包装一层react控件来实现子组件的属性传递。
  • 文章只是对SSR作了一个入门的介绍，如Loadable和样式的处理在文章中没有介绍，但这两点对于SSR来讲很重要，之后找机会写一篇相关的博文
相关文章
相关标签/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公众号
   欢迎关注本站公众号,获取更多信息
联系我们 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程