golang透明处理JSON输入为标准表单POST插件库formjson的使用

golang透明处理JSON输入为标准表单POST插件库formjson的使用

FormJSON是一个net/http处理器，它实现了对POST数据的内容协商，以便将JSON数据透明地当作application/x-www-form-urlencoded表单数据来处理。这样处理后，就可以直接使用http.Request内置的r.FormValue("key")方法来获取数据。

为了匹配application/x-www-form-urlencoded的能力，FormJSON只支持单层JSON对象，且键和值都必须是字符串类型。

使用示例

下面是一个完整的示例代码，展示了如何使用formjson库：

package main

import (
    "net/http"
    "fmt"

    "github.com/rs/formjson"
)

func main() {
    // 定义一个处理函数，使用FormValue获取表单值
    h := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
        // 从表单中获取name参数的值
        body := fmt.Sprintf("Hello %s!", r.FormValue("name"))
        w.Write([]byte(body))
    })

    // 使用formjson包装原始处理器
    handler := formjson.Handler(h)
    
    // 启动HTTP服务器
    http.ListenAndServe(":8080", handler)
}

测试请求

发送JSON格式的POST请求：

curl -H "Content-Type:application/json" -d '{"name":"World"}' :8080

这个请求会被formjson处理器转换为等效的表单POST请求：

curl -d name=World :8080

两种请求方式都会得到相同的响应：“Hello World!”。

注意事项

  1. 该库只处理单层JSON对象，不支持嵌套结构
  2. JSON中的键和值都必须是字符串类型
  3. 使用前需要先导入github.com/rs/formjson包
  4. 通过包装原始处理器来启用JSON到表单的透明转换

许可证

所有源代码均遵循MIT许可证。


更多关于golang透明处理JSON输入为标准表单POST插件库formjson的使用的实战教程也可以访问 https://www.itying.com/category-94-b0.html

1 回复

更多关于golang透明处理JSON输入为标准表单POST插件库formjson的使用的实战系列教程也可以访问 https://www.itying.com/category-94-b0.html


Golang 透明处理 JSON 输入为标准表单 POST - formjson 使用指南

formjson 是一个实用的 Golang 库，它允许你将 JSON 格式的请求体透明地转换为标准的 application/x-www-form-urlencoded 表单格式，这在需要与老式表单 API 交互时特别有用。

安装

go get github.com/gorilla/schema
go get github.com/monoculum/formjson

基本用法

1. 作为中间件使用

package main

import (
	"fmt"
	"net/http"
	
	"github.com/gorilla/mux"
	"github.com/monoculum/formjson"
)

type User struct {
	Username string `json:"username" schema:"username"`
	Password string `json:"password" schema:"password"`
	Age      int    `json:"age" schema:"age"`
}

func main() {
	r := mux.NewRouter()
	
	// 使用 formjson 中间件
	r.Use(formjson.Middleware)
	
	r.HandleFunc("/register", func(w http.ResponseWriter, r *http.Request) {
		var user User
		if err := formjson.Parse(r, &user); err != nil {
			http.Error(w, err.Error(), http.StatusBadRequest)
			return
		}
		
		fmt.Printf("注册用户: %+v\n", user)
		w.Write([]byte("注册成功"))
	}).Methods("POST")
	
	http.ListenAndServe(":8080", r)
}

2. 直接解析 JSON 到结构体

func handleForm(w http.ResponseWriter, r *http.Request) {
	var input struct {
		Name  string `json:"name" schema:"name"`
		Email string `json:"email" schema:"email"`
	}
	
	// 自动处理 JSON 或表单数据
	if err := formjson.Parse(r, &input); err != nil {
		http.Error(w, err.Error(), http.StatusBadRequest)
		return
	}
	
	fmt.Printf("收到数据: %+v\n", input)
}

高级特性

1. 处理嵌套结构

type Address struct {
	Street string `json:"street" schema:"street"`
	City   string `json:"city" schema:"city"`
}

type Profile struct {
	Name    string  `json:"name" schema:"name"`
	Age     int     `json:"age" schema:"age"`
	Address Address `json:"address" schema:"address"`
}

func handleProfile(w http.ResponseWriter, r *http.Request) {
	var profile Profile
	if err := formjson.Parse(r, &profile); err != nil {
		http.Error(w, err.Error(), http.StatusBadRequest)
		return
	}
	
	fmt.Printf("用户资料: %+v\n", profile)
}

2. 自定义标签

type CustomStruct struct {
	FieldOne string `json:"field_one" schema:"custom_name"`
	FieldTwo int    `json:"another_field" schema:"another_name"`
}

3. 处理数组

type Survey struct {
	Questions []string `json:"questions" schema:"questions"`
	Answers   []int    `json:"answers" schema:"answers"`
}

实际应用场景

  1. 兼容老系统：新前端发送 JSON，但后端只接受表单数据
  2. API 网关：统一处理不同格式的输入
  3. 测试工具：简化测试代码，可以用 JSON 测试表单接口

性能考虑

formjson 在内部使用了 gorilla/schema 进行表单解码，性能开销很小。对于高并发场景：

  1. 可以复用解码器实例
  2. 对于简单结构，直接使用 json.Unmarshal 可能更快

错误处理

func handleRequest(w http.ResponseWriter, r *http.Request) {
	var data MyStruct
	
	if err := formjson.Parse(r, &data); err != nil {
		switch err {
		case formjson.ErrInvalidContentType:
			// 处理不支持的内容类型
		case schema.MultiError:
			// 处理字段级别的验证错误
		default:
			// 其他错误
		}
		return
	}
	
	// 处理数据...
}

formjson 提供了一种优雅的方式在现代 JSON API 和传统表单接口之间架起桥梁，特别适合渐进式迁移老系统的场景。

回到顶部