响应

func (ctx *RequestContext) SetContentType(contentType string)
func (ctx *RequestContext) SetContentTypeBytes(contentType []byte)
func (ctx *RequestContext) SetConnectionClose()
func (ctx *RequestContext) SetStatusCode(statusCode int)
func (ctx *RequestContext) Status(code int)
func (ctx *RequestContext) NotFound()
func (ctx *RequestContext) NotModified()
func (ctx *RequestContext) Redirect(statusCode int, uri []byte)
func (ctx *RequestContext) Header(key, value string)
func (ctx *RequestContext) SetCookie(name, value string, maxAge int, path, domain string, sameSite protocol.CookieSameSite, secure, httpOnly bool)
func (ctx *RequestContext) AbortWithStatus(code int)
func (ctx *RequestContext) AbortWithError(code int, err error) *errors.Error

SetContentType

设置 Content-Type 。

函数签名:

func (ctx *RequestContext) SetContentType(contentType string)

示例:

h.GET("/user", func(c context.Context, ctx *app.RequestContext) {
    ctx.Write([]byte(`{"foo":"bar"}`))
    ctx.SetContentType("application/json; charset=utf-8")
})

SetContentTypeBytes

以 []byte 方式设置 Content-Type 。

函数签名:

func (ctx *RequestContext) SetContentTypeBytes(contentType []byte)

示例:

h.GET("/user", func(c context.Context, ctx *app.RequestContext) {
    ctx.Write([]byte(`{"foo":"bar"}`))
    ctx.SetContentType([]byte("application/json; charset=utf-8"))
})

SetConnectionClose

设置 Connection: close ，告知客户端服务器想关闭连接。

函数签名:

func (ctx *RequestContext) SetConnectionClose()

示例:

h.GET("/user", func(c context.Context, ctx *app.RequestContext) {
    ctx.SetConnectionClose()
})

SetStatusCode

设置 Status Code

函数签名:

func (ctx *RequestContext) SetStatusCode(statusCode int)

示例:

h.GET("/user", func(c context.Context, ctx *app.RequestContext) {
    ctx.SetStatusCode(consts.StatusOK)
})

Status

设置 Status Code，SetStatusCode 的别名。

函数签名:

func (ctx *RequestContext) Status(code int)

NotFound

设置 Status Code 代码为 404 。

函数签名:

func (ctx *RequestContext) NotFound()

NotModified

设置 Status Code 代码为 304 。

函数签名:

func (ctx *RequestContext) NotModified()

Redirect

设置 Status Code 代码以及要跳转的地址。

函数签名:

func (ctx *RequestContext) Redirect(statusCode int, uri []byte)

示例:

h.GET("/user", func(c context.Context, ctx *app.RequestContext) {
    ctx.Redirect(consts.StatusFound, []byte("/pet"))
})

h.GET("/pet", func(c context.Context, ctx *app.RequestContext) {
    ctx.String(consts.StatusOK, "cat")
})

Header

设置或删除指定 Header 。

函数签名:

func (ctx *RequestContext) Header(key, value string)

示例:

h.GET("/user", func(c context.Context, ctx *app.RequestContext) {
    ctx.Header("My-Name", "tom")
    ctx.Header("My-Name", "")
    ctx.Header("My-Name-Not-Exists", "yes")
})

SetCookie

设置 Cookie 。(更多内容请参考 hertz-examples/parameter/cookie)

函数签名:

func (ctx *RequestContext) SetCookie(name, value string, maxAge int, path, domain string, sameSite protocol.CookieSameSite, secure, httpOnly bool)

示例:

h.GET("/user", func(c context.Context, ctx *app.RequestContext) {
    ctx.SetCookie("user", "hertz", 1, "/", "localhost", protocol.CookieSameSiteLaxMode, true, true)
})

AbortWithStatus

设置 Status Code 并终止后续的 Handler。

函数签名:

func (ctx *RequestContext) AbortWithStatus(code int)

示例:

h.GET("/user", func(c context.Context, ctx *app.RequestContext) {
    ctx.AbortWithStatus(consts.StatusOK)
}, func(c context.Context, ctx *app.RequestContext) {
    // will not execute
})

AbortWithError

设置 Status Code 收集 Error 并终止后续的 Handler，返回 Error。(更多内容请参考 RequestContext/Error)

函数签名:

func (ctx *RequestContext) AbortWithError(code int, err error) *errors.Error

示例:

h.GET("/user", func(c context.Context, ctx *app.RequestContext) {
    err := ctx.AbortWithError(consts.StatusOK)
}, func(c context.Context, ctx *app.RequestContext) {
    // will not execute
})

ResponseHeader 对象

使用 RequestContext.Response.Header 获取 ResponseHeader 对象，它与 RequestHeader 对象及提供的函数基本一致。

Body

func (ctx *RequestContext) SetBodyStream(bodyStream io.Reader, bodySize int)
func (ctx *RequestContext) SetBodyString(body string)
func (ctx *RequestContext) Write(p []byte) (int, error)
func (ctx *RequestContext) WriteString(s string) (int, error)
func (ctx *RequestContext) Render(code int, r render.Render)
func (ctx *RequestContext) String(code int, format string, values ...interface{})
func (ctx *RequestContext) ProtoBuf(code int, obj interface{})
func (ctx *RequestContext) JSON(code int, obj interface{})
func (ctx *RequestContext) PureJSON(code int, obj interface{})
func (ctx *RequestContext) IndentedJSON(code int, obj interface{})
func (ctx *RequestContext) HTML(code int, name string, obj interface{})
func (ctx *RequestContext) Data(code int, contentType string, data []byte)
func (ctx *RequestContext) XML(code int, obj interface{})
func (ctx *RequestContext) File(filepath string)
func (ctx *RequestContext) FileAttachment(filepath, filename string)
func (ctx *RequestContext) FileFromFS(filepath string, fs *FS)
func (ctx *RequestContext) AbortWithMsg(msg string, statusCode int)
func (ctx *RequestContext) AbortWithStatusJSON(code int, jsonObj interface{})

SetBodyStream

设置 Body Stream 和可选的 Body 大小。

函数签名:

func (ctx *RequestContext) SetBodyStream(bodyStream io.Reader, bodySize int)

示例:

h.GET("/user", func(c context.Context, ctx *app.RequestContext) {
    data := "hello world"
    r := strings.NewReader(data)
    ctx.SetBodyStream(r, -1) // Body: "hello world"
})

h.GET("/user1", func(c context.Context, ctx *app.RequestContext) {
    data := "hello world"
    r1 := strings.NewReader(data)
    ctx.SetBodyStream(r1, 5) // Body: "hello"
})

SetBodyString

设置 Body 。

函数签名:

func (ctx *RequestContext) SetBodyString(body string)

示例:

h.GET("/user", func(c context.Context, ctx *app.RequestContext) {
    ctx.SetBodyString("hello world") // Body: "hello world"
})

Write

将 p 添加到 Body 中。

函数签名:

func (ctx *RequestContext) Write(p []byte) (int, error)

示例:

h.GET("/user", func(c context.Context, ctx *app.RequestContext) {
    ctx.Write([]byte("hello"))
    ctx.Write([]byte(" "))
    ctx.Write([]byte("world"))
    // Body: "hello world"
})

WriteString

设置 Body 并返回大小。

函数签名:

func (ctx *RequestContext) WriteString(s string) (int, error)

示例:

h.GET("/user", func(c context.Context, ctx *app.RequestContext) {
    size, _ := ctx.WriteString("hello world")// Body: "hello world", size == 11
})

Render

设置 Status Code 并通过 Render 设置 ContentType 和 Body。(更多内容请参考 server/render)

函数签名:

func (ctx *RequestContext) Render(code int, r render.Render)

示例:

h.GET("/user", func(c context.Context, ctx *app.RequestContext) {
    ctx.Render(consts.StatusOK, render.String{
        Format: "%s %s",
        Data:   []interface{}{"hello", "world"},
    })
    // Status Code: 200
    // Content-Type: text/plain; charset=utf-8 
    // Body: hello world
})

String

设置 Status Code 以及通过 render.String 设置 Body。

函数签名:

func (ctx *RequestContext) String(code int, format string, values ...interface{})

示例:

h.GET("/user", func(c context.Context, ctx *app.RequestContext) {
    ctx.String(consts.StatusOK, "%s %s", "hello", "world")
    // Status Code: 200
    // Content-Type: text/plain; charset=utf-8 
    // Body: hello world
})

ProtoBuf

设置 Status Code 以及通过 render.ProtoBuf 设置 Body。(更多内容请参考 TestProtobuf)

函数签名:

func (ctx *RequestContext) ProtoBuf(code int, obj interface{})

示例:

h.GET("/user", func(c context.Context, ctx *app.RequestContext) {
    obj := yourProtoStruct{...} // your proto struct here
    ctx.ProtoBuf(consts.StatusOK, &obj)
})

JSON

设置 Status Code 以及通过 render.JSONRender 设置 Body。

函数签名:

func (ctx *RequestContext) JSON(code int, obj interface{})

示例:

h.GET("/user", func(c context.Context, ctx *app.RequestContext) {
    ctx.JSON(consts.StatusOK, utils.H{
        "foo":  "bar",
        "html": "<b>",
    })
    // Status Code: 200
    // Content-Type: application/json; charset=utf-8 
    // Body: {"foo":"bar","html":"\u003cb\u003e"}
})

PureJSON

设置 Status Code 以及通过 render.PureJSON 设置 Body。

注意: 与 JSON 不同，PureJSON 不会用 unicode 字符替换 html 特殊字符。

函数签名:

func (ctx *RequestContext) PureJSON(code int, obj interface{})

示例:

h.GET("/user", func(c context.Context, ctx *app.RequestContext) {
    ctx.JSON(consts.StatusOK, utils.H{
        "foo":  "bar",
        "html": "<b>",
    })
    // Status Code: 200
    // Content-Type: application/json; charset=utf-8 
    // Body: {"foo":"bar","html":"<b>"}
})

IndentedJSON

设置 Status Code 以及通过 render.IndentedJSON 设置 Body。

注意: 与 JSON 不同，IndentedJSON 会提供换行与缩进。

函数签名:

func (ctx *RequestContext) IndentedJSON(code int, obj interface{})

示例:

h.GET("/user", func(c context.Context, ctx *app.RequestContext) {
    ctx.JSON(consts.StatusOK, utils.H{
        "foo":  "bar",
        "html": "<b>",
    })
    // Status Code: 200
    // Content-Type: application/json; charset=utf-8 
    // Body:
    // {
    //     "foo": "bar",
    //     "html": "\u003cb\u003e"
    // }
})

HTML

设置 Status Code 以及通过 render.HTML 设置 Body。(更多内容请参考 hertz-examples/render/html)

函数签名:

func (ctx *RequestContext) HTML(code int, name string, obj interface{})

示例:

h.Delims("{[{", "}]}")
h.LoadHTMLGlob("render/html/*")

h.GET("/index", func(c context.Context, ctx *app.RequestContext) {
    ctx.HTML(http.StatusOK, "index.tmpl", utils.H{
        "title": "Main website",
    })
})

Data

设置 Status Code 以及通过 render.Data 设置 Body。

函数签名:

func (ctx *RequestContext) Data(code int, contentType string, data []byte)

示例:

h.GET("/user", func(c context.Context, ctx *app.RequestContext) {
    data := []byte(`{"foo":"bar","html":"<b>"}`)
    ctx.Data(consts.StatusOK, "application/json; charset=utf-8", data)
    // Status Code: 200
    // Content-Type: application/json; charset=utf-8 
    // Body: {"foo":"bar","html":"<b>"}
})

XML

设置 Status Code 以及通过 render.XML 设置 Body。

函数签名:

func (ctx *RequestContext) XML(code int, obj interface{})

示例:

h.GET("/user", func(c context.Context, ctx *app.RequestContext) {
    type User struct {
        XMLName  xml.Name `xml:"user"`
        UserName string   `xml:"userName"`
        UserAge  int64    `xml:"userAge"`
    }

    ctx.XML(consts.StatusOK, &User{
        UserName: "foo",
        UserAge:  10,
    })
    // Status Code: 200
    // Content-Type: application/xml; charset=utf-8 
    // Body: <user><userName>foo</userName><userAge>10</userAge></user>
})

File

将指定文件写入到 Body Stream 。

函数签名:

func (ctx *RequestContext) File(filepath string)

示例:

h.GET("/user", func(c context.Context, ctx *app.RequestContext) {
    ctx.File("./main.go")
})

FileAttachment

将指定文件写入到 Body Stream 并通过 Content-Disposition 指定为下载。

函数签名:

func (ctx *RequestContext) FileAttachment(filepath, filename string)

示例:

h.GET("/user", func(c context.Context, ctx *app.RequestContext) {
    ctx.FileAttachment("./main.go")
})

FileFromFS

将指定文件写入到 Body Stream 。

函数签名:

func (ctx *RequestContext) FileFromFS(filepath string, fs *FS)

示例:

h.GET("/user", func(c context.Context, ctx *app.RequestContext) {
    ctx.FileFromFS("./main.go", &app.FS{
        Root:               ".",
        IndexNames:         nil,
        GenerateIndexPages: false,
        AcceptByteRange:    true,
    })
})

AbortWithMsg

设置 Status Code 和 Body 并终止后续的 Handler。

函数签名:

func (ctx *RequestContext) AbortWithMsg(msg string, statusCode int)

示例:

h.GET("/user", func(c context.Context, ctx *app.RequestContext) {
    ctx.AbortWithMsg("abort", consts.StatusOK)
}, func(c context.Context, ctx *app.RequestContext) {
    // will not execute
})

AbortWithStatusJSON

设置 Status Code 和 Json 格式 Body 并终止后续的 Handler。

函数签名:

func (ctx *RequestContext) AbortWithStatusJSON(code int, jsonObj interface{})

示例:

 h.GET("/user", func(c context.Context, ctx *app.RequestContext) {
  ctx.AbortWithStatusJSON(consts.StatusOK, utils.H{
   "foo":  "bar",
   "html": "<b>",
  })
 }, func(c context.Context, ctx *app.RequestContext) {
  // will not execute
 })

其他

func (ctx *RequestContext) Flush() error 
func (ctx *RequestContext) GetResponse() (dst *protocol.Response)

Flush

把数据刷入被劫持的 Response Writer 中。(更多内容请参考 response_writer)

函数签名:

func (ctx *RequestContext) Flush() error

GetResponse

获取 Response 对象。

函数签名:

func (ctx *RequestContext) GetResponse() (dst *protocol.Response)

反馈

当前页面对你有帮助吗？

请告诉我们如何改进.

最后修改 April 20, 2023 : doc: context (7ebac71)