使用 Egg React SSR 构建服务端渲染应用的最佳实践

2025-05-06 10:21:25作者：幸俭卉

1. 项目介绍

Egg React SSR 是一个基于 Egg.js 框架和 React 的服务端渲染解决方案。它提供了丰富的中间件支持和插件机制，使得开发者可以快速搭建高性能、可扩展的服务端渲染应用。

2. 项目快速启动

首先，确保你的开发环境中已经安装了 Node.js 和 npm。以下是快速启动 Egg React SSR 的步骤：

# 克隆项目
git clone https://github.com/zhangyuang/egg-react-ssr.git

# 进入项目目录
cd egg-react-ssr

# 安装依赖
npm install

# 启动开发服务器
npm run dev

启动后，你可以在浏览器中访问 http://localhost:7001 来查看应用。

3. 应用案例和最佳实践

3.1 目录结构

以下是 Egg React SSR 的推荐目录结构：

egg-react-ssr/
├── app/
│   ├── controller/
│   ├── middleware/
│   ├── model/
│   ├── public/
│   ├── router.js
│   └── view/
├── config/
│   ├── config.default.js
│   └── plugin.js
└── package.json

app/controller: 存放控制器方法。
app/middleware: 存放中间件。
app/model: 存放数据模型。
app/public: 存放静态文件。
app/router.js: 定义路由规则。
app/view: 存放模板文件。

3.2 路由配置

在 app/router.js 中定义路由规则，例如：

module.exports = app => {
  const { router, controller } = app;
  router.get('/', controller.home.index);
};

3.3 控制器实现

在 app/controller/home.js 中实现控制器方法，例如：

const Controller = require('egg').Controller;

class HomeController extends Controller {
  async index() {
    const { ctx } = this;
    ctx.body = await ctx.render('index');
  }
}

module.exports = HomeController;

3.4 视图模板

在 app/view/index.tpl 中编写 React 组件，例如：

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

class App extends React.Component {
  render() {
    return <h1>Hello, world!</h1>;
  }
}

ReactDOM.render(<App />, document.getElementById('app'));

在 app/public/index.html 中添加挂载点：

<!DOCTYPE html>
<html>
<head>
  <title>Egg React SSR</title>
</head>
<body>
  <div id="app"></div>
  <!-- 引入 React 和 ReactDOM -->
  <script src="https://unpkg.com/react@16/umd/react.production.min.js"></script>
  <script src="https://unpkg.com/react-dom@16/umd/react-dom.production.min.js"></script>
</body>
</html>