-
Notifications
You must be signed in to change notification settings - Fork 3
/
setup.go
138 lines (123 loc) · 5.03 KB
/
setup.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
package ginKit
import (
"github.com/gin-contrib/pprof"
"github.com/gin-gonic/gin"
"github.com/richelieu-yang/chimera/v2/src/consts"
"github.com/richelieu-yang/chimera/v2/src/core/errorKit"
"github.com/richelieu-yang/chimera/v2/src/core/interfaceKit"
"github.com/richelieu-yang/chimera/v2/src/log/logrusKit"
"github.com/richelieu-yang/chimera/v2/src/netKit"
"github.com/sirupsen/logrus"
"time"
)
func MustSetUp(config *Config, recoveryMiddleware gin.HandlerFunc, businessLogic func(engine *gin.Engine) error) {
err := setUp(config, recoveryMiddleware, businessLogic)
if err != nil {
logrusKit.DisableQuote(nil)
logrus.Fatalf("%+v", err)
}
}
// setUp
/*
PS: 正常执行的情况下,此方法会阻塞调用的协程.
@param config 可以为nil(将返回error)
@param recoveryMiddleware 可以为nil(将采用默认值 gin.Recovery())
@param businessLogic 可以为nil;业务逻辑,可以在其中进行 路由绑定 等操作...
*/
func setUp(config *Config, recoveryMiddleware gin.HandlerFunc, businessLogic func(engine *gin.Engine) error) error {
if err := interfaceKit.AssertNotNil(config, "config"); err != nil {
return err
}
// Gin的模式,默认debug模式,后续可以在 businessLogic 里面调整
gin.SetMode(config.Mode)
/*
gin框架中如何让日志文字带颜色输出?
https://mp.weixin.qq.com/s/eHtIC5egDoqx4LdAvcE5Qw
PS: 如果 Gin.ForceConsoleColor() 和 Gin.DisableConsoleColor() 都不调用,那么默认是在终端中输出日志是带颜色的,输出到其他地方是不带颜色的.
*/
if config.Colorful {
// 强制日志带颜色输出(无论是在终端还是其他输出设备)
gin.ForceConsoleColor()
} else {
// 禁用日志带颜色输出
gin.DisableConsoleColor()
}
// 通过logrus输出Gin的日志.
// Richelieu:从目前表现来看,虽然gin和logrus都可以设置颜色,但在此处,只要gin允许了,logrus的logger是否允许就无效了
gin.DefaultWriter = logrus.StandardLogger().Out
engine := NewEngine()
/*
MaxMultipartMemory只是限制内存,不是针对文件上传文件大小,即使文件大小比这个大,也会写入临时文件。
默认32MiB,并不涉及"限制上传文件的大小",原因:上传的文件s按顺序存入内存中,累加大小不得超出 32Mb ,最后累加超出的文件就存入系统的临时文件中。非文件字段部分不计入累加。所以这种情况,文件上传是没有任何限制的。
参考: https://studygolang.com/articles/22643
*/
engine.MaxMultipartMemory = 32 << 20
// pprof
if config.Pprof {
pprof.Register(engine, pprof.DefaultPrefix) // 等价于 pprof.Register(engine)
}
// middleware
if err := attachMiddlewares(engine, config.Middleware, recoveryMiddleware); err != nil {
return err
}
// favicon
if err := AttachDefaultFavicon(engine); err != nil {
return err
}
// 404
if err := AttachDefaultNoRoute(engine); err != nil {
return err
}
if businessLogic != nil {
if err := businessLogic(engine); err != nil {
return errorKit.Wrap(err, "Fail to execute businessLogic().")
}
}
ssl := config.SSL
if ssl.Port != 0 {
if config.Port == 0 {
// (1) https port(本服务使用1个端口)
if err := netKit.AssertValidPort(ssl.Port); err != nil {
return errorKit.Wrap(err, "Https port(%d) should be set to a valid value.", ssl.Port)
}
return engine.RunTLS(netKit.JoinHostnameAndPort(config.HostName, ssl.Port), ssl.CertFile, ssl.KeyFile)
} else {
// (2) https port + http port(本服务使用2个端口)
if err := netKit.AssertValidPort(ssl.Port); err != nil {
return errorKit.Wrap(err, "Https port(%d) should be set to a valid value.", ssl.Port)
}
if err := netKit.AssertValidPort(config.Port); err != nil {
return errorKit.Wrap(err, "Http port(%d) should be set to a valid value.", config.Port)
}
if config.Port == ssl.Port {
return errorKit.New("Http port and https port are same(%d).", config.Port)
}
go func() {
if err := engine.Run(netKit.JoinHostnameAndPort(config.HostName, config.Port)); err != nil {
logrus.WithError(err).WithFields(logrus.Fields{
"port": config.Port,
}).Fatalf("[%s, GIN] Fail to start http server.", consts.UpperProjectName)
}
}()
go func() {
time.Sleep(time.Millisecond * 20)
if err := engine.RunTLS(netKit.JoinHostnameAndPort(config.HostName, ssl.Port), ssl.CertFile, ssl.KeyFile); err != nil {
logrus.WithError(err).WithFields(logrus.Fields{
"port": ssl.Port,
"certFile": ssl.CertFile,
"keyFile": ssl.KeyFile,
}).Fatalf("[%s, GIN] Fail to start https server.", consts.UpperProjectName)
}
}()
select {}
}
}
// (3) http port(本服务使用1个端口)
if config.Port == 0 {
return errorKit.New("At least one of http port and https port should be set to a valid value.")
}
if err := netKit.AssertValidPort(config.Port); err != nil {
return errorKit.Wrap(err, "Http port(%d) should be set to a valid value.", config.Port)
}
return engine.Run(netKit.JoinHostnameAndPort(config.HostName, config.Port))
}