HOW - BFF 服务实践系列（一）- 基于 NodeJS 实现

一、为什么选择 NodeJS

1. NodeJS 纯异步具有非阻塞的 I/O
2. NodeJS 数据拼装更方便
3. NodeJS 基于 JavaScript，作为前端开发者学习成本低

二、NodeJS 框架

1. express
2. koa
3. fastify
4. eggjs
5. nestjs
6. …

三、基本流程：基于 express

基于 Node.js 实现一个 BFF 服务，以下是一个详细的指南，帮助前端开发者使用 Node.js 创建一个功能完备的 BFF 服务。

1. 设置项目环境

首先，确保你已经安装了 Node.js 和 npm（Node Package Manager）。然后，创建一个新的项目目录并初始化一个新的 Node.js 项目：

mkdir my-bff-service
cd my-bff-service
npm init -y

2. 安装必要的依赖

安装常用的 Express 框架以及其他一些常用的中间件：

npm install express axios body-parser cors

3. 创建服务器入口文件

在项目根目录下创建一个 server.js 文件，并设置基本的 Express 服务器：

// src/server.js
const express = require('express');
const bodyParser = require('body-parser');
const cors = require('cors');

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

// 中间件
app.use(bodyParser.json());
app.use(cors());

// 示例路由
app.get('/', (req, res) => {
  res.send('BFF Service is running');
});

app.listen(PORT, () => {
  console.log(`BFF service is running on port ${PORT}`);
});

4. 配置环境变量

使用 dotenv 包来管理环境变量：

npm install dotenv

在项目根目录下创建一个 .env 文件，并添加必要的环境变量：

PORT=3000
API_URL_1=https://api.example1.com
API_URL_2=https://api.example2.com

在 server.js 文件中加载环境变量：

// src/server.js
require('dotenv').config();

5. 创建数据聚合和代理逻辑

使用 axios 来处理与后端服务的通信。在项目目录下创建一个 routes 目录，并在其中创建一个 api.js 文件来处理路由和数据聚合逻辑：

// src/routes/api.js
const express = require('express');
const axios = require('axios');
const router = express.Router();

const API_URL_1 = process.env.API_URL_1;
const API_URL_2 = process.env.API_URL_2;

router.get('/dashboard', async (req, res) => {
  try {
    const [ordersResponse, recommendationsResponse] = await Promise.all([
      axios.get(`${API_URL_1}/orders`, { headers: { Authorization: req.headers.authorization } }),
      axios.get(`${API_URL_2}/recommendations`, { headers: { Authorization: req.headers.authorization } })
    ]);

    const aggregatedData = {
      orders: ordersResponse.data,
      recommendations: recommendationsResponse.data
    };

    res.json(aggregatedData);
  } catch (error) {
    console.error(error);
    res.status(500).json({ error: 'Failed to fetch data' });
  }
});

module.exports = router;

在 server.js 中引入并使用这个路由：

// src/server.js
const apiRoutes = require('./routes/api');
app.use('/api', apiRoutes);

6. 添加错误处理和日志记录

添加一个简单的错误处理中间件和日志记录：

app.use((err, req, res, next) => {
  console.error(err.stack);
  res.status(500).send('Something broke!');
});

// 日志记录
app.use((req, res, next) => {
  console.log(`${req.method} ${req.url}`);
  next();
});

7. 测试和部署

通过以下命令启动 BFF 服务：

node server.js

访问 http://localhost:3000/api/dashboard 以测试数据聚合和代理功能。

8. 示例目录结构

my-bff-service/
├── node_modules/
├── routes/
│   └── api.js
├── .env
├── package.json
├── server.js

9. 进一步的改进

1. 缓存：使用如 redis 这样的缓存机制提高响应速度。
2. 安全性：实现更加健壮的认证和授权机制。
3. 测试：使用如 mocha、chai 这样的测试框架编写单元测试和集成测试。
4. 性能优化：使用如 pm2 这样的进程管理工具和负载均衡策略。

通过上述步骤，你可以创建一个基本的 BFF 服务，并根据具体需求进行进一步的扩展和优化。