本文旨在帮助 Go 语言初学者理解如何使用 GoRest 框架正确处理 POST 请求中的表单数据。通过分析常见错误，我们将展示如何避免将 HTML 表单直接提交到期望 JSON 格式的 API，并提供使用 JavaScript 通过 AJAX 发送数据的示例代码，以确保数据以正确的格式发送到服务器。
在使用 GoRest 构建 RESTful API 时，处理 POST 请求并正确解析客户端发送的数据至关重要。 常见的错误之一是将 HTML 表单直接提交到期望 JSON 格式的 API 端点。 默认情况下，HTML 表单以 application/x-www-form-urlencoded 格式发送数据，而 GoRest 可能会期望 application/json 格式。
问题分析
问题的核心在于客户端（通常是浏览器）发送的数据格式与服务器端期望的数据格式不匹配。 当使用 HTML 表单的 <form> 标签提交数据时，浏览器默认使用 application/x-www-form-urlencoded 格式。 这意味着数据被编码为键值对，并以 URL 编码的形式发送。
例如，以下 HTML 表单：
<form method="POST" action="http://127.0.0.1:8787/api/save/"> key: <input type="text" name="key" /><br /> json: <input type="text" name="json" /><br /> <input type="submit" /> </form>
提交后，数据可能以以下形式发送：
key=arst&json=%7B%27arst%27%3A%27arst%27%7D
如果 GoRest 服务期望接收 JSON 数据，它将尝试将此 URL 编码的数据解析为 JSON 对象，从而导致解析错误。
解决方案：使用 JavaScript 和 AJAX 发送 JSON 数据
要解决此问题，需要使用 JavaScript 将表单数据格式化为 JSON，然后使用 AJAX 将其发送到服务器。
以下是一个示例，展示如何使用 JavaScript 将表单数据转换为 JSON 并通过 AJAX 发送：
<div>
<input type="hidden" name="endpont" value="http://127.0.0.1:8787/api/save/" />
key: <input type="text" name="key" id="keyInput" /><br />
json: <input type="text" name="json" id="jsonInput" /><br />
<input type="button" onclick="send_using_ajax();" />
</div>
<script>
function send_using_ajax() {
var key = document.getElementById("keyInput").value;
var json = document.getElementById("jsonInput").value;
var data = {
key: key,
json: json
};
var xhr = new XMLHttpRequest();
xhr.open("POST", "http://127.0.0.1:8787/api/save/", true);
xhr.setRequestHeader("Content-Type", "application/json");
xhr.onload = function () {
if (xhr.status === 200) {
console.log("Success:", xhr.responseText);
} else {
console.error("Error:", xhr.status, xhr.responseText);
}
};
xhr.send(JSON.stringify(data));
}
</script>代码解释：
- 获取表单数据: 使用 document.getElementById 获取 key 和 json 输入框的值。
- 构建 JSON 对象: 创建一个 JavaScript 对象 data，并将表单值赋给相应的键。
- 创建 XMLHttpRequest 对象: 创建一个新的 XMLHttpRequest 对象，用于发送 HTTP 请求。
-
配置请求:
- xhr.open("POST", "http://127.0.0.1:8787/api/save/", true); 指定请求方法为 POST，URL 为 API 端点，并设置为异步请求。
- xhr.setRequestHeader("Content-Type", "application/json"); 设置请求头 Content-Type 为 application/json，告诉服务器发送的是 JSON 数据。
- 处理响应: xhr.onload 函数处理服务器的响应。 如果状态码为 200 (OK)，则在控制台中记录成功消息；否则，记录错误消息。
- 发送请求: xhr.send(JSON.stringify(data)); 将 JavaScript 对象 data 转换为 JSON 字符串，并将其作为请求体发送到服务器。
GoRest 服务端代码修改
为了接收 JSON 数据，需要在 GoRest 服务端进行相应的修改。 确保 postdata 指向一个可以正确解析 JSON 数据的结构体。
package main
import (
"code.google.com/p/gorest"
"encoding/json"
"fmt"
"net/http"
)
func main() {
gorest.RegisterService(new(HelloService)) //Register our service
http.Handle("/", gorest.Handle())
http.ListenAndServe(":8787", nil)
}
// Service Definition
type HelloService struct {
gorest.RestService `root:"/api/"`
save gorest.EndPoint `method:"POST" path:"/save/" output:"string" postdata:"MyData"`
}
type MyData struct {
Key string `json:"key"`
Json string `json:"json"`
}
func (serv HelloService) Save(PostData MyData) string {
fmt.Println(PostData)
return "OK"
}
代码解释：
- 定义 MyData 结构体: 创建一个名为 MyData 的结构体，用于表示接收的 JSON 数据。 使用 json 标签指定 JSON 字段与结构体字段之间的映射关系。
- 修改 postdata: 将 postdata 从 map[string]string 修改为 MyData，告诉 GoRest 服务端期望接收 MyData 类型的 JSON 数据。
- 修改 Save 函数: 将 Save 函数的参数类型从 map[string]string 修改为 MyData。
- 返回字符串: 修改Save函数的返回值为string类型，并返回"OK"字符串，符合output:"string"的定义。
总结
通过使用 JavaScript 和 AJAX，可以控制客户端发送的数据格式，确保与服务器端期望的格式匹配。 在使用 GoRest 构建 API 时，务必注意客户端和服务器端的数据格式要求，并采取相应的措施来避免解析错误。 理解数据格式转换和 AJAX 的使用是构建健壮的 RESTful API 的关键。
