gf/net/ghttp/ghttp_server_config.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 (
	"crypto/tls"
	"fmt"
	"net/http"
	"strconv"
	"time"

	"github.com/gogf/gf/os/gfile"
	"github.com/gogf/gf/os/glog"
)

const (
	gDEFAULT_HTTP_ADDR                 = ":80"         // 默认HTTP监听地址
	gDEFAULT_HTTPS_ADDR                = ":443"        // 默认HTTPS监听地址
	NAME_TO_URI_TYPE_DEFAULT           = 0             // 服务注册时对象和方法名称转换为URI时，全部转为小写，单词以'-'连接符号连接
	NAME_TO_URI_TYPE_FULLNAME          = 1             // 不处理名称，以原有名称构建成URI
	NAME_TO_URI_TYPE_ALLLOWER          = 2             // 仅转为小写，单词间不使用连接符号
	NAME_TO_URI_TYPE_CAMEL             = 3             // 采用驼峰命名方式
	gDEFAULT_COOKIE_PATH               = "/"           // 默认path
	gDEFAULT_COOKIE_MAX_AGE            = 86400 * 365   // 默认cookie有效期(一年)
	gDEFAULT_SESSION_MAX_AGE           = 86400         // 默认session有效期(一天)
	gDEFAULT_SESSION_ID_NAME           = "gfsessionid" // 默认存放Cookie中的SessionId名称
	gCHANGE_CONFIG_WHILE_RUNNING_ERROR = "cannot be changed while running"
)

// 自定义日志处理方法类型
type LogHandler func(r *Request, error ...interface{})

// HTTP Server 设置结构体，静态配置
type ServerConfig struct {
	// 底层http对象配置
	Addr           string        // 监听IP和端口，监听本地所有IP使用":端口"(支持多个地址，使用","号分隔)
	HTTPSAddr      string        // HTTPS服务监听地址(支持多个地址，使用","号分隔)
	HTTPSCertPath  string        // HTTPS证书文件路径
	HTTPSKeyPath   string        // HTTPS签名文件路径
	Handler        http.Handler  // 默认的处理函数
	ReadTimeout    time.Duration // 读取超时
	WriteTimeout   time.Duration // 写入超时
	IdleTimeout    time.Duration // 等待超时
	MaxHeaderBytes int           // 最大的header长度
	TLSConfig      tls.Config
	KeepAlive      bool

	// 静态文件配置
	IndexFiles        []string         // 默认访问的文件列表
	IndexFolder       bool             // 如果访问目录是否显示目录列表
	ServerAgent       string           // Server Agent
	ServerRoot        string           // 服务器服务的本地目录根路径(检索优先级比StaticPaths低)
	SearchPaths       []string         // 静态文件搜索目录(包含ServerRoot，按照优先级进行排序)
	StaticPaths       []staticPathItem // 静态文件目录映射(按照优先级进行排序)
	FileServerEnabled bool             // 是否允许静态文件服务(通过静态文件服务方法调用自动识别)

	// COOKIE
	CookieMaxAge int    // Cookie有效期
	CookiePath   string // Cookie有效Path(注意同时也会影响SessionID)
	CookieDomain string // Cookie有效Domain(注意同时也会影响SessionID)

	// SESSION
	SessionMaxAge int    // Session有效期
	SessionIdName string // SessionId名称

	// IP访问控制
	DenyIps  []string // 不允许访问的ip列表，支持ip前缀过滤，如: 10 将不允许10开头的ip访问
	AllowIps []string // 仅允许访问的ip列表，支持ip前缀过滤，如: 10 将仅允许10开头的ip访问

	// 路由访问控制
	DenyRoutes []string          // 不允许访问的路由规则列表
	Rewrites   map[string]string // URI Rewrite重写配置

	// 日志配置
	LogPath          string     // 存放日志的目录路径(默认为空，表示不写文件)
	LogHandler       LogHandler // 自定义日志处理回调方法(默认为空)
	LogStdout        bool       // 是否打印日志到终端(默认开启)
	ErrorLogEnabled  bool       // 是否开启error log(默认开启)
	AccessLogEnabled bool       // 是否开启access log(默认关闭)

	// 其他设置
	NameToUriType     int      // 服务注册时对象和方法名称转换为URI时的规则
	GzipContentTypes  []string // 允许进行gzip压缩的文件类型
	DumpRouteMap      bool     // 是否在程序启动时默认打印路由表信息
	RouterCacheExpire int      // 路由检索缓存过期时间(秒)
}

// 默认HTTP Server配置
var defaultServerConfig = ServerConfig{
	Addr:              "",
	HTTPSAddr:         "",
	Handler:           nil,
	ReadTimeout:       60 * time.Second,
	WriteTimeout:      60 * time.Second,
	IdleTimeout:       60 * time.Second,
	MaxHeaderBytes:    1024,
	KeepAlive:         true,
	IndexFiles:        []string{"index.html", "index.htm"},
	IndexFolder:       false,
	ServerAgent:       "gf",
	ServerRoot:        "",
	StaticPaths:       make([]staticPathItem, 0),
	FileServerEnabled: false,
	CookieMaxAge:      gDEFAULT_COOKIE_MAX_AGE,
	CookiePath:        gDEFAULT_COOKIE_PATH,
	CookieDomain:      "",
	SessionMaxAge:     gDEFAULT_SESSION_MAX_AGE,
	SessionIdName:     gDEFAULT_SESSION_ID_NAME,
	LogStdout:         true,
	ErrorLogEnabled:   true,
	AccessLogEnabled:  false,
	DumpRouteMap:      true,
	RouterCacheExpire: 60,
	Rewrites:          make(map[string]string),
}

// 获取默认的http server设置
func Config() ServerConfig {
	return defaultServerConfig
}

// http server setting设置
// 注意使用该方法进行http server配置时，需要配置所有的配置项，否则没有配置的属性将会默认变量为空
func (s *Server) SetConfig(c ServerConfig) {
	if s.Status() == SERVER_STATUS_RUNNING {
		glog.Error(gCHANGE_CONFIG_WHILE_RUNNING_ERROR)
		return
	}
	if c.Handler == nil {
		c.Handler = http.HandlerFunc(s.defaultHttpHandle)
	}
	s.config = c

	if c.LogPath != "" {
		s.logger.SetPath(c.LogPath)
	}
}

// 设置http server参数 - Addr
func (s *Server) SetAddr(itemFunc string) {
	if s.Status() == SERVER_STATUS_RUNNING {
		glog.Error(gCHANGE_CONFIG_WHILE_RUNNING_ERROR)
		return
	}
	s.config.Addr = itemFunc
}

// 设置http server参数 - Port
func (s *Server) SetPort(port ...int) {
	if s.Status() == SERVER_STATUS_RUNNING {
		glog.Error("config cannot be changed while running")
	}
	if len(port) > 0 {
		s.config.Addr = ""
		for _, v := range port {
			if len(s.config.Addr) > 0 {
				s.config.Addr += ","
			}
			s.config.Addr += ":" + strconv.Itoa(v)
		}
	}
}

// 设置http server参数 - HTTPS Addr
func (s *Server) SetHTTPSAddr(itemFunc string) {
	if s.Status() == SERVER_STATUS_RUNNING {
		glog.Error(gCHANGE_CONFIG_WHILE_RUNNING_ERROR)
		return
	}
	s.config.HTTPSAddr = itemFunc
}

// 设置http server参数 - HTTPS Port
func (s *Server) SetHTTPSPort(port ...int) {
	if s.Status() == SERVER_STATUS_RUNNING {
		glog.Error(gCHANGE_CONFIG_WHILE_RUNNING_ERROR)
		return
	}
	if len(port) > 0 {
		s.config.HTTPSAddr = ""
		for _, v := range port {
			if len(s.config.HTTPSAddr) > 0 {
				s.config.HTTPSAddr += ","
			}
			s.config.HTTPSAddr += ":" + strconv.Itoa(v)
		}
	}
}

// 开启HTTPS支持，但是必须提供Cert和Key文件，tlsConfig为可选项
func (s *Server) EnableHTTPS(certFile, keyFile string, tlsConfig ...tls.Config) {
	if s.Status() == SERVER_STATUS_RUNNING {
		glog.Error(gCHANGE_CONFIG_WHILE_RUNNING_ERROR)
		return
	}
	certFileRealPath := gfile.RealPath(certFile)
	if certFileRealPath == "" {
		certFileRealPath = gfile.RealPath(gfile.Pwd() + gfile.Separator + certFile)
		if certFileRealPath == "" {
			certFileRealPath = gfile.RealPath(gfile.MainPkgPath() + gfile.Separator + certFile)
		}
	}
	if certFileRealPath == "" {
		glog.Fatal(fmt.Sprintf(`[ghttp] EnableHTTPS failed: certFile "%s" does not exist`, certFile))
	}
	keyFileRealPath := gfile.RealPath(keyFile)
	if keyFileRealPath == "" {
		keyFileRealPath = gfile.RealPath(gfile.Pwd() + gfile.Separator + keyFile)
		if keyFileRealPath == "" {
			keyFileRealPath = gfile.RealPath(gfile.MainPkgPath() + gfile.Separator + keyFile)
		}
	}
	if keyFileRealPath == "" {
		glog.Fatal(fmt.Sprintf(`[ghttp] EnableHTTPS failed: keyFile "%s" does not exist`, keyFile))
	}
	s.config.HTTPSCertPath = certFileRealPath
	s.config.HTTPSKeyPath = keyFileRealPath
	if len(tlsConfig) > 0 {
		s.config.TLSConfig = tlsConfig[0]
	}
}

// 设置TLS配置对象
func (s *Server) SetTLSConfig(tlsConfig tls.Config) {
	if s.Status() == SERVER_STATUS_RUNNING {
		glog.Error(gCHANGE_CONFIG_WHILE_RUNNING_ERROR)
		return
	}
	s.config.TLSConfig = tlsConfig
}

// 设置http server参数 - ReadTimeout
func (s *Server) SetReadTimeout(t time.Duration) {
	if s.Status() == SERVER_STATUS_RUNNING {
		glog.Error(gCHANGE_CONFIG_WHILE_RUNNING_ERROR)
		return
	}
	s.config.ReadTimeout = t
}

// 设置http server参数 - WriteTimeout
func (s *Server) SetWriteTimeout(t time.Duration) {
	if s.Status() == SERVER_STATUS_RUNNING {
		glog.Error(gCHANGE_CONFIG_WHILE_RUNNING_ERROR)
		return
	}
	s.config.WriteTimeout = t
}

// 设置http server参数 - IdleTimeout
func (s *Server) SetIdleTimeout(t time.Duration) {
	if s.Status() == SERVER_STATUS_RUNNING {
		glog.Error(gCHANGE_CONFIG_WHILE_RUNNING_ERROR)
		return
	}
	s.config.IdleTimeout = t
}

// 设置http server参数 - MaxHeaderBytes
func (s *Server) SetMaxHeaderBytes(b int) {
	if s.Status() == SERVER_STATUS_RUNNING {
		glog.Error(gCHANGE_CONFIG_WHILE_RUNNING_ERROR)
		return
	}
	s.config.MaxHeaderBytes = b

}

// 设置http server参数 - ServerAgent
func (s *Server) SetServerAgent(agent string) {
	if s.Status() == SERVER_STATUS_RUNNING {
		glog.Error(gCHANGE_CONFIG_WHILE_RUNNING_ERROR)
		return
	}
	s.config.ServerAgent = agent
}

func (s *Server) SetGzipContentTypes(types []string) {
	if s.Status() == SERVER_STATUS_RUNNING {
		glog.Error(gCHANGE_CONFIG_WHILE_RUNNING_ERROR)
		return
	}
	s.config.GzipContentTypes = types
}

// 服务注册时对象和方法名称转换为URI时的规则
func (s *Server) SetNameToUriType(t int) {
	if s.Status() == SERVER_STATUS_RUNNING {
		glog.Error(gCHANGE_CONFIG_WHILE_RUNNING_ERROR)
		return
	}
	s.config.NameToUriType = t
}

// 是否在程序启动时打印路由表信息
func (s *Server) SetDumpRouteMap(enabled bool) {
	if s.Status() == SERVER_STATUS_RUNNING {
		glog.Error(gCHANGE_CONFIG_WHILE_RUNNING_ERROR)
		return
	}
	s.config.DumpRouteMap = enabled
}

// 设置路由缓存过期时间(秒)
func (s *Server) SetRouterCacheExpire(expire int) {
	if s.Status() == SERVER_STATUS_RUNNING {
		glog.Error(gCHANGE_CONFIG_WHILE_RUNNING_ERROR)
		return
	}
	s.config.RouterCacheExpire = expire
}

// 设置KeepAlive
func (s *Server) SetKeepAlive(enabled bool) {
	if s.Status() == SERVER_STATUS_RUNNING {
		glog.Error(gCHANGE_CONFIG_WHILE_RUNNING_ERROR)
		return
	}
	s.config.KeepAlive = enabled
}

// 获取WebServer名称
func (s *Server) GetName() string {
	return s.name
}