base64Captcha

一个灵活多样的验证码包

Base64captcha 支持任何 Unicode 字符，并且可以轻松自定义以支持数学、中文、韩语、日语、俄语、阿拉伯语等。

1. 📖📖📖 文档与演示

• 文档
• 引用
• 在线演示

2. 🚀🚀🚀 快速开始

2.1 🎬🎬🎬 使用历史版本

Tag v1.2.2

go get github.com/smart-unicom/[email protected]

或编辑你的 go.mod 文件为

github.com/smart-unicom/[email protected]

2.2 📥📥📥 下载包

go get -u github.com/smart-unicom/base64Captcha

大陆 Gopher 如果没有 VPN 导致 go get golang.org/x/image 失败的解决方案:

• go version > 1.11
• 设置环境变量 GOPROXY=https://goproxy.io

2.3 🏂🏂🏂 如何使用 base64Captcha 编程

2.3.1 🏇🏇🏇 实现 Store 接口 或使用内置内存存储

• 内置内存存储

type Store interface {
	// Set 设置验证码 id 对应的值
	Set(id string, value string)

	// Get 返回验证码 id 对应的值。Clear 表示
	// 是否从存储中删除该验证码
	Get(id string, clear bool) string
	
    // 直接验证验证码答案
	Verify(id, answer string, clear bool) bool
}

2.3.2 🏄🏄🏄 实现 Driver 接口 或使用内置驱动程序

内置驱动程序包括:

1. 内置数字驱动
2. 内置字符串驱动
3. 内置数学驱动
4. 内置中文驱动

// Driver 验证码接口，供验证码引擎进行操作
	type Driver interface {
	//DrawCaptcha 绘制二进制项
	DrawCaptcha(content string) (item Item, err error)
	//GenerateIdQuestionAnswer 创建随机 id、内容和答案
	GenerateIdQuestionAnswer() (id, q, a string)
}

2.3.3 🚴🚴🚴 核心代码 captcha.go

captcha.go 是 base64Captcha 的入口，非常简单。

package base64Captcha

import (
	"math/rand"
	"time"
)

func init() {
	//初始化随机数种子
	rand.Seed(time.Now().UnixNano())
}

// Captcha 验证码基本信息
	type Captcha struct {
	Driver Driver
	Store  Store
}

//NewCaptcha 从驱动和存储创建一个验证码实例
func NewCaptcha(driver Driver, store Store) *Captcha {
	return &Captcha{Driver: driver, Store: store}
}

//Generate 生成一个随机 id、base64 图像字符串或错误
func (c *Captcha) Generate() (id, b64s string, err error) {
	id,content, answer := c.Driver.GenerateIdQuestionAnswer()
	item, err := c.Driver.DrawCaptcha(content)
	if err != nil {
		return "", "", err
	}
	c.Store.Set(id, answer)
	b64s = item.EncodeB64string()
	return
}

//通过给定的 id 键验证并从存储中删除验证码值，
//返回布尔值。
//如果多个验证码实例共享同一个存储。
//你可能想要调用 `store.Verify` 方法。
func (c *Captcha) Verify(id, answer string, clear bool) (match bool) {
	match = c.Store.Get(id, clear) == answer
	return
}

2.3.4 🚵🚵🚵 生成 Base64(图像/音频) 字符串

func (c *Captcha) Generate() (id, b64s string, err error) {
	id,content, answer := c.Driver.GenerateIdQuestionAnswer()
	item, err := c.Driver.DrawCaptcha(content)
	if err != nil {
		return "", "", err
	}
	c.Store.Set(id, answer)
	b64s = item.EncodeB64string()
	return
}

2.3.5 🤸🤸🤸 验证答案

//如果多个验证码实例共享同一个存储。你可能想使用 `store.Verify` 方法。
//通过给定的 id 键验证并从存储中删除验证码值，返回布尔值。
func (c *Captcha) Verify(id, answer string, clear bool) (match bool) {
	match = c.Store.Get(id, clear) == answer
	return
}

2.3.6 🏃🏃🏃 完整示例

// 使用验证码包的 HTTP 服务器示例
package main

import (
	"encoding/json"
	"fmt"
	"github.com/smart-unicom/base64Captcha"
	"log"
	"net/http"
)

//configJsonBody json 请求体
	type configJsonBody struct {
	Id            string
	CaptchaType   string
	VerifyValue   string
	DriverAudio   *base64Captcha.DriverAudio
	DriverString  *base64Captcha.DriverString
	DriverChinese *base64Captcha.DriverChinese
	DriverMath    *base64Captcha.DriverMath
	DriverDigit   *base64Captcha.DriverDigit
}

var store = base64Captcha.DefaultMemStore

// base64Captcha 创建 http 处理器
func generateCaptchaHandler(w http.ResponseWriter, r *http.Request) {
	//解析请求参数
	decoder := json.NewDecoder(r.Body)
	var param configJsonBody
	err := decoder.Decode(&param)
	if err != nil {
		log.Println(err)
	}
	defer r.Body.Close()
	var driver base64Captcha.Driver

	//创建 base64 编码的验证码
	switch param.CaptchaType {
	case "audio":
		driver = param.DriverAudio
	case "string":
		driver = param.DriverString.ConvertFonts()
	case "math":
		driver = param.DriverMath.ConvertFonts()
	case "chinese":
		driver = param.DriverChinese.ConvertFonts()
	default:
		driver = param.DriverDigit
	}
	c := base64Captcha.NewCaptcha(driver, store)
	id, b64s, err := c.Generate()
	body := map[string]interface{}{"code": 1, "data": b64s, "captchaId": id, "msg": "success"}
	if err != nil {
		body = map[string]interface{}{"code": 0, "msg": err.Error()}
	}
	w.Header().Set("Content-Type", "application/json; charset=utf-8")
	json.NewEncoder(w).Encode(body)
}

// base64Captcha 验证 http 处理器
func captchaVerifyHandle(w http.ResponseWriter, r *http.Request) {

	//解析请求 json 体
	decoder := json.NewDecoder(r.Body)
	var param configJsonBody
	err := decoder.Decode(&param)
	if err != nil {
		log.Println(err)
	}
	defer r.Body.Close()
	//验证验证码
	body := map[string]interface{}{"code": 0, "msg": "failed"}
	if store.Verify(param.Id, param.VerifyValue, true) {
		body = map[string]interface{}{"code": 1, "msg": "ok"}
	}

	//设置 json 响应
	w.Header().Set("Content-Type", "application/json; charset=utf-8")

	json.NewEncoder(w).Encode(body)
}

//启动 net/http 服务器
func main() {
	//服务 Vuejs+ElementUI+Axios Web 应用
	http.Handle("/", http.FileServer(http.Dir("./static")))

	//创建验证码的 api
	http.HandleFunc("/api/getCaptcha", generateCaptchaHandler)

	//验证验证码的 api
	http.HandleFunc("/api/verifyCaptcha", captchaVerifyHandle)

	fmt.Println("服务器运行在 :8777")
	if err := http.ListenAndServe(":8777", nil); err != nil {
		log.Fatal(err)
	}
}

2.3.7 使用 Redis 作为存储示例

package main

import (
	"encoding/json"
	"fmt"
	"github.com/smart-unicom/base64Captcha"
	"log"
	"net/http"
	"time"
)

//configJsonBody json 请求体
	type configJsonBody struct {
	Id            string
	CaptchaType   string
	VerifyValue   string
	DriverAudio   *base64Captcha.DriverAudio
	DriverString  *base64Captcha.DriverString
	DriverChinese *base64Captcha.DriverChinese
	DriverMath    *base64Captcha.DriverMath
	DriverDigit   *base64Captcha.DriverDigit
}

// 创建 Redis 存储实例
func init() {
	// Redis 配置
	config := base64Captcha.RedisConfig{
		Addr:       "localhost:6379",  // Redis 地址
		Password:   "",               // Redis 密码
		DB:         0,                // Redis 数据库索引
		KeyPrefix:  "captcha:",       // Redis 键前缀
		Expiration: 10 * time.Minute, // 验证码过期时间
	}

	// 创建 Redis 存储
	store = base64Captcha.NewStoreRedis(config)
}

var store *base64Captcha.StoreRedis

// base64Captcha 创建 http 处理器
func generateCaptchaHandler(w http.ResponseWriter, r *http.Request) {
	//解析请求参数
	decoder := json.NewDecoder(r.Body)
	var param configJsonBody
	err := decoder.Decode(&param)
	if err != nil {
		log.Println(err)
	}
	defer r.Body.Close()
	var driver base64Captcha.Driver

	//创建 base64 编码的验证码
	switch param.CaptchaType {
	case "audio":
		driver = param.DriverAudio
	case "string":
		driver = param.DriverString.ConvertFonts()
	case "math":
		driver = param.DriverMath.ConvertFonts()
	case "chinese":
		driver = param.DriverChinese.ConvertFonts()
	default:
		driver = param.DriverDigit
	}
	c := base64Captcha.NewCaptcha(driver, store)
	id, b64s, err := c.Generate()
	body := map[string]interface{}{"code": 1, "data": b64s, "captchaId": id, "msg": "success"}
	if err != nil {
		body = map[string]interface{}{"code": 0, "msg": err.Error()}
	}
	w.Header().Set("Content-Type", "application/json; charset=utf-8")
	json.NewEncoder(w).Encode(body)
}

// base64Captcha 验证 http 处理器
func captchaVerifyHandle(w http.ResponseWriter, r *http.Request) {

	//解析请求 json 体
	decoder := json.NewDecoder(r.Body)
	var param configJsonBody
	err := decoder.Decode(&param)
	if err != nil {
		log.Println(err)
	}
	defer r.Body.Close()
	//验证验证码
	body := map[string]interface{}{"code": 0, "msg": "failed"}
	if store.Verify(param.Id, param.VerifyValue, true) {
		body = map[string]interface{}{"code": 1, "msg": "ok"}
	}

	//设置 json 响应
	w.Header().Set("Content-Type", "application/json; charset=utf-8")

	json.NewEncoder(w).Encode(body)
}

//启动 net/http 服务器
func main() {
	//服务 Vuejs+ElementUI+Axios Web 应用
	http.Handle("/", http.FileServer(http.Dir("./static")))

	//创建验证码的 api
	http.HandleFunc("/api/getCaptcha", generateCaptchaHandler)

	//验证验证码的 api
	http.HandleFunc("/api/verifyCaptcha", captchaVerifyHandle)

	fmt.Println("服务器运行在 :8777")
	if err := http.ListenAndServe(":8777", nil); err != nil {
		log.Fatal(err)
	}
}

2.3.8 使用 Etcd 作为存储示例

captcha with etcd database as store

3. 🎨🎨🎨 自定义

你可以通过实现 接口驱动 和 接口项目 来自定义验证码显示图像。

以下是一些参考示例：

1. DriverMath
2. DriverChinese
3. ItemChar

你甚至可以根据自己的喜好设计 captcha 结构。

4. 💖💖💖 感谢

• dchest/captha
• @slayercat
• @amzyang
• @Luckyboys
• @hi-sb

5. 🍭🍭🍭 许可证

base64Captcha 源代码根据 Apache 许可证第 2 版授权 (http://www.apache.org/licenses/LICENSE-2.0.html).