GoFrame 请求输入-基本介绍
请求输入依靠 ghttp.Request
对象实现,ghttp.Request
继承了底层的http.Request
对象。ghttp.Request
包含一个与当前请求对应的返回输出对象Response
,用于数据的返回处理。
相关方法: https://pkg.go.dev/github.com/gogf/gf/v2/net/ghttp
简要说明
可以看到Request
对象的参数获取方法非常丰富,可以分为以下几类:
-
Get
: 常用方法,简化参数获取,GetRequest
的别名。 -
GetQuery
: 获取GET
方式传递过来的参数,包括Query String
及Body
参数解析。 -
GetForm
: 获取表单方式传递过来的参数,表单方式提交的参数Content-Type
往往为application/x-www-form-urlencoded
, application/form-data
, multipart/form-data
, multipart/mixed
等等。 -
GetRequest
: 获取客户端提交的参数,不区分提交方式。 -
Get*Struct
: 将指定提交类型的所有请求参数绑定到指定的struct
对象上,注意给定的参数为对象指针。绝大部分场景中往往使用Parse
方法将请求数据转换为请求对象,具体详见后续章节。 -
GetBody/GetBodyString
: 获取客户端提交的原始数据,该数据是客户端写入到body
中的原始数据,与HTTP Method
无关,例如客户端提交JSON/XML
数据格式时可以通过该方法获取原始的提交数据。 -
GetJson
: 自动将原始请求信息解析为gjson.Json
对象指针返回。 -
Exit*
: 用于请求流程退出控制,详见本章后续说明;
提交方式
GoFrame
框架的参数获取不是通过HTTP Method
来做区分,而是通过参数提交类型来区分。例如,分别通过HTTP Method: POST、INPUT、DELETE
来提交表单参数,在服务端获取参数不是通过GetPost/GetInput/GetDelete
的方式来获取,而是统一通过GetForm
方法来获取表单参数,针对其他的HTTP Method
也是如此。
在GoFrame
框架下,有以下几种提交类型:
-
Router
: 路由参数,来源于路由规则匹配。 -
Query
: URL
中的Query String
参数解析,如:http://127.0.0.1/index?id=1&name=john 中的id=1&name=john
。 -
Form
: 表单提交参数,最常见的提交方式,提交的Content-Type
往往为:application/x-www-form-urlencoded
、multipart/form-data
、multipart/mixed
。 -
Body
: 原始提交内容,从Body
中获取并解析得到的参数,JSON/XML
请求往往使用这种方式提交。 -
Custom
: 自定义参数,往往在服务端的中间件、服务函数中通过SetParam/GetParam
方法管理。
参数类型
获取的参数方法可以对指定键名的数据进行自动类型转换,例如:http://127.0.0.1:8199/?amount=19.66,通过Get(xxx).String()
将会返回19.66
的字符串类型,Get(xxx).Float32()/Get(xxx).Float64()
将会分别返回float32
和float64
类型的数值19.66
。但是,Get(xxx).Int()/Get(xxx).Uint()
将会返回19
(如果参数为float
类型的字符串,将会按照向下取整进行整型转换)。
聪明的您一定发现了,获取到的参数都是泛型变量,根据该泛型变量再根据需要调用对应的方法转换为对应的数据类型。
使用示例:
package main
import (
"github.com/gogf/gf/v2/frame/g"
"github.com/gogf/gf/v2/net/ghttp"
)
func main() {
s := g.Server()
s.BindHandler("/", func(r *ghttp.Request) {
r.Response.Writeln(r.Get("amount").String())
r.Response.Writeln(r.Get("amount").Int())
r.Response.Writeln(r.Get("amount").Float32())
})
s.SetPort(8199)
s.Run()
}
执行后我们访问地址 http://127.0.0.1:8199/?amount=19.66 页面输出
19.66
19
19.66
参数优先级
我们考虑一种场景,当不同的提交方式中存在同名的参数名称会怎么样?在GoFrame
框架下,我们根据不同的获取方法,将会按照不同的优先级进行获取,优先级高的方式提交的参数将会优先覆盖其他方式的同名参数。优先级规则如下:
-
Get
及GetRequset
方法:Router < Query < Body < Form < Custom
,也就是说自定义参数的优先级最高,其次是Form
表单参数,再次是Body
提交参数,以此类推。例如,Query
和Form
中都提交了同样名称的参数id,参数值分别为1和2,那么Get("id")/GetForm("id")
将会返回2,而GetQuery("id")
将会返回1。 -
GetQuery
方法:Query > Body
,也就是说query string
的参数将会覆盖Body
中提交的同名参数。例如,Query
和Body
中都提交了同样名称的参数id
,参数值分别为1和2,那么Get("id")
将会返回2,而GetQuery("id")
将会返回1。 -
GetForm
方法:由于该类型的方法仅用于获取Form
表单参数,因此没什么优先级的差别。
使用示例:
package main
import (
"github.com/gogf/gf/v2/frame/g"
"github.com/gogf/gf/v2/net/ghttp"
)
func main() {
s := g.Server()
s.BindHandler("/input", func(r *ghttp.Request) {
r.Response.Writeln(r.Get("amount"))
})
s.BindHandler("/query", func(r *ghttp.Request) {
r.Response.Writeln(r.GetQuery("amount"))
})
s.SetPort(8199)
s.Run()
}
执行后,我们通过curl
工具进行测试:
$ curl -d "amount=1" -X POST "http://127.0.0.1:8199/input?amount=100"
1
$ curl -d "amount=1" -X POST "http://127.0.0.1:8199/query?amount=100"
100
可以看到,当我们访问/input
路由时,该路由方法中采用了Get
方法获取amount
参数,按照同名优先级的规则返回了1,即body
中传递的参数。而当我们通过/query
路由访问时,该路由方法内部使用了GetQuery
方法获取amount
参数,因此获取到的是query string
参数中的amount
值,返回了100。