如何在 Go 语言中正确解析 URL 查询参数中的 JSON 字符串

12次阅读

如何在 Go 语言中正确解析 URL 查询参数中的 JSON 字符串

本文详解如何使用 go 的 `encoding/json` 包安全解析 url 查询参数(如 `filters`)中传递的合法 json 字符串,并处理常见错误(如非法 json 格式、url 编码缺失、类型断言等)。

go Web 开发中,常需从 http 请求的查询字符串(query String)中提取结构化数据。但需特别注意:URL 查询参数本身不是自动解析的 json——它只是普通字符串,且必须符合 JSON 语法规范,同时通常需经过 URL 编码以保证安全性与兼容性。

你提供的原始 URL:

http://127.0.0.1:3001/find?field=hostname&field=app&filters=["hostname":"example.com,"type":"vm"]

存在两个关键问题:

  1. filters 值 [“hostname”:”example.com,”type”:”vm”] 不是合法 JSON(方括号 [] 表示数组,但内部却是键值对,应为花括号 {} 包裹的对象);
  2. 缺少 URL 编码(如双引号 “、冒号 : 等特殊字符未转义),易导致解析失败或服务端截断。

✅ 正确做法是:

  • 前端应将 JSON 对象序列化后,再进行 url.QueryEscape 编码;
  • 后端用 r.URL.Query().Get(“filters”) 获取原始字符串,再用 json.Unmarshal 解析。

以下是完整、健壮的服务端解析示例:

package main  import (     "encoding/json"     "fmt"     "log"     "net/http"     "net/url" )  func handler(w http.ResponseWriter, r *http.Request) {     // 1. 获取 filters 查询参数(注意:使用 Get 而非 Query()["filters"],避免切片越界)     filtersStr := r.URL.Query().Get("filters")     if filtersStr == "" {         http.Error(w, "missing 'filters' parameter", http.StatusbadRequest)         return     }      // 2. (可选)若前端已 URL 编码,此处需先解码(标准 net/http 已自动解码,通常无需手动调用 url.QueryUnescape)     // filtersStr, _ = url.QueryUnescape(filtersStr)      // 3. 解析 JSON 字符串为 map[string]string     var filters map[string]string     if err := json.Unmarshal([]byte(filtersStr), &filters); err != nil {         http.Error(w, "invalid JSON in 'filters': "+err.Error(), http.StatusBadRequest)         return     }      // 4. 安全提取字段(带默认值或存在性检查)     hostname := filters["hostname"]     typ := filters["type"]      fmt.Fprintf(w, "hostname=%s, type=%s", hostname, typ) }  func main() {     http.HandleFunc("/find", handler)     log.Println("Server starting on :3001...")     log.Fatal(http.ListenAndServe(":3001", nil)) }

? 关键注意事项

  • ✅ 使用 r.URL.Query().Get(“key”) 替代 r.URL.Query()[“key”],避免空切片 panic;
  • ✅ 总是校验 filtersStr 是否为空,并对 json.Unmarshal 错误做明确响应(如返回 400 Bad Request);
  • ✅ 若需支持嵌套结构(如 {“metadata”: {“env”: “prod”}}),应定义结构体而非 map[string]string,提升类型安全;
  • ⚠️ 切勿直接拼接用户输入的 JSON 字符串执行 eval 类操作——Go 的 json.Unmarshal 是安全的反序列化,不执行代码。

✅ 推荐的前端构造方式(javaScript):

const filters = { hostname: "example.com", type: "vm" }; const encodedFilters = encodeURIComponent(JSON.stringify(filters)); const url = `http://127.0.0.1:3001/find?field=hostname&field=App&filters=${encodedFilters}`;

这样生成的 URL 查询部分为:

...&filters=%7B%22hostname%22%3A%22example.com%22%2C%22type%22%3A%22vm%22%7D

经 Go net/http 自动解码后,即可被 json.Unmarshal 正确解析。

掌握这一模式,你就能在 Go 中可靠、安全地处理任意结构化的 JSON 查询参数。

text=ZqhQzanResources