feat: add gin logger middleware

rm: nf mod

middlewares/logger/logger.go

@@ -0,0 +1,74 @@
+package logger
+
+import (
+	"fmt"
+	"gitea.loveuer.com/yizhisec/packages/logger"
+	"gitea.loveuer.com/yizhisec/packages/opt"
+	"gitea.loveuer.com/yizhisec/packages/tool"
+	"github.com/gin-gonic/gin"
+	"strings"
+	"sync"
+	"time"
+)
+
+var (
+	defaultTrace      = "middleware-logger"
+	stringBuilderPool = sync.Pool{
+		New: func() interface{} {
+			return &strings.Builder{}
+		},
+	}
+)
+
+func New() gin.HandlerFunc {
+	return func(c *gin.Context) {
+		start := time.Now()
+		ip := c.RemoteIP()
+
+		trace := c.Request.Header.Get(opt.TraceKey)
+		if trace == "" {
+			if v, ok := c.Request.Context().Value(opt.TraceKey).(string); ok && v != "" {
+				trace = v
+			} else {
+				trace = defaultTrace
+			}
+		}
+
+		c.Next()
+
+		status := c.Writer.Status()
+		duration := time.Since(start)
+
+		var logFn func(msg string, data ...any)
+		switch {
+		case status >= 500:
+			logFn = logger.Error
+		case status >= 400:
+			logFn = logger.Warn
+		default:
+			logFn = logger.Info
+		}
+
+		if logFn != nil {
+			b := stringBuilderPool.Get().(*strings.Builder)
+			b.Reset()
+
+			b.WriteString("[")
+			b.WriteString(fmt.Sprintf("%36s", trace))
+			b.WriteString("] | ")
+			b.WriteString(fmt.Sprintf("%3d", status))
+			b.WriteString(" | ")
+			b.WriteString(fmt.Sprintf("%15s", ip))
+			b.WriteString(" | ")
+			b.WriteString(tool.HumanDuration(duration.Nanoseconds()))
+			b.WriteString(" | ")
+			b.WriteString(c.Request.Method)
+			b.WriteString(" | ")
+			b.WriteString(c.Request.RequestURI)
+
+			logFn(b.String())
+
+			stringBuilderPool.Put(b)
+		}
+	}
+}

middlewares/logger/logger_test.go

@@ -0,0 +1,59 @@
+package logger
+
+import (
+	"errors"
+	"github.com/gin-gonic/gin"
+	"net/http"
+	"testing"
+	"time"
+)
+
+func TestLogger(t *testing.T) {
+	gin.SetMode(gin.TestMode)
+	app := gin.New()
+	app.Use(New())
+
+	app.GET("/200", func(c *gin.Context) {
+		c.JSON(200, gin.H{"hello": "world"})
+	})
+	app.GET("/400", func(c *gin.Context) {
+		c.JSON(400, gin.H{"hello": "world"})
+	})
+	app.GET("/500", func(c *gin.Context) {
+		c.JSON(500, gin.H{"hello": "world"})
+	})
+
+	ok := make(chan struct{})
+	svc := http.Server{
+		Handler: app,
+		Addr:    "127.0.0.1:8080",
+	}
+	go func() {
+		ok <- struct{}{}
+		if err := svc.ListenAndServe(); err != nil && !errors.Is(err, http.ErrServerClosed) {
+			t.Error(err)
+		}
+	}()
+
+	<-ok
+	time.Sleep(200 * time.Millisecond)
+
+	justErr := func(_ any, e error) error {
+		return e
+	}
+
+	err := errors.Join(
+		justErr(http.Get("http://127.0.0.1:8080/200")),
+		justErr(http.Get("http://127.0.0.1:8080/400")),
+		justErr(http.Get("http://127.0.0.1:8080/500")),
+	)
+
+	if err != nil {
+		t.Error(err)
+	}
+
+	err = svc.Shutdown(t.Context())
+	if err != nil {
+		t.Error(err)
+	}
+}