295 lines
12 KiB
Go
295 lines
12 KiB
Go
package server
|
||
|
||
import (
|
||
"github.com/gin-contrib/pprof"
|
||
"github.com/gorilla/websocket"
|
||
"github.com/kercylan98/minotaur/utils/log"
|
||
"github.com/kercylan98/minotaur/utils/timer"
|
||
"google.golang.org/grpc"
|
||
"net/http"
|
||
"sync"
|
||
"sync/atomic"
|
||
"time"
|
||
)
|
||
|
||
const (
|
||
// WebsocketMessageTypeText 表示文本数据消息。文本消息负载被解释为 UTF-8 编码的文本数据
|
||
WebsocketMessageTypeText = websocket.TextMessage
|
||
// WebsocketMessageTypeBinary 表示二进制数据消息
|
||
WebsocketMessageTypeBinary = websocket.BinaryMessage
|
||
// WebsocketMessageTypeClose 表示关闭控制消息。可选消息负载包含数字代码和文本。使用 FormatCloseMessage 函数来格式化关闭消息负载
|
||
WebsocketMessageTypeClose = websocket.CloseMessage
|
||
// WebsocketMessageTypePing 表示 ping 控制消息。可选的消息负载是 UTF-8 编码的文本
|
||
WebsocketMessageTypePing = websocket.PingMessage
|
||
// WebsocketMessageTypePong 表示一个 pong 控制消息。可选的消息负载是 UTF-8 编码的文本
|
||
WebsocketMessageTypePong = websocket.PongMessage
|
||
)
|
||
|
||
type Option func(srv *Server)
|
||
type option struct {
|
||
disableAnts bool // 是否禁用协程池
|
||
antsPoolSize int // 协程池大小
|
||
}
|
||
|
||
type runtime struct {
|
||
deadlockDetect time.Duration // 是否开启死锁检测
|
||
supportMessageTypes map[int]bool // websocket 模式下支持的消息类型
|
||
certFile, keyFile string // TLS文件
|
||
tickerPool *timer.Pool // 定时器池
|
||
ticker *timer.Ticker // 定时器
|
||
tickerAutonomy bool // 定时器是否独立运行
|
||
connTickerSize int // 连接定时器大小
|
||
websocketReadDeadline time.Duration // websocket 连接超时时间
|
||
websocketCompression int // websocket 压缩等级
|
||
websocketWriteCompression bool // websocket 写入压缩
|
||
limitLife time.Duration // 限制最大生命周期
|
||
packetWarnSize int // 数据包大小警告
|
||
messageStatisticsDuration time.Duration // 消息统计时长
|
||
messageStatisticsLimit int // 消息统计数量
|
||
messageStatistics []*atomic.Int64 // 消息统计数量
|
||
messageStatisticsLock *sync.RWMutex // 消息统计锁
|
||
connWriteBufferSize int // 连接写入缓冲区大小
|
||
websocketUpgrader *websocket.Upgrader // websocket 升级器
|
||
websocketConnInitializer func(writer http.ResponseWriter, request *http.Request, conn *websocket.Conn) error // websocket 连接初始化
|
||
dispatcherBufferSize int // 消息分发器缓冲区大小
|
||
lowMessageDuration time.Duration // 慢消息时长
|
||
asyncLowMessageDuration time.Duration // 异步慢消息时长
|
||
}
|
||
|
||
// WithLowMessageDuration 通过指定慢消息时长的方式创建服务器，当消息处理时间超过指定时长时，将会输出 WARN 类型的日志
|
||
// - 默认值为 DefaultLowMessageDuration
|
||
// - 当 duration <= 0 时，表示关闭慢消息检测
|
||
func WithLowMessageDuration(duration time.Duration) Option {
|
||
return func(srv *Server) {
|
||
srv.lowMessageDuration = duration
|
||
}
|
||
}
|
||
|
||
// WithAsyncLowMessageDuration 通过指定异步消息的慢消息时长的方式创建服务器，当消息处理时间超过指定时长时，将会输出 WARN 类型的日志
|
||
// - 默认值为 DefaultAsyncLowMessageDuration
|
||
// - 当 duration <= 0 时，表示关闭慢消息检测
|
||
func WithAsyncLowMessageDuration(duration time.Duration) Option {
|
||
return func(srv *Server) {
|
||
srv.asyncLowMessageDuration = duration
|
||
}
|
||
}
|
||
|
||
// WithWebsocketConnInitializer 通过 websocket 连接初始化的方式创建服务器，当 initializer 返回错误时，服务器将不会处理该连接的后续逻辑
|
||
// - 该选项仅在创建 NetworkWebsocket 服务器时有效
|
||
func WithWebsocketConnInitializer(initializer func(writer http.ResponseWriter, request *http.Request, conn *websocket.Conn) error) Option {
|
||
return func(srv *Server) {
|
||
if srv.network != NetworkWebsocket {
|
||
return
|
||
}
|
||
srv.websocketConnInitializer = initializer
|
||
}
|
||
}
|
||
|
||
// WithWebsocketUpgrade 通过指定 websocket.Upgrader 的方式创建服务器
|
||
// - 默认值为 DefaultWebsocketUpgrader
|
||
// - 该选项仅在创建 NetworkWebsocket 服务器时有效
|
||
func WithWebsocketUpgrade(upgrader *websocket.Upgrader) Option {
|
||
return func(srv *Server) {
|
||
if srv.network != NetworkWebsocket {
|
||
return
|
||
}
|
||
srv.websocketUpgrader = upgrader
|
||
}
|
||
}
|
||
|
||
// WithConnWriteBufferSize 通过连接写入缓冲区大小的方式创建服务器
|
||
// - 默认值为 DefaultConnWriteBufferSize
|
||
// - 设置合适的缓冲区大小可以提高服务器性能，但是会占用更多的内存
|
||
func WithConnWriteBufferSize(size int) Option {
|
||
return func(srv *Server) {
|
||
if size <= 0 {
|
||
return
|
||
}
|
||
srv.connWriteBufferSize = size
|
||
}
|
||
}
|
||
|
||
// WithDispatcherBufferSize 通过消息分发器缓冲区大小的方式创建服务器
|
||
// - 默认值为 DefaultDispatcherBufferSize
|
||
// - 设置合适的缓冲区大小可以提高服务器性能，但是会占用更多的内存
|
||
func WithDispatcherBufferSize(size int) Option {
|
||
return func(srv *Server) {
|
||
if size <= 0 {
|
||
return
|
||
}
|
||
srv.dispatcherBufferSize = size
|
||
}
|
||
}
|
||
|
||
// WithMessageStatistics 通过消息统计的方式创建服务器
|
||
// - 默认不开启，当 duration 和 limit 均大于 0 的时候，服务器将记录每 duration 期间的消息数量，并保留最多 limit 条
|
||
func WithMessageStatistics(duration time.Duration, limit int) Option {
|
||
return func(srv *Server) {
|
||
if duration <= 0 || limit <= 0 {
|
||
return
|
||
}
|
||
srv.messageStatisticsDuration = duration
|
||
srv.messageStatisticsLimit = limit
|
||
srv.messageStatisticsLock = new(sync.RWMutex)
|
||
}
|
||
}
|
||
|
||
// WithPacketWarnSize 通过数据包大小警告的方式创建服务器，当数据包大小超过指定大小时，将会输出 WARN 类型的日志
|
||
// - 默认值为 DefaultPacketWarnSize
|
||
// - 当 size <= 0 时，表示不设置警告
|
||
func WithPacketWarnSize(size int) Option {
|
||
return func(srv *Server) {
|
||
if size <= 0 {
|
||
srv.packetWarnSize = 0
|
||
log.Info("WithPacketWarnSize", log.String("State", "Ignore"), log.String("Reason", "size <= 0"))
|
||
return
|
||
}
|
||
srv.packetWarnSize = size
|
||
}
|
||
}
|
||
|
||
// WithLimitLife 通过限制最大生命周期的方式创建服务器
|
||
// - 通常用于测试服务器，服务器将在到达最大生命周期时自动关闭
|
||
func WithLimitLife(t time.Duration) Option {
|
||
return func(srv *Server) {
|
||
srv.limitLife = t
|
||
}
|
||
}
|
||
|
||
// WithWebsocketWriteCompression 通过数据写入压缩的方式创建Websocket服务器
|
||
// - 默认不开启数据压缩
|
||
func WithWebsocketWriteCompression() Option {
|
||
return func(srv *Server) {
|
||
if srv.network != NetworkWebsocket {
|
||
return
|
||
}
|
||
srv.websocketWriteCompression = true
|
||
}
|
||
}
|
||
|
||
// WithWebsocketCompression 通过数据压缩的方式创建Websocket服务器
|
||
// - 默认不开启数据压缩
|
||
func WithWebsocketCompression(level int) Option {
|
||
return func(srv *Server) {
|
||
if srv.network != NetworkWebsocket {
|
||
return
|
||
}
|
||
if !(-2 <= level && level <= 9) {
|
||
panic("websocket: invalid compression level")
|
||
}
|
||
srv.websocketCompression = level
|
||
}
|
||
}
|
||
|
||
// WithDeadlockDetect 通过死锁、死循环、永久阻塞检测的方式创建服务器
|
||
// - 当检测到死锁、死循环、永久阻塞时，服务器将会生成 WARN 类型的日志，关键字为 "SuspectedDeadlock"
|
||
// - 默认不开启死锁检测
|
||
func WithDeadlockDetect(t time.Duration) Option {
|
||
return func(srv *Server) {
|
||
if t > 0 {
|
||
srv.deadlockDetect = t
|
||
log.Info("DeadlockDetect", log.String("Time", t.String()))
|
||
}
|
||
}
|
||
}
|
||
|
||
// WithDisableAsyncMessage 通过禁用异步消息的方式创建服务器
|
||
func WithDisableAsyncMessage() Option {
|
||
return func(srv *Server) {
|
||
srv.disableAnts = true
|
||
}
|
||
}
|
||
|
||
// WithAsyncPoolSize 通过指定异步消息池大小的方式创建服务器
|
||
// - 当通过 WithDisableAsyncMessage 禁用异步消息时，此选项无效
|
||
// - 默认值为 DefaultAsyncPoolSize
|
||
func WithAsyncPoolSize(size int) Option {
|
||
return func(srv *Server) {
|
||
srv.antsPoolSize = size
|
||
}
|
||
}
|
||
|
||
// WithWebsocketReadDeadline 设置 Websocket 读取超时时间
|
||
// - 默认： DefaultWebsocketReadDeadline
|
||
// - 当 t <= 0 时，表示不设置超时时间
|
||
func WithWebsocketReadDeadline(t time.Duration) Option {
|
||
return func(srv *Server) {
|
||
if srv.network != NetworkWebsocket {
|
||
return
|
||
}
|
||
srv.websocketReadDeadline = t
|
||
}
|
||
}
|
||
|
||
// WithTicker 通过定时器创建服务器，为服务器添加定时器功能
|
||
// - poolSize：指定服务器定时器池大小，当池子内的定时器数量超出该值后，多余的定时器在释放时将被回收，该值小于等于 0 时将使用 timer.DefaultTickerPoolSize
|
||
// - size：服务器定时器时间轮大小
|
||
// - connSize：服务器连接定时器时间轮大小，当该值小于等于 0 的时候，在新连接建立时将不再为其创建定时器
|
||
// - autonomy：定时器是否独立运行（独立运行的情况下不会作为服务器消息运行，会导致并发问题）
|
||
func WithTicker(poolSize, size, connSize int, autonomy bool) Option {
|
||
return func(srv *Server) {
|
||
if poolSize <= 0 {
|
||
poolSize = timer.DefaultTickerPoolSize
|
||
}
|
||
srv.tickerPool = timer.NewPool(poolSize)
|
||
srv.connTickerSize = connSize
|
||
srv.tickerAutonomy = autonomy
|
||
if !autonomy {
|
||
srv.ticker = srv.tickerPool.GetTicker(size)
|
||
} else {
|
||
srv.ticker = srv.tickerPool.GetTicker(size, timer.WithCaller(func(name string, caller func()) {
|
||
srv.PushTickerMessage(name, caller)
|
||
}))
|
||
}
|
||
}
|
||
}
|
||
|
||
// WithTLS 通过安全传输层协议TLS创建服务器
|
||
// - 支持：Http、Websocket
|
||
func WithTLS(certFile, keyFile string) Option {
|
||
return func(srv *Server) {
|
||
switch srv.network {
|
||
case NetworkHttp, NetworkWebsocket:
|
||
srv.certFile = certFile
|
||
srv.keyFile = keyFile
|
||
}
|
||
}
|
||
}
|
||
|
||
// WithGRPCServerOptions 通过GRPC的可选项创建GRPC服务器
|
||
func WithGRPCServerOptions(options ...grpc.ServerOption) Option {
|
||
return func(srv *Server) {
|
||
if srv.network != NetworkGRPC {
|
||
return
|
||
}
|
||
srv.grpcServer = grpc.NewServer(options...)
|
||
}
|
||
}
|
||
|
||
// WithWebsocketMessageType 设置仅支持特定类型的Websocket消息
|
||
func WithWebsocketMessageType(messageTypes ...int) Option {
|
||
return func(srv *Server) {
|
||
if srv.network != NetworkWebsocket {
|
||
return
|
||
}
|
||
var supports = make(map[int]bool)
|
||
for _, messageType := range messageTypes {
|
||
switch messageType {
|
||
case WebsocketMessageTypeText, WebsocketMessageTypeBinary, WebsocketMessageTypeClose, WebsocketMessageTypePing, WebsocketMessageTypePong:
|
||
supports[messageType] = true
|
||
}
|
||
}
|
||
srv.supportMessageTypes = supports
|
||
}
|
||
}
|
||
|
||
// WithPProf 通过性能分析工具PProf创建服务器
|
||
func WithPProf(pattern ...string) Option {
|
||
return func(srv *Server) {
|
||
if srv.network != NetworkHttp {
|
||
return
|
||
}
|
||
pprof.Register(srv.ginServer, pattern...)
|
||
}
|
||
}
|