/
component.go
278 lines (249 loc) · 7.17 KB
/
component.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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
package egin
import (
"context"
"crypto/tls"
"crypto/x509"
"embed"
"errors"
"fmt"
"io/fs"
"net"
"net/http"
"os"
"path"
"path/filepath"
"strings"
"sync"
healthcheck "github.com/RaMin0/gin-health-check"
"github.com/gin-gonic/gin"
"github.com/go-resty/resty/v2"
"github.com/gotomicro/ego/core/constant"
"github.com/gotomicro/ego/core/eapp"
"github.com/gotomicro/ego/core/elog"
"github.com/gotomicro/ego/server"
)
// PackageName 包名
const PackageName = "server.egin"
// Component ...
type Component struct {
*gin.Engine
mu sync.Mutex
name string
config *Config
logger *elog.Component
Server *http.Server
listener net.Listener
routerCommentMap map[string]string // router的中文注释,非并发安全
embedWrapper *EmbedWrapper
invokers []func() error // 用户初始化函数
}
func newComponent(name string, config *Config, logger *elog.Component) *Component {
gin.SetMode(config.Mode)
comp := &Component{
name: name,
config: config,
logger: logger,
Engine: gin.New(),
listener: nil,
routerCommentMap: make(map[string]string),
}
// 判断是否存在自定义listener
if config.listener != nil {
comp.listener = config.listener
}
if config.EmbedPath != "" {
comp.embedWrapper = &EmbedWrapper{
embedFs: config.embedFs,
path: config.EmbedPath,
}
}
// 设置信任的header头
comp.Engine.TrustedPlatform = config.TrustedPlatform
comp.Engine.UseH2C = config.EnableH2C
return comp
}
// Name 配置名称
func (c *Component) Name() string {
return c.name
}
// PackageName 包名
func (c *Component) PackageName() string {
return PackageName
}
// Prepare 预准备数据
func (c *Component) Prepare() error {
for _, fn := range c.invokers {
err := fn()
if err != nil {
return err
}
}
return nil
}
// Init 初始化
func (c *Component) Init() error {
// 如果没有配置listener
if c.config.listener == nil {
if err := c.defaultListener(); err != nil {
return err
}
}
c.config.Port = c.listener.Addr().(*net.TCPAddr).Port
return nil
}
func (c *Component) defaultListener() error {
var err error
if c.config.Network == "local" {
c.listener = newLocalListener()
} else {
c.listener, err = net.Listen(c.config.Network, c.config.Address())
if err != nil {
c.logger.Panic("new egin server err", elog.FieldErrKind("listen err"), elog.FieldErr(err))
}
}
return nil
}
// Health implements server.Component interface.
func (c *Component) Health() bool {
cli, err := resty.New().
SetHeader("app", eapp.Name()).
SetBaseURL("http://"+c.config.Address()).R().SetHeader(healthcheck.DefaultHeaderName, healthcheck.DefaultHeaderValue).Get("/")
if err != nil {
c.logger.Error("health fail", elog.FieldErr(err))
return false
}
return cli.StatusCode() == healthcheck.DefaultResponseCode && cli.String() == healthcheck.DefaultResponseText
}
// RegisterRouteComment 注册路由注释
func (c *Component) RegisterRouteComment(method, path, comment string) {
c.routerCommentMap[commentUniqKey(method, path)] = comment
}
// Start implements server.Component interface.
func (c *Component) Start() error {
var err error
for _, route := range c.Engine.Routes() {
info, flag := c.routerCommentMap[commentUniqKey(route.Method, route.Path)]
// 如果有注释,日志打出来
if flag {
c.logger.Info("add route", elog.FieldMethod(route.Method), elog.String("path", route.Path), elog.Any("info", info))
} else {
c.logger.Info("add route", elog.FieldMethod(route.Method), elog.String("path", route.Path))
}
}
// 因为start和stop在多个goroutine里,需要对Server上写锁
c.mu.Lock()
c.Server = &http.Server{
Addr: c.config.Address(),
Handler: c,
ReadHeaderTimeout: c.config.ServerReadHeaderTimeout,
ReadTimeout: c.config.ServerReadTimeout,
WriteTimeout: c.config.ServerWriteTimeout,
// Handler: http.TimeoutHandler(c, 1*time.Second, "timeout"),
}
c.mu.Unlock()
if c.config.EnableTLS {
config, errTLS := c.buildTLSConfig()
if errTLS != nil {
return errTLS
}
c.Server.TLSConfig = config
err = c.Server.ServeTLS(c.listener, "", "")
} else {
err = c.Server.Serve(c.listener)
}
if err == http.ErrServerClosed {
return nil
}
return err
}
// Stop implements server.Component interface
// it will terminate gin server immediately
func (c *Component) Stop() error {
c.mu.Lock()
err := c.Server.Close()
c.mu.Unlock()
return err
}
// GracefulStop implements server.Component interface
// it will stop gin server gracefully
func (c *Component) GracefulStop(ctx context.Context) error {
c.mu.Lock()
err := c.Server.Shutdown(ctx)
c.mu.Unlock()
return err
}
// Info returns server info, used by governor and consumer balancer
func (c *Component) Info() *server.ServiceInfo {
info := server.ApplyOptions(
server.WithScheme("http"),
server.WithAddress(c.listener.Addr().String()),
server.WithKind(constant.ServiceProvider),
)
return &info
}
// Invoker returns server info, used by governor and consumer balancer
// Experimental
func (c *Component) Invoker(fns ...func() error) {
c.invokers = append(c.invokers, fns...)
}
func commentUniqKey(method, path string) string {
return fmt.Sprintf("%s@%s", strings.ToLower(method), path)
}
func (c *Component) buildTLSConfig() (*tls.Config, error) {
tlsConfig := &tls.Config{}
serverCert, err := tls.LoadX509KeyPair(c.config.TLSCertFile, c.config.TLSKeyFile)
if err != nil {
return nil, err
}
tlsConfig.Certificates = []tls.Certificate{serverCert}
tlsConfig.ClientCAs = x509.NewCertPool()
tlsConfig.ClientAuth = c.config.ClientAuthType()
tlsConfig.ClientSessionCache = c.config.TLSSessionCache
clientCAs := c.config.TLSClientCAs
for i := range clientCAs {
clientCA := clientCAs[i]
ca, err := os.ReadFile(clientCA)
if err != nil {
return nil, fmt.Errorf("read client ca fail:%+v", err)
}
if !tlsConfig.ClientCAs.AppendCertsFromPEM(ca) {
return nil, fmt.Errorf("append client ca fail:%+v", err)
}
}
return tlsConfig, nil
}
// HTTPEmbedFs http的文件系统
func (c *Component) HTTPEmbedFs() http.FileSystem {
return http.FS(c.embedWrapper)
}
// GetEmbedWrapper http的文件系统
func (c *Component) GetEmbedWrapper() *EmbedWrapper {
return c.embedWrapper
}
// Listener listener信息
func (c *Component) Listener() net.Listener {
return c.listener
}
// EmbedWrapper 嵌入普通的静态资源的wrapper
type EmbedWrapper struct {
embedFs embed.FS // 静态资源
path string // 设置embed文件到静态资源的相对路径,也就是embed注释里的路径
}
// Open 静态资源被访问的核心逻辑
func (e *EmbedWrapper) Open(name string) (fs.File, error) {
if filepath.Separator != '/' && strings.ContainsRune(name, filepath.Separator) {
return nil, errors.New("http: invalid character in file path")
}
fullName := filepath.ToSlash(path.Join(e.path, path.Clean("/"+name)))
file, err := e.embedFs.Open(fullName)
return file, err
}
func newLocalListener() net.Listener {
l, err := net.Listen("tcp", "127.0.0.1:0")
if err != nil {
if l, err = net.Listen("tcp6", "[::1]:0"); err != nil {
panic(fmt.Sprintf("httptest: failed to listen on a port: %v", err))
}
}
return l
}