使用 Koa 实现用户注册与数据验证

使用 Koa 实现用户注册与数据验证

在本篇博客中，我们将学习如何在 Koa 中实现用户注册功能，并使用 Joi 进行数据验证。我们将从最基本的注册接口开始，逐步添加数据校验、唯一性验证和数据库存储等功能。

实现最基本的注册功能

编写 userController

首先，我们创建一个简单的注册控制器：

module.exports.register = async (ctx, next) => {
  ctx.body = 'register';
}

添加路由

接着，我们在主路由文件中添加注册路由：

const Router = require('koa-router');
const userController = require('./controllers/userController');
const router = new Router();

router.post('/user/register', userController.register);

module.exports = router;

增加注册基本校验

使用 Joi 添加验证

Joi 是一个强大的数据验证库。我们可以使用它来验证用户提交的数据。首先，安装 Joi：

npm install joi

新建 middleware/userValidate.js

创建一个中间件文件，用于注册数据验证：

const Joi = require('joi');

module.exports.registerValidate = (ctx, next) => {
  const schema = Joi.object({
    username: Joi.string().required(),
    password: Joi.string().min(6).required(),
    email: Joi.string().email().required(),
    phone: Joi.string().required()
  }).validate(ctx.request.body);

  if (schema.error) {
    ctx.throw(400, schema.error.details[0].message);
  } else {
    return next();
  }
}

路由中添加校验

在路由中添加验证中间件：

const { registerValidate } = require('./middleware/userValidate');

router.post('/user/register', registerValidate, userController.register);

完善注册业务逻辑

完善邮箱的唯一验证

更新验证中间件，增加邮箱唯一性的检查：

const Joi = require('joi');
const User = require('../models/User');

module.exports.registerValidate = async (ctx, next) => {
  const schema = Joi.object({
    username: Joi.string().required(),
    password: Joi.string().min(6).required(),
    email: Joi.string().email().required(),
    phone: Joi.string().required()
  }).validate(ctx.request.body);

  if (schema.error) {
    ctx.throw(400, schema.error.details[0].message);
  }

  const emailExists = await User.findOne({ email: ctx.request.body.email });
  if (emailExists) {
    ctx.throw(400, '邮箱已经被注册');
  }

  await next();
}

用户数据入库

更新 userController 中的注册方法，保存用户数据到数据库，并返回不包含密码的用户信息：

const User = require('../models/User');

module.exports.register = async ctx => {
  const userModel = new User(ctx.request.body);
  const dbBack = await userModel.save();
  const userResponse = dbBack.toObject();
  delete userResponse.password;
  ctx.body = userResponse;
}

总结

通过以上步骤，我们实现了一个基本的用户注册功能，包括数据验证和邮箱唯一性检查，并将用户数据保存到数据库中。使用 Koa 和 Joi，我们能够快速构建出安全且功能完善的用户注册系统。