gf/net/ghttp/ghttp_request_param_ctx.go

66 lines
1.9 KiB
Go
Raw Normal View History

2021-01-17 21:46:25 +08:00
// Copyright GoFrame Author(https://goframe.org). All Rights Reserved.
//
// This Source Code Form is subject to the terms of the MIT License.
// If a copy of the MIT was not distributed with this file,
// You can obtain one at https://github.com/gogf/gf.
package ghttp
import (
"context"
2021-11-13 23:23:55 +08:00
2021-10-11 21:41:56 +08:00
"github.com/gogf/gf/v2/container/gvar"
"github.com/gogf/gf/v2/os/gctx"
)
// RequestFromCtx retrieves and returns the Request object from context.
func RequestFromCtx(ctx context.Context) *Request {
if v := ctx.Value(ctxKeyForRequest); v != nil {
return v.(*Request)
}
return nil
}
2020-04-06 22:31:45 +08:00
// Context is alias for function GetCtx.
// This function overwrites the http.Request.Context function.
2020-04-06 22:31:45 +08:00
// See GetCtx.
func (r *Request) Context() context.Context {
if r.context == nil {
// DO NOT use the http context as it will be canceled after request done,
// which makes the asynchronous goroutine encounter "context canceled" error.
// r.context = r.Request.Context()
r.context = gctx.New()
}
// Inject Request object into context.
if RequestFromCtx(r.context) == nil {
r.context = context.WithValue(r.context, ctxKeyForRequest, r)
}
return r.context
}
2020-04-06 22:31:45 +08:00
// GetCtx retrieves and returns the request's context.
func (r *Request) GetCtx() context.Context {
return r.Context()
}
2020-12-18 22:57:08 +08:00
// SetCtx custom context for current request.
func (r *Request) SetCtx(ctx context.Context) {
r.context = ctx
}
// GetCtxVar retrieves and returns a Var with given key name.
// The optional parameter `def` specifies the default value of the Var if given `key`
2020-04-06 22:31:45 +08:00
// does not exist in the context.
func (r *Request) GetCtxVar(key interface{}, def ...interface{}) *gvar.Var {
value := r.Context().Value(key)
if value == nil && len(def) > 0 {
value = def[0]
}
return gvar.New(value)
}
// SetCtxVar sets custom parameter to context with key-value pair.
func (r *Request) SetCtxVar(key interface{}, value interface{}) {
r.context = context.WithValue(r.Context(), key, value)
}