使用 Koa2 和 Redis 实现验证码功能-JavaScript中文网-JavaScript教程资源分享门户

验证码是一种常见的用户验证方式，它可以有效地防止恶意攻击和机器人恶意行为。本文将介绍如何使用 Koa2 和 Redis 实现验证码功能。

Koa2 简介

Koa2 是一个轻量级的 Node.js Web 框架，它具有中间件架构和异步流程控制的优点。Koa2 的应用和中间件使用 async/await 实现，使得代码更加简洁易懂。

Redis 简介

Redis 是一个开源的内存数据结构存储系统，它可以作为数据库、缓存和消息队列使用。Redis 具有高性能、高可用性和数据持久化等优点，被广泛应用于互联网服务中。

实现过程

1. 安装依赖

首先安装必要的依赖：

npm install koa koa-router koa-bodyparser redis --save

2. 初始化 Redis 客户端

在应用启动时初始化 Redis 客户端：

const redis = require('redis');
const client = redis.createClient();

client.on('error', err => {
  console.error('Redis error: ', err);
});

3. 生成验证码

使用 svg-captcha 生成验证码图片和验证码字符串，并将验证码字符串存储在 Redis 中：

// www.javascriptcn.com code example
const svgCaptcha = require('svg-captcha');

router.get('/captcha', async (ctx, next) => {
  const captcha = svgCaptcha.create();
  const key = `captcha:${ctx.ip}`;
  const value = captcha.text;
  const ttl = 300; // 验证码有效期为 5 分钟
  client.setex(key, ttl, value); // 将验证码字符串存储在 Redis 中
  ctx.type = 'svg';
  ctx.body = captcha.data;
});

4. 验证验证码

在用户提交验证码时，从 Redis 中获取存储的验证码字符串，与用户输入的验证码进行比较：

// www.javascriptcn.com code example
router.post('/login', async (ctx, next) => {
  const { username, password, captcha } = ctx.request.body;
  const key = `captcha:${ctx.ip}`;
  const value = await new Promise((resolve, reject) => {
    client.get(key, (err, value) => {
      if (err) reject(err);
      else resolve(value);
    });
  });
  if (value && value.toLowerCase() === captcha.toLowerCase()) {
    // 验证码正确，执行登录逻辑
  } else {
    // 验证码错误，提示用户重新输入
  }
});

5. 清除验证码

在用户登录成功后，清除 Redis 中存储的验证码字符串：

const key = `captcha:${ctx.ip}`;
client.del(key);

示例代码

完整的示例代码如下：

// www.javascriptcn.com code example
const Koa = require('koa');
const Router = require('koa-router');
const bodyParser = require('koa-bodyparser');
const router = new Router();
const redis = require('redis');
const svgCaptcha = require('svg-captcha');

const app = new Koa();
const client = redis.createClient();

client.on('error', err => {
  console.error('Redis error: ', err);
});

router.get('/captcha', async (ctx, next) => {
  const captcha = svgCaptcha.create();
  const key = `captcha:${ctx.ip}`;
  const value = captcha.text;
  const ttl = 300; // 验证码有效期为 5 分钟
  client.setex(key, ttl, value); // 将验证码字符串存储在 Redis 中
  ctx.type = 'svg';
  ctx.body = captcha.data;
});

router.post('/login', async (ctx, next) => {
  const { username, password, captcha } = ctx.request.body;
  const key = `captcha:${ctx.ip}`;
  const value = await new Promise((resolve, reject) => {
    client.get(key, (err, value) => {
      if (err) reject(err);
      else resolve(value);
    });
  });
  if (value && value.toLowerCase() === captcha.toLowerCase()) {
    // 验证码正确，执行登录逻辑
    ctx.body = 'Login success!';
    client.del(key);
  } else {
    // 验证码错误，提示用户重新输入
    ctx.body = 'Captcha error!';
  }
});

app.use(bodyParser());
app.use(router.routes());

app.listen(3000, () => {
  console.log('Server start at http://localhost:3000');
});

学习意义

本文通过实际的示例代码介绍了使用 Koa2 和 Redis 实现验证码功能的方法，学习者可以通过阅读本文，了解到 Node.js Web 开发和 Redis 的基本用法。本文的示例代码简单易懂，适合初学者学习和入门。在实际开发中，验证码作为一种常见的用户验证方式，对于保护用户信息和防范恶意攻击具有重要意义。

来源：JavaScript中文网，转载请注明来源 https://www.javascriptcn.com/post/67d65660a941bf7134c0da36

使用 Koa2 和 Redis 实现验证码功能