Package captcha 技术文档
2024-12-23 14:12:02作者:余洋婵Anita
1. 安装指南
1.1 环境要求
- Go 语言环境(建议使用 Go 1.13 或更高版本)
1.2 安装步骤
- 打开终端或命令行工具。
- 使用
go get
命令安装captcha
包:go get github.com/dchest/captcha
- 安装完成后,你可以在你的 Go 项目中导入该包:
import "github.com/dchest/captcha"
2. 项目的使用说明
2.1 生成验证码
- 使用
captcha.New()
函数生成一个新的验证码,返回验证码的 ID。id := captcha.New()
- 你可以通过
captcha.NewLen(length int)
函数自定义验证码的长度。id := captcha.NewLen(8)
2.2 生成验证码的图像或音频
- 使用
captcha.WriteImage(w io.Writer, id string, width, height int)
函数生成验证码的图像,并将其写入指定的io.Writer
。captcha.WriteImage(w, id, 240, 80)
- 使用
captcha.WriteAudio(w io.Writer, id string, lang string)
函数生成验证码的音频,并将其写入指定的io.Writer
。captcha.WriteAudio(w, id, "en")
2.3 验证验证码
- 使用
captcha.Verify(id string, digits []byte)
函数验证用户输入的验证码是否正确。isValid := captcha.Verify(id, userInputDigits)
- 也可以使用
captcha.VerifyString(id string, digits string)
函数,接受字符串形式的验证码输入。isValid := captcha.VerifyString(id, userInputString)
2.4 刷新验证码
- 使用
captcha.Reload(id string)
函数生成一个新的验证码,替换原有的验证码。captcha.Reload(id)
3. 项目API使用文档
3.1 函数
func New() string
- 生成一个新的验证码,返回验证码的 ID。
func NewLen(length int) (id string)
- 生成一个指定长度的验证码,返回验证码的 ID。
func RandomDigits(length int) (b []byte)
- 生成一个指定长度的随机数字序列,返回字节切片。
func Reload(id string) bool
- 重新生成指定验证码 ID 的验证码,返回是否成功。
func Server(imgWidth, imgHeight int) http.Handler
- 返回一个 HTTP 处理器,用于提供验证码的图像或音频。
func SetCustomStore(s Store)
- 设置自定义的验证码存储,替换默认的内存存储。
func Verify(id string, digits []byte) bool
- 验证用户输入的验证码是否正确。
func VerifyString(id string, digits string) bool
- 验证用户输入的验证码是否正确,接受字符串形式的输入。
func WriteAudio(w io.Writer, id string, lang string) error
- 生成验证码的音频,并写入指定的
io.Writer
。
func WriteImage(w io.Writer, id string, width, height int) error
- 生成验证码的图像,并写入指定的
io.Writer
。
3.2 类型
type Audio struct
- 表示验证码的音频对象。
type Image struct
- 表示验证码的图像对象。
type Store interface
- 自定义验证码存储接口。
4. 项目安装方式
4.1 使用 go get
安装
go get github.com/dchest/captcha
4.2 在项目中导入
import "github.com/dchest/captcha"
通过以上步骤,你可以成功安装并使用 captcha
包来生成和验证验证码。
热门项目推荐
相关项目推荐
鸿蒙开发工具大赶集
本仓将收集和展示鸿蒙开发工具,欢迎大家踊跃投稿。通过pr附上您的工具介绍和使用指南,并加上工具对应的链接,通过的工具将会成功上架到我们社区。014FlashMLA
FlashMLA是DeepSeek在2025年2月24日启动的“开源周”中发布的首个核心技术项目。 主要针对 Hopper GPU 的高效 MLA 解码内核,优化了可变长度序列服务。支持 BF16 和特定块大小分页 kvcache。源项目地址:https://github.com/deepseek-ai/FlashMLAC++00每日精选项目
🔥🔥 每日精选已经升级为:【行业动态】,快去首页看看吧,后续都在【首页 - 行业动态】内更新,多条更新哦~🔥🔥 每日推荐行业内最新、增长最快的项目,快速了解行业最新热门项目动态~~030BootstrapAdmin
基于 RBAC 的 Net8 后台管理框架,权限管理,前后台分离,支持多站点单点登录,兼容所有主流浏览器,内置微信、支付宝、QQ等多种登录方式,内置多种样式,可切换至 Blazor 多 Tabs 模式,权限控制细化到网页内任意元素(按钮、表格、文本框等等)C#00Cangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。Cangjie061毕方Talon工具
本工具是一个端到端的工具,用于项目的生成IR并自动进行缺陷检测。Python040PDFMathTranslate
PDF scientific paper translation with preserved formats - 基于 AI 完整保留排版的 PDF 文档全文双语翻译,支持 Google/DeepL/Ollama/OpenAI 等服务,提供 CLI/GUI/DockerPython06mybatis-plus
mybatis 增强工具包,简化 CRUD 操作。 文档 http://baomidou.com 低代码组件库 http://aizuda.comJava03国产编程语言蓝皮书
《国产编程语言蓝皮书》-编委会工作区018- DDeepSeek-R1探索新一代推理模型,DeepSeek-R1系列以大规模强化学习为基础,实现自主推理,表现卓越,推理行为强大且独特。开源共享,助力研究社区深入探索LLM推理能力,推动行业发展。【此简介由AI生成】。Python00
热门内容推荐
最新内容推荐
项目优选
收起

Python - 100天从新手到大师
Python
643
120

React Native鸿蒙化仓库
C++
9
19

方舟分析器:面向ArkTS语言的静态程序分析框架
TypeScript
6
10

open-eBackup是一款开源备份软件,采用集群高扩展架构,通过应用备份通用框架、并行备份等技术,为主流数据库、虚拟化、文件系统、大数据等应用提供E2E的数据备份、恢复等能力,帮助用户实现关键数据高效保护。
HTML
90
65

本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
205
61

🎉 基于Spring Boot、Spring Cloud & Alibaba、Vue3 & Vite、Element Plus的分布式前后端分离微服务架构权限管理系统
Vue
45
31

本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
287
82

为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
901
0

🎉 基于SpringBoot,Spring Security,JWT,Vue & Element 的前后端分离权限管理系统,同时提供了 Vue3 的版本
Java
182
44

旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
60
49