构建基于 RESTful API 的微服务（下）-FunTeaLearn Online Web Tutorials

在上一篇文章中，我们介绍了如何构建基于 RESTful API 的微服务的概念和基本步骤。在本文中，我们将继续深入探讨如何实现这些步骤，包括如何设计 API，如何处理数据，如何处理错误，以及如何测试和部署微服务。

设计 API

在设计 API 时，我们需要考虑以下几个方面：

1. 路由和端点

首先，我们需要确定我们的 API 路由和端点。路由是指 URL 的路径，端点是指 HTTP 方法（GET、POST、PUT、DELETE 等）和相关处理程序。例如，我们的用户服务可能有以下端点：

GET /users：获取所有用户
GET /users/:id：获取单个用户
POST /users：创建新用户
PUT /users/:id：更新用户
DELETE /users/:id：删除用户

2. 数据模型

其次，我们需要确定我们的数据模型。数据模型是指我们将在 API 中使用的数据结构。在我们的用户服务中，我们可能有以下数据模型：

{
  "id": "1",
  "name": "John Doe",
  "email": "john.doe@example.com",
  "password": "123456",
  "createdAt": "2021-01-01T00:00:00Z",
  "updatedAt": "2021-01-01T00:00:00Z"
}

3. 请求和响应格式

最后，我们需要确定我们的请求和响应格式。请求格式是指客户端发送请求时应遵循的格式，响应格式是指服务器返回响应时应遵循的格式。在我们的用户服务中，我们可能有以下请求和响应格式：

请求格式：

{
  "name": "John Doe",
  "email": "john.doe@example.com",
  "password": "123456"
}

响应格式：

{
  "id": "1",
  "name": "John Doe",
  "email": "john.doe@example.com",
  "createdAt": "2021-01-01T00:00:00Z",
  "updatedAt": "2021-01-01T00:00:00Z"
}

处理数据

在处理数据时，我们需要考虑以下几个方面：

1. 数据库

首先，我们需要选择适合我们的微服务的数据库。常见的选择包括关系型数据库（如 MySQL、PostgreSQL）和 NoSQL 数据库（如 MongoDB、Redis）。我们需要根据我们的数据模型和需求来选择最合适的数据库。

2. 数据访问层

其次，我们需要创建数据访问层来处理数据库操作。数据访问层是指我们的代码与数据库交互的层。我们可以使用 ORM（对象关系映射）工具来简化这个过程。例如，我们可以使用 Sequelize 来操作 MySQL 或 PostgreSQL，使用 Mongoose 来操作 MongoDB。

3. 数据验证

最后，我们需要验证客户端提交的数据。我们可以使用 Joi 或 Yup 等验证库来验证数据格式和内容。例如，我们可以使用 Joi 来验证用户提交的数据是否符合我们的数据模型。

处理错误

在处理错误时，我们需要考虑以下几个方面：

1. 错误处理中间件

首先，我们需要编写错误处理中间件来处理服务器端错误。错误处理中间件是指在发送错误响应时应用的中间件。我们可以使用 Express 的内置错误处理中间件或编写自己的错误处理中间件来处理错误。

2. 错误码

其次，我们需要定义错误码来标识不同类型的错误。错误码是指我们在发送错误响应时使用的数字代码。例如，我们可以使用 HTTP 状态码来表示不同类型的错误。

3. 日志记录

最后，我们需要记录错误日志来帮助我们诊断和解决错误。我们可以使用 Winston 或 Bunyan 等日志库来记录错误日志。

测试和部署

在测试和部署时，我们需要考虑以下几个方面：

1. 单元测试

首先，我们需要编写单元测试来测试我们的代码。单元测试是指测试我们的代码的单个组件或函数的测试。我们可以使用 Mocha 或 Jest 等测试框架来编写单元测试。

2. 集成测试

其次，我们需要编写集成测试来测试我们的微服务。集成测试是指测试我们的微服务与其依赖项（如数据库）之间的交互的测试。我们可以使用 Supertest 或 Chai-http 等测试库来编写集成测试。

3. 部署

最后，我们需要部署我们的微服务。我们可以使用 Docker 或 Kubernetes 等容器化技术来部署我们的微服务。我们还可以使用 Heroku 或 AWS Lambda 等云平台来部署我们的微服务。

示例代码

以下是一个使用 Express 和 MongoDB 构建用户服务的示例代码：

// www.javascriptcn.com code example
const express = require('express');
const Joi = require('joi');
const mongoose = require('mongoose');

const app = express();

// 数据模型
const userSchema = new mongoose.Schema({
  name: {
    type: String,
    required: true,
    minlength: 3,
    maxlength: 50
  },
  email: {
    type: String,
    required: true,
    minlength: 5,
    maxlength: 255,
    unique: true
  },
  password: {
    type: String,
    required: true,
    minlength: 6,
    maxlength: 1024
  }
});

const User = mongoose.model('User', userSchema);

// 中间件
app.use(express.json());

// 路由和端点
app.get('/api/users', async (req, res) => {
  const users = await User.find().select('-__v');
  res.send(users);
});

app.get('/api/users/:id', async (req, res) => {
  const user = await User.findById(req.params.id).select('-__v');
  if (!user) return res.status(404).send('User not found.');
  res.send(user);
});

app.post('/api/users', async (req, res) => {
  const schema = Joi.object({
    name: Joi.string().min(3).max(50).required(),
    email: Joi.string().min(5).max(255).required().email(),
    password: Joi.string().min(6).max(1024).required()
  });

  const { error } = schema.validate(req.body);
  if (error) return res.status(400).send(error.details[0].message);

  let user = await User.findOne({ email: req.body.email });
  if (user) return res.status(400).send('User already registered.');

  user = new User({
    name: req.body.name,
    email: req.body.email,
    password: req.body.password
  });

  await user.save();

  res.send({
    id: user._id,
    name: user.name,
    email: user.email
  });
});

app.put('/api/users/:id', async (req, res) => {
  const schema = Joi.object({
    name: Joi.string().min(3).max(50),
    email: Joi.string().min(5).max(255).email(),
    password: Joi.string().min(6).max(1024)
  });

  const { error } = schema.validate(req.body);
  if (error) return res.status(400).send(error.details[0].message);

  const user = await User.findByIdAndUpdate(req.params.id, {
    name: req.body.name,
    email: req.body.email,
    password: req.body.password
  }, { new: true });

  if (!user) return res.status(404).send('User not found.');

  res.send({
    id: user._id,
    name: user.name,
    email: user.email
  });
});

app.delete('/api/users/:id', async (req, res) => {
  const user = await User.findByIdAndRemove(req.params.id);
  if (!user) return res.status(404).send('User not found.');
  res.send({
    id: user._id,
    name: user.name,
    email: user.email
  });
});

// 错误处理中间件
app.use((err, req, res, next) => {
  res.status(500).send('Something went wrong.');
});

// 连接到 MongoDB
mongoose.connect('mongodb://localhost/users', { useNewUrlParser: true, useUnifiedTopology: true })
  .then(() => console.log('Connected to MongoDB...'))
  .catch(err => console.error('Could not connect to MongoDB...', err));

// 启动服务器
const port = process.env.PORT || 3000;
app.listen(port, () => console.log(`Listening on port ${port}...`));

以上代码演示了如何使用 Express 和 MongoDB 构建用户服务。我们定义了数据模型、路由和端点、中间件和错误处理中间件，并连接到了 MongoDB 数据库。我们还编写了单元测试和集成测试，并使用 Docker 部署了我们的微服务。

Source: FunTeaLearn,Please indicate the source for reprints https://funteas.com/post/67da3ccda941bf7134211373

构建基于 RESTful API 的微服务（下）