Abort |
中断请求的后续处理链,但不影响当前正在执行的处理 |
|
AbortWithError |
中断请求的后续处理链,并将错误信息记录到c.Errors 切片中 |
内部调用AbortWithStatus 和Error |
AbortWithStatus |
中断请求的后续处理链,并在响应头中返回指定的HTTP状态码 |
内部调用Status 和Abort |
AbortWithStatusJSON |
中断请求的后续处理链,并在响应头中返回指定的HTTP状态码 ,响应体中返回指定的JSON |
内部调用Abort 和JSON |
AddParam |
将参数添加到Gin 的上下文对象中;另一个重要作用是为了端到端测试 |
|
AsciiJSON |
将一个结构体序列化为JSON 格式(其中的Unicode 字符转换为ASCII 字符)响应 |
|
Bind |
根据请求的方法和Content-Type 头信息自动选择合适的绑定引擎,将请求体中的数据解析并绑定到指定的结构体指针中 |
内部调用MustBindWith |
BindHeader |
使用binding.Header 绑定请求的数据 |
内部调用MustBindWith |
BindJSON |
使用binding.JSON 绑定请求的数据 |
内部调用MustBindWith |
BindQuery |
使用binding.Query 绑定请求的数据 |
内部调用MustBindWith |
BindTOML |
使用binding.TOML 绑定请求的数据 |
内部调用MustBindWith |
BindUri |
将请求的URI (统一资源标识符)中的参数绑定到传入的结构体指针指向的结构体上 |
内部调用ShouldBindUri |
BindWith |
使用指定的绑定引擎将请求的数据绑定到传入的结构体指针指向的结构体上 |
已弃用,建议使用MustBindWith 或ShouldBindWith |
BindXML |
使用binding.XML 绑定请求的数据 |
内部调用MustBindWith |
BindYAML |
使用binding.YAML 绑定请求的数据 |
内部调用MustBindWith |
ClientIP |
通过一种尽力而为的算法来获取发起请求的真实客户端IP地址 |
|
ContentType |
返回请求中Content-Type 请求头的值 |
|
Cookie |
从请求中获取指定名称的Cookie 值 |
返回的Cookie 值是经过反编码处理的,且同名的Cookie 只会返回其中一个 |
Copy |
返回当前上下文的一个副本 |
需要将上下文传递给一个新的goroutine 时必须使用 |
Data |
将指定的数据写入响应的主体流中,同时更新响应的状态码 |
内部调用Render |
DataFromReader |
将指定的io.Reader 中的数据写入到响应的主体流中,同时更新响应的状态码 |
内部调用Render |
Deadline |
返回该上下文的截止时间 |
|
DefaultPostForm |
从POST 请求的application/x-www-form-urlencoded 格式表单或multipart/form-data 格式表单中获取指定键对应的值,若不存在则使用默认值 |
内部使用GetPostForm |
DefaultQuery |
从请求的URL 查询字符串中获取指定键对应的值,若不存在则使用默认值 |
内部使用GetQuery |
Done |
返回一个只读通道,当上下文被取消(比如调用c.CancelFunc )或者超时(使用c.WithTimeout 等方法)时,该通道会被关闭。可以通过监听这个通道来感知上下文的状态变化,从而做出相应的处理 |
|
Err |
用于获取上下文被取消或超时时的错误信息 |
|
Error |
将错误信息附加到当前的上下文(Context)中的错误列表里,以便后续统一处理 |
传入nil 错误会导致panic |
File |
将指定的文件以高效的方式写入响应的主体流中 |
|
FileAttachment |
将指定的文件以高效的方式写入响应的主体流中,并设置响应头中的Content-Disposition 字段 |
|
FileFromFS |
从指定的http.FileSystem 中读取文件,并将文件内容以高效的方式写入响应的主体流中 |
|
FormFile |
从POST 请求的表单数据(通常是multipart/form-data 格式)中获取指定表单键对应的第一个文件 |
|
FullPath |
返回当前请求所匹配到的路由的完整路径 |
|
Get |
从上下文中获取指定键对应的值,同时返回该键是否存在 |
|
GetBool |
从上下文中获取指定键对应的值,并将其转换为bool 类型返回 |
内部调用Get |
GetDuration |
从上下文中获取指定键对应的值,并将其转换为duration 类型返回 |
内部调用Get |
GetFloat64 |
从上下文中获取指定键对应的值,并将其转换为float64 类型返回 |
内部调用Get |
GetHeader |
从请求头中获取指定键对应的值 |
|
GetInt |
从上下文中获取指定键对应的值,并将其转换为int 类型返回 |
内部调用Get |
GetInt64 |
从上下文中获取指定键对应的值,并将其转换为int64 类型返回 |
内部调用Get |
GetPostForm |
从POST 请求的application/x-www-form-urlencoded 格式表单或multipart/form-data 格式表单中获取指定键对应的值 |
内部调用GetPostFormArray |
GetPostFormArray |
从POST 请求的application/x-www-form-urlencoded 格式表单或multipart/form-data 格式表单中获取指定键对应的所有值,并以字符串切片的形式返回;同时返回该键是否至少存在一个与之对应的值 |
|
GetPostFormMap |
从POST 请求的表单数据里获取指定键对应的map 类型的值,并返回该键是否存在 |
|
GetQuery |
从请求的URL 查询字符串中获取指定键对应的值,并返回该键是否存在 |
内部调用GetQueryArray |
GetQueryArray |
从请求的URL 查询字符串中获取指定键对应的所有值,并以字符串切片的形式返回;同时返回该键是否至少存在一个与之对应的值 |
|
GetQueryMap |
从请求的URL 查询字符串里获取指定键对应的map 类型的值,并返回该键是否存在 |
|
GetRawData |
获取请求体中的原始数据流数据 |
|
GetString |
从上下文中获取指定键对应的值,并将其转换为string 类型返回 |
内部调用Get |
GetStringMap |
从上下文中获取指定键对应的值,并将其转换为map[string]any 类型返回 |
内部调用Get |
GetStringMapString |
从上下文中获取指定键对应的值,并将其转换为map[string]string 类型返回 |
内部调用Get |
GetStringMapStringSlice |
从上下文中获取指定键对应的值,并将其转换为map[string][]string 类型返回 |
内部调用Get |
GetStringSlice |
从上下文中获取指定键对应的值,并将其转换为[]string 类型返回 |
内部调用Get |
GetTime |
从上下文中获取指定键对应的值,并将其转换为time.Time 类型返回 |
内部调用Get |
GetUint |
从上下文中获取指定键对应的值,并将其转换为uint 类型返回 |
内部调用Get |
GetUint64 |
从上下文中获取指定键对应的值,并将其转换为uint64 类型返回 |
内部调用Get |
HTML |
渲染指定文件名的HTTP 模板,同时更新响应状态码 |
|
Handler |
返回主处理器,即最后一个处理函数 |
|
HandlerName |
返回主处理器的名称 |
名称会包含包名 |
HandlerNames |
返回当前上下文中所有已注册处理器的名称列表 |
|
Header |
设置响应头信息,若值为空字符串则删除对应项 |
|
IndentedJSON |
将给定的结构体序列化为格式化后的JSON (带有缩进和换行符)写入响应体 |
比较消耗资源和带宽 |
IsAborted |
判断当前的上下文是否已经被中止 |
|
IsWebsocket |
判断客户端发送的请求是否是WebSocket 握手 |
|
JSON |
将给定的结构体序列化为JSON 写入响应体 |
响应的Content-Type 为application/json |
JSONP |
将给定的结构体序列化为JSON 格式,并在响应体中添加填充以实现从与客户端不同域名的服务器请求数据 |
响应的Content-Type 为application/javascript |
MultipartForm |
获取multipart/form-data 类型的表单请求的解析结果,包含了表单中的所有字段和上传的文件信息 |
|
MustBindWith |
使用指定的绑定引擎将请求的数据绑定到传入的结构体指针上 |
内部调用ShouldBindWith |
MustGet |
从上下文中获取指定键对应的值,若不存在则触发panic |
内部调用Get |
Negotiate |
根据客户端请求头中Accept 字段指定的可接受格式,调用不同的渲染器生成合适的响应内容 |
内部用到了NegotiateFormat |
NegotiateFormat |
从客户端请求头的Accept 字段里,结合服务器所支持的格式,协商出一个可接受的响应格式并返回 |
|
Next |
用于中间件中,让当前处理流程继续执行后续的中间件和最终的处理函数,当后续的处理完成后,控制权会返回到调用Next 方法的位置,继续执行该中间件剩余的代码 |
专为中间件设计,不应在普通的路由处理函数中使用 |
Param |
从URL 路径中提取指定参数的值 |
|
PostForm |
从POST 请求的application/x-www-form-urlencoded 格式表单或multipart/form-data 格式表单中获取指定键对应的值 |
内部调用GetPostForm |
PostFormArray |
从POST 请求的application/x-www-form-urlencoded 格式表单或multipart/form-data 格式表单中获取指定键对应的所有值 |
内部调用GetPostFormArray |
PostFormMap |
从POST 请求的表单数据中获取指定表单键所对应的map[string]string 类型的值 |
内部调用GetPostFormMap |
ProtoBuf |
将给定的结构体序列化为ProtoBuf 写入响应体 |
|
PureJSON |
将给定的结构体序列化为JSON 写入响应体,但会直接保留原始的特殊HTML 字符 |
|
Query |
从请求的URL 查询字符串中获取指定键对应的值,若不存在返回空字符串 |
内部调用GetQuery |
QueryArray |
从请求的URL 查询字符串中获取指定键对应的所有值,并以字符串切片的形式返回 |
内部调用GetQueryArray |
QueryMap |
从请求的URL 查询字符串中获取指定键对应的map[string]string 值 |
内部调用GetQuery |
Redirect |
将客户端的请求重定向到指定的位置 |
|
RemoteIP |
从请求的Request.RemoteAddr 字段中解析出客户端的IP地址 |
|
Render |
设置响应头信息,然后调用传入的渲染器的Render 方法来将数据渲染到响应体中 |
|
SSEvent |
向响应的主体流中写入一个服务器发送事件SSE |
单向通信,即只能服务器向客户端推送数据 |
SaveUploadedFile |
将客户端通过表单上传的文件保存到服务器指定的目标路径 |
|
SecureJSON |
将给定的结构体序列化为JSON 写入响应体,若数据为数组则在前面添加安全前缀 |
默认前缀为while(1), |
Set |
在当前的上下文中存储一个新的键值对 |
常用于在不同中间件和处理函数之间方便地共享数据 |
SetAccepted |
设置请求头中的Accept 字段的数据 |
|
SetCookie |
在响应头中添加Set-Cookie 字段,从而在客户端浏览器中设置Cookie |
|
SetSameSite |
设置Cookie 的SameSite 属性 |
|
ShouldBind |
依据请求的方法和Content-Type 头,自动挑选合适的绑定引擎,把请求体中的数据绑定到指定的结构体指针上 |
绑定失败不会自动设置响应状态码或终止请求处理。内部调用ShouldBindWith |
ShouldBindBodyWith |
使用指定的绑定引擎将请求中的数据绑定到传入的结构体指针上,但会将请求体的数据存储在上下文中 |
|
ShouldBindBodyWithJSON |
使用binding.JSON 绑定引擎将请求中的数据绑定到传入的结构体指针上,并将请求体的数据存储在上下文中 |
内部调用ShouldBindBodyWith |
ShouldBindBodyWithTOML |
使用binding.TOML 绑定引擎将请求中的数据绑定到传入的结构体指针上,并将请求体的数据存储在上下文中 |
内部调用ShouldBindBodyWith |
ShouldBindBodyWithXML |
使用binding.XML 绑定引擎将请求中的数据绑定到传入的结构体指针上,并将请求体的数据存储在上下文中 |
内部调用ShouldBindBodyWith |
ShouldBindBodyWithYAML |
使用binding.YAML 绑定引擎将请求中的数据绑定到传入的结构体指针上,并将请求体的数据存储在上下文中 |
内部调用ShouldBindBodyWith |
ShouldBindHeader |
使用binding.Header 绑定引擎将请求中的数据绑定到传入的结构体指针上 |
内部调用ShouldBindWith |
ShouldBindJSON |
使用binding.JSON 绑定引擎将请求中的数据绑定到传入的结构体指针上 |
内部调用ShouldBindWith |
ShouldBindQuery |
使用binding.Query 绑定引擎将请求中的数据绑定到传入的结构体指针上 |
内部调用ShouldBindWith |
ShouldBindTOML |
使用binding.TOML 绑定引擎将请求中的数据绑定到传入的结构体指针上 |
内部调用ShouldBindWith |
ShouldBindUri |
使用指定的绑定引擎将请求的URI 中的参数绑定到传入的结构体指针所指向的结构体实例上 |
|
ShouldBindWith |
使用指定的绑定引擎将请求中的数据绑定到传入的结构体指针上 |
|
ShouldBindXML |
使用binding.XML 绑定引擎将请求中的数据绑定到传入的结构体指针上 |
内部调用ShouldBindWith |
ShouldBindYAML |
使用binding.YAML 绑定引擎将请求中的数据绑定到传入的结构体指针上 |
内部调用ShouldBindWith |
Status |
设置响应的状态码 |
|
Stream |
用于发送流式响应 |
|
String |
将给定的字符串写入响应体中 |
|
TOML |
将给定的结构体序列化为TOML 写入响应体 |
|
Value |
从当前的Context 中获取与指定键关联的值 |
内部调用Get |
XML |
将给定的结构体序列化为XML 写入响应体 |
|
YAML |
将给定的结构体序列化为YAML 写入响应体 |
|