-
Notifications
You must be signed in to change notification settings - Fork 1
/
gin.go
420 lines (354 loc) · 10.8 KB
/
gin.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
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
package contact
import (
"context"
"fmt"
"github.com/gin-gonic/gin"
"github.com/go-playground/validator/v10"
"github.com/go-resty/resty/v2"
lib "github.com/maxiloEmmmm/go-tool"
"github.com/opentracing/opentracing-go"
"github.com/uber/jaeger-client-go"
jaegercfg "github.com/uber/jaeger-client-go/config"
"io"
"net/http"
"strconv"
"strings"
"time"
)
type page struct {
PageKey string
PageSizeKey string
PageSizeDefault int
CurrentDefault int
}
type pageInfo struct {
Current int
Size int
}
var GinPage = page{PageKey: "page", PageSizeKey: "page_size", PageSizeDefault: 15, CurrentDefault: 1}
func (help *GinHelp) GetPageInfo() pageInfo {
var gp pageInfo
if val, exist := help.Get("page"); exist {
gp = val.(pageInfo)
} else {
gp = pageInfo{
Current: GinPage.CurrentDefault,
Size: GinPage.PageSizeDefault,
}
}
return gp
}
type GinDataEnginePageHelp func(current int, size int) interface{}
func (help *GinHelp) GinPageHelp(cb GinDataEnginePageHelp) interface{} {
var gp = help.GetPageInfo()
return GinPageBase(cb, gp.Current, gp.Size)
}
func (help *GinHelp) GinPageHelpWithOptionSize(cb GinDataEnginePageHelp, size int) interface{} {
var gp = help.GetPageInfo()
return GinPageBase(cb, gp.Current, size)
}
func GinPageBase(cb GinDataEnginePageHelp, current int, size int) interface{} {
return cb(current, size)
}
type Cors struct {
AllowOrigin []string
AllowHeaders []string
AllowMethods []string
// response header without Cache-Control、Content-Language、Content-Type、Expires、Last-Modified、Pragma
// if client will get...
ExposeHeaders []string
AllowCredentials bool
}
var CorsConfig = Cors{
AllowOrigin: []string{"*"},
AllowHeaders: []string{"Content-Type", "AccessToken", "X-CSRF-Token", "Authorization", "X-Requested-With"},
AllowMethods: []string{"POST", "GET", "OPTIONS", "PUT", "PATCH", "DELETE"},
AllowCredentials: false,
}
func GinCors() gin.HandlerFunc {
return func(c *gin.Context) {
method := c.Request.Method
origin := c.GetHeader("Origin")
if lib.InArray(CorsConfig.AllowOrigin, "*") || lib.InArray(CorsConfig.AllowOrigin, origin) {
c.Header("Access-Control-Allow-Origin", origin)
c.Header("Access-Control-Allow-Headers", strings.Join(CorsConfig.AllowHeaders, ","))
c.Header("Access-Control-Allow-Methods", strings.Join(CorsConfig.AllowMethods, ","))
c.Header("Access-Control-Expose-Headers", strings.Join(CorsConfig.ExposeHeaders, ","))
c.Header("Access-Control-Allow-Credentials", lib.AssetsReturn(CorsConfig.AllowCredentials, "true", "false").(string))
if method == "OPTIONS" {
c.AbortWithStatus(http.StatusNoContent)
}
}
c.Next()
}
}
func InitOpenTracing() (opentracing.Tracer, io.Closer) {
cfg, err := jaegercfg.FromEnv()
cfg.ServiceName = Config.OpenTracing.Service
cfg.Sampler.Type = Config.OpenTracing.Sampler.Type
cfg.Sampler.Param = Config.OpenTracing.Sampler.Param
cfg.Reporter.LogSpans = Config.OpenTracing.Reporter.LogSpans
cfg.Reporter.LocalAgentHostPort = Config.OpenTracing.Reporter.LocalAgentHostPort
tracer, closer, err := cfg.NewTracer(jaegercfg.Logger(jaeger.StdLogger))
if err != nil {
gin.DefaultWriter.Write([]byte(fmt.Sprintf("ERROR: cannot init Jaeger: %v\n", err)))
}
// opentracing.setGlobalTracer is singleton, not better
return tracer, closer
}
func SpanWrap(tracer opentracing.Tracer, key string, span opentracing.Span) opentracing.Span {
var s opentracing.Span
if span != nil {
s = tracer.StartSpan(key, opentracing.ChildOf(span.Context()))
} else {
s = tracer.StartSpan(key)
}
return s
}
func ClientSpanWrap(tracer opentracing.Tracer, span opentracing.Span) *resty.Client {
client := resty.New()
client.OnBeforeRequest(func(client *resty.Client, request *resty.Request) error {
s := SpanWrap(tracer, request.Method, span)
s.SetTag("url", request.URL)
client.OnAfterResponse(func(client *resty.Client, response *resty.Response) error {
s.Finish()
return nil
})
tracer.Inject(
s.Context(),
opentracing.HTTPHeaders,
opentracing.HTTPHeadersCarrier(request.Header))
return nil
})
return client
}
func GinOpenTracing() gin.HandlerFunc {
return func(c *gin.Context) {
tracer, closer := InitOpenTracing()
var serverSpan opentracing.Span
wireContext, err := tracer.Extract(
opentracing.HTTPHeaders,
opentracing.HTTPHeadersCarrier(c.Request.Header))
if err != nil {
serverSpan = tracer.StartSpan("request")
} else {
serverSpan = tracer.StartSpan("request", opentracing.ChildOf(wireContext))
}
c.Set("open-tracing.span", serverSpan)
c.Set("open-tracing.tracer", tracer)
defer func() {
serverSpan.Finish()
closer.Close()
}()
c.Next()
}
}
func InitGin() {
switch Config.App.Mode {
case gin.DebugMode:
gin.SetMode(gin.DebugMode)
case gin.ReleaseMode:
gin.SetMode(gin.ReleaseMode)
case gin.TestMode:
gin.SetMode(gin.TestMode)
default:
gin.SetMode(gin.DebugMode)
}
}
var ServerErrorWrite = new(ServerErrorIO)
type ServerErrorIO struct{}
func (sew ServerErrorIO) Write(p []byte) (n int, err error) {
buffer := new(strings.Builder)
buffer.WriteString("[SERVER_ERROR]:")
buffer.Write(p)
return gin.DefaultWriter.Write([]byte(buffer.String()))
}
func GinHelpHandle(h GinHelpHandlerFunc) gin.HandlerFunc {
return func(c *gin.Context) {
gp := pageInfo{Current: 1, Size: 10}
if page, err := strconv.Atoi(c.DefaultQuery(GinPage.PageKey, "1")); err == nil {
gp.Current = page
}
if pageSize, err := strconv.Atoi(c.DefaultQuery(GinPage.PageSizeKey, string(GinPage.PageSizeDefault))); err == nil {
gp.Size = pageSize
}
c.Set("page", gp)
help := &GinHelp{Context: c, AppContext: context.Background()}
help.AppContext = context.WithValue(help.AppContext, "app", help)
defer func(c *GinHelp) {
if err := recover(); err != nil {
switch err.(type) {
case ResponseAbortError:
{
return
}
default:
{
errMsg := ""
if e, ok := err.(error); ok {
errMsg = e.(error).Error()
} else {
errMsg = fmt.Sprintf("%+v", err)
}
md5 := lib.Md5(fmt.Sprintf("%d%s", time.Now().Unix(), errMsg))
ServerErrorWrite.Write([]byte(lib.StringJoin(md5, "-", errMsg)))
if span, exist := c.Get("open-tracing.span"); exist {
span.(opentracing.Span).LogKV(
"msg", errMsg,
"error_code", md5,
)
span.(opentracing.Span).SetTag("status", "error")
}
c.AbortWithStatusJSON(http.StatusUnprocessableEntity, InValidFunc("server", md5))
}
}
}
}(help)
h(help)
}
}
type ResponseAbortError struct{}
func (r ResponseAbortError) Error() string {
return "abort"
}
type GinHelp struct {
*gin.Context
AppContext context.Context
}
type GinHelpHandlerFunc func(c *GinHelp)
type H map[string]interface{}
func GinRouteAuth() gin.HandlerFunc {
return GinHelpHandle(func(c *GinHelp) {
token := c.GetToken()
jwt := JwtNew()
jwt.SetSecret(Config.Jwt.Secret)
if err := jwt.ParseToken(token); err != nil {
c.InValidError("auth:token:parse", err)
} else {
c.Set("auth", jwt)
c.Next()
}
})
}
func (help *GinHelp) SpanWrapWithApp(key string) opentracing.Span {
return SpanWrap(help.TracingTracer(), key, help.TracingSpan())
}
func (help *GinHelp) ClientSpanWrapWithApp() *resty.Client {
return ClientSpanWrap(help.TracingTracer(), help.TracingSpan())
}
func (help *GinHelp) TracingSpan() opentracing.Span {
if context, exist := help.Get("open-tracing.span"); exist {
return context.(opentracing.Span)
} else {
return nil
}
}
func (help *GinHelp) TracingTracer() opentracing.Tracer {
if context, exist := help.Get("open-tracing.tracer"); exist {
return context.(opentracing.Tracer)
} else {
return nil
}
}
// 响应
func (help *GinHelp) Response(code int, jsonObj interface{}) {
help.AbortWithStatusJSON(code, jsonObj)
panic(ResponseAbortError{})
}
// 分页响应辅助
func (help *GinHelp) ResourcePage(data interface{}, total int) {
help.Resource(H{
"data": data,
"total": total,
})
}
// 成功响应
func (help *GinHelp) Resource(data interface{}) {
help.Response(http.StatusOK, data)
}
// 创建成功响应
func (help *GinHelp) ResourceCreate(data interface{}) {
help.Response(http.StatusCreated, data)
}
// 删除成功响应
func (help *GinHelp) ResourceDelete() {
help.Response(http.StatusNoContent, "")
}
// 资源丢失响应 不推荐使用 太过于底层 推荐InValid*
func (help *GinHelp) ResourceNotFound() {
help.Response(http.StatusNotFound, "")
}
type GinInValidFunc func(code string, message string) interface{}
var InValidFunc GinInValidFunc = defaultInValidFunc
var defaultInValidFunc GinInValidFunc = func(code string, message string) interface{} {
return H{
"code": code,
"message": message,
}
}
// 客户端错误响应
func (help *GinHelp) InValid(code string, msg string) {
help.Response(http.StatusUnprocessableEntity, InValidFunc(code, msg))
}
// 断言客户端错误
func (help *GinHelp) AssetsInValid(code string, err error) {
if err != nil {
switch err.(type) {
case validator.ValidationErrors:
{
if errors, ok := err.(validator.ValidationErrors); ok && len(errors) > 0 {
e := errors[0]
help.InValid(code, lib.StringJoin(
e.Translate(Tranintance.Tran),
", 类型: ", e.Type().Name(),
", 当前值: ", fmt.Sprintf("%v", e.Value()),
", 数据结构路径: ", e.StructNamespace()))
} else {
help.InValidError(code, err)
}
}
default:
help.InValidError(code, err)
}
}
}
// 客户端错误响应
func (help *GinHelp) InValidError(code string, err error) {
help.InValid(code, err.Error())
}
// 客户端query错误响应
func (help *GinHelp) InValidBindQuery(query interface{}) {
help.AssetsInValid("input:query", help.ShouldBindQuery(query))
}
// 客户端uri错误响应
func (help *GinHelp) InValidBindUri(query interface{}) {
help.AssetsInValid("input:uri", help.ShouldBindUri(query))
}
// 客户端body错误响应
func (help *GinHelp) InValidBind(json interface{}) {
help.AssetsInValid("input:body", help.ShouldBind(json))
}
// 客户端未认证 不推荐使用 太过于底层 推荐InValid*
func (help *GinHelp) Unauthorized(msg string) {
help.Response(http.StatusUnauthorized, map[string]interface{}{"msg": msg})
}
// 客户端错误请求 不推荐使用 太过于底层 推荐InValid*
func (help *GinHelp) BadRequest(msg string) {
help.Response(http.StatusBadRequest, map[string]interface{}{"msg": msg})
}
// 客户端权限不足 不推荐使用 太过于底层 推荐InValid*
func (help *GinHelp) Forbidden(msg string) {
help.Response(http.StatusForbidden, map[string]interface{}{"msg": msg})
}
// 服务端错误响应 不推荐使用 太过于底层 推荐InValid*
func (help *GinHelp) ServerError(msg string) {
help.Response(http.StatusInternalServerError, map[string]interface{}{"msg": msg})
}
// 获取token
func (help *GinHelp) GetToken() string {
token := help.GetHeader("Authorization")
if len(token) == 0 {
token, _ = help.GetQuery("token")
}
return token
}