beego项目实战——图形验证码

因为前端页面有些修改，所以就先开始做后端的接口，先做图形验证码功能
图形验证码基于一个已有的库base64Captcha开发，文档写的一点不友好，看的很吃力，但没有办法，为了用人家的东西只能硬着头皮看了

定义model

看了文档之后发现验证码是两部分，一个是验证码的标识ID字符串，一个是转为base64的图片字符串，所以直接定义如下model

// Captcha 图形验证码
type Captcha struct {
    ID   string
    B64s string
}

var store = base64Captcha.DefaultMemStore

// GetCaptcha 获取验证码
func GetCaptcha() (id string, b64s string, err error) {
    bgcolor := color.RGBA{0, 0, 0, 0}
    fonts := []string{"wqy-microhei.ttc"}
    driver := base64Captcha.NewDriverMath(40, 102, 0, 0, &bgcolor, fonts)
    captcha := base64Captcha.NewCaptcha(driver, store)
    id, b64s, err = captcha.Generate()
    return id, b64s, err
}

// VerifyCaptcha 校验图形验证码
func VerifyCaptcha(id string, b64s string) bool {
    return store.Verify(id, b64s, true)
}

go语言虽然省略了public等关键字，但真心觉得这是一大败笔，这个大写开头的变量名太难受了

使用自带memory store

var store = base64Captcha.DefaultMemStore

使用base64Captcha.NewDriverMath就可以生成一个返回数学运算的driver，从左到右的参数分别为高、宽、背景文字干扰的个数、画线的条数、背景色指针、字体数组

还要用指针引用传参真心难受，一边吐槽还得一边学更难受

使用刚才生成的driver和store生成验证码的实例，然后使用Generate()生成验证码，返回三个结果分别为验证码的id，验证码的base64字符串，以及go语言独有的err
store.Verify用来校验验证码，传入的参数分别为验证码的id，输入的验证码，验证完成后是否清掉验证码
为了防止被暴力破解直接最后一个参数设为true

controller

Get()

func (c *CaptchaController) Get() {
    id, b64s, err := models.GetCaptcha()
    if err != nil {
        c.Data["json"] = err.Error()
    } else {
        c.Data["json"] = models.Captcha{id, b64s}
    }
    c.ServeJSON()
}

Post()

func (c *CaptchaController) Post() {
    var captcha models.Captcha
    json.Unmarshal(c.Ctx.Input.RequestBody, &captcha)
    if models.VerifyCaptcha(captcha.ID, captcha.B64s) {
        c.Data["json"] = true
    } else {
        c.Data["json"] = false
    }
    c.ServeJSON()
}

使用json.Unmarshal将前端传过来的json解析到结构体里去

router

在router中添加路由

beego.NSNamespace("/captcha",
    beego.NSInclude(
        &controllers.CaptchaController{},
    ),
),

因为使用了自动化文档，所以此处的写法比较特殊，采用的是namespace+Include 的写法

添加注解

// @Title GetCaptcha
// @Description 获取图形验证码
// @Success 200 {object} models.Captcha
// @router / [get]

// @Title VerifyCaptcha
// @Description 校验图形验证码
// @Param body body models.Captcha true "验证码"
// @Success 200 {bool} true or false
// @router / [post]

关于代码注解的相关规则可以看一下注解文档，这里就不做过多解释

运行

bee run -gendoc=true -downdoc=true

效果

文档

接口

获取验证码

验证码

校验验证码

最后编辑于：2020.03.31 14:46:58