登录
推荐 文章 Go 技术 课程 下载 专题 AI
首页 >  Golang >  Go教程

Go huh 怎么给输入框添加字段校验函数

来源:17golang原创

时间:2026-10-13 14:19:55 442浏览 收藏

Go huh 给输入框添加字段校验函数,直接在 huh.NewInput() 后调用 Validate(func(string) error) 即可。校验函数接收当前字符串:返回 nil 表示通过,返回一个 error 就让当前字段保留错误信息,表单不会把无效值当成已确认输入。

官方地址:https://github.com/charmbracelet/huh

先记住三个判断
  • Validate 的参数是 func(string) error,不要把布尔函数直接传进去。
  • 空值、长度这类通用约束可以复用 huh 自带函数,业务规则单独写,便于更换表单策略。
  • Value(&name) 负责接收字段值;校验失败时,先处理错误,不要在外层把未通过的值当成最终结果。
给Go huh的输入框添加字段校验函数,核心是先绑定字段对应的校验规则,再在提交触发的校验方法里逐行执行规则判断,捕获不满足条件的场景直接返回自定义提示即可,不需要改动框架底层的逻辑。

先把校验函数挂到 huh.Input

Input.Validate 保存的是一个字符串到错误的映射。最小用法是给用户名做非空和长度检查:规则通过时返回 nil,否则返回带有读者可理解提示的错误。下面的示例只展示字段配置,注释说明了关键参数和失败分支。

huh NewForm、NewGroup、NewInput、Input Validate 与校验错误之间的调用关系说明图
图1:huh 输入校验的调用关系说明图,不是终端截图或运行证据。
package main

import (
    "errors"
    "fmt"
    "strings"

    "charm.land/huh/v2"
)

func validateUserName(value string) error {
    // 先去掉首尾空白,避免用户输入几个空格时绕过非空判断。
    value = strings.TrimSpace(value)
    if value == "" {
        return errors.New("用户名不能为空")
    }
    // 长度限制只针对业务允许的范围,错误信息直接给出修复方向。
    if len([]rune(value))  20 {
        return errors.New("用户名长度需要在 2 到 20 个字符之间")
    }
    return nil
}

func main() {
    var name string

    form := huh.NewForm(
        huh.NewGroup(
            huh.NewInput().
                Title("用户名").
                Value(&name).
                // Validate 绑定当前输入框,返回 error 就会保留字段错误。
                Validate(validateUserName),
        ),
    )

    if err := form.Run(); err != nil {
        // 表单退出或终端不可用时仍要处理 Run 的错误。
        fmt.Println("表单未完成:", err)
        return
    }
    fmt.Println("已确认用户名:", name)
}

这里使用 []rune 计算字符数,是为了让中文用户名不按 UTF-8 字节数被过早拒绝;它不等于显示宽度,也不负责 Unicode 规范化。若你的业务只允许 ASCII 标识符,应在校验函数里明确写出字符集规则。

把通用规则和业务规则分开

如果每个输入框都手写空值、最小长度和最大长度,表单多起来后很难维护。huh v2 提供 ValidateNotEmpty、ValidateMinLength、ValidateMaxLength、ValidateLength 和 ValidateOneOf 等函数;它们返回的仍是同一种校验函数,可以和业务条件放进一个组合器。

输入字符串经过 TrimSpace、huh 通用校验和业务规则后形成 error 的关系说明图
图2:字段规则组合与错误对象关系说明图,不是运行结果截图。
func validateProject(value string) error {
    // 先统一空白,再复用 huh 的通用规则,业务规则只保留项目特有部分。
    value = strings.TrimSpace(value)
    if err := huh.ValidateNotEmpty()(value); err != nil {
        return err
    }
    if err := huh.ValidateLength(3, 32)(value); err != nil {
        return err
    }
    // 项目名的首字符规则属于业务约束,不应混进所有输入框的通用规则。
    first := []rune(value)[0]
    if first  'Z' && first  'z' {
        return errors.New("项目名必须以英文字母开头")
    }
    return nil
}

组合时有一个细节:ValidateLength 的边界要和产品文案一致,示例中的上下限是包含在内的业务范围。把通用规则放前面,能让空值先得到稳定提示;业务规则放后面,能避免对空切片或空字符串做不必要的索引操作。

按输入负载选择校验位置

从表单设计角度,可以把校验分成三类:短文本字段适合在 Input.Validate 内同步返回错误;跨字段约束应放到表单完成后的业务层;需要访问网络或磁盘的检查,不应让字段校验函数承担长时间阻塞。

约束类型适合位置原因
不能为空、长度、格式Input.Validate输入字段自己就能给出即时错误
两个字段必须一致form.Run 成功后的业务层需要同时读取多个已确认值
远程名称是否已占用提交后的异步业务流程避免交互字段被网络延迟拖住

这种拆分的核心是约束和负载匹配:本地、确定、快速的规则放在字段层;跨字段和外部系统决策放在表单之后。这样即使以后把终端表单换成 HTTP 或桌面界面,业务校验也不会全部绑死在 huh 回调里。

几个容易踩到的边界

第一,Validate 不会替代 Value。前者决定输入是否通过,后者决定通过后把值写到哪里;只绑定校验却不绑定值,表单结束后自然拿不到结果。第二,返回错误要说明如何修复,不要只返回 errors.New("invalid")。第三,可访问模式也会使用校验函数,所以不要在函数里依赖终端颜色、光标或界面状态。

如果需要读取字段当前错误,可以使用字段对象的 Error();如果只是正常运行表单,通常让 huh 负责显示字段错误即可。对于昂贵校验,把它放到 form.Run 成功后的业务流程,并在外层提供重试或取消策略。

常见问题

Validate 应该返回 bool 还是 error?

返回 error。通过返回 nil,失败返回带提示的错误;如果已有布尔判断,可以在包装函数里把 false 转换成具体错误。

能不能直接使用 huh.ValidateNotEmpty?

可以。它本身就是返回 func(string) error 的校验函数,适合直接传给 Validate,也可以先处理空白再调用。

为什么校验通过了但外层变量还是空的?

检查是否调用了 Value(&变量),以及是否确实从 form.Run 返回成功。校验函数只负责判断,不负责把值写入你的业务变量。

声明:本文转载于:17golang原创 如有侵犯,请联系study_golang@163.com删除
相关阅读
更多>
最新阅读
更多>
课程推荐
更多>