update: add resp 418

chore: add ctx alias method

.github/workflows/nfctl.yml

@@ -2,7 +2,7 @@ name: Auto Build
 on:
   push:
     branches:
-      - 'master'
+      - 'release/nfctl/*'
 
 env:
   RELEASE_VERSION: v24.07.14-r3

ctx.go

@@ -51,11 +51,10 @@ func newContext(app *App, writer http.ResponseWriter, request *http.Request) *Ct
 	}
 
 	c := context.WithValue(request.Context(), TraceKey, traceId)
-	request.WithContext(c)
 
 	ctx := &Ctx{
 		lock:       sync.Mutex{},
-		Request:    request,
+		Request:    request.WithContext(c),
 		path:       request.URL.Path,
 		method:     request.Method,
 		StatusCode: 200,
@@ -75,6 +74,7 @@ func newContext(app *App, writer http.ResponseWriter, request *http.Request) *Ct
 	}
 
 	ctx.Writer = &ctx.writermem
+	ctx.writermem.Header().Set(TraceKey, traceId)
 
 	return ctx
 }
@@ -289,23 +289,30 @@ func (c *Ctx) Status(code int) *Ctx {
 	c.lock.Lock()
 	defer c.lock.Unlock()
 
-	c.writermem.WriteHeader(code)
+	c.Writer.WriteHeader(code)
 	c.StatusCode = c.writermem.status
 
 	return c
 }
 
+// Set set response header
 func (c *Ctx) Set(key string, value string) {
-	c.writermem.Header().Set(key, value)
+	c.Writer.Header().Set(key, value)
 }
 
+// AddHeader add response header
+func (c *Ctx) AddHeader(key string, value string) {
+	c.Writer.Header().Add(key, value)
+}
+
+// SetHeader set response header
 func (c *Ctx) SetHeader(key string, value string) {
-	c.writermem.Header().Set(key, value)
+	c.Writer.Header().Set(key, value)
 }
 
 func (c *Ctx) SendStatus(code int) error {
 	c.Status(code)
-	c.writermem.WriteHeaderNow()
+	c.Writer.WriteHeaderNow()
 	return nil
 }
 
@@ -323,7 +330,7 @@ func (c *Ctx) Writef(format string, values ...interface{}) (int, error) {
 func (c *Ctx) JSON(data interface{}) error {
 	c.SetHeader("Content-Type", MIMEApplicationJSON)
 
-	encoder := json.NewEncoder(&c.writermem)
+	encoder := json.NewEncoder(c.Writer)
 
 	if err := encoder.Encode(data); err != nil {
 		return err
@@ -356,5 +363,5 @@ func (c *Ctx) HTML(html string) error {
 }
 
 func (c *Ctx) Write(data []byte) (int, error) {
-	return c.writermem.Write(data)
+	return c.Writer.Write(data)
 }

middleware.go

@@ -2,11 +2,9 @@ package nf
 
 import (
 	"fmt"
-	"github.com/google/uuid"
 	"github.com/loveuer/nf/nft/log"
 	"os"
 	"runtime/debug"
-	"strings"
 	"time"
 )
 
@@ -29,33 +27,19 @@ func NewRecover(enableStackTrace bool) HandlerFunc {
 	}
 }
 
-func NewLogger(traceHeader ...string) HandlerFunc {
+func NewLogger() HandlerFunc {
-	Header := "X-Trace-ID"
-	if len(traceHeader) > 0 && traceHeader[0] != "" {
-		Header = traceHeader[0]
-	}
 
 	return func(c *Ctx) error {
 		var (
 			now   = time.Now()
-			trace = c.Get(Header)
 			logFn func(msg string, data ...any)
 			ip    = c.IP()
 		)
 
-		if trace == "" {
-			trace = uuid.Must(uuid.NewV7()).String()
-		}
-
-		c.SetHeader(Header, trace)
-
-		traces := strings.Split(trace, "-")
-		shortTrace := traces[len(traces)-1]
-
 		err := c.Next()
 		duration := time.Since(now)
 
-		msg := fmt.Sprintf("NF | %s | %15s | %3d | %s | %6s | %s", shortTrace, ip, c.StatusCode, HumanDuration(duration.Nanoseconds()), c.Method(), c.Path())
+		msg := fmt.Sprintf("NF | %v | %15s | %3d | %s | %6s | %s", c.Context().Value(TraceKey), ip, c.StatusCode, HumanDuration(duration.Nanoseconds()), c.Method(), c.Path())
 
 		switch {
 		case c.StatusCode >= 500:

nft/log/default.go

@@ -21,7 +21,7 @@ var (
 		os.Exit(1)
 	}
 
-	defaultLogger = &logger{
+	DefaultLogger = &logger{
 		Mutex:      sync.Mutex{},
 		timeFormat: "2006-01-02T15:04:05",
 		writer:     os.Stdout,
@@ -36,32 +36,32 @@ var (
 )
 
 func SetTimeFormat(format string) {
-	defaultLogger.SetTimeFormat(format)
+	DefaultLogger.SetTimeFormat(format)
 }
 
 func SetLogLevel(level LogLevel) {
-	defaultLogger.SetLogLevel(level)
+	DefaultLogger.SetLogLevel(level)
 }
 
 func Debug(msg string, data ...any) {
-	defaultLogger.Debug(msg, data...)
+	DefaultLogger.Debug(msg, data...)
 }
 func Info(msg string, data ...any) {
-	defaultLogger.Info(msg, data...)
+	DefaultLogger.Info(msg, data...)
 }
 
 func Warn(msg string, data ...any) {
-	defaultLogger.Warn(msg, data...)
+	DefaultLogger.Warn(msg, data...)
 }
 
 func Error(msg string, data ...any) {
-	defaultLogger.Error(msg, data...)
+	DefaultLogger.Error(msg, data...)
 }
 
 func Panic(msg string, data ...any) {
-	defaultLogger.Panic(msg, data...)
+	DefaultLogger.Panic(msg, data...)
 }
 
 func Fatal(msg string, data ...any) {
-	defaultLogger.Fatal(msg, data...)
+	DefaultLogger.Fatal(msg, data...)
 }

nft/resp/resp.go

@@ -2,9 +2,10 @@ package resp
 
 import (
 	"fmt"
-	"github.com/loveuer/nf"
 	"strconv"
 	"strings"
+
+	"github.com/loveuer/nf"
 )
 
 func handleEmptyMsg(status uint32, msg string) string {
@@ -102,6 +103,18 @@ func Resp403(c *nf.Ctx, data any, msgs ...string) error {
 	return Resp(c, 403, msg, err, data)
 }
 
+func Resp418(c *nf.Ctx, data any, msgs ...string) error {
+	msg := MSG418
+	err := ""
+
+	if len(msgs) > 0 && msgs[0] != "" {
+		msg = fmt.Sprintf("%s: %s", msg, strings.Join(msgs, "; "))
+		err = ""
+	}
+
+	return Resp(c, 418, msg, err, data)
+}
+
 func Resp429(c *nf.Ctx, data any, msgs ...string) error {
 	msg := MSG429
 	err := ""

nft/resp/var.go

@@ -7,6 +7,7 @@ const (
 	MSG401 = "登录已过期, 请重新登录"
 	MSG403 = "请求权限不足"
 	MSG404 = "请求资源未找到"
+	MSG418 = "请求条件不满足, 请稍后再试"
 	MSG429 = "请求过于频繁, 请稍后再试"
 	MSG500 = "服务器开小差了, 请稍后再试"
 	MSG501 = "功能开发中, 尽情期待"

readme.md

@@ -5,8 +5,9 @@
 ##### basic usage
 
 - get param
-```go
+
-func main() {
+  ```go
+  func main() {
       app := nf.New()
 
       app.Get("/hello/:name", func(c *nf.Ctx) error {
@@ -15,12 +16,13 @@ func main() {
       })
 
       log.Fatal(app.Run("0.0.0.0:80"))
-}
+  }
-```
+  ```
 
 - parse request query
-```go
+
-func handleQuery(c *nf.Ctx) error {
+  ```go
+  func handleQuery(c *nf.Ctx) error {
       type Req struct {
           Name string   `query:"name"`
           Addr []string `query:"addr"`
@@ -36,12 +38,13 @@ func handleQuery(c *nf.Ctx) error {
       }
 
       return c.JSON(nf.Map{"query": req})
-}
+  }
-```
+  ```
 
 - parse application/json body
-```go
+
-func handlePost(c *nf.Ctx) error {
+  ```go
+  func handlePost(c *nf.Ctx) error {
       type Req struct {
           Name string   `json:"name"`
           Addr []string `json:"addr"`
@@ -63,5 +66,37 @@ func handlePost(c *nf.Ctx) error {
       }
 
       return c.JSON(nf.Map{"struct": req, "map": reqMap})
-}
+  }
-```
+  ```
+
+- pass local value
+
+  ```go
+  type User struct {
+      Id int
+      Username string
+  }
+
+  func main() {
+      app := nf.New()
+      app.Use(auth())
+
+      app.Get("/item/list", list)
+  }
+
+  func auth() nf.HandlerFunc {
+      return func(c *nf.Ctx) error {
+          c.Locals("user", &User{Id: 1, Username:"user"})
+          return c.Next()
+      }
+  }
+
+  func list(c *nf.Ctx) error {
+      user, ok := c.Locals("user").(*User)
+      if !ok {
+          return c.Status(401).SendString("login required")
+      }
+
+      ...
+  }
+  ```