根据 [trek-captcha](https://github.com/trekjs/captcha) 仓库的文档,我将为您提供完整的本地运行步骤:
### 1. 前置要求
- Node.js 环境
- npm 包管理器
### 2. 安装步骤
1. **创建新项目目录**:
```bash
mkdir captcha-demo
cd captcha-demo
```
2. **初始化项目**:
```bash
npm init -y
```
3. **安装 trek-captcha**:
```bash
npm install trek-captcha --save
```
### 3. 创建测试文件
1. **创建 `index.js` 文件**:
```javascript:index.js
'use strict'
const fs = require('fs')
const captcha = require('trek-captcha')
async function run() {
// 生成验证码
const { token, buffer } = await captcha({
size: 5, // 验证码长度,默认5
style: -1 // 样式,-1表示随机
})
// 打印验证码文本
console.log('验证码:', token)
// 将验证码图片保存为 GIF 文件
fs.createWriteStream('captcha.gif')
.on('finish', () => console.log('验证码图片已保存为 captcha.gif'))
.end(buffer)
}
run().catch(console.error)
```
### 4. 运行项目
1. **执行程序**:
```bash
node index.js
```
运行后,将会:
- 在控制台显示验证码文本
- 在当前目录生成 `captcha.gif` 验证码图片文件
### 5. 在 Web 应用中使用(Express 示例)
如果您想在 Web 应用中使用,这里是一个 Express 示例:
1. **安装额外依赖**:
```bash
npm install express
```
2. **创建 `web.js`**:
```javascript:web.js
const express = require('express')
const captcha = require('trek-captcha')
const app = express()
// 存储验证码会话
const sessions = new Map()
app.get('/', (req, res) => {
res.send(`
<h1>验证码示例</h1>
<img src="/captcha" />
<form action="/verify" method="GET">
<input type="text" name="code" />
<button type="submit">验证</button>
</form>
`)
})
app.get('/captcha', async (req, res) => {
const { token, buffer } = await captcha()
// 存储验证码
const sessionId = Date.now().toString()
sessions.set(sessionId, token)
// 设置 cookie
res.cookie('sessionId', sessionId)
// 发送验证码图片
res.setHeader('Content-Type', 'image/gif')
res.send(buffer)
})
app.get('/verify', (req, res) => {
const sessionId = req.cookies.sessionId
const userInput = req.query.code
const correctCode = sessions.get(sessionId)
if (userInput === correctCode) {
res.send('验证成功!')
} else {
res.send('验证失败!')
}
// 清除已使用的验证码
sessions.delete(sessionId)
})
app.listen(3000, () => {
console.log('服务器运行在 http://localhost:3000')
})
```
3. **运行 Web 服务**:
```bash
node web.js
```
4. **访问测试页面**:
打开浏览器访问 `http://localhost:3000`
### 6. 注意事项
1. 验证码配置选项:
```javascript
const options = {
size: 5, // 验证码长度
style: -1 // 样式(-1为随机)
}
```
2. 返回值说明:
- `token`: 验证码文本
- `buffer`: 验证码图片的二进制数据
3. 生成的验证码图片为 GIF 格式
4. 该库的特点是:
- 纯 JavaScript 实现
- 不需要 C/C++ 环境
- 不需要 ImageMagick
- 不需要 Canvas
这样就完成了 trek-captcha 的完整安装和使用流程。可以根据实际需求选择简单的文件生成方式或集成到 Web 应用中。
代码库中展示了两种实现方式 - Node.js(trek-captcha)和 PHP(mews/captcha)。我分别说明:
### Node.js 实现 (trek-captcha)
1. 首先安装包:
```bash
npm install trek-captcha
```2. 基础使用示例(参考 README):
```javascript
const fs = require('fs')
const captcha = require('trek-captcha')async function run() {
const { token, buffer } = await captcha()
// 保存验证码图片到文件
fs.createWriteStream('captcha.gif')
.on('finish', () => console.log(token)) // 打印验证码文本
.end(buffer)
}run()
```captcha() 函数可以接受一个可选的配置对象:
```javascript
const options = {
size: 5, // 验证码文本长度(默认: 5)
style: -1 // 颜色样式(-1表示随机)
}const { token, buffer } = await captcha(options)
```### PHP 实现 (mews/captcha)
1. 通过 Composer 安装:
```bash
composer require mews/captcha
```2. 对于 Laravel 应用,服务提供者和门面会自动注册。如需手动注册,在 `config/app.php` 中添加:
```php
'providers' => [
Mews\Captcha\CaptchaServiceProvider::class,
]'aliases' => [
'Captcha' => Mews\Captcha\Facades\Captcha::class,
]
```3. 发布配置文件:
```bash
php artisan vendor:publish --provider="Mews\Captcha\CaptchaServiceProvider"
```4. 在 Laravel 中的基本用法:
```php
// 生成验证码
return captcha();// 验证验证码
if(captcha_check($value)) {
// 验证成功
}// 生成验证码 HTML
{!! captcha_img() !!}
```两种实现的主要区别:
- Node.js 版本不依赖任何外部库,直接生成 GIF 图片
- PHP 版本通过 Intervention/Image 库使用 GD/Imagick 进行图片处理可以根据自己的技术栈和需求选择合适的实现方式。如果你是在 Node.js 环境下开发,推荐使用 trek-captcha;如果是 PHP/Laravel 环境,则可以使用 mews/captcha。
需要注意的是,trek-captcha 生成的是 GIF 格式的验证码,而 mews/captcha 默认生成 JPEG 格式,但都能很好地完成验证码的功能。