Starting from version GoFrame v1.11, the Request object provides native support for client-submitted JSON/XML data formats, offering developers more convenient data acquisition features to further improve development efficiency.

Example 1, Simple Example

  1. package main
  2. import (
  3. "github.com/gogf/gf/v2/frame/g"
  4. "github.com/gogf/gf/v2/net/ghttp"
  5. )
  6. func main() {
  7. s := g.Server()
  8. s.BindHandler("/", func(r *ghttp.Request) {
  9. r.Response.Writef("name: %v, pass: %v", r.Get("name"), r.Get("pass"))
  10. })
  11. s.SetPort(8199)
  12. s.Run()
  13. }

After execution, we use the curl tool to submit data for testing:

  1. Query Data Format
  1. $ curl "http://127.0.0.1:8199/?name=john&pass=123"
  2. name: john, pass: 123
  1. Form Submit Form
  1. $ curl -d "name=john&pass=123" "http://127.0.0.1:8199/"
  2. name: john, pass: 123
  1. JSON Data Format
  1. $ curl -d '{"name":"john","pass":"123"}' "http://127.0.0.1:8199/"
  2. name: john, pass: 123
  1. XML Data Format
  1. $ curl -d '<?xml version="1.0" encoding="UTF-8"?><doc><name>john</name><pass>123</pass></doc>' "http://127.0.0.1:8199/"
  2. name: john, pass: 123
  3. $ curl -d '<doc><name>john</name><pass>123</pass></doc>' "http://127.0.0.1:8199/"
  4. name: john, pass: 123

Example 2, Object Conversion and Validation

  1. package main
  2. import (
  3. "github.com/gogf/gf/v2/frame/g"
  4. "github.com/gogf/gf/v2/net/ghttp"
  5. "github.com/gogf/gf/v2/util/gvalid"
  6. )
  7. type RegisterReq struct {
  8. Name string `p:"username" v:"required|length:6,30#Please enter account|Account length should be between:{min} to:{max}"`
  9. Pass string `p:"password1" v:"required|length:6,30#Please enter password|Password is too short"`
  10. Pass2 string `p:"password2" v:"required|length:6,30|same:password1#Please confirm password|Password is too short|Passwords do not match"`
  11. }
  12. type RegisterRes struct {
  13. Code int `json:"code"`
  14. Error string `json:"error"`
  15. Data interface{} `json:"data"`
  16. }
  17. func main() {
  18. s := g.Server()
  19. s.BindHandler("/register", func(r *ghttp.Request) {
  20. var req *RegisterReq
  21. if err := r.Parse(&req); err != nil {
  22. // Validation error.
  23. if v, ok := err.(gvalid.Error); ok {
  24. r.Response.WriteJsonExit(RegisterRes{
  25. Code: 1,
  26. Error: v.FirstString(),
  27. })
  28. }
  29. // Other error.
  30. r.Response.WriteJsonExit(RegisterRes{
  31. Code: 1,
  32. Error: err.Error(),
  33. })
  34. }
  35. // ...
  36. r.Response.WriteJsonExit(RegisterRes{
  37. Data: req,
  38. })
  39. })
  40. s.SetPort(8199)
  41. s.Run()
  42. }

After execution, we use the curl tool to submit data for testing:

  1. JSON Data Format
  1. $ curl -d '{"username":"johngcn","password1":"123456","password2":"123456"}' "http://127.0.0.1:8199/register"
  2. {"code":0,"error":"","data":{"Name":"johngcn","Pass":"123456","Pass2":"123456"}}
  3. $ curl -d '{"username":"johngcn","password1":"123456","password2":"1234567"}' "http://127.0.0.1:8199/register"
  4. {"code":1,"error":"Passwords do not match","data":null}

As you can see, the JSON content we submitted is intelligently converted into a structure object by the Parse method.

  1. XML Data Format
  1. $ curl -d '<?xml version="1.0" encoding="UTF-8"?><doc><username>johngcn</username><password1>123456</password1><password2>123456</password2></doc>' "http://127.0.0.1:8199/register"
  2. {"code":0,"error":"","data":{"Name":"johngcn","Pass":"123456","Pass2":"123456"}}
  3. $ curl -d '<?xml version="1.0" encoding="UTF-8"?><doc><username>johngcn</username><password1>123456</password1><password2>1234567</password2></doc>' "http://127.0.0.1:8199/register"
  4. {"code":1,"error":"Passwords do not match","data":null}

As you can see, the XML content we submitted is also intelligently converted into a structure object by the Parse method.