Package captcha 技术文档

1. 安装指南

1.1 环境要求

• Go 语言环境（建议使用 Go 1.13 或更高版本）

1.2 安装步骤

1. 打开终端或命令行工具。
2. 使用 go get 命令安装 captcha 包：

   go get github.com/dchest/captcha
   

3. 安装完成后，你可以在你的 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 包来生成和验证验证码。