mirror of
https://gitee.com/johng/gf.git
synced 2024-12-03 20:58:47 +08:00
254 lines
8.0 KiB
Go
254 lines
8.0 KiB
Go
// Copyright 2017 gf Author(https://github.com/gogf/gf). 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 (
|
||
"fmt"
|
||
"io/ioutil"
|
||
"net/http"
|
||
"strings"
|
||
|
||
"github.com/gogf/gf/os/gsession"
|
||
|
||
"github.com/gogf/gf/container/gvar"
|
||
"github.com/gogf/gf/encoding/gjson"
|
||
"github.com/gogf/gf/os/gtime"
|
||
"github.com/gogf/gf/text/gregex"
|
||
)
|
||
|
||
// 请求对象
|
||
type Request struct {
|
||
*http.Request
|
||
Id int // 请求ID(当前Server对象唯一)
|
||
Server *Server // 请求关联的服务器对象
|
||
Cookie *Cookie // 与当前请求绑定的Cookie对象(并发安全)
|
||
Session *gsession.Session // 与当前请求绑定的Session对象(并发安全)
|
||
Response *Response // 对应请求的返回数据操作对象
|
||
Router *Router // 匹配到的路由对象
|
||
EnterTime int64 // 请求进入时间(微秒)
|
||
LeaveTime int64 // 请求完成时间(微秒)
|
||
Middleware *Middleware // 中间件功能调用对象
|
||
handlers []*handlerParsedItem // 请求执行服务函数列表(包含中间件、路由函数、钩子函数)
|
||
handlerIndex int // 当前执行函数的索引号
|
||
hasHookHandler bool // 是否检索到钩子函数(用于请求时提高钩子函数功能启用判断效率)
|
||
hasServeHandler bool // 是否检索到服务函数
|
||
parsedGet bool // GET参数是否已经解析
|
||
parsedPost bool // POST参数是否已经解析
|
||
parsedRaw bool // 原始参数是否已经解析
|
||
getMap map[string]interface{} // GET解析参数
|
||
postMap map[string]interface{} // POST解析参数
|
||
routerMap map[string]interface{} // 路由解析参数
|
||
rawVarMap map[string]interface{} // 原始数据参数
|
||
error error // 当前请求执行错误
|
||
exit bool // 是否退出当前请求流程执行
|
||
params map[string]interface{} // 开发者自定义参数(请求流程中有效)
|
||
parsedHost string // 解析过后不带端口号的服务器域名名称
|
||
clientIp string // 解析过后的客户端IP地址
|
||
rawContent []byte // 客户端提交的原始参数
|
||
isFileRequest bool // 是否为静态文件请求(非服务请求，当静态文件存在时，优先级会被服务请求高，被识别为文件请求)
|
||
}
|
||
|
||
// 创建一个Request对象
|
||
func newRequest(s *Server, r *http.Request, w http.ResponseWriter) *Request {
|
||
request := &Request{
|
||
routerMap: make(map[string]interface{}),
|
||
Id: s.servedCount.Add(1),
|
||
Server: s,
|
||
Request: r,
|
||
Response: newResponse(s, w),
|
||
EnterTime: gtime.Microsecond(),
|
||
}
|
||
// 会话处理
|
||
request.Cookie = GetCookie(request)
|
||
request.Session = s.sessionManager.New(request.GetSessionId())
|
||
request.Response.Request = request
|
||
request.Middleware = &Middleware{
|
||
request: request,
|
||
}
|
||
return request
|
||
}
|
||
|
||
// 获取Web Socket连接对象(如果是非WS请求会失败，注意检查返回的error结果)
|
||
func (r *Request) WebSocket() (*WebSocket, error) {
|
||
if conn, err := wsUpgrader.Upgrade(r.Response.Writer, r.Request, nil); err == nil {
|
||
return &WebSocket{
|
||
conn,
|
||
}, nil
|
||
} else {
|
||
return nil, err
|
||
}
|
||
}
|
||
|
||
// 获得指定名称的参数字符串(Router/GET/POST)，同 GetRequestString
|
||
// 这是常用方法的简化别名
|
||
func (r *Request) Get(key string, def ...interface{}) interface{} {
|
||
return r.GetRequest(key, def...)
|
||
}
|
||
|
||
// 建议都用该参数替代参数获取
|
||
func (r *Request) GetVar(key string, def ...interface{}) *gvar.Var {
|
||
return r.GetRequestVar(key, def...)
|
||
}
|
||
|
||
// 获取原始请求输入二进制。
|
||
func (r *Request) GetRaw() []byte {
|
||
if r.rawContent == nil {
|
||
r.rawContent, _ = ioutil.ReadAll(r.Body)
|
||
}
|
||
return r.rawContent
|
||
}
|
||
|
||
// 获取原始请求输入字符串。
|
||
func (r *Request) GetRawString() string {
|
||
return string(r.GetRaw())
|
||
}
|
||
|
||
// 获取原始json请求输入字符串，并解析为json对象
|
||
func (r *Request) GetJson() (*gjson.Json, error) {
|
||
return gjson.LoadJson(r.GetRaw())
|
||
}
|
||
|
||
func (r *Request) GetString(key string, def ...interface{}) string {
|
||
return r.GetRequestString(key, def...)
|
||
}
|
||
|
||
func (r *Request) GetBool(key string, def ...interface{}) bool {
|
||
return r.GetRequestBool(key, def...)
|
||
}
|
||
|
||
func (r *Request) GetInt(key string, def ...interface{}) int {
|
||
return r.GetRequestInt(key, def...)
|
||
}
|
||
|
||
func (r *Request) GetInts(key string, def ...interface{}) []int {
|
||
return r.GetRequestInts(key, def...)
|
||
}
|
||
|
||
func (r *Request) GetUint(key string, def ...interface{}) uint {
|
||
return r.GetRequestUint(key, def...)
|
||
}
|
||
|
||
func (r *Request) GetFloat32(key string, def ...interface{}) float32 {
|
||
return r.GetRequestFloat32(key, def...)
|
||
}
|
||
|
||
func (r *Request) GetFloat64(key string, def ...interface{}) float64 {
|
||
return r.GetRequestFloat64(key, def...)
|
||
}
|
||
|
||
func (r *Request) GetFloats(key string, def ...interface{}) []float64 {
|
||
return r.GetRequestFloats(key, def...)
|
||
}
|
||
|
||
func (r *Request) GetArray(key string, def ...interface{}) []string {
|
||
return r.GetRequestArray(key, def...)
|
||
}
|
||
|
||
func (r *Request) GetStrings(key string, def ...interface{}) []string {
|
||
return r.GetRequestStrings(key, def...)
|
||
}
|
||
|
||
func (r *Request) GetInterfaces(key string, def ...interface{}) []interface{} {
|
||
return r.GetRequestInterfaces(key, def...)
|
||
}
|
||
|
||
func (r *Request) GetMap(def ...map[string]interface{}) map[string]interface{} {
|
||
return r.GetRequestMap(def...)
|
||
}
|
||
|
||
func (r *Request) GetMapStrStr(def ...map[string]interface{}) map[string]string {
|
||
return r.GetRequestMapStrStr(def...)
|
||
}
|
||
|
||
// 将所有的request参数映射到struct属性上，参数pointer应当为一个struct对象的指针,
|
||
// mapping为非必需参数，自定义参数与属性的映射关系
|
||
func (r *Request) GetToStruct(pointer interface{}, mapping ...map[string]string) error {
|
||
return r.GetRequestToStruct(pointer, mapping...)
|
||
}
|
||
|
||
// 仅退出当前逻辑执行函数, 如:服务函数、HOOK函数
|
||
func (r *Request) Exit() {
|
||
panic(gEXCEPTION_EXIT)
|
||
}
|
||
|
||
// 退出当前请求执行，后续所有的服务逻辑流程(包括其他的HOOK)将不会执行
|
||
func (r *Request) ExitAll() {
|
||
r.exit = true
|
||
panic(gEXCEPTION_EXIT_ALL)
|
||
}
|
||
|
||
// 仅针对HOOK执行，默认情况下HOOK会按照优先级进行调用，当使用ExitHook后当前类型的后续HOOK将不会被调用
|
||
func (r *Request) ExitHook() {
|
||
panic(gEXCEPTION_EXIT_HOOK)
|
||
}
|
||
|
||
// 判断当前请求是否停止执行
|
||
func (r *Request) IsExited() bool {
|
||
return r.exit
|
||
}
|
||
|
||
// 获取请求的服务端IP/域名
|
||
func (r *Request) GetHost() string {
|
||
if len(r.parsedHost) == 0 {
|
||
array, _ := gregex.MatchString(`(.+):(\d+)`, r.Host)
|
||
if len(array) > 1 {
|
||
r.parsedHost = array[1]
|
||
} else {
|
||
r.parsedHost = r.Host
|
||
}
|
||
}
|
||
return r.parsedHost
|
||
}
|
||
|
||
// 判断是否为静态文件请求
|
||
func (r *Request) IsFileRequest() bool {
|
||
return r.isFileRequest
|
||
}
|
||
|
||
// 判断是否为AJAX请求
|
||
func (r *Request) IsAjaxRequest() bool {
|
||
return strings.EqualFold(r.Header.Get("X-Requested-With"), "XMLHttpRequest")
|
||
}
|
||
|
||
// 获取请求的客户端IP地址
|
||
func (r *Request) GetClientIp() string {
|
||
if len(r.clientIp) == 0 {
|
||
if r.clientIp = r.Header.Get("X-Real-IP"); r.clientIp == "" {
|
||
array, _ := gregex.MatchString(`(.+):(\d+)`, r.RemoteAddr)
|
||
if len(array) > 1 {
|
||
r.clientIp = array[1]
|
||
} else {
|
||
r.clientIp = r.RemoteAddr
|
||
}
|
||
}
|
||
}
|
||
return r.clientIp
|
||
}
|
||
|
||
// 获得当前请求URL地址
|
||
func (r *Request) GetUrl() string {
|
||
scheme := "http"
|
||
if r.TLS != nil {
|
||
scheme = "https"
|
||
}
|
||
return fmt.Sprintf(`%s://%s%s`, scheme, r.Host, r.URL.String())
|
||
}
|
||
|
||
// 从Cookie和Header中查询SESSIONID
|
||
func (r *Request) GetSessionId() string {
|
||
id := r.Cookie.GetSessionId()
|
||
if id == "" {
|
||
id = r.Header.Get(r.Server.GetSessionIdName())
|
||
}
|
||
return id
|
||
}
|
||
|
||
// 获得请求来源URL地址
|
||
func (r *Request) GetReferer() string {
|
||
return r.Header.Get("Referer")
|
||
}
|