iris.context.readquery() 是唯一支持 query 自动绑定的原生方法,需结构体字段导出、显式 url tag、类型匹配,失败静默归零,须校验 error 和业务有效性。

iris.Context.ReadQuery() 是唯一支持 Query 自动绑定的原生方法
别试图用 ctx.ReadJSON() 或 ctx.ReadForm() 去读 query string,它们不处理 URL 查询参数。Iris 提供了专用的 ctx.ReadQuery(),它会把 ?name=alice&age=25 这类参数自动反序列化到结构体字段中,前提是字段名、标签和类型都对得上。
常见错误现象:调用 ctx.ReadQuery(&v) 后 v 字段全是零值,但没报错——大概率是结构体字段未导出,或 url tag 拼写错误,或字段类型无法从字符串转换(如 time.Time 未配解析器)。
- 结构体字段必须首字母大写(导出),否则
ReadQuery完全跳过 - 推荐显式加
url:"name"标签,避免依赖字段名自动映射(大小写敏感) - 支持基础类型转换:string/int/uint/float/bool,
int64可直接接收?id=123;但time.Time需配合自定义UnmarshalText方法 - 嵌套结构体、切片(如
[]string)也支持,但需确保查询参数格式匹配(例如?tags=a&tags=b→[]string{"a","b"})
Query 结构体字段命名与 url tag 必须严格对应
URL 参数名和结构体字段不是靠“驼峰转横线”自动推导的,ReadQuery 默认只按字段名(首字母小写)匹配,但容易出错。最稳的方式是显式声明 url tag。
例如请求是 /search?user_name=joy&is_active=true&limit=10,结构体就得这么写:
type SearchQuery struct {
UserName string `url:"user_name"`
IsActive bool `url:"is_active"`
Limit int `url:"limit"`
}
如果漏掉 url tag,而字段写成 UserName,ReadQuery 会去找 username(小写),导致绑定失败;写成 Username 则找 username,依然不匹配。
当代理已经知道网站路由或内容URL,并且在启动前需要有效的sitemap XML、sitemap索引或robots.txt引用时,请使用sitemap。这是一个发布构件技能,而不是爬虫或SEO平台。
-
url:"-"表示忽略该字段,不参与绑定 - 字段类型为指针(如
*string)时,空参数会被设为nil,而非空字符串 - 没有默认值机制:字段没出现在 query 中,就保持 Go 零值(
""、0、false),不会自动填充预设值
不能和路由路径参数、表单数据混用同一个结构体
一个结构体不能同时被 ReadQuery、ReadForm 和 ReadJSON 复用。Iris 不会智能区分来源,ReadQuery 只看 URL 查询字符串,其它来源的数据它根本看不到。
典型误用场景:前端发 GET /users?role=admin,后端却在 handler 里同时调用 ReadQuery 和 ReadForm,指望后者也读到 role —— 不可能,ReadForm 只读 application/x-www-form-urlencoded 或 multipart/form-data 的 body。
- 路径参数(如
/users/{id})必须用ctx.Params().Get("id")单独取,不能塞进 query 结构体 - 想统一收参?只能手动合并:先
ReadQuery,再Params().Get,最后赋值到新结构体 - 别给结构体字段加
json或formtag 期望复用,ReadQuery只认urltag
Query 绑定失败时静默归零,务必检查 error 返回值
ctx.ReadQuery(&v) 返回 error,但这个 error 只在严重问题时出现(比如字段类型不支持、反射失败)。更多时候,参数类型不匹配(如传 ?age=abc 给 int 字段)会导致字段被设为 0,且不报错。
这意味着你不能只靠 “没 error 就万事大吉”,必须主动校验业务逻辑所需的字段是否有效。比如分页接口要求 page ≥ 1,就得在绑定后加判断:
var q SearchQuery
if err := ctx.ReadQuery(&q); err != nil {
ctx.StatusCode(400)
ctx.JSON(iris.Map{"error": "invalid query"})
return
}
if q.Page
- 不要依赖
ReadQuery做输入校验,它只负责转换,不负责业务规则 - 需要强校验(如必填、范围、格式)请用
go-playground/validator等库,在ReadQuery后立即调用Validate.Struct(q) - 前端传多余参数不会报错,
ReadQuery默认静默忽略,这点和ReadJSON一致
ReadQuery 的返回 error,又没做字段有效性兜底,结果线上跑着跑着就返回了全零值数据。










