Golang圖片驗證碼的使用方法

更新時間：2024年05月07日 10:30:34 作者：GEEK JUMP

最近在使用到Golang進行原生開發(fā),注冊和登錄頁面都涉及到圖片驗證碼的功能,支持很多類型的驗證方式,例如支持數(shù)字類型、字母類型、音頻驗證碼、中文驗證碼,本文給大家介紹Golang圖片驗證碼的使用,感興趣的朋友跟隨小編一起看看吧

一、背景

最近在使用到Golang進行原生開發(fā)，注冊和登錄頁面都涉及到圖片驗證碼的功能。找了下第三方庫的一些實現(xiàn)，發(fā)現(xiàn)了這個庫用得還是蠻多的。并且支持很多類型的驗證方式，例如支持數(shù)字類型、字母類型、音頻驗證碼、中文驗證碼等等。

項目地址: https://github.com/mojocn/base64Captcha

官方文檔地址: https://captcha.mojotv.cn/.netlify/functions/captcha

支持多種驗證碼類型(多種驗證碼驅動):

二、基本使用

1、生成驗證碼base64字符串

生成驗證碼的基本邏輯順序如下:

0、需要準備存儲驗證碼的一種驅動實現(xiàn)Store接口，庫中有一個基于Store接口的內存存儲方案的默認實現(xiàn)類: base64Captcha.DefaultMemStore

1、需要定義生成驗證碼類型的Driver驅動類實例, 配置驗證碼信息，例如圖片大小、高度、模糊度等等

2、通過base64Captcha.NewCaptcha(&driver, store),生成驗證碼的base64字符串、驗證碼ID、驗證碼的答案、以及error信息，最后重點拿到驗證碼ID、驗證碼base64字符串響應給前端進行展示

3、最后底層會將數(shù)據(jù)存儲到store存儲方式中，這個store類實現(xiàn)了Store接口，將驗證碼信息進行存儲

// 這里我自己實現(xiàn)了一個基于Redis的Store存儲驅動類
var store = captcha.NewRedisStore(db.GetRedisConn())
func GenCaptcha() (string, string) {
    // 設置驗證碼驅動類型，這里是數(shù)字運算類型的驗證碼 
    // 例如會生成幾個數(shù)的基本運算， 最后求運算結果作為驗證碼結果
	driver := base64Captcha.DriverMath{          
		Height:     50,
		Width:      200,
		NoiseCount: 0,
	}
	captchaObj := base64Captcha.NewCaptcha(&driver, store)
	captchaId, b64s, _, err := captchaObj.Generate()
	if err != nil {
		panic(err.Error())
	}
	return captchaId, b64s // 拿到驗證碼ID、驗證碼的base64字符串
}

拿到驗證碼ID、驗證碼的base64字符串，前端頁面使用一個隱藏的input存儲驗證碼ID、一個input作為表單提交驗證碼的值、一個img標簽，將src設置為這個base64字符串，即可正常顯示這個驗證碼.

前端局部代碼如下:

顯示效果如下:

后端查看Redis的存儲信息: 可以看到驗證碼ID、驗證碼答案 8 x 5 = 40

2、后端校驗驗證碼

后端校驗的大致邏輯就是:

0、需要準備存儲驗證碼的一種驅動實現(xiàn)store，庫有有一個基于Store接口的內存存儲方案的實現(xiàn)類base64Captcha.DefaultMemStore。這個使用剛才和生成驗證碼的store變量一樣即可

1、直接通過store對象，調用Verify方法，傳遞驗證碼ID、以及驗證碼答案即可，驗證結果返回true則代表通過，返回false則表示不通過. 還有一個參數(shù)clear(bool), 代表執(zhí)行驗證后無論是否通過，都需要將這個驗證碼刪除/作廢

func VerifyCaptcha(captchaId string, answer string) bool {
	return store.Verify(captchaId, answer, true)
}

后端獲取驗證碼，進行校驗的代碼截圖:

3、Redis存儲驅動代碼: RedisStore

非生產(chǎn)環(huán)境代碼，只是簡單示例，請勿使用在生產(chǎn)環(huán)境。因為有些邏輯沒有做嚴格校驗以及測試

package captcha
import (
	"context"
	"github.com/redis/go-redis/v9"
	"sync"
	"time"
)
const captchaKey = "string:captcha:"
var ctx = context.Background()
type RedisStore struct {
	redisClient *redis.Client
	mtx         sync.Mutex
}
func (r *RedisStore) Set(id string, value string) error {
	r.mtx.Lock()
	defer r.mtx.Unlock()
	key := captchaKey + id
	result := r.redisClient.SetNX(ctx, key, value, time.Second*60)
	if result.Err() != nil {
		return result.Err()
	}
	return nil
}
func (r *RedisStore) Get(id string, clear bool) string {
	r.mtx.Lock()
	defer r.mtx.Unlock()
	key := captchaKey + id
	result := r.redisClient.Get(ctx, key)
	if result.Err() != nil {
		return ""
	}
	if clear {
		go r.redisClient.Del(ctx, key)
	}
	return result.Val()
}
func (r *RedisStore) Verify(id, answer string, clear bool) bool {
	r.mtx.Lock()
	defer r.mtx.Unlock()
	key := captchaKey + id
	result := r.redisClient.Get(ctx, key)
	if result.Err() != nil {
		return false
	}
	storeAnswer := result.Val()
	if clear {
		go r.redisClient.Del(ctx, key)
	}
	return answer == storeAnswer
}
func NewRedisStore(redisClient *redis.Client) *RedisStore {
	return &RedisStore{
		redisClient: redisClient,
		mtx:         sync.Mutex{},
	}
}