captcha
1 验证码虚线的作用以及虚线是如何实现的
验证码的虚线的作用
- 验证码的虚线的作用:防止AI扫描识别
- 虚线是如何实现的: 调用了数学包里面的sin,cos
2 使用方法
2.1 安装依赖
go get -u github.com/mojocn/base64Captcha
2.2设置默认内存储存器
// 库中提供的默认内存存储器。内存存储器用于存储和验证生成的验证码信息。它将验证码的标识符、验证码图片和相关的验证数据存储在内存中。
var stores = base64Captcha.DefaultMemStore
2.3生成验证码方法以及配置文件解析
var driver base64Captcha.Driver
var driverString base64Captcha.DriverString
// 配置验证码信息
captchaConfig := base64Captcha.DriverString{
// 验证码图片的高度,以像素为单位。
Height: 60,
//验证码图片的宽度,以像素为单位。
Width: 200,
//验证码图片中随机噪点的数量。在这个例子中,值为0表示没有噪点。
NoiseCount: 0,
// 控制显示在验证码图片中的线条的选项。在这个例子中,1: 直线 2: 曲线4: 点线8: 虚线16: 中空直线32: 中空曲线
ShowLineOptions: 2 | 4,
//验证码的长度,即验证码中字符的数量。
Length: 4,
//验证码的字符源,用于生成验证码的字符。在这个例子中,使用数字和小写字母作为字符源。
Source: "1234567890qwertyuioplkjhgfdsazxcvbnm",
BgColor: &color.RGBA{
//验证码图片的背景颜色。在这个例子中,使用RGBA颜色模型,R表示红色分量,G表示绿色分量,B表示蓝色分量,A表示透明度。
R: 3,
G: 102,
B: 214,
A: 125,
},
//用于绘制验证码文本的字体文件。在这个例子中,使用名为"wqy-microhei.ttc"的字体文件。
Fonts: []string{"wqy-microhei.ttc"},
}
driverString = captchaConfig
//将driverString中指定的字体文件转换为驱动程序所需的字体格式,并将结果赋值给driver变量。这个步骤是为了将字体文件转换为正确的格式,以便在生成验证码时使用正确的字体。
driver = driverString.ConvertFonts()
//使用driver和stores参数创建一个新的验证码实例,并将其赋值给captcha变量。这里的stores参数表示验证码存储器,用于存储和验证验证码。
captcha := base64Captcha.NewCaptcha(driver, stores)
//调用captcha实例的Generate方法生成验证码。lid是生成的验证码的唯一标识符,lb64s是生成的验证码图片的Base64编码字符串,lerr是生成过程中的任何错误。
lid, lb64s, lerr := captcha.Generate()
// 从验证码存储器中获取验证码的值
code = stores.Get(lid, true)
return lid, lb64s, code, lerr
3 内容解析
3.1 声明驱动的含义
var driver base64Captcha.Driver点进源码里面只有两个主要部分
- func (d Driver) DrawCaptcha(content string) (item Item, err error)
- DrawCaptcha 绘制二进制验证码,接收一个 content 参数,用于生成并绘制验证码。它返回一个 Item 结构体和可能的错误。Item 结构体包含了绘制的验证码图像或其他相关信息。
//item结构体源码如下
type Item interface {
//WriteTo writes to a writer
WriteTo(w io.Writer) (n int64, err error)
//EncodeB64string encodes as base64 string
EncodeB64string() string
}
- GenerateIdQuestionAnswer 生成随机的id、问题和答案
- 问题字符串 q 是指用于展示给用户的验证码问题或提示,通常是一个文字描述或短语,要求用户根据该问题来完成验证码的验证。
- 答案字符串 a 是用户对于验证码问题的回答或响应。用户需要根据展示给他们的问题,在输入框中填写或选择正确的答案。 -func (d Driver) GenerateIdQuestionAnswer() (id, q, a string)
3.2配置使用以及源码解析
- driverString = captchaConfig这个只是将上述的配置信息传赋值给声明的配置信息
- driver = driverString.ConvertFonts()这个在上面已经说过他的简单介绍,源码如下
func (d *DriverString) ConvertFonts() *DriverString {
//是否为 nil。如果是,它将 DefaultEmbeddedFonts 赋值给 d.fontsStorage。否则返回一个使用其默认字体
if d.fontsStorage == nil {
d.fontsStorage = DefaultEmbeddedFonts
}
//代码创建了一个空的切片 tfs,用于存储字体文件。然后它遍历 d.Fonts 切片中的每个元素,并通过
// d.fontsStorage.LoadFontByName 方法加载对应的字体文件。加载的字体文件会被追加到 tfs 切片中。
tfs := []*truetype.Font{}
for _, fff := range d.Fonts {
tf := d.fontsStorage.LoadFontByName("fonts/" + fff)
tfs = append(tfs, tf)
}
//代码创建了一个空的切片 tfs,用于存储字体文件。然后它遍历 d.Fonts 切片中的每个元素,
//并通过 d.fontsStorage.LoadFontByName 方法加载对应的字体文件。加载的字体文件会被追加到 tfs 切片中。这意味着如果没有加载任何字体文件,它将使用 fontsAll 中的默认字体。
if len(tfs) == 0 {
tfs = fontsAll
}
//这行代码将刚刚生成的字体切片 tfs 赋值给 d.fontsArray,将其存储在 DriverString 结构体中。
d.fontsArray = tfs
return d
}
- captcha := base64Captcha.NewCaptcha(driver, stores)
func NewCaptcha(driver Driver, store Store) *Captcha {
//这行代码创建了一个 Captcha 结构体的实例,并使用传入的 driver 和 store 参数初始化了 Driver 和 Store 字段。
return &Captcha{Driver: driver, Store: store}
}
- lid, lb64s, lerr := captcha.Generate()
func (c *Captcha) Generate() (id, b64s string, err error) {
id, content, answer := c.Driver.GenerateIdQuestionAnswer()
//这里调用的就是上面介绍第一个声明的验证码的生成方法
item, err := c.Driver.DrawCaptcha(content)
//根据验证码的内容 content 生成验证码图像,并返回生成的图像,也是上面介绍的第一个声明的一部分
if err != nil {
return "", "", err
}
err = c.Store.Set(id, answer)
//将验证码的标识符 id 和正确答案 answer 存储在声明的默认内存存储器中。
if err != nil {
return "", "", err
}
b64s = item.EncodeB64string()
// item 的 EncodeB64string 方法,将生成的验证码图像转换为 Base64 字符串表示。(个人理解图片在传递过程中是以二进制的形式传递的,通过这个方法将其转化为Base64编码的形式)
//Base64 是一种常用的编码方式,用于将二进制数据转换成可打印的 ASCII 字符串。Base64 编码通常用于在文本协议中传输二进制数据,或者在需要将二进制数据表示为字符串时使用。
return
}
- code = stores.Get(lid, flase)涉及到默认内存存储器直接就在这里简单说明了
type Store interface {
//这个方法就是上面生成验证码时,向默认内存存储器储存数据
Set(id string, value string) error
//获取通过生成验证码的id获取默认内存存储器中存储的数据
//第二个参数:true会返回与指定的验证码数据项相关的其他信息。这些信息可能包括验证码生成时间、过期时间、元数据或其他属性。false返回指定验证码数据项本身,而不包含与其相关的其他信息
Get(id string, clear bool) string
//第一个参数是验证码的唯一表示即判断是否是当前验证码 第二个参数是用户输入的验证码 第三个参数是是否开启大小写映射,即验证时是否忽略大小写,这个包直接就给我们封装了校验验证码
Verify(id, answer string, clear bool) bool
}
4 代码实例
import (
"fmt"
"github.com/mojocn/base64Captcha"
"image/color"
)
var stores = base64Captcha.DefaultMemStore
func CaptMake() (id, b64s string, code string, err error) {
var driver base64Captcha.Driver
var driverString base64Captcha.DriverString
// 配置验证码信息
captchaConfig := base64Captcha.DriverString{
Height: 60,
Width: 200,
NoiseCount: 0,
ShowLineOptions: 2 | 4,
Length: 4,
Source: "1234567890qwertyuioplkjhgfdsazxcvbnm",
BgColor: &color.RGBA{
R: 3,
G: 102,
B: 214,
A: 125,
},
Fonts: []string{"wqy-microhei.ttc"},
}
driverString = captchaConfig
driver = driverString.ConvertFonts()
captcha := base64Captcha.NewCaptcha(driver, stores)
lid, lb64s, lerr := captcha.Generate()
code = stores.Get(lid, true)
fmt.Println(code)
return lid, lb64s, code, lerr
}
//这个解析方式只是上面介绍的内存存储器的方法调用,使用起来看情况是否使用
func CaptVerify(id string, capt string) bool {
if stores.Verify(id, capt, false) {
return true
} else {
return false
}
}