httpKit

package
v2.2.59 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 10, 2023 License: Apache-2.0 Imports: 25 Imported by: 1

Documentation

Overview

Package httpKit

请求头 || 响应头 key: 不区分大小写

Index

Constants

View Source
const (
	// PlainContentType 纯文本格式
	PlainContentType = "text/plain; charset=utf-8"

	// JsonContentType JSON数据格式
	JsonContentType = "application/json; charset=utf-8"

	// OctetStreamContentType 二进制流数据(如常见的文件下载)
	/*
		参考:https://www.runoob.com/http/http-content-type.html
	*/
	OctetStreamContentType = "application/octet-stream; charset=utf-8"
)

Variables

This section is empty.

Functions

func AddHeader

func AddHeader(header http.Header, key, value string)

AddHeader

e.g.

header := make(map[string][]string)

AddHeader(header, "k", "0")
fmt.Println(header) 		// map[K:[0]]
AddHeader(header, "k", "1")
fmt.Println(header) 		// map[K:[0 1]]
AddHeader(header, "k", "1")
fmt.Println(header) 		// map[K:[0 1 1]]

func AddHeaderIfMissing

func AddHeaderIfMissing(header http.Header, key, value string)

AddHeaderIfMissing

PS: 区分大小写.

func AddHeaderIfMissingIgnoreCase

func AddHeaderIfMissingIgnoreCase(header http.Header, key, value string)

AddHeaderIfMissingIgnoreCase

PS: 不区分大小写.

func AssertHttpUrl

func AssertHttpUrl(httpUrl string) error

func DelHeader

func DelHeader(header http.Header, key string)

func GetFormFile

func GetFormFile(r *http.Request, key string, maxMemory int64) (multipart.File, *multipart.FileHeader, error)

GetFormFile

[Go] golang获取http中的get传递的参数

https://www.cnblogs.com/taoshihan/p/12943118.html

@param maxMemory 可以为-1,此时将采用默认值

func GetHeader

func GetHeader(header http.Header, key string) string

GetHeader

PS: 存在多个值的话([]string),返回第一个值.

@param key 不存在对应值的话,将返回 ""

func GetHeaderValues

func GetHeaderValues(header http.Header, key string) []string

GetHeaderValues

@param key 不存在对应值的话,将返回 nil

func GetOrigin

func GetOrigin(header http.Header) string

GetOrigin 获取请求的Origin

func GetPostParam

func GetPostParam(r *http.Request, key string) (string, error)

GetPostParam

[Go] golang获取http中的get传递的参数

https://www.cnblogs.com/taoshihan/p/12943118.html

func GetProto

func GetProto(req *http.Request) string

GetProto

@return "HTTP/1.0" || "HTTP/1.1" || ...

func GetRequestUrl

func GetRequestUrl(req *http.Request) string

GetRequestUrl 返回当前接口的url.

PS: 包括query、fragment.

func GetRoute

func GetRoute(req *http.Request) string

GetRoute 获取: 路由(不带query).

e.g.

http://127.0.0.1/a/b?1=1&2=2 => "/a/b"

func GetRouteWithQuery

func GetRouteWithQuery(req *http.Request) string

GetRouteWithQuery 获取: 路由(带query).

e.g.

http://127.0.0.1/a/b?1=1&2=2 => "/a/b?1=1&2=2"

func GetURLRawQuery

func GetURLRawQuery(req *http.Request) string

GetURLRawQuery

e.g. http://127.0.0.1/a/b?1=1&2=2 => "1=1&2=2"

func GetUrlParam

func GetUrlParam(r *http.Request, key string) string

GetUrlParam

[Go] golang获取http中的get传递的参数

https://www.cnblogs.com/taoshihan/p/12943118.html

func GetUrlParam1

func GetUrlParam1(r *http.Request, key string) (string, error)

GetUrlParam1

[Go] golang获取http中的get传递的参数

https://www.cnblogs.com/taoshihan/p/12943118.html

func GetUserAgent

func GetUserAgent(header http.Header) string

GetUserAgent 获取http请求头中"User Agent"的值.

参考: https://www.sunzhongwei.com/golang-gin-for-user-agent-in-http-request-header-value

e.g. Chrome浏览器: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36 Safari浏览器: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/15.5 Safari/605.1.15

func HeaderContainsValue

func HeaderContainsValue(header http.Header, key, value string) bool

HeaderContainsValue Header中,指定key对应的value切片是否包含指定value?

PS: 区分大小写.

func HeaderContainsValueIgnoreCase

func HeaderContainsValueIgnoreCase(header http.Header, key, value string) bool

HeaderContainsValueIgnoreCase Header中,指定key对应的value切片是否包含指定value?\

PS: 不区分大小写.

func HeaderToMap

func HeaderToMap(header http.Header) map[string]interface{}

HeaderToMap http.Header(即 map[string][]string) => map[string]interface{}

func IsProxyDialError

func IsProxyDialError(err error) bool

IsProxyDialError 代理请求返回的error,是否是因为dial目标地址失败?

func MakeRequestBodySeekable

func MakeRequestBodySeekable(req *http.Request) error

MakeRequestBodySeekable

Go语言: 如何让 request.Body 可以多次读取

https://www.cnblogs.com/ayanmw/p/17191530.html

PS: (1) 一般与 proxy() 搭配使用; (2) 某个路由涉及代理(请求转发)的话,需要在handler里面 首先 调用此方法.

func OverrideRequestBody

func OverrideRequestBody(req *http.Request, m map[string][]string)

OverrideRequestBody 覆盖request body.

条件: (1) POST (2) x-www-form-urlencoded

func PolyfillContextPath

func PolyfillContextPath(relativePath string) string

PolyfillContextPath *

  • e.g.
  • "" => ""
  • "/" => "/"
  • "//" => "/"
  • "///" => "/"
  • "/c/////c//" => "/c/c/" *
  • @return 优化过的ContextPath

func Proxy

func Proxy(w http.ResponseWriter, r *http.Request, targetAddr string, options ...ProxyOption) error

Proxy 代理请求(反向代理,请求转发).

PS: 转发请求前如果想变更请求头(Request Header),可以在调用此函数前设置请求头.

@param w e.g.ctx.Writer @param r e.g.ctx.Request

func ResetRequestBody

func ResetRequestBody(req *http.Request) error

ResetRequestBody 重置请求体,以防: 已经读完body了,请求转发给别人,别人收到的请求没内容.

PS: req.Body可以为nil.

func RespondData

func RespondData(w http.ResponseWriter, code int, contentType string, data []byte) error

RespondData 响应字节流(二进制流)

参考: gin里面的 Context.Data() .

@return 如果不为nil,建议输出到控制台

func RespondFile

func RespondFile(w http.ResponseWriter, r *http.Request, code int, filePath, fileName string) error

RespondFile 响应文件

参考: gin里面的 Context.File() 和 Context.FileAttachment() .

@param filePath 文件路径 @param fileName 文件名(可以为"",此时将从 传参filePath 中获取) @return 如果不为nil,建议输出到控制台

func RespondJson

func RespondJson(w http.ResponseWriter, code int, obj any) error

RespondJson

参考: gin里面的 Context.JSON() .

func RespondString

func RespondString(w http.ResponseWriter, code int, format string, values ...any) error

RespondString

参考: gin里面的 Context.ToDsnString() .

func RespondStringData

func RespondStringData(w http.ResponseWriter, code int, data []byte) error

func SetCacheControlNoCache

func SetCacheControlNoCache(header http.Header)

SetCacheControlNoCache 实际上是有缓存的)浏览器对请求回来的response做缓存,但是每次在向客户端(浏览器)提供响应数据时,缓存都要向服务器评估缓存响应的有效性。

PS: (1) 一般情况下, "no-cache" 就够了; (2) 详见"Web.docx".

func SetCacheControlNoStore

func SetCacheControlNoStore(header http.Header)

SetCacheControlNoStore 禁止一切缓存.

PS: 详见"Web.docx".

func SetHeader

func SetHeader(header http.Header, key, value string)

SetHeader

e.g.

header := make(map[string][]string)

httpKit.AddHeader(header, "k", "0")
fmt.Println(header) 				// map[K:[0]]
httpKit.AddHeader(header, "k", "1")
fmt.Println(header) 				// map[K:[0 1]]

httpKit.SetHeader(header, "k", "2")
fmt.Println(header) 				// map[K:[2]]
httpKit.SetHeader(header, "k", "")
fmt.Println(header) 				// map[]

func SetHeaderIfMissing

func SetHeaderIfMissing(header http.Header, key, value string)

SetHeaderIfMissing

PS: 区分大小写.

func SetHeaderIfMissingIgnoreCase

func SetHeaderIfMissingIgnoreCase(header http.Header, key, value string)

SetHeaderIfMissingIgnoreCase

PS: 不区分大小写.

func Status

func Status(w http.ResponseWriter, code int)

Status 设置响应的http状态码

PS: (1) 不建议多次设置 http状态码; (2) 如果多次设置的话,感觉 第一次设置的值 会生效.

@param code -1: 不设置http状态码

func ToRequestBodyString

func ToRequestBodyString(m map[string][]string) string

ToRequestBodyString

条件: (1) POST (2) x-www-form-urlencoded

e.g.

m := map[string][]string{
	"a": []string{"test"},
	"b": []string{"测试"},
}
fmt.Println(ToRequestBodyString(m)) // a=test&b=%E6%B5%8B%E8%AF%95

Types

type ProxyOption

type ProxyOption func(opts *proxyOptions)

func WithErrorLogger

func WithErrorLogger(errorLogger *log.Logger) ProxyOption

func WithQueryParams

func WithQueryParams(queryParams map[string][]string) ProxyOption

func WithReqUrlPath

func WithReqUrlPath(reqUrlPath *string) ProxyOption

WithReqUrlPath

@param reqUrlPath 不带query

func WithScheme

func WithScheme(scheme string) ProxyOption

type Repeat

type Repeat struct {
	Reader io.ReaderAt
	Offset int64
}

func (*Repeat) Close

func (p *Repeat) Close() error

func (*Repeat) Read

func (p *Repeat) Read(val []byte) (n int, err error)

Read 重写读方法,使每次读取request.Body时能从指定位置读取

func (*Repeat) Reset

func (p *Repeat) Reset()

Reset 重置偏移量

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL