这里是 iris.Context 提供的完整的方法列表。

    1. type (
    2.     BodyDecoder interface {
    3.         Decode(data []byte) error
    4.     }
    6.     Unmarshaler interface {
    7.         Unmarshal(data []byte, outPtr interface{}) error
    8.     }
    10.     UnmarshalerFunc func(data []byte, outPtr interface{}) error
    11. )
    13. func (u UnmarshalerFunc) Unmarshal(data []byte, v interface{}) error {
    14.     return u(data, v)
    15. }

    • BodyDecoder：

      • BodyDecoder 是一个接口，任何结构体都可以实现，以便于实现自定义读取JSON或者XML的 decode 行为。

    • 一个简单的例子：

      1.       type User struct { Username string }
      3.       func (u *User) Decode(data []byte) error {
      4.               return json.Unmarshal(data, u)
      5.       }
      • context.ReadJSON/ReadXML(&User{}) 将会调用 User 的Decode来解码请求体
      • 记住：这是完全可选的，默认的ReadJSON解码器是 encoding/json ，ReadXML解码器是 encoding/xml

    • Unmarshaler

      • 这是一个接口，实现了可以反序列化任何类型的原始数据。
      • 提示：任何值的指针实现了 BodyDecoder 将会覆写 unmarshaler。
    • UnmarshalerFunc
      • Unmarahsler 接口的快捷方式
      • 更多详情看 Unmarshaler 和 BodyDecoder

    • Unmarshal

      • 解析 x-encoded 的数据，并将结构存储到 v 指向的指针中。
      • Unmarshal 使用与 Marshal 使用的相反的编码，必须为map，slice和指针。
    • Context 是一个客户端在服务器的 “中间人对象”。一个新的 Context 是从每一个连接的一个 sync.Pool中获取的。 Context 是 Iris 的HTTP流上最重要的东西。开发者通过一个 Context 发送客户端请求的响应。开发者也从Context 中获取客户端请求的信息。
    1.     type Context interface {
    3.         BeginRequest(http.ResponseWriter, *http.Request)
    5.         EndRequest()
    7.         ResetResponseWriter(ResponseWriter)
    9.         Request() *http.Request
    11.         ResetRequest(r *http.Request)
    13.         SetCurrentRouteName(currentRouteName string)
    15.         GetCurrentRoute() RouteReadOnly
    17.         Do(Handlers)
    19.         AddHandler(...Handler)
    21.         SetHandlers(Handlers)
    23.         Handlers() Handlers
    25.         HandlerIndex(n int) (currentIndex int)
    27.         Proceed(Handler) bool
    29.         HandlerName() string
    31.         HandlerFileLine() (file string, line int)
    33.         RouteName() string
    35.         Next()
    37.         NextOr(handlers ...Handler) bool
    39.         NextOrNotFound() bool
    41.         NextHandler() Handler
    43.         Skip()
    45.         StopExecution()
    47.         IsStopped() bool
    49.         OnConnectionClose(fnGoroutine func()) bool
    51.         OnClose(cb func())
    53.         Params() *RequestParams
    55.         Values() *memstore.Store
    57.         Translate(format string, args ...interface{}) string
    59.         Method() string
    61.         Path() string
    63.         RequestPath(escape bool) string
    65.         Host() string
    67.         Subdomain() (subdomain string)
    69.         IsWWW() bool
    71.         FullRequestURI() string
    73.         RemoteAddr() string
    75.         GetHeader(name string) string
    77.         IsAjax() bool
    79.         IsMobile() bool
    81.         GetReferrer() Referrer
    83.         Header(name string, value string)
    85.         ContentType(cType string)
    87.         GetContentType() string
    89.         GetContentTypeRequested() string
    91.         GetContentLength() int64
    93.         StatusCode(statusCode int)
    95.         GetStatusCode() int
    97.         Redirect(urlToRedirect string, statusHeader ...int)
    99.         URLParamExists(name string) bool
    101.         URLParamDefault(name string, def string) string
    103.         URLParam(name string) string
    105.         URLParamTrim(name string) string
    107.         URLParamEscape(name string) string
    109.         URLParamInt(name string) (int, error)
    111.         URLParamIntDefault(name string, def int) int
    113.         URLParamInt32Default(name string, def int32) int32
    115.         URLParamInt64(name string) (int64, error)
    117.         URLParamInt64Default(name string, def int64) int64
    119.         URLParamFloat64(name string) (float64, error)
    121.         URLParamFloat64Default(name string, def float64) float64
    123.         URLParamBool(name string) (bool, error)
    125.         URLParams() map[string]string
    127.         FormValueDefault(name string, def string) string
    129.         FormValue(name string) string
    131.         FormValues() map[string][]string
    133.         PostValueDefault(name string, def string) string
    135.         PostValue(name string) string
    137.         PostValueTrim(name string) string
    139.         PostValueInt(name string) (int, error)
    141.         PostValueIntDefault(name string, def int) int
    143.         PostValueInt64(name string) (int64, error)
    145.         PostValueInt64Default(name string, def int64) int64
    147.         PostValueFloat64(name string) (float64, error)
    149.         PostValueFloat64Default(name string, def float64) float64
    151.         PostValueBool(name string) (bool, error)
    153.         PostValues(name string) []string
    155.         FormFile(key string) (multipart.File, *multipart.FileHeader, error)
    157.         UploadFormFiles(destDirectory string, before ...func(Context, *multipart.FileHeader)) (n int64, err error)
    159.         NotFound()
    161.         SetMaxRequestBodySize(limitOverBytes int64)
    163.         GetBody() ([]byte, error)
    165.         UnmarshalBody(outPtr interface{}, unmarshaler Unmarshaler) error
    167.         ReadJSON(jsonObjectPtr interface{}) error
    169.         ReadXML(xmlObjectPtr interface{}) error
    171.         ReadForm(formObject interface{}) error
    173.         ReadQuery(ptr interface{}) error
    175.         Write(body []byte) (int, error)
    177.         Writef(format string, args ...interface{}) (int, error)
    179.         WriteString(body string) (int, error)
    181.         SetLastModified(modtime time.Time)
    183.         CheckIfModifiedSince(modtime time.Time) (bool, error)
    185.         WriteNotModified()
    187.         WriteWithExpiration(body []byte, modtime time.Time) (int, error)
    189.         StreamWriter(writer func(w io.Writer) bool)
    191.         ClientSupportsGzip() bool
    193.         WriteGzip(b []byte) (int, error)
    195.         TryWriteGzip(b []byte) (int, error)
    197.         GzipResponseWriter() *GzipResponseWriter
    199.         Gzip(enable bool)
    201.         ViewLayout(layoutTmplFile string)
    203.         ViewData(key string, value interface{})
    205.         GetViewData() map[string]interface{}
    207.         View(filename string, optionalViewModel ...interface{}) error
    209.         Binary(data []byte) (int, error)
    211.         Text(format string, args ...interface{}) (int, error)
    213.         HTML(format string, args ...interface{}) (int, error)
    215.         JSON(v interface{}, options ...JSON) (int, error)
    217.         JSONP(v interface{}, options ...JSONP) (int, error)
    219.         XML(v interface{}, options ...XML) (int, error)
    221.         Markdown(markdownB []byte, options ...Markdown) (int, error)
    223.         YAML(v interface{}) (int, error)
    225.         ServeContent(content io.ReadSeeker, filename string, modtime time.Time, gzipCompression bool) error
    227.         ServeFile(filename string, gzipCompression bool) error
    229.         SendFile(filename string, destinationName string) error
    231.         SetCookie(cookie *http.Cookie, options ...CookieOption)
    233.         SetCookieKV(name, value string, options ...CookieOption)
    235.         GetCookie(name string, options ...CookieOption) string
    237.         RemoveCookie(name string, options ...CookieOption)
    239.         VisitAllCookies(visitor func(name string, value string))
    241.         MaxAge() int64
    243.         Record()
    245.         Recorder() *ResponseRecorder
    247.         IsRecording() (*ResponseRecorder, bool)
    249.         BeginTransaction(pipe func(t *Transaction))
    251.         SkipTransactions()
    253.         TransactionsSkipped() bool
    255.         Exec(method, path string)
    257.         RouteExists(method, path string) bool
    259.         Application() Application
    261.         String() string
    262.     }
    • BeginRequest(http.ResponseWriter, *http.Request) 
      1. - `BeginRequest` 对每个请求执行一次。
      • 它为新来的请求准备 context(新的或者从pool获取) 的字段。

      • 为了遵守 Iris 的流程，开发者应该：

        1.  1. 将处理器重置为 `nil`
        2.  2. 将值重置为空
        3.  3. 将session重置为 `nil`
        4.  4. 将响应writer重置为 `http.ResponseWriter`
        5.  5. 将请求重置为 `*http.Request`
      • 其他可选的步骤，视开发的应用程序类型而定
    • BeginRequest(http.ResponseWriter, *http.Request) 
      1. - 当发送完响应后执行一次，当前的 `context` 无用或者释放。
      • 为了遵守 Iris 的流程，开发者应该：
        1. 刷新响应 writer 的结果
        2. 释放响应 writer
      • 其他可选的步骤，视开发的应用程序类型而定
    • ResponseWriter() ResponseWriter 
      1. - 预期返回与 response writer 兼容的 `http.ResponseWriter`
    • ResetResponseWriter(ResponseWriter) 
      1. - 升级或者修改 `Context` 的 `ResponseWriter`
    • Request() *http.Request 
      1. - 按预期返回原始的 `*http.Request`
    • ResetRequest(r *http.Request) 
      1.     - 设置 `Context` 的 `Request`

      • 通过标准的 *http.Request 的 WithContext 方法创建的新请求存储到 iris.Context 中很有用。

        • 当你出于某种愿意要对 *http.Request 完全覆写时，使用 ResetRequest。

        • 记住，当你只想改变一些字段的时候，你可以使用Request() ，它返回一个 Request 的指针，因此在没有完全覆写的情况下，改变也是用效的。

        • 用法：你使用原生的 http 处理器，它使用的是标准库 context 来替代 iris.Context.Values，从而获取值。

          1.  r := ctx.Request()
          2.      stdCtx := context.WithValue(r.Context(), key, val)
          3.      ctx.ResetRequest(r.WithContext(stdCtx)).
    • SetCurrentRouteName(currentRouteName string) 
      1. - `SetCurrentRouteName` 在内部设置 route 的名字， 目的是为了开发人员调用 `GetCurrentRoute()` 函数时能找到正确的当前的 `只读` 路由。
      • 它被路由器初始化，如果你手动改变名字，除了通过 GetCurrentRoute() 函数你将会获取到别的 route 之外，没有什么其它影响。
      • 此外，要在该 context 执行不同路径的处理器，你应该使用 Exec 函数，或者通过 SetHandlers/AddHandler 函数改变头部信息。
    • GetCurrentRoute() RouteReadOnly 
      1. - 返回被这个请求路径注册的只读的路由。