├── test ├── views │ └── mini │ │ ├── test.log │ │ ├── test.txt │ │ └── testActionResult.html ├── init_test.go ├── panic_test.go ├── https_test.go ├── param_name_test.go ├── area_test.go ├── getHttpContext_test.go ├── _apidoc_test.go ├── newApplicationBuilder_test.go ├── benchmark_run_test.go ├── error_test.go ├── routes_test.go ├── run_test.go ├── routeRegexp_test.go ├── validate_test.go ├── cors_test.go ├── response_test.go ├── inject_test.go ├── jwt_test.go ├── websocket_test.go ├── actionResult_test.go ├── controller_test.go └── request_test.go ├── minimal ├── init.go ├── handleMiddleware.go └── register.go ├── check ├── icheck.go └── check.go ├── context ├── iMiddleware.go ├── iFilter.go ├── iHttpSession.go ├── httpData.go ├── httpCookies.go ├── httpURL.go ├── httpRequest.go ├── httpResponse.go ├── httpJwt.go ├── httpRoute.go ├── httpContext.go └── regexp.go ├── controller ├── action.go ├── iActionFilter.go ├── iController.go ├── baseController.go ├── init.go ├── handleMiddleware.go └── register.go ├── action ├── IActionResult.go ├── contentResult.go ├── fileContentResult.go ├── redirectToRouteResult.go ├── imageResult.go ├── callResult.go └── viewResult.go ├── iSessionMiddlewareCreat.go ├── middleware ├── urlRewriting.go ├── websocket.go ├── cors.go ├── routing.go ├── exception.go ├── http.go ├── validate.go ├── apiResponse.go └── initMiddleware.go ├── .gitignore ├── session-redis ├── middleware │ └── session.go ├── sessionMiddlewareCreat.go ├── module.go ├── go.mod └── context │ └── httpSession.go ├── filter └── jwtFilter.go ├── module.go ├── .github ├── ISSUE_TEMPLATE │ └── feature_request.md └── workflows │ └── test.yml ├── jwt.go ├── websocket ├── handleMiddleware.go ├── socketHandler.go ├── register.go ├── webSocketContext.go └── baseContext.go ├── route.go ├── LICENSE ├── go.mod ├── httpHandler.go ├── README.md ├── run.go ├── apiDoc.go ├── serveMux.go └── applicationBuilder.go /test/views/mini/test.log: -------------------------------------------------------------------------------- 1 | ddd -------------------------------------------------------------------------------- /test/views/mini/test.txt: -------------------------------------------------------------------------------- 1 | bbb -------------------------------------------------------------------------------- /test/views/mini/testActionResult.html: -------------------------------------------------------------------------------- 1 | aaa -------------------------------------------------------------------------------- /minimal/init.go: -------------------------------------------------------------------------------- 1 | package minimal 2 | 3 | func Init() { 4 | } 5 | -------------------------------------------------------------------------------- /test/init_test.go: -------------------------------------------------------------------------------- 1 | package test 2 | 3 | func init() { 4 | //fs.Initialize[webapi.Module]("demo") 5 | } 6 | -------------------------------------------------------------------------------- /check/icheck.go: -------------------------------------------------------------------------------- 1 | package check 2 | 3 | // ICheck 当json反序化到dto时，将调用ICheck接口 4 | type ICheck interface { 5 | // Check 自定义检查 6 | Check() 7 | } 8 | -------------------------------------------------------------------------------- /context/iMiddleware.go: -------------------------------------------------------------------------------- 1 | package context 2 | 3 | // IMiddleware 中间件 4 | type IMiddleware interface { 5 | Invoke(httpContext *HttpContext) 6 | } 7 | -------------------------------------------------------------------------------- /controller/action.go: -------------------------------------------------------------------------------- 1 | package controller 2 | 3 | type Action struct { 4 | Method string // POST/GET/PUT/DELETE 5 | Params string // 函数的入参名称 6 | } 7 | -------------------------------------------------------------------------------- /action/IActionResult.go: -------------------------------------------------------------------------------- 1 | package action 2 | 3 | import "github.com/farseer-go/webapi/context" 4 | 5 | type IResult interface { 6 | ExecuteResult(httpContext *context.HttpContext) 7 | } 8 | -------------------------------------------------------------------------------- /iSessionMiddlewareCreat.go: -------------------------------------------------------------------------------- 1 | package webapi 2 | 3 | import "github.com/farseer-go/webapi/context" 4 | 5 | type ISessionMiddlewareCreat interface { 6 | // Create 创建Session中间件 7 | Create() context.IMiddleware 8 | } 9 | -------------------------------------------------------------------------------- /controller/iActionFilter.go: -------------------------------------------------------------------------------- 1 | package controller 2 | 3 | // IActionFilter 过滤器 4 | type IActionFilter interface { 5 | // OnActionExecuting Action执行前 6 | OnActionExecuting() 7 | // OnActionExecuted Action执行后 8 | OnActionExecuted() 9 | } 10 | -------------------------------------------------------------------------------- /context/iFilter.go: -------------------------------------------------------------------------------- 1 | package context 2 | 3 | // IFilter 过滤器 4 | type IFilter interface { 5 | // OnActionExecuting 页面执行前执行 6 | OnActionExecuting(httpContext *HttpContext) 7 | // OnActionExecuted 页面执行后执行 8 | OnActionExecuted(httpContext *HttpContext) 9 | } 10 | -------------------------------------------------------------------------------- /test/panic_test.go: -------------------------------------------------------------------------------- 1 | package test 2 | 3 | import ( 4 | "github.com/farseer-go/webapi" 5 | "github.com/stretchr/testify/assert" 6 | "testing" 7 | ) 8 | 9 | func TestPanic(t *testing.T) { 10 | assert.Panics(t, func() { 11 | webapi.RegisterPOST("/", func() {}) 12 | }) 13 | } 14 | -------------------------------------------------------------------------------- /context/iHttpSession.go: -------------------------------------------------------------------------------- 1 | package context 2 | 3 | type IHttpSession interface { 4 | // GetValue 获取Session 5 | GetValue(name string) any 6 | // SetValue 设置Session 7 | SetValue(name string, val any) 8 | // Remove 删除Session 9 | Remove(name string) 10 | // Clear 清空Session 11 | Clear() 12 | } 13 | -------------------------------------------------------------------------------- /controller/iController.go: -------------------------------------------------------------------------------- 1 | package controller 2 | 3 | import ( 4 | "github.com/farseer-go/collections" 5 | ) 6 | 7 | // 得到IController接口的所有方法名称 8 | var lstControllerMethodName collections.List[string] 9 | 10 | type IController interface { 11 | getAction() map[string]Action // 获取Action设置 12 | } 13 | -------------------------------------------------------------------------------- /middleware/urlRewriting.go: -------------------------------------------------------------------------------- 1 | package middleware 2 | 3 | import "github.com/farseer-go/webapi/context" 4 | 5 | type UrlRewriting struct { 6 | context.IMiddleware 7 | } 8 | 9 | func (receiver *UrlRewriting) Invoke(httpContext *context.HttpContext) { 10 | receiver.IMiddleware.Invoke(httpContext) 11 | } 12 | -------------------------------------------------------------------------------- /context/httpData.go: -------------------------------------------------------------------------------- 1 | package context 2 | 3 | import "github.com/farseer-go/collections" 4 | 5 | type HttpData struct { 6 | value collections.Dictionary[string, any] 7 | } 8 | 9 | // Get 获取值 10 | func (receiver *HttpData) Get(key string) any { 11 | return receiver.value.GetValue(key) 12 | } 13 | 14 | // Set 设置值 15 | func (receiver *HttpData) Set(key string, val any) { 16 | receiver.value.Add(key, val) 17 | } 18 | -------------------------------------------------------------------------------- /test/https_test.go: -------------------------------------------------------------------------------- 1 | package test 2 | 3 | import ( 4 | "github.com/farseer-go/fs" 5 | "github.com/farseer-go/fs/configure" 6 | "github.com/farseer-go/webapi" 7 | "testing" 8 | ) 9 | 10 | func TestHttps(t *testing.T) { 11 | fs.Initialize[webapi.Module]("demo") 12 | configure.SetDefault("Log.Component.webapi", true) 13 | 14 | webapi.UsePprof() 15 | webapi.UseTLS("", "") 16 | go webapi.Run(":80443") 17 | } 18 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Binaries for programs and plugins 2 | *.exe 3 | *.exe~ 4 | *.dll 5 | *.so 6 | *.dylib 7 | 8 | # Test binary, built with `go test -c` 9 | *.test 10 | 11 | # Output of the go coverage tool, specifically when used with LiteIDE 12 | *.out 13 | 14 | # Dependency directories (remove the comment below to include it) 15 | # vendor/ 16 | .idea/* 17 | go.sum 18 | go.work.sum 19 | go.work 20 | /test/log/ 21 | *.DS_Store -------------------------------------------------------------------------------- /controller/baseController.go: -------------------------------------------------------------------------------- 1 | package controller 2 | 3 | import ( 4 | "github.com/farseer-go/webapi/context" 5 | ) 6 | 7 | type BaseController struct { 8 | *context.HttpContext // 上下文 9 | Action map[string]Action // 设置每个Action参数 10 | } 11 | 12 | func (receiver *BaseController) getAction() map[string]Action { 13 | if receiver.Action == nil { 14 | receiver.Action = make(map[string]Action) 15 | } 16 | return receiver.Action 17 | } 18 | -------------------------------------------------------------------------------- /action/contentResult.go: -------------------------------------------------------------------------------- 1 | package action 2 | 3 | import ( 4 | "github.com/farseer-go/webapi/context" 5 | ) 6 | 7 | // ContentResult 返回响应内容 8 | type ContentResult struct { 9 | content string 10 | } 11 | 12 | func (receiver ContentResult) ExecuteResult(httpContext *context.HttpContext) { 13 | httpContext.Response.WriteString(receiver.content) 14 | } 15 | 16 | // Content 内容 17 | func Content(content string) IResult { 18 | return ContentResult{ 19 | content: content, 20 | } 21 | } 22 | -------------------------------------------------------------------------------- /session-redis/middleware/session.go: -------------------------------------------------------------------------------- 1 | package middleware 2 | 3 | import ( 4 | webapiContext "github.com/farseer-go/webapi/context" 5 | "github.com/farseer-go/webapi/session-redis/context" 6 | ) 7 | 8 | type Session struct { 9 | webapiContext.IMiddleware 10 | } 11 | 12 | func (receiver *Session) Invoke(httpContext *webapiContext.HttpContext) { 13 | httpContext.Session = context.InitSession(httpContext.Response.W, httpContext.Request.R) 14 | receiver.IMiddleware.Invoke(httpContext) 15 | } 16 | -------------------------------------------------------------------------------- /filter/jwtFilter.go: -------------------------------------------------------------------------------- 1 | package filter 2 | 3 | import ( 4 | "github.com/farseer-go/fs/exception" 5 | "github.com/farseer-go/webapi/context" 6 | ) 7 | 8 | type JwtFilter struct { 9 | } 10 | 11 | func (receiver JwtFilter) OnActionExecuting(httpContext *context.HttpContext) { 12 | if !httpContext.Jwt.Valid() { 13 | exception.ThrowWebExceptionf(context.InvalidStatusCode, context.InvalidMessage) 14 | } 15 | } 16 | 17 | func (receiver JwtFilter) OnActionExecuted(httpContext *context.HttpContext) { 18 | } 19 | -------------------------------------------------------------------------------- /session-redis/sessionMiddlewareCreat.go: -------------------------------------------------------------------------------- 1 | package session_redis 2 | 3 | import ( 4 | webapiContext "github.com/farseer-go/webapi/context" 5 | "github.com/farseer-go/webapi/session-redis/context" 6 | "github.com/farseer-go/webapi/session-redis/middleware" 7 | ) 8 | 9 | type SessionMiddlewareCreat struct { 10 | } 11 | 12 | // Create 创建Session中间件 13 | func (receiver *SessionMiddlewareCreat) Create() webapiContext.IMiddleware { 14 | go context.ClearSession() 15 | return &middleware.Session{} 16 | } 17 | -------------------------------------------------------------------------------- /test/param_name_test.go: -------------------------------------------------------------------------------- 1 | package test 2 | 3 | import ( 4 | "github.com/farseer-go/fs" 5 | "github.com/farseer-go/fs/configure" 6 | "github.com/farseer-go/webapi" 7 | "testing" 8 | ) 9 | 10 | func hello(pageSize int, pageIndex int) (int, int) { 11 | return pageSize, pageIndex 12 | } 13 | 14 | func TestParamName(t *testing.T) { 15 | fs.Initialize[webapi.Module]("demo") 16 | configure.SetDefault("Log.Component.webapi", true) 17 | webapi.RegisterDELETE("/cors/test", hello) 18 | webapi.UseCors() 19 | go webapi.Run(":8080") 20 | } 21 | -------------------------------------------------------------------------------- /controller/init.go: -------------------------------------------------------------------------------- 1 | package controller 2 | 3 | import ( 4 | "github.com/farseer-go/collections" 5 | "reflect" 6 | ) 7 | 8 | func Init() { 9 | // 获取IController的方法列表 10 | getIControllerMethodNames() 11 | } 12 | 13 | // 获取IController的方法列表 14 | func getIControllerMethodNames() { 15 | iControllerType := reflect.TypeOf((*IController)(nil)).Elem() 16 | lstControllerMethodName = collections.NewList[string]() 17 | for i := 0; i < iControllerType.NumMethod(); i++ { 18 | lstControllerMethodName.Add(iControllerType.Method(i).Name) 19 | } 20 | } 21 | -------------------------------------------------------------------------------- /action/fileContentResult.go: -------------------------------------------------------------------------------- 1 | package action 2 | 3 | import ( 4 | "github.com/farseer-go/webapi/context" 5 | "os" 6 | ) 7 | 8 | // FileContentResult 返回文件内容 9 | type FileContentResult struct { 10 | filePath string 11 | } 12 | 13 | func (receiver FileContentResult) ExecuteResult(httpContext *context.HttpContext) { 14 | file, _ := os.ReadFile(receiver.filePath) 15 | httpContext.Response.Write(file) 16 | } 17 | 18 | // FileContent 文件 19 | func FileContent(filePath string) IResult { 20 | return FileContentResult{ 21 | filePath: filePath, 22 | } 23 | } 24 | -------------------------------------------------------------------------------- /middleware/websocket.go: -------------------------------------------------------------------------------- 1 | package middleware 2 | 3 | import ( 4 | "github.com/farseer-go/webapi/context" 5 | "net/http" 6 | ) 7 | 8 | type Websocket struct { 9 | context.IMiddleware 10 | } 11 | 12 | func (receiver *Websocket) Invoke(httpContext *context.HttpContext) { 13 | httpContext.Response.SetHttpCode(http.StatusOK) 14 | httpContext.Response.SetStatusCode(http.StatusOK) 15 | 16 | // 下一步：exceptionMiddleware 17 | receiver.IMiddleware.Invoke(httpContext) 18 | 19 | _ = httpContext.WebsocketConn.WriteClose(httpContext.Response.GetHttpCode()) 20 | } 21 | -------------------------------------------------------------------------------- /module.go: -------------------------------------------------------------------------------- 1 | package webapi 2 | 3 | import ( 4 | "github.com/farseer-go/fs/modules" 5 | "github.com/farseer-go/webapi/context" 6 | "github.com/farseer-go/webapi/controller" 7 | "github.com/farseer-go/webapi/minimal" 8 | ) 9 | 10 | type Module struct { 11 | } 12 | 13 | func (module Module) DependsModule() []modules.FarseerModule { 14 | return nil 15 | } 16 | 17 | func (module Module) PreInitialize() { 18 | controller.Init() 19 | minimal.Init() 20 | defaultApi = NewApplicationBuilder() 21 | } 22 | 23 | func (module Module) PostInitialize() { 24 | context.InitJwt() 25 | } 26 | -------------------------------------------------------------------------------- /action/redirectToRouteResult.go: -------------------------------------------------------------------------------- 1 | package action 2 | 3 | import ( 4 | "github.com/farseer-go/webapi/context" 5 | "net/http" 6 | ) 7 | 8 | // RedirectToRouteResult 重定向功能 9 | type RedirectToRouteResult struct { 10 | url string 11 | } 12 | 13 | func (receiver RedirectToRouteResult) ExecuteResult(httpContext *context.HttpContext) { 14 | httpContext.Response.AddHeader("Location", receiver.url) 15 | httpContext.Response.SetHttpCode(http.StatusFound) 16 | } 17 | 18 | // Redirect 重定向 19 | func Redirect(url string) IResult { 20 | return RedirectToRouteResult{ 21 | url: url, 22 | } 23 | } 24 | -------------------------------------------------------------------------------- /session-redis/module.go: -------------------------------------------------------------------------------- 1 | package session_redis 2 | 3 | import ( 4 | "github.com/farseer-go/fs/configure" 5 | "github.com/farseer-go/fs/modules" 6 | "github.com/farseer-go/webapi" 7 | "github.com/farseer-go/webapi/session-redis/context" 8 | ) 9 | 10 | type Module struct { 11 | } 12 | 13 | func (module Module) DependsModule() []modules.FarseerModule { 14 | return []modules.FarseerModule{webapi.Module{}} 15 | } 16 | 17 | func (module Module) PreInitialize() { 18 | sessionTimeout := configure.GetInt("Webapi.Session.Age") 19 | if sessionTimeout > 0 { 20 | context.SessionTimeout = sessionTimeout 21 | } 22 | } 23 | -------------------------------------------------------------------------------- /action/imageResult.go: -------------------------------------------------------------------------------- 1 | package action 2 | 3 | import ( 4 | "bytes" 5 | "github.com/farseer-go/webapi/context" 6 | ) 7 | 8 | // ImageResult 处理图片 9 | type ImageResult struct { 10 | buffer *bytes.Buffer 11 | imageType string 12 | } 13 | 14 | func (receiver *ImageResult) ExecuteResult(httpContext *context.HttpContext) { 15 | httpContext.Response.Write(receiver.buffer.Bytes()) 16 | httpContext.Response.SetHeader("Content-Type", receiver.imageType) 17 | } 18 | 19 | // Image 返回图片格式 20 | func Image(buffer *bytes.Buffer, imageType string) IResult { 21 | return &ImageResult{ 22 | buffer: buffer, 23 | imageType: imageType, 24 | } 25 | } 26 | -------------------------------------------------------------------------------- /check/check.go: -------------------------------------------------------------------------------- 1 | package check 2 | 3 | import ( 4 | "github.com/farseer-go/fs/exception" 5 | "strings" 6 | ) 7 | 8 | // IsEmpty 当val为empty时，抛出异常 9 | func IsEmpty(val string, statusCode int, err string) { 10 | if strings.TrimSpace(val) == "" { 11 | exception.ThrowWebException(statusCode, err) 12 | } 13 | } 14 | 15 | // IsTrue 当val为true时，抛出异常 16 | func IsTrue(val bool, statusCode int, err string) { 17 | if val { 18 | exception.ThrowWebException(statusCode, err) 19 | } 20 | } 21 | 22 | // IsFalse 当val为false时，抛出异常 23 | func IsFalse(val bool, statusCode int, err string) { 24 | if !val { 25 | exception.ThrowWebException(statusCode, err) 26 | } 27 | } 28 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature_request.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Feature request 3 | about: Suggest an idea for this project 4 | title: '' 5 | labels: '' 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Is your feature request related to a problem? Please describe.** 11 | A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] 12 | 13 | **Describe the solution you'd like** 14 | A clear and concise description of what you want to happen. 15 | 16 | **Describe alternatives you've considered** 17 | A clear and concise description of any alternative solutions or features you've considered. 18 | 19 | **Additional context** 20 | Add any other context or screenshots about the feature request here. 21 | -------------------------------------------------------------------------------- /jwt.go: -------------------------------------------------------------------------------- 1 | package webapi 2 | 3 | import ( 4 | "github.com/golang-jwt/jwt/v5" 5 | ) 6 | 7 | var jwtKey []byte // jwt key 8 | var jwtKeyType string // key type 9 | var jwtKeyMethod jwt.SigningMethod // sign method 10 | 11 | //type MyCustomClaims struct { 12 | // Foo string `json:"foo"` 13 | // jwt.RegisteredClaims 14 | //} 15 | 16 | //// NewJwtToken 生成Jwt Token 17 | //func NewJwtToken(claims map[string]any) (string, error) { 18 | // //jwt.MapClaims{ 19 | // // "foo": "bar", 20 | // // "nbf": time.Date(2015, 10, 10, 12, 0, 0, 0, time.UTC).Unix(), 21 | // //} 22 | // token := jwt.NewWithClaims(jwtKeyMethod, jwt.MapClaims(claims)) 23 | // if len(jwtKey) == 0 { 24 | // return token.SigningString() 25 | // } 26 | // return token.SignedString(jwtKey) 27 | //} 28 | -------------------------------------------------------------------------------- /test/area_test.go: -------------------------------------------------------------------------------- 1 | package test 2 | 3 | import ( 4 | "io" 5 | "net/http" 6 | "testing" 7 | "time" 8 | 9 | "github.com/farseer-go/fs" 10 | "github.com/farseer-go/fs/configure" 11 | "github.com/farseer-go/webapi" 12 | "github.com/stretchr/testify/assert" 13 | ) 14 | 15 | func TestArea(t *testing.T) { 16 | fs.Initialize[webapi.Module]("demo") 17 | configure.SetDefault("Log.Component.webapi", true) 18 | webapi.Area("api/1.0", func() { 19 | webapi.RegisterGET("/mini/test", func() string { 20 | return "ok" 21 | }) 22 | }) 23 | go webapi.Run(":8087") 24 | time.Sleep(10 * time.Millisecond) 25 | 26 | rsp, _ := http.Get("http://127.0.0.1:8087/api/1.0/mini/test") 27 | body, _ := io.ReadAll(rsp.Body) 28 | _ = rsp.Body.Close() 29 | assert.Equal(t, "ok", string(body)) 30 | } 31 | -------------------------------------------------------------------------------- /websocket/handleMiddleware.go: -------------------------------------------------------------------------------- 1 | package websocket 2 | 3 | import ( 4 | "github.com/farseer-go/webapi/context" 5 | "reflect" 6 | ) 7 | 8 | type HandleMiddleware struct { 9 | } 10 | 11 | func (receiver HandleMiddleware) Invoke(httpContext *context.HttpContext) { 12 | // 执行过滤器OnActionExecuting 13 | for i := 0; i < len(httpContext.Route.Filters); i++ { 14 | httpContext.Route.Filters[i].OnActionExecuting(httpContext) 15 | } 16 | 17 | // 实现了check.ICheck（必须放在过滤器之后执行） 18 | httpContext.RequestParamCheck() 19 | 20 | // 调用action 21 | callValues := reflect.ValueOf(httpContext.Route.Action).Call(httpContext.Request.Params) 22 | httpContext.Response.SetValues(callValues...) 23 | 24 | // 执行过滤器OnActionExecuted 25 | for i := 0; i < len(httpContext.Route.Filters); i++ { 26 | httpContext.Route.Filters[i].OnActionExecuted(httpContext) 27 | } 28 | } 29 | -------------------------------------------------------------------------------- /test/getHttpContext_test.go: -------------------------------------------------------------------------------- 1 | package test 2 | 3 | import ( 4 | "github.com/farseer-go/fs" 5 | "github.com/farseer-go/fs/core" 6 | "github.com/farseer-go/webapi" 7 | "github.com/stretchr/testify/assert" 8 | "net/http" 9 | "testing" 10 | "time" 11 | ) 12 | 13 | func TestGetHttpContext(t *testing.T) { 14 | fs.Initialize[webapi.Module]("demo") 15 | 16 | webapi.RegisterPOST("/getHttpContext", func() string { 17 | return webapi.GetHttpContext().ContentType 18 | }) 19 | webapi.UseApiResponse() 20 | go webapi.Run(":8089") 21 | time.Sleep(10 * time.Millisecond) 22 | 23 | t.Run("getHttpContext", func(t *testing.T) { 24 | rsp, _ := http.Post("http://127.0.0.1:8089/getHttpContext", "application/json", nil) 25 | apiResponse := core.NewApiResponseByReader[string](rsp.Body) 26 | _ = rsp.Body.Close() 27 | assert.Equal(t, "application/json", apiResponse.Data) 28 | }) 29 | } 30 | -------------------------------------------------------------------------------- /test/_apidoc_test.go: -------------------------------------------------------------------------------- 1 | package test 2 | 3 | import ( 4 | "fmt" 5 | "github.com/farseer-go/fs" 6 | "github.com/farseer-go/webapi" 7 | "testing" 8 | ) 9 | 10 | func TestApiDoc(t *testing.T) { 11 | fs.Initialize[webapi.Module]("demo") 12 | webapi.UseApiResponse() 13 | webapi.PrintRoute() 14 | webapi.UseApiDoc() 15 | 16 | webapi.RegisterPOST("/dto", func(req pageSizeRequest) string { 17 | webapi.GetHttpContext().Response.SetMessage(200, "测试成功") 18 | return fmt.Sprintf("hello world pageSize=%d，pageIndex=%d", req.PageSize, req.PageIndex) 19 | }) 20 | 21 | webapi.RegisterGET("/empty", func() any { 22 | return pageSizeRequest{PageSize: 3, PageIndex: 2} 23 | }) 24 | 25 | webapi.RegisterPUT("/multiParam", func(pageSize int, pageIndex int) pageSizeRequest { 26 | return pageSizeRequest{ 27 | PageSize: pageSize, 28 | PageIndex: pageIndex, 29 | } 30 | }, "page_size", "pageIndex") 31 | 32 | go webapi.Run("") 33 | } 34 | -------------------------------------------------------------------------------- /middleware/cors.go: -------------------------------------------------------------------------------- 1 | package middleware 2 | 3 | import "github.com/farseer-go/webapi/context" 4 | 5 | type Cors struct { 6 | context.IMiddleware 7 | } 8 | 9 | func (receiver *Cors) Invoke(httpContext *context.HttpContext) { 10 | httpContext.Response.AddHeader("Access-Control-Allow-Headers", httpContext.Header.GetValue("Access-Control-Request-Headers")) 11 | httpContext.Response.AddHeader("Access-Control-Allow-Methods", httpContext.Header.GetValue("Access-Control-Request-Methods")) 12 | httpContext.Response.AddHeader("Access-Control-Allow-Credentials", "true") 13 | httpContext.Response.AddHeader("Access-Control-Max-Age", "86400") 14 | 15 | if httpContext.Header.GetValue("Origin") != "" { 16 | httpContext.Response.AddHeader("Access-Control-Allow-Origin", httpContext.Header.GetValue("Origin")) 17 | } 18 | 19 | if httpContext.Method == "OPTIONS" { 20 | httpContext.Response.SetHttpCode(204) 21 | return 22 | } 23 | receiver.IMiddleware.Invoke(httpContext) 24 | } 25 | -------------------------------------------------------------------------------- /middleware/routing.go: -------------------------------------------------------------------------------- 1 | package middleware 2 | 3 | import ( 4 | "bytes" 5 | "github.com/farseer-go/webapi/context" 6 | ) 7 | 8 | type routing struct { 9 | context.IMiddleware 10 | } 11 | 12 | func (receiver *routing) Invoke(httpContext *context.HttpContext) { 13 | // 检查method 14 | if httpContext.Route.Schema != "ws" && httpContext.Method != "OPTIONS" && !httpContext.Route.Method.Contains(httpContext.Method) { 15 | // 响应码 16 | httpContext.Response.Reject(405, "405 Method NotAllowed") 17 | return 18 | } 19 | 20 | // 解析Body 21 | buf := new(bytes.Buffer) 22 | _, _ = buf.ReadFrom(httpContext.Request.R.Body) 23 | httpContext.Request.BodyString = buf.String() 24 | httpContext.Request.BodyBytes = buf.Bytes() 25 | 26 | // 解析请求的参数 27 | httpContext.Request.ParseQuery() 28 | httpContext.Request.ParseForm() 29 | httpContext.URI.Query = httpContext.Request.Query 30 | 31 | // 转换成Handle函数需要的参数 32 | httpContext.Request.Params = httpContext.ParseParams() 33 | 34 | receiver.IMiddleware.Invoke(httpContext) 35 | } 36 | -------------------------------------------------------------------------------- /minimal/handleMiddleware.go: -------------------------------------------------------------------------------- 1 | package minimal 2 | 3 | import ( 4 | "github.com/farseer-go/fs/container" 5 | "github.com/farseer-go/fs/trace" 6 | "github.com/farseer-go/webapi/context" 7 | "reflect" 8 | ) 9 | 10 | type HandleMiddleware struct { 11 | } 12 | 13 | func (receiver HandleMiddleware) Invoke(httpContext *context.HttpContext) { 14 | // 执行过滤器OnActionExecuting 15 | for i := 0; i < len(httpContext.Route.Filters); i++ { 16 | httpContext.Route.Filters[i].OnActionExecuting(httpContext) 17 | } 18 | 19 | // 实现了check.ICheck（必须放在过滤器之后执行） 20 | httpContext.RequestParamCheck() 21 | 22 | traceDetail := container.Resolve[trace.IManager]().TraceHand("执行路由") 23 | // 调用action 24 | callValues := reflect.ValueOf(httpContext.Route.Action).Call(httpContext.Request.Params) 25 | httpContext.Response.SetValues(callValues...) 26 | traceDetail.End(nil) 27 | 28 | // 执行过滤器OnActionExecuted 29 | for i := 0; i < len(httpContext.Route.Filters); i++ { 30 | httpContext.Route.Filters[i].OnActionExecuted(httpContext) 31 | } 32 | } 33 | -------------------------------------------------------------------------------- /action/callResult.go: -------------------------------------------------------------------------------- 1 | package action 2 | 3 | import ( 4 | "github.com/farseer-go/collections" 5 | "github.com/farseer-go/fs/parse" 6 | "github.com/farseer-go/webapi/context" 7 | ) 8 | 9 | // callResult 默认调用Action结果 10 | type callResult struct { 11 | } 12 | 13 | func NewCallResult() callResult { 14 | return callResult{} 15 | } 16 | 17 | func (receiver callResult) ExecuteResult(httpContext *context.HttpContext) { 18 | // 只有一个返回值 19 | if len(httpContext.Response.Body) == 1 { 20 | responseBody := httpContext.Response.Body[0] 21 | // 基本类型直接转string 22 | if httpContext.Route.IsGoBasicType { 23 | httpContext.Response.Write([]byte(parse.ToString(responseBody))) 24 | } else { // dto 25 | httpContext.Response.WriteJson(responseBody) 26 | httpContext.Response.SetHeader("Content-Type", "application/json") 27 | } 28 | return 29 | } 30 | 31 | // 多个返回值，则转成数组Json 32 | lst := collections.NewListAny() 33 | for i := 0; i < len(httpContext.Response.Body); i++ { 34 | lst.Add(httpContext.Response.Body[i]) 35 | } 36 | httpContext.Response.WriteJson(lst) 37 | } 38 | -------------------------------------------------------------------------------- /test/newApplicationBuilder_test.go: -------------------------------------------------------------------------------- 1 | package test 2 | 3 | import ( 4 | "bytes" 5 | "io" 6 | "net/http" 7 | "testing" 8 | "time" 9 | 10 | "github.com/farseer-go/fs" 11 | "github.com/farseer-go/fs/configure" 12 | "github.com/farseer-go/fs/snc" 13 | "github.com/farseer-go/webapi" 14 | "github.com/stretchr/testify/assert" 15 | ) 16 | 17 | func TestNewApplicationBuilder(t *testing.T) { 18 | fs.Initialize[webapi.Module]("demo") 19 | configure.SetDefault("Log.Component.webapi", true) 20 | 21 | server := webapi.NewApplicationBuilder() 22 | server.RegisterPOST("/mini/test", func() {}) 23 | go server.Run(":8083") 24 | time.Sleep(10 * time.Millisecond) 25 | 26 | t.Run("mini/test2:8083", func(t *testing.T) { 27 | sizeRequest := pageSizeRequest{PageSize: 10, PageIndex: 2} 28 | marshal, _ := snc.Marshal(sizeRequest) 29 | rsp, _ := http.Post("http://127.0.0.1:8083/mini/test", "application/json", bytes.NewReader(marshal)) 30 | body, _ := io.ReadAll(rsp.Body) 31 | _ = rsp.Body.Close() 32 | assert.Equal(t, "", string(body)) 33 | assert.Equal(t, 200, rsp.StatusCode) 34 | }) 35 | } 36 | -------------------------------------------------------------------------------- /route.go: -------------------------------------------------------------------------------- 1 | package webapi 2 | 3 | import ( 4 | "github.com/farseer-go/webapi/context" 5 | "github.com/farseer-go/webapi/filter" 6 | ) 7 | 8 | // Route 路由配置 9 | type Route struct { 10 | Method string // Method类型（GET|POST|PUT|DELETE） 11 | Url string // 路由地址 12 | Action any // Handle 13 | Message string // api返回的StatusMessage 14 | Filters []context.IFilter // 过滤器（对单个路由的执行单元） 15 | Params []string // Handle的入参 16 | // Summary string // api的描述 17 | } 18 | 19 | // UseJwt 使用Jwt 20 | func (receiver Route) UseJwt() Route { 21 | receiver.Filters = append(receiver.Filters, filter.JwtFilter{}) 22 | return receiver 23 | } 24 | 25 | // POST 使用POST 26 | func (receiver Route) POST() Route { 27 | receiver.Method = "POST" 28 | return receiver 29 | } 30 | 31 | // GET 使用GET 32 | func (receiver Route) GET() Route { 33 | receiver.Method = "GET" 34 | return receiver 35 | } 36 | 37 | // Filter 添加过滤器 38 | func (receiver Route) Filter(filter context.IFilter) Route { 39 | receiver.Filters = append(receiver.Filters, filter) 40 | return receiver 41 | 42 | } 43 | -------------------------------------------------------------------------------- /.github/workflows/test.yml: -------------------------------------------------------------------------------- 1 | # This workflow will build a golang project 2 | # For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-go 3 | 4 | name: Test 5 | 6 | on: 7 | push: 8 | branches: [ "main" ] 9 | pull_request: 10 | branches: [ "main" ] 11 | 12 | jobs: 13 | 14 | build: 15 | runs-on: ubuntu-latest 16 | steps: 17 | - uses: actions/checkout@v3 18 | 19 | - name: Set up Go 20 | uses: actions/setup-go@v3 21 | with: 22 | go-version: 1.23.3 23 | 24 | - name: Go Mod Tidy 25 | run: go mod tidy 26 | 27 | # - name: Build 28 | # run: go build -v ./... 29 | 30 | # - name: Test 31 | # run: go test -v ./... 32 | 33 | - name: Run coverage 34 | #run: cd test && go test -race -coverprofile=coverage.txt -covermode=atomic 35 | run: go test -race -covermode=count -coverprofile=coverage.txt -covermode=atomic -run="^Test" -coverpkg=$(go list ./... | grep -v "/test" | tr '\n' ',') ./test 36 | - name: Upload coverage to Codecov 37 | uses: codecov/codecov-action@v3 38 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2023 farseer-go 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /go.mod: -------------------------------------------------------------------------------- 1 | module github.com/farseer-go/webapi 2 | 3 | go 1.23.0 4 | 5 | toolchain go1.23.8 6 | 7 | require ( 8 | github.com/farseer-go/collections v0.17.3 9 | github.com/farseer-go/fs v0.17.3 10 | github.com/farseer-go/utils v0.17.3 11 | github.com/go-playground/locales v0.14.1 12 | github.com/go-playground/universal-translator v0.18.1 13 | github.com/go-playground/validator/v10 v10.27.0 14 | github.com/golang-jwt/jwt/v5 v5.2.3 15 | github.com/stretchr/testify v1.10.0 16 | github.com/timandy/routine v1.1.5 17 | golang.org/x/net v0.42.0 18 | ) 19 | 20 | require ( 21 | github.com/davecgh/go-spew v1.1.1 // indirect 22 | github.com/gabriel-vasile/mimetype v1.4.9 // indirect 23 | github.com/json-iterator/go v1.1.12 // indirect 24 | github.com/leodido/go-urn v1.4.0 // indirect 25 | github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect 26 | github.com/modern-go/reflect2 v1.0.2 // indirect 27 | github.com/pmezard/go-difflib v1.0.0 // indirect 28 | golang.org/x/crypto v0.40.0 // indirect 29 | golang.org/x/sys v0.34.0 // indirect 30 | golang.org/x/text v0.27.0 // indirect 31 | gopkg.in/yaml.v3 v3.0.1 // indirect 32 | ) 33 | -------------------------------------------------------------------------------- /websocket/socketHandler.go: -------------------------------------------------------------------------------- 1 | package websocket 2 | 3 | import ( 4 | "github.com/farseer-go/fs/asyncLocal" 5 | "github.com/farseer-go/fs/container" 6 | "github.com/farseer-go/fs/trace" 7 | "github.com/farseer-go/webapi/context" 8 | "golang.org/x/net/websocket" 9 | ) 10 | 11 | func SocketHandler(route *context.HttpRoute) websocket.Handler { 12 | return func(conn *websocket.Conn) { 13 | // 调用action 14 | // 解析报文、组装httpContext 15 | httpContext := context.NewHttpContext(route, nil, conn.Request()) 16 | httpContext.SetWebsocket(conn) 17 | 18 | // InitContext 初始化同一协程上下文，避免在同一协程中多次初始化 19 | asyncLocal.InitContext() 20 | 21 | // 创建链路追踪上下文 22 | trackContext := container.Resolve[trace.IManager]().EntryWebSocket(httpContext.URI.Host, httpContext.URI.Url, httpContext.Header.ToMap(), httpContext.URI.GetRealIp()) 23 | trackContext.SetBody(httpContext.Request.BodyString, httpContext.Response.GetHttpCode(), string(httpContext.Response.BodyBytes), nil) 24 | container.Resolve[trace.IManager]().Push(trackContext, nil) 25 | //httpContext.Data.Set("Trace", trackContext) 26 | 27 | // 设置到routine，可用于任意子函数获取 28 | context.RoutineHttpContext.Set(httpContext) 29 | // 执行第一个中间件 30 | route.HttpMiddleware.Invoke(httpContext) 31 | asyncLocal.Release() 32 | } 33 | } 34 | -------------------------------------------------------------------------------- /test/benchmark_run_test.go: -------------------------------------------------------------------------------- 1 | package test 2 | 3 | import ( 4 | "bytes" 5 | "fmt" 6 | "net/http" 7 | "testing" 8 | "time" 9 | 10 | "github.com/farseer-go/fs" 11 | "github.com/farseer-go/fs/configure" 12 | "github.com/farseer-go/fs/snc" 13 | "github.com/farseer-go/webapi" 14 | ) 15 | 16 | // BenchmarkRun-12 4434 304151 ns/op 22731 B/op 202 allocs/op（优化前） 17 | // BenchmarkRun-12 4432 239972 ns/op 22758 B/op 203 allocs/op（第一次优化：HttpResponse.Body改为[]any） 18 | func BenchmarkRun(b *testing.B) { 19 | fs.Initialize[webapi.Module]("demo") 20 | configure.SetDefault("Log.Component.webapi", true) 21 | 22 | webapi.RegisterPOST("/dto", func(req pageSizeRequest) string { 23 | webapi.GetHttpContext().Response.SetMessage(200, "测试成功") 24 | return fmt.Sprintf("hello world pageSize=%d，pageIndex=%d", req.PageSize, req.PageIndex) 25 | }) 26 | 27 | webapi.UseApiResponse() 28 | go webapi.Run(":8094") 29 | time.Sleep(10 * time.Millisecond) 30 | b.ReportAllocs() 31 | sizeRequest := pageSizeRequest{PageSize: 10, PageIndex: 2} 32 | marshal, _ := snc.Marshal(sizeRequest) 33 | 34 | for i := 0; i < b.N; i++ { 35 | rsp, _ := http.Post("http://127.0.0.1:8094/dto", "application/json", bytes.NewReader(marshal)) 36 | _ = rsp.Body.Close() 37 | } 38 | } 39 | -------------------------------------------------------------------------------- /httpHandler.go: -------------------------------------------------------------------------------- 1 | package webapi 2 | 3 | import ( 4 | "net/http" 5 | 6 | "github.com/farseer-go/fs/asyncLocal" 7 | "github.com/farseer-go/fs/container" 8 | "github.com/farseer-go/fs/trace" 9 | "github.com/farseer-go/webapi/context" 10 | ) 11 | 12 | func HttpHandler(route *context.HttpRoute) http.HandlerFunc { 13 | return func(w http.ResponseWriter, r *http.Request) { 14 | // InitContext 初始化同一协程上下文，避免在同一协程中多次初始化 15 | asyncLocal.InitContext() 16 | // 解析报文、组装httpContext 17 | httpContext := context.NewHttpContext(route, w, r) 18 | // 创建链路追踪上下文 19 | trackContext := container.Resolve[trace.IManager]().EntryWebApi(httpContext.URI.Host, httpContext.URI.Url, httpContext.Method, httpContext.ContentType, httpContext.Header.ToMap(), httpContext.URI.GetRealIp()) 20 | // 记录出入参 21 | defer func() { 22 | trackContext.SetBody(httpContext.Request.BodyString, httpContext.Response.GetHttpCode(), string(httpContext.Response.BodyBytes), httpContext.ResponseHeader.ToMap()) 23 | container.Resolve[trace.IManager]().Push(trackContext, nil) 24 | }() 25 | httpContext.Data.Set("Trace", trackContext) 26 | 27 | // 设置到routine，可用于任意子函数获取 28 | context.RoutineHttpContext.Set(httpContext) 29 | // 执行第一个中间件 30 | route.HttpMiddleware.Invoke(httpContext) 31 | asyncLocal.Release() 32 | } 33 | } 34 | -------------------------------------------------------------------------------- /middleware/exception.go: -------------------------------------------------------------------------------- 1 | package middleware 2 | 3 | import ( 4 | "net/http" 5 | 6 | "github.com/farseer-go/fs/core" 7 | "github.com/farseer-go/fs/exception" 8 | "github.com/farseer-go/webapi/context" 9 | "golang.org/x/net/websocket" 10 | ) 11 | 12 | // exception 异常中间件（默认加载） 13 | type exceptionMiddleware struct { 14 | context.IMiddleware 15 | } 16 | 17 | func (receiver *exceptionMiddleware) Invoke(httpContext *context.HttpContext) { 18 | // exceptionMiddleware 与 ApiResponse 中间件是互诉的。 19 | exception.Try(func() { 20 | // 下一步：routing 21 | receiver.IMiddleware.Invoke(httpContext) 22 | }).CatchWebException(func(exp exception.WebException) { 23 | // ws协议先主动发一条消息，然后立即关闭 24 | if httpContext.WebsocketConn != nil { 25 | _ = websocket.JSON.Send(httpContext.WebsocketConn, core.ApiResponseStringError(exp.Message, exp.StatusCode)) 26 | } 27 | // 响应码 28 | httpContext.Response.Write([]byte(exp.Message)) 29 | httpContext.Response.SetHttpCode(exp.StatusCode) 30 | }).CatchException(func(exp any) { 31 | // ws协议先主动发一条消息，然后立即关闭 32 | if httpContext.WebsocketConn != nil { 33 | _ = websocket.JSON.Send(httpContext.WebsocketConn, core.ApiResponseStringError(httpContext.Exception.Error(), http.StatusInternalServerError)) 34 | } 35 | 36 | // 响应码 37 | httpContext.Response.Write([]byte(httpContext.Exception.Error())) 38 | httpContext.Response.SetHttpCode(http.StatusInternalServerError) 39 | }) 40 | } 41 | -------------------------------------------------------------------------------- /session-redis/go.mod: -------------------------------------------------------------------------------- 1 | module github.com/farseer-go/webapi/session-redis 2 | 3 | go 1.22 4 | 5 | toolchain go1.23.3 6 | 7 | require ( 8 | github.com/farseer-go/cache v0.16.0 9 | github.com/farseer-go/cacheMemory v0.16.0 10 | github.com/farseer-go/fs v0.16.0 11 | github.com/farseer-go/redis v0.16.0 12 | github.com/farseer-go/webapi v0.16.0 13 | ) 14 | 15 | require ( 16 | github.com/cespare/xxhash/v2 v2.3.0 // indirect 17 | github.com/dgryski/go-rendezvous v0.0.0-20200823014737-9f7001d12a5f // indirect 18 | github.com/farseer-go/collections v0.16.0 // indirect 19 | github.com/farseer-go/mapper v0.16.0 // indirect 20 | github.com/gabriel-vasile/mimetype v1.4.8 // indirect 21 | github.com/go-playground/locales v0.14.1 // indirect 22 | github.com/go-playground/universal-translator v0.18.1 // indirect 23 | github.com/go-playground/validator/v10 v10.26.0 // indirect 24 | github.com/go-redis/redis/v8 v8.11.5 // indirect 25 | github.com/golang-jwt/jwt/v5 v5.2.2 // indirect 26 | github.com/json-iterator/go v1.1.12 // indirect 27 | github.com/leodido/go-urn v1.4.0 // indirect 28 | github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect 29 | github.com/modern-go/reflect2 v1.0.2 // indirect 30 | github.com/timandy/routine v1.1.5 // indirect 31 | golang.org/x/crypto v0.36.0 // indirect 32 | golang.org/x/net v0.38.0 // indirect 33 | golang.org/x/sys v0.31.0 // indirect 34 | golang.org/x/text v0.23.0 // indirect 35 | gopkg.in/yaml.v3 v3.0.1 // indirect 36 | ) 37 | -------------------------------------------------------------------------------- /middleware/http.go: -------------------------------------------------------------------------------- 1 | package middleware 2 | 3 | import ( 4 | "net/http" 5 | "strings" 6 | 7 | "github.com/farseer-go/collections" 8 | "github.com/farseer-go/webapi/action" 9 | "github.com/farseer-go/webapi/context" 10 | ) 11 | 12 | // Http HTTP报文响应中间件（默认加载） 13 | type Http struct { 14 | context.IMiddleware 15 | } 16 | 17 | func (receiver *Http) Invoke(httpContext *context.HttpContext) { 18 | httpContext.Response.SetHttpCode(http.StatusOK) 19 | httpContext.Response.SetStatusCode(http.StatusOK) 20 | 21 | // 下一步：exceptionMiddleware 22 | receiver.IMiddleware.Invoke(httpContext) 23 | 24 | // 说明没有中间件对输出做处理 25 | if len(httpContext.Response.BodyBytes) == 0 && len(httpContext.Response.Body) > 0 { 26 | // IActionResult 27 | if httpContext.IsActionResult() { 28 | actionResult := httpContext.Response.Body[0].(action.IResult) 29 | actionResult.ExecuteResult(httpContext) 30 | } else { 31 | // 则转成callResult 32 | action.NewCallResult().ExecuteResult(httpContext) 33 | } 34 | } 35 | 36 | // 输出返回值 37 | httpContext.Response.W.WriteHeader(httpContext.Response.GetHttpCode()) 38 | 39 | // 响应header 40 | rspHeader := collections.NewDictionary[string, string]() 41 | for k, v := range httpContext.Response.W.Header() { 42 | rspHeader.Add(k, strings.Join(v, ";")) 43 | } 44 | httpContext.ResponseHeader = rspHeader.ToReadonlyDictionary() 45 | 46 | // 写入Response流 47 | if len(httpContext.Response.BodyBytes) > 0 { 48 | _, _ = httpContext.Response.W.Write(httpContext.Response.BodyBytes) 49 | } 50 | } 51 | -------------------------------------------------------------------------------- /test/error_test.go: -------------------------------------------------------------------------------- 1 | package test 2 | 3 | import ( 4 | "github.com/farseer-go/fs" 5 | "github.com/farseer-go/fs/core" 6 | "github.com/farseer-go/fs/exception" 7 | "github.com/farseer-go/webapi" 8 | "github.com/stretchr/testify/assert" 9 | "net/http" 10 | "testing" 11 | "time" 12 | ) 13 | 14 | func TestError(t *testing.T) { 15 | fs.Initialize[webapi.Module]("demo") 16 | webapi.RegisterPOST("/error/1", func() { 17 | exception.ThrowWebException(501, "s501") 18 | }) 19 | 20 | webapi.RegisterPOST("/error/2", func() { 21 | exception.ThrowException("s500") 22 | }) 23 | webapi.UseApiResponse() 24 | go webapi.Run(":8081") 25 | time.Sleep(10 * time.Millisecond) 26 | 27 | t.Run("error/1", func(t *testing.T) { 28 | rsp, _ := http.Post("http://127.0.0.1:8081/error/1", "application/json", nil) 29 | apiResponse := core.NewApiResponseByReader[any](rsp.Body) 30 | _ = rsp.Body.Close() 31 | assert.Equal(t, 501, apiResponse.StatusCode) 32 | assert.Equal(t, "s501", apiResponse.StatusMessage) 33 | assert.Equal(t, false, apiResponse.Status) 34 | assert.Equal(t, 200, rsp.StatusCode) 35 | }) 36 | 37 | t.Run("error/2", func(t *testing.T) { 38 | rsp, _ := http.Post("http://127.0.0.1:8081/error/2", "application/json", nil) 39 | apiResponse := core.NewApiResponseByReader[any](rsp.Body) 40 | _ = rsp.Body.Close() 41 | assert.Equal(t, 500, apiResponse.StatusCode) 42 | assert.Equal(t, "s500", apiResponse.StatusMessage) 43 | assert.Equal(t, false, apiResponse.Status) 44 | assert.Equal(t, 200, rsp.StatusCode) 45 | }) 46 | } 47 | -------------------------------------------------------------------------------- /test/routes_test.go: -------------------------------------------------------------------------------- 1 | package test 2 | 3 | import ( 4 | "bytes" 5 | "fmt" 6 | "io" 7 | "net/http" 8 | "testing" 9 | "time" 10 | 11 | "github.com/farseer-go/fs" 12 | "github.com/farseer-go/fs/configure" 13 | "github.com/farseer-go/fs/snc" 14 | "github.com/farseer-go/webapi" 15 | "github.com/stretchr/testify/assert" 16 | ) 17 | 18 | func TestRoutes(t *testing.T) { 19 | fs.Initialize[webapi.Module]("demo") 20 | configure.SetDefault("Log.Component.webapi", true) 21 | 22 | webapi.RegisterRoutes(webapi.Route{Url: "/mini/test1", Method: "POST|GET", Action: func(req pageSizeRequest) string { 23 | return fmt.Sprintf("hello world pageSize=%d，pageIndex=%d", req.PageSize, req.PageIndex) 24 | }}) 25 | go webapi.Run(":8095") 26 | time.Sleep(10 * time.Millisecond) 27 | 28 | t.Run("mini/test1:8095-POST", func(t *testing.T) { 29 | sizeRequest := pageSizeRequest{PageSize: 10, PageIndex: 2} 30 | marshal, _ := snc.Marshal(sizeRequest) 31 | rsp, _ := http.Post("http://127.0.0.1:8095/mini/test1", "application/json", bytes.NewReader(marshal)) 32 | body, _ := io.ReadAll(rsp.Body) 33 | _ = rsp.Body.Close() 34 | assert.Equal(t, "hello world pageSize=10，pageIndex=2", string(body)) 35 | assert.Equal(t, 200, rsp.StatusCode) 36 | }) 37 | t.Run("mini/test1:8095-GET", func(t *testing.T) { 38 | rsp, _ := http.Get("http://127.0.0.1:8095/mini/test1?page_size=10&PageIndex=2") 39 | body, _ := io.ReadAll(rsp.Body) 40 | _ = rsp.Body.Close() 41 | assert.Equal(t, "hello world pageSize=10，pageIndex=2", string(body)) 42 | assert.Equal(t, 200, rsp.StatusCode) 43 | }) 44 | } 45 | -------------------------------------------------------------------------------- /context/httpCookies.go: -------------------------------------------------------------------------------- 1 | package context 2 | 3 | import ( 4 | "net/http" 5 | "time" 6 | ) 7 | 8 | // 初始化Cookies 9 | func initCookies(w http.ResponseWriter, r *http.Request) *HttpCookies { 10 | return &HttpCookies{ 11 | w: w, 12 | r: r, 13 | } 14 | } 15 | 16 | type HttpCookies struct { 17 | w http.ResponseWriter 18 | r *http.Request 19 | } 20 | 21 | // Get 获取Cookie 22 | func (r *HttpCookies) Get(name string) *http.Cookie { 23 | cookie, _ := r.r.Cookie(name) 24 | return cookie 25 | } 26 | 27 | // GetValue 获取Cookie 28 | func (r *HttpCookies) GetValue(name string) string { 29 | cookie, _ := r.r.Cookie(name) 30 | if cookie == nil { 31 | return "" 32 | } 33 | return cookie.Value 34 | } 35 | 36 | // SetValue 设置Cookie 37 | func (r *HttpCookies) SetValue(name string, val string) { 38 | http.SetCookie(r.w, &http.Cookie{ 39 | Name: name, 40 | Value: val, 41 | Path: "/", 42 | HttpOnly: false, 43 | }) 44 | } 45 | 46 | // SetSuretyValue 设置Cookie安全值，将不允许脚本读取该值（HttpOnly） 47 | func (r *HttpCookies) SetSuretyValue(name string, val string) { 48 | http.SetCookie(r.w, &http.Cookie{ 49 | Name: name, 50 | Value: val, 51 | Path: "/", 52 | HttpOnly: true, 53 | }) 54 | } 55 | 56 | // SetCookie 设置Cookie 57 | func (r *HttpCookies) SetCookie(cookie *http.Cookie) { 58 | http.SetCookie(r.w, cookie) 59 | } 60 | 61 | // Remove 删除Cookie 62 | func (r *HttpCookies) Remove(name string) { 63 | http.SetCookie(r.w, &http.Cookie{ 64 | Name: name, 65 | Value: "", 66 | HttpOnly: true, 67 | MaxAge: -1, 68 | Expires: time.Unix(1, 0), 69 | }) 70 | } 71 | -------------------------------------------------------------------------------- /context/httpURL.go: -------------------------------------------------------------------------------- 1 | package context 2 | 3 | import ( 4 | "net/http" 5 | "strings" 6 | 7 | "github.com/farseer-go/fs/parse" 8 | ) 9 | 10 | type HttpURL struct { 11 | Url string // 请求地址 http(s)://xxx.xxx.xxx/xxx 12 | Path string // 请求地址 13 | RemoteAddr string // 客户端IP端口 14 | X_Forwarded_For string // 客户端IP端口 15 | X_Real_Ip string // 客户端IP端口 16 | Host string // 请求的Host主机头 17 | Proto string // http协议 18 | RequestURI string 19 | QueryString string 20 | Query map[string]any 21 | R *http.Request 22 | } 23 | 24 | //func (receiver *HttpURL) ParseQuery() { 25 | // for k, v := range receiver.R.URL.Query() { 26 | // key := strings.ToLower(k) 27 | // receiver.Query[key] = strings.Join(v, "&") 28 | // } 29 | //} 30 | 31 | // GetRealIp 获取真实IP 32 | func (receiver *HttpURL) GetRealIp() string { 33 | ip := receiver.X_Real_Ip 34 | if ip == "" { 35 | ip = strings.Split(receiver.X_Forwarded_For, ",")[0] 36 | } 37 | if ip == "" { 38 | ip = receiver.RemoteAddr 39 | } 40 | return strings.Split(ip, ":")[0] 41 | } 42 | 43 | // GetRealIpPort 获取真实IP、Port 44 | func (receiver *HttpURL) GetRealIpPort() (string, int) { 45 | ips := []string{receiver.X_Real_Ip, strings.Split(receiver.X_Forwarded_For, ",")[0], receiver.RemoteAddr} 46 | for _, ip := range ips { 47 | if ipPorts := strings.Split(ip, ":"); len(ipPorts) == 2 { 48 | return ipPorts[0], parse.ToInt(ipPorts[1]) 49 | } 50 | } 51 | 52 | // 如果没有找到IP和端口，则返回RemoteAddr的IP部分和0端口 53 | return strings.Split(receiver.RemoteAddr, ":")[0], 0 54 | } 55 | -------------------------------------------------------------------------------- /test/run_test.go: -------------------------------------------------------------------------------- 1 | package test 2 | 3 | import ( 4 | "github.com/farseer-go/fs" 5 | "github.com/farseer-go/fs/configure" 6 | "github.com/farseer-go/fs/core" 7 | "github.com/farseer-go/webapi" 8 | "github.com/farseer-go/webapi/middleware" 9 | "github.com/stretchr/testify/assert" 10 | "net/http" 11 | "testing" 12 | "time" 13 | ) 14 | 15 | type pageSizeRequest struct { 16 | PageSize int `json:"Page_size"` 17 | PageIndex int 18 | noExported string //测试不导出字段 19 | } 20 | 21 | func Hello2() any { 22 | return pageSizeRequest{PageSize: 3, PageIndex: 2} 23 | } 24 | 25 | func TestRun(t *testing.T) { 26 | fs.Initialize[webapi.Module]("demo") 27 | configure.SetDefault("Log.Component.webapi", true) 28 | webapi.RegisterRoutes(webapi.Route{Url: "/mini/hello2", Method: "GET", Action: Hello2}) 29 | 30 | assert.Panics(t, func() { 31 | webapi.RegisterRoutes(webapi.Route{Url: "/mini/hello3", Method: "GET", Action: Hello2, Params: []string{"aaa"}}) 32 | }) 33 | webapi.UseWebApi() 34 | webapi.UseStaticFiles() 35 | webapi.UseApiResponse() 36 | webapi.RegisterMiddleware(&middleware.UrlRewriting{}) 37 | 38 | go webapi.Run(":8093") 39 | time.Sleep(10 * time.Millisecond) 40 | 41 | t.Run("mini/hello2", func(t *testing.T) { 42 | rsp, _ := http.Get("http://127.0.0.1:8093/mini/hello2") 43 | apiResponse := core.NewApiResponseByReader[pageSizeRequest](rsp.Body) 44 | _ = rsp.Body.Close() 45 | assert.Equal(t, 3, apiResponse.Data.PageSize) 46 | assert.Equal(t, 2, apiResponse.Data.PageIndex) 47 | assert.Equal(t, 200, rsp.StatusCode) 48 | assert.Equal(t, 200, apiResponse.StatusCode) 49 | }) 50 | } 51 | -------------------------------------------------------------------------------- /test/routeRegexp_test.go: -------------------------------------------------------------------------------- 1 | package test 2 | 3 | import ( 4 | "github.com/farseer-go/fs" 5 | "github.com/farseer-go/fs/configure" 6 | "github.com/farseer-go/fs/core" 7 | "github.com/farseer-go/webapi" 8 | "github.com/stretchr/testify/assert" 9 | "net/http" 10 | "testing" 11 | "time" 12 | ) 13 | 14 | func TestRouteRegexp(t *testing.T) { 15 | fs.Initialize[webapi.Module]("demo") 16 | configure.SetDefault("Log.Component.webapi", true) 17 | 18 | webapi.RegisterGET("/mini/{pageSize}-{pageIndex}", func(pageSize int, pageIndex int) (int, int) { 19 | return pageSize, pageIndex 20 | }) 21 | webapi.RegisterPOST("/mini/{pageSize}/{pageIndex}", func(pageSize int, pageIndex int) (int, int) { 22 | return pageSize, pageIndex 23 | }) 24 | 25 | webapi.UseApiResponse() 26 | 27 | go webapi.Run(":8091") 28 | time.Sleep(10 * time.Millisecond) 29 | 30 | t.Run("/mini/{pageSize}-{pageIndex}-get", func(t *testing.T) { 31 | req, _ := http.NewRequest("GET", "http://127.0.0.1:8091/mini/15-6", nil) 32 | rsp, _ := http.DefaultClient.Do(req) 33 | apiResponse := core.NewApiResponseByReader[[]int](rsp.Body) 34 | _ = rsp.Body.Close() 35 | assert.Equal(t, []int{15, 6}, apiResponse.Data) 36 | assert.Equal(t, 200, rsp.StatusCode) 37 | }) 38 | 39 | t.Run("/mini/{pageSize}/{pageIndex}-post", func(t *testing.T) { 40 | req, _ := http.NewRequest("POST", "http://127.0.0.1:8091/mini/15/6", nil) 41 | rsp, _ := http.DefaultClient.Do(req) 42 | apiResponse := core.NewApiResponseByReader[[]int](rsp.Body) 43 | _ = rsp.Body.Close() 44 | assert.Equal(t, []int{15, 6}, apiResponse.Data) 45 | assert.Equal(t, 200, rsp.StatusCode) 46 | }) 47 | } 48 | -------------------------------------------------------------------------------- /middleware/validate.go: -------------------------------------------------------------------------------- 1 | package middleware 2 | 3 | import ( 4 | "errors" 5 | "github.com/farseer-go/collections" 6 | "github.com/farseer-go/fs/exception" 7 | "github.com/farseer-go/webapi/context" 8 | "github.com/go-playground/locales/zh" 9 | ut "github.com/go-playground/universal-translator" 10 | "github.com/go-playground/validator/v10" 11 | zhTranslations "github.com/go-playground/validator/v10/translations/zh" 12 | "reflect" 13 | ) 14 | 15 | var validate *validator.Validate 16 | var trans ut.Translator 17 | 18 | type Validate struct { 19 | context.IMiddleware 20 | } 21 | 22 | // InitValidate 初始化字段验证 23 | func InitValidate() { 24 | validate = validator.New(validator.WithRequiredStructEnabled()) 25 | trans, _ = ut.New(zh.New()).GetTranslator("zh") 26 | _ = zhTranslations.RegisterDefaultTranslations(validate, trans) 27 | //注册一个函数，获取struct tag里自定义的label作为字段名 28 | validate.RegisterTagNameFunc(func(fld reflect.StructField) string { 29 | name := fld.Tag.Get("label") 30 | return name 31 | }) 32 | } 33 | 34 | func (receiver *Validate) Invoke(httpContext *context.HttpContext) { 35 | // 验证dto 36 | if httpContext.Route.RequestParamIsModel { 37 | lstError := collections.NewList[string]() 38 | err := validate.Struct(httpContext.Request.Params[0].Interface()) 39 | if err != nil { 40 | var validationErrors validator.ValidationErrors 41 | errors.As(err, &validationErrors) 42 | for _, validationError := range validationErrors { 43 | lstError.Add(validationError.Translate(trans)) 44 | } 45 | } 46 | if lstError.Count() > 0 { 47 | exception.ThrowWebException(403, lstError.ToString(",")) 48 | return 49 | } 50 | } 51 | receiver.IMiddleware.Invoke(httpContext) 52 | } 53 | -------------------------------------------------------------------------------- /test/validate_test.go: -------------------------------------------------------------------------------- 1 | package test 2 | 3 | import ( 4 | "bytes" 5 | "fmt" 6 | "io" 7 | "net/http" 8 | "testing" 9 | "time" 10 | 11 | "github.com/farseer-go/fs" 12 | "github.com/farseer-go/fs/configure" 13 | "github.com/farseer-go/fs/snc" 14 | "github.com/farseer-go/webapi" 15 | "github.com/stretchr/testify/assert" 16 | ) 17 | 18 | type ValidateRequest struct { 19 | Name string `validate:"required" label:"账号"` 20 | Age int `validate:"gte=0,lte=100" label:"年龄"` 21 | } 22 | 23 | func TestValidate(t *testing.T) { 24 | fs.Initialize[webapi.Module]("demo") 25 | configure.SetDefault("Log.Component.webapi", true) 26 | webapi.RegisterRoutes(webapi.Route{Url: "/Validate", Method: "POST", Action: func(dto ValidateRequest) string { 27 | return fmt.Sprintf("%+v", dto) 28 | }}) 29 | webapi.UseValidate() 30 | go webapi.Run(":8092") 31 | time.Sleep(10 * time.Millisecond) 32 | 33 | t.Run("/Validate error", func(t *testing.T) { 34 | sizeRequest := ValidateRequest{Name: "", Age: 200} 35 | marshal, _ := snc.Marshal(sizeRequest) 36 | rsp, _ := http.Post("http://127.0.0.1:8092/Validate", "application/json", bytes.NewReader(marshal)) 37 | body, _ := io.ReadAll(rsp.Body) 38 | _ = rsp.Body.Close() 39 | assert.Equal(t, "账号为必填字段,年龄必须小于或等于100", string(body)) 40 | assert.Equal(t, 403, rsp.StatusCode) 41 | }) 42 | 43 | t.Run("/Validate success", func(t *testing.T) { 44 | sizeRequest := ValidateRequest{Name: "steden", Age: 37} 45 | marshal, _ := snc.Marshal(sizeRequest) 46 | rsp, _ := http.Post("http://127.0.0.1:8092/Validate", "application/json", bytes.NewReader(marshal)) 47 | body, _ := io.ReadAll(rsp.Body) 48 | _ = rsp.Body.Close() 49 | assert.Equal(t, "{Name:steden Age:37}", string(body)) 50 | assert.Equal(t, 200, rsp.StatusCode) 51 | }) 52 | } 53 | -------------------------------------------------------------------------------- /test/cors_test.go: -------------------------------------------------------------------------------- 1 | package test 2 | 3 | import ( 4 | "bytes" 5 | "io" 6 | "net/http" 7 | "testing" 8 | "time" 9 | 10 | "github.com/farseer-go/fs" 11 | "github.com/farseer-go/fs/configure" 12 | "github.com/farseer-go/fs/snc" 13 | "github.com/farseer-go/webapi" 14 | "github.com/stretchr/testify/assert" 15 | ) 16 | 17 | func TestCors(t *testing.T) { 18 | fs.Initialize[webapi.Module]("demo") 19 | configure.SetDefault("Log.Component.webapi", true) 20 | server := webapi.NewApplicationBuilder() 21 | server.RegisterDELETE("/cors/test", func(pageSize int, pageIndex int) (int, int) { 22 | return pageSize, pageIndex 23 | }, "page_Size", "pageIndex") 24 | server.UseCors() 25 | go server.Run(":8080") 26 | time.Sleep(10 * time.Millisecond) 27 | 28 | t.Run("/cors/test:8080", func(t *testing.T) { 29 | sizeRequest := pageSizeRequest{PageSize: 10, PageIndex: 2} 30 | marshal, _ := snc.Marshal(sizeRequest) 31 | req, _ := http.NewRequest("DELETE", "http://127.0.0.1:8080/cors/test", bytes.NewReader(marshal)) 32 | req.Header.Set("Content-Type", "application/json") 33 | rsp, _ := http.DefaultClient.Do(req) 34 | body, _ := io.ReadAll(rsp.Body) 35 | _ = rsp.Body.Close() 36 | assert.Equal(t, "[10,2]", string(body)) 37 | assert.Equal(t, 200, rsp.StatusCode) 38 | }) 39 | 40 | t.Run("/cors/test:8080-OPTIONS", func(t *testing.T) { 41 | sizeRequest := pageSizeRequest{PageSize: 10, PageIndex: 2} 42 | marshal, _ := snc.Marshal(sizeRequest) 43 | req, _ := http.NewRequest("OPTIONS", "http://127.0.0.1:8080/cors/test", bytes.NewReader(marshal)) 44 | req.Header.Set("Content-Type", "application/json") 45 | req.Header.Set("Origin", "localhost") 46 | rsp, _ := http.DefaultClient.Do(req) 47 | body, _ := io.ReadAll(rsp.Body) 48 | _ = rsp.Body.Close() 49 | assert.Equal(t, "", string(body)) 50 | assert.Equal(t, "localhost", rsp.Header.Get("Access-Control-Allow-Origin")) 51 | assert.Equal(t, "true", rsp.Header.Get("Access-Control-Allow-Credentials")) 52 | assert.Equal(t, 204, rsp.StatusCode) 53 | }) 54 | } 55 | -------------------------------------------------------------------------------- /context/httpRequest.go: -------------------------------------------------------------------------------- 1 | package context 2 | 3 | import ( 4 | "io" 5 | "net/http" 6 | "net/url" 7 | "reflect" 8 | "strings" 9 | 10 | "github.com/farseer-go/fs/snc" 11 | ) 12 | 13 | type HttpRequest struct { 14 | Body io.ReadCloser 15 | BodyString string 16 | BodyBytes []byte 17 | Form map[string]any 18 | Query map[string]any 19 | Params []reflect.Value // 转换成Handle函数需要的参数 20 | R *http.Request 21 | } 22 | 23 | // jsonToMap 将json转成map类型 24 | func (r *HttpRequest) jsonToMap() map[string]any { 25 | mapVal := make(map[string]any) 26 | //_ = json.Unmarshal(r.BodyBytes, &mapVal) 27 | // d := json.NewDecoder(bytes.NewReader(r.BodyBytes)) 28 | // d.UseNumber() 29 | // _ = d.Decode(&mapVal) 30 | snc.Unmarshal(r.BodyBytes, &mapVal) 31 | 32 | // 将Key转小写 33 | for k, v := range mapVal { 34 | kLower := strings.ToLower(k) 35 | if k != kLower { 36 | delete(mapVal, k) 37 | mapVal[kLower] = v 38 | } 39 | } 40 | return mapVal 41 | } 42 | 43 | // ParseForm 解析来自form的值 44 | func (r *HttpRequest) ParseForm() { 45 | for k, v := range r.R.Form { 46 | key := strings.ToLower(k) 47 | r.Form[key] = strings.Join(v, "&") 48 | r.Query[key] = strings.Join(v, "&") 49 | } 50 | 51 | // multipart/form-data提交的数据在Body中 52 | if r.BodyString != "" { 53 | parseQuery, _ := url.ParseQuery(r.BodyString) 54 | for key, value := range parseQuery { 55 | key = strings.ToLower(key) 56 | if len(value) > 0 { 57 | r.Form[key] = strings.Join(value, ",") 58 | r.Query[key] = strings.Join(value, ",") 59 | } 60 | } 61 | //formValues := strings.Split(r.BodyString, "&") 62 | //for _, value := range formValues { 63 | // kv := strings.Split(value, "=") 64 | // if len(kv) > 1 { 65 | // key := strings.ToLower(kv[0]) 66 | // r.Form[key] = kv[1] 67 | // r.Query[key] = kv[1] 68 | // } 69 | //} 70 | } 71 | } 72 | 73 | // ParseQuery 解析来自url的值 74 | func (r *HttpRequest) ParseQuery() { 75 | for k, v := range r.R.URL.Query() { 76 | key := strings.ToLower(k) 77 | r.Query[key] = strings.Join(v, "&") 78 | } 79 | } 80 | -------------------------------------------------------------------------------- /test/response_test.go: -------------------------------------------------------------------------------- 1 | package test 2 | 3 | import ( 4 | "bytes" 5 | 6 | "fmt" 7 | "net/http" 8 | "testing" 9 | "time" 10 | 11 | "github.com/farseer-go/fs" 12 | "github.com/farseer-go/fs/configure" 13 | "github.com/farseer-go/fs/core" 14 | "github.com/farseer-go/fs/snc" 15 | "github.com/farseer-go/webapi" 16 | "github.com/stretchr/testify/assert" 17 | ) 18 | 19 | func TestResponse(t *testing.T) { 20 | fs.Initialize[webapi.Module]("demo") 21 | configure.SetDefault("Log.Component.webapi", true) 22 | 23 | webapi.RegisterDELETE("/multiResponse", func(pageSize int, pageIndex int) (int, int) { 24 | return pageSize, pageIndex 25 | }, "page_size", "pageIndex") 26 | 27 | webapi.RegisterPOST("/basicTypeResponse", func(req pageSizeRequest) string { 28 | return fmt.Sprintf("hello world pageSize=%d，pageIndex=%d", req.PageSize, req.PageIndex) 29 | }) 30 | 31 | webapi.UseApiResponse() 32 | go webapi.Run(":8086") 33 | time.Sleep(10 * time.Millisecond) 34 | 35 | t.Run("multiResponse", func(t *testing.T) { 36 | sizeRequest := pageSizeRequest{PageSize: 10, PageIndex: 2} 37 | marshal, _ := snc.Marshal(sizeRequest) 38 | req, _ := http.NewRequest("DELETE", "http://127.0.0.1:8086/multiResponse", bytes.NewReader(marshal)) 39 | req.Header.Set("Content-Type", "application/json") 40 | rsp, _ := http.DefaultClient.Do(req) 41 | apiResponse := core.NewApiResponseByReader[[]int](rsp.Body) 42 | _ = rsp.Body.Close() 43 | assert.Equal(t, []int{10, 2}, apiResponse.Data) 44 | assert.Equal(t, 200, rsp.StatusCode) 45 | }) 46 | 47 | t.Run("basicTypeResponse", func(t *testing.T) { 48 | sizeRequest := pageSizeRequest{PageSize: 10, PageIndex: 2} 49 | marshal, _ := snc.Marshal(sizeRequest) 50 | rsp, _ := http.Post("http://127.0.0.1:8086/basicTypeResponse", "application/json", bytes.NewReader(marshal)) 51 | apiResponse := core.NewApiResponseByReader[string](rsp.Body) 52 | _ = rsp.Body.Close() 53 | assert.Equal(t, fmt.Sprintf("hello world pageSize=%d，pageIndex=%d", sizeRequest.PageSize, sizeRequest.PageIndex), apiResponse.Data) 54 | assert.Equal(t, 200, rsp.StatusCode) 55 | assert.Equal(t, 200, apiResponse.StatusCode) 56 | }) 57 | } 58 | -------------------------------------------------------------------------------- /middleware/apiResponse.go: -------------------------------------------------------------------------------- 1 | package middleware 2 | 3 | import ( 4 | "fmt" 5 | "net/http" 6 | "time" 7 | 8 | "github.com/farseer-go/collections" 9 | "github.com/farseer-go/fs/core" 10 | "github.com/farseer-go/fs/exception" 11 | "github.com/farseer-go/fs/trace" 12 | "github.com/farseer-go/webapi/context" 13 | ) 14 | 15 | type ApiResponse struct { 16 | context.IMiddleware 17 | } 18 | 19 | func (receiver *ApiResponse) Invoke(httpContext *context.HttpContext) { 20 | // ActionResult类型，不做ApiResponse解析 21 | if httpContext.IsActionResult() { 22 | receiver.IMiddleware.Invoke(httpContext) 23 | return 24 | } 25 | 26 | var apiResponse core.ApiResponse[any] 27 | catch := exception.Try(func() { 28 | receiver.IMiddleware.Invoke(httpContext) 29 | 30 | var returnVal any 31 | // 只有一个返回值 32 | bodyLength := len(httpContext.Response.Body) 33 | if bodyLength == 1 { 34 | returnVal = httpContext.Response.Body[0] 35 | } else if bodyLength > 1 { 36 | // 多个返回值，则转成数组Json 37 | lst := collections.NewListAny() 38 | for i := 0; i < bodyLength; i++ { 39 | lst.Add(httpContext.Response.Body[i]) 40 | } 41 | returnVal = lst 42 | } 43 | statusCode, statusMessage := httpContext.Response.GetStatus() 44 | apiResponse = core.Success[any](statusMessage, returnVal) 45 | apiResponse.StatusCode = statusCode 46 | apiResponse.Status = statusCode == 200 47 | }) 48 | 49 | catch.CatchWebException(func(exp exception.WebException) { 50 | apiResponse = core.Error[any](exp.Message, exp.StatusCode) 51 | }) 52 | 53 | catch.CatchRefuseException(func(exp exception.RefuseException) { 54 | apiResponse = core.Error[any](exp.Message, http.StatusInternalServerError) 55 | }) 56 | 57 | catch.CatchException(func(exp any) { 58 | // 响应码 59 | apiResponse = core.Error[any](fmt.Sprint(exp), http.StatusInternalServerError) 60 | }) 61 | 62 | traceContext := httpContext.Data.Get("Trace").(*trace.TraceContext) 63 | apiResponse.TraceId = traceContext.TraceId 64 | apiResponse.ElapsedMilliseconds = (time.Now().UnixMicro() - traceContext.StartTs) / 1000 65 | httpContext.Route.IsGoBasicType = false 66 | httpContext.Response.Body = []any{apiResponse} 67 | } 68 | -------------------------------------------------------------------------------- /websocket/register.go: -------------------------------------------------------------------------------- 1 | package websocket 2 | 3 | import ( 4 | "reflect" 5 | "strings" 6 | 7 | "github.com/farseer-go/collections" 8 | "github.com/farseer-go/fs/color" 9 | "github.com/farseer-go/fs/flog" 10 | "github.com/farseer-go/fs/types" 11 | "github.com/farseer-go/webapi/context" 12 | "github.com/farseer-go/webapi/middleware" 13 | ) 14 | 15 | // Register 注册单个Api 16 | func Register(area string, method string, route string, actionFunc any, filters []context.IFilter, paramNames ...string) *context.HttpRoute { 17 | actionType := reflect.TypeOf(actionFunc) 18 | inParams := types.GetInParam(actionType) 19 | outParams := types.GetOutParam(actionType) 20 | 21 | if len(inParams) < 1 || !strings.HasPrefix(inParams[0].String(), "*websocket.Context[") { 22 | flog.Panicf("注册ws路由%s%s失败：%s函数入参必须为：%s", area, route, color.Red(actionType.String()), color.Blue("*websocket.Context[T any]")) 23 | } 24 | 25 | if len(outParams) != 0 { 26 | flog.Panicf("注册ws路由%s%s失败：%s函数不能有出参", area, route, color.Red(actionType.String())) 27 | } 28 | 29 | // 如果设置了方法的入参（多参数），则需要全部设置 30 | if len(paramNames) > 0 && len(paramNames) != len(inParams) { 31 | flog.Panicf("注册路由%s%s失败：%s函数入参与%s不匹配，建议重新运行fsctl -r命令", area, route, color.Red(actionType.String()), color.Blue(paramNames)) 32 | } 33 | 34 | // 入参的泛型是否为DTO模式 35 | itemTypeMethod, _ := inParams[0].MethodByName("ItemType") 36 | itemType := itemTypeMethod.Type.Out(0) 37 | isDtoModel := types.IsDtoModelIgnoreInterface([]reflect.Type{itemType}) 38 | 39 | // 添加到路由表 40 | return &context.HttpRoute{ 41 | Schema: "ws", 42 | RouteUrl: area + route, 43 | Action: actionFunc, 44 | Method: collections.NewList(strings.Split(strings.ToUpper(method), "|")...), 45 | RequestParamType: collections.NewList(inParams...), 46 | ResponseBodyType: collections.NewList(outParams...), 47 | RequestParamIsModel: isDtoModel, 48 | ResponseBodyIsModel: false, 49 | ParamNames: collections.NewList(paramNames...), 50 | HttpMiddleware: &middleware.Websocket{}, 51 | HandleMiddleware: &HandleMiddleware{}, 52 | IsGoBasicType: types.IsGoBasicType(itemType), 53 | Filters: filters, 54 | } 55 | } 56 | -------------------------------------------------------------------------------- /minimal/register.go: -------------------------------------------------------------------------------- 1 | package minimal 2 | 3 | import ( 4 | "reflect" 5 | "strings" 6 | 7 | "github.com/farseer-go/collections" 8 | "github.com/farseer-go/fs/color" 9 | "github.com/farseer-go/fs/flog" 10 | "github.com/farseer-go/fs/types" 11 | "github.com/farseer-go/webapi/check" 12 | "github.com/farseer-go/webapi/context" 13 | "github.com/farseer-go/webapi/middleware" 14 | ) 15 | 16 | // Register 注册单个Api 17 | func Register(area string, method string, route string, actionFunc any, filters []context.IFilter, paramNames ...string) *context.HttpRoute { 18 | actionType := reflect.TypeOf(actionFunc) 19 | inParams := types.GetInParam(actionType) 20 | 21 | // 如果设置了方法的入参（多参数），则需要全部设置 22 | if len(paramNames) > 0 && len(paramNames) != len(inParams) { 23 | flog.Panicf("注册路由%s%s失败：%s函数入参与%s不匹配，建议重新运行fsctl -r命令", area, route, color.Red(actionType.String()), color.Blue(paramNames)) 24 | } 25 | 26 | lstRequestParamType := collections.NewList(inParams...) 27 | lstResponseParamType := collections.NewList(types.GetOutParam(actionType)...) 28 | 29 | // 入参是否为DTO模式 30 | isDtoModel := types.IsDtoModelIgnoreInterface(inParams) 31 | // 是否实现了ICheck 32 | var requestParamIsImplCheck bool 33 | if isDtoModel { 34 | // 是否实现了check.ICheck 35 | var checker = reflect.TypeOf((*check.ICheck)(nil)).Elem() 36 | requestParamIsImplCheck = lstRequestParamType.First().Implements(checker) 37 | if !requestParamIsImplCheck { 38 | requestParamIsImplCheck = reflect.PointerTo(lstRequestParamType.First()).Implements(checker) 39 | } 40 | } 41 | 42 | // 添加到路由表 43 | return &context.HttpRoute{ 44 | Schema: "http", 45 | RouteUrl: area + route, 46 | Action: actionFunc, 47 | Method: collections.NewList(strings.Split(strings.ToUpper(method), "|")...), 48 | RequestParamType: lstRequestParamType, 49 | ResponseBodyType: lstResponseParamType, 50 | RequestParamIsImplCheck: requestParamIsImplCheck, 51 | RequestParamIsModel: isDtoModel, 52 | ResponseBodyIsModel: types.IsDtoModel(lstResponseParamType.ToArray()), 53 | ParamNames: collections.NewList(paramNames...), 54 | HttpMiddleware: &middleware.Http{}, 55 | HandleMiddleware: &HandleMiddleware{}, 56 | IsGoBasicType: types.IsGoBasicType(lstResponseParamType.First()), 57 | Filters: filters, 58 | } 59 | } 60 | -------------------------------------------------------------------------------- /middleware/initMiddleware.go: -------------------------------------------------------------------------------- 1 | package middleware 2 | 3 | import ( 4 | "github.com/farseer-go/collections" 5 | "github.com/farseer-go/webapi/context" 6 | "reflect" 7 | ) 8 | 9 | // InitMiddleware 初始化管道 10 | func InitMiddleware(lstRouteTable map[string]*context.HttpRoute, lstMiddleware collections.List[context.IMiddleware]) { 11 | for _, route := range lstRouteTable { 12 | // 系统web是没有中间件的 13 | if route.HttpMiddleware == nil { 14 | continue 15 | } 16 | // 组装管道 17 | lstPipeline := assembledPipeline(route, lstMiddleware) 18 | for middlewareIndex := 0; middlewareIndex < lstPipeline.Count(); middlewareIndex++ { 19 | // 最后一个中间件不需要再设置 20 | if middlewareIndex+1 == lstPipeline.Count() { 21 | break 22 | } 23 | curMiddleware := lstPipeline.Index(middlewareIndex) 24 | nextMiddleware := lstPipeline.Index(middlewareIndex + 1) 25 | setNextMiddleware(curMiddleware, nextMiddleware) 26 | } 27 | } 28 | } 29 | 30 | // 组装管道 31 | func assembledPipeline(route *context.HttpRoute, lstMiddleware collections.List[context.IMiddleware]) collections.List[context.IMiddleware] { 32 | // 添加系统中间件 33 | lst := collections.NewList[context.IMiddleware](route.HttpMiddleware, &exceptionMiddleware{}, &routing{}) 34 | 35 | // 添加用户自定义中间件 36 | for i := 0; i < lstMiddleware.Count(); i++ { 37 | middlewareType := reflect.TypeOf(lstMiddleware.Index(i)).Elem() 38 | if route.Schema != "ws" || (middlewareType.String() != "middleware.ApiResponse" && middlewareType.String() != "middleware.Cors") { 39 | valIns := reflect.New(middlewareType).Interface() 40 | lst.Add(valIns.(context.IMiddleware)) 41 | } 42 | } 43 | 44 | // 添加Handle中间件 45 | lst.Add(route.HandleMiddleware) 46 | 47 | // 找到cors中间件，放入到http之后（即移到第2个索引） 48 | for i := 3; i < lst.Count(); i++ { 49 | if corsMiddleware, isHaveCors := lst.Index(i).(*Cors); isHaveCors { 50 | lst.RemoveAt(i) 51 | lst.Insert(1, corsMiddleware) 52 | break 53 | } 54 | } 55 | return lst 56 | } 57 | 58 | // setNextMiddleware 设置下一个管道 59 | func setNextMiddleware(curMiddleware, nextMiddleware context.IMiddleware) { 60 | curMiddlewareValue := reflect.ValueOf(curMiddleware) 61 | // 找到next字段进行赋值下一个中间件管道 62 | for fieldIndex := 0; fieldIndex < curMiddlewareValue.Elem().NumField(); fieldIndex++ { 63 | field := curMiddlewareValue.Elem().Field(fieldIndex) 64 | if field.Type().String() == "context.IMiddleware" { 65 | field.Set(reflect.ValueOf(nextMiddleware)) 66 | break 67 | } 68 | } 69 | } 70 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # webapi 概述 2 | > 包：`"github.com/farseer-go/webapi"` 3 | > 4 | > 模块：`webapi.Module` 5 | 6 | 7 | - `Document` 8 | - [English](https://farseer-go.github.io/doc/#/en-us/) 9 | - [中文](https://farseer-go.github.io/doc/) 10 | - [English](https://farseer-go.github.io/doc/#/en-us/) 11 | - Source 12 | - [github](https://github.com/farseer-go/fs) 13 | 14 | 15 | ![](https://img.shields.io/github/stars/farseer-go?style=social) 16 | ![](https://img.shields.io/github/license/farseer-go/webapi) 17 | ![](https://img.shields.io/github/go-mod/go-version/farseer-go/webapi) 18 | ![](https://img.shields.io/github/v/release/farseer-go/webapi) 19 | [![codecov](https://img.shields.io/codecov/c/github/farseer-go/webapi)](https://codecov.io/gh/farseer-go/webapi) 20 | ![](https://img.shields.io/github/languages/code-size/farseer-go/webapi) 21 | [![Build](https://github.com/farseer-go/webapi/actions/workflows/test.yml/badge.svg)](https://github.com/farseer-go/webapi/actions/workflows/test.yml) 22 | ![](https://goreportcard.com/badge/github.com/farseer-go/webapi) 23 | 24 | > 用于快速构建api服务，带来极简、优雅的开发体验。编写api服务时，不需要使用httpRequest、httpResponse等数据结构。 25 | 26 | webapi使用了中间件的管道模型编写，让我们加入非业务逻辑时非常简单。 27 | 28 | 包含两种风格来提供API服务： 29 | - `MinimalApi`：动态API风格（直接绑定到逻辑层） 30 | - `Mvc`：Controller、Action风格 31 | 32 | > 使用minimalApi时，甚至不需要UI层来提供API服务。 33 | 34 | ## webapi有哪些功能 35 | - 支持中间件 36 | - 入参、出参隐式绑定 37 | - 支持静态目录绑定 38 | - ActionFilter过虑器 39 | - ActionResult抽象结果 40 | - Area区域设置 41 | - MinimalApi模式 42 | - Mvc模式 43 | - HttpContext上下文 44 | - Header隐式绑定 45 | 46 | 大部份情况下，除了main需要配置webapi路由外，在你的api handle中就是一个普通的func函数，不需要依赖webapi组件。webapi会根据`func函数`的`出入参`来`隐式绑定数据`。 47 | 48 | ```go 49 | func main() { 50 | fs.Initialize[webapi.Module]("FOPS") 51 | webapi.RegisterPOST("/mini/hello1", Hello1) 52 | webapi.RegisterPOST("/mini/hello3", Hello3, "pageSize", "pageIndex") 53 | webapi.Run() 54 | } 55 | 56 | // 使用结构（DTO）来接收入参 57 | // 返回string 58 | func Hello1(req pageSizeRequest) string { 59 | return fmt.Sprintf("hello world pageSize=%d，pageIndex=%d", req.PageSize, req.PageIndex) 60 | } 61 | 62 | // 使用基础参数来接收入参 63 | // 返回pageSizeRequest结构（会自动转成json) 64 | func Hello3(pageSize int, pageIndex int) pageSizeRequest { 65 | return pageSizeRequest{ 66 | PageSize: pageSize, 67 | PageIndex: pageIndex, 68 | } 69 | } 70 | 71 | // 也可以定义一个结构，用于接收参数 72 | type pageSizeRequest struct { 73 | PageSize int 74 | PageIndex int 75 | } 76 | ``` 77 | 函数中，`出入参都会自动绑定数据` 78 | 79 | > 如果是`application/json`，则会自动被反序列化成model，如果是`x-www-form-urlencoded`，则会将每一项的key/value匹配到model字段中 80 | 81 | 可以看到，整个过程，`不需要`做`json序列化`、`httpRequest`、`httpResponse`的操作。 -------------------------------------------------------------------------------- /action/viewResult.go: -------------------------------------------------------------------------------- 1 | package action 2 | 3 | import ( 4 | "github.com/farseer-go/collections" 5 | "github.com/farseer-go/webapi/context" 6 | "os" 7 | "strings" 8 | ) 9 | 10 | // ViewResult 返回视图功能 11 | type ViewResult struct { 12 | viewName string 13 | data map[string]any 14 | } 15 | 16 | func (receiver ViewResult) ExecuteResult(httpContext *context.HttpContext) { 17 | // 默认视图，则以routeUrl为视图位置 18 | action := httpContext.URI.Path[strings.LastIndex(httpContext.URI.Path, "/")+1:] 19 | path, _ := receiver.cutPrefix(httpContext.URI.Path, "/") 20 | path = path[:len(path)-len(action)] 21 | 22 | if receiver.viewName == "" { 23 | receiver.viewName = "./views/" + path + action + ".html" 24 | } else { 25 | receiver.viewName = strings.TrimPrefix(receiver.viewName, "/") 26 | lstViewPath := collections.NewList(strings.Split(receiver.viewName, "/")...) 27 | if !strings.Contains(lstViewPath.Last(), ".") { 28 | receiver.viewName = "./views/" + path + receiver.viewName + ".html" 29 | } else { 30 | receiver.viewName = "./views/" + path + receiver.viewName 31 | } 32 | } 33 | 34 | file, _ := os.ReadFile(receiver.viewName) 35 | //if len(receiver.data) > 0 { 36 | // htmlSource := string(file) 37 | // startIndex := -1 38 | // stopIndex := -1 39 | // // 遍历html字符串 40 | // for i := 0; i < len(htmlSource); i++ { 41 | // // 查找开始标记 42 | // if i < len(htmlSource)-1 { 43 | // if htmlSource[i:1] == "${" { 44 | // startIndex = i 45 | // i++ 46 | // } 47 | // } 48 | // 49 | // // 查找结束标记 50 | // if startIndex > -1 && htmlSource[i] == '}' { 51 | // stopIndex = i 52 | // 53 | // // 找到了 54 | // htmlSource[startIndex : stopIndex-startIndex] 55 | // } 56 | // } 57 | // for k, v := range receiver.data { 58 | // htmlSource = strings.ReplaceAll(htmlSource, "${"+k+"}", parse.Convert(v, "")) 59 | // } 60 | //} else { 61 | // 62 | //} 63 | 64 | httpContext.Response.Write(file) 65 | } 66 | 67 | // CutPrefix go 1.20 68 | func (receiver ViewResult) cutPrefix(s, prefix string) (after string, found bool) { 69 | if !strings.HasPrefix(s, prefix) { 70 | return s, false 71 | } 72 | return s[len(prefix):], true 73 | } 74 | 75 | // View 视图 76 | func View(viewName ...string) IResult { 77 | var view string 78 | if len(viewName) > 0 { 79 | view = viewName[0] 80 | } 81 | return ViewResult{ 82 | viewName: view, 83 | } 84 | } 85 | 86 | // ViewData 视图 87 | func ViewData(Data map[string]any, viewName ...string) IResult { 88 | var view string 89 | if len(viewName) > 0 { 90 | view = viewName[0] 91 | } 92 | return ViewResult{ 93 | viewName: view, 94 | data: Data, 95 | } 96 | } 97 | -------------------------------------------------------------------------------- /test/inject_test.go: -------------------------------------------------------------------------------- 1 | package test 2 | 3 | import ( 4 | "github.com/farseer-go/fs" 5 | "github.com/farseer-go/fs/container" 6 | "github.com/farseer-go/webapi" 7 | "github.com/farseer-go/webapi/controller" 8 | "github.com/stretchr/testify/assert" 9 | "io" 10 | "net/http" 11 | "testing" 12 | "time" 13 | ) 14 | 15 | type ITestInject interface { 16 | Call() string 17 | } 18 | 19 | type testInject struct { 20 | value string 21 | } 22 | 23 | func (receiver *testInject) Call() string { 24 | return receiver.value 25 | } 26 | 27 | type testInjectController struct { 28 | controller.BaseController 29 | } 30 | 31 | func (r *testInjectController) Hello1(val ITestInject) string { 32 | return val.Call() 33 | } 34 | 35 | // 测试注入 36 | func TestInject(t *testing.T) { 37 | fs.Initialize[webapi.Module]("demo") 38 | // 注册接口实例 39 | container.Register(func() ITestInject { 40 | return &testInject{"ok1"} 41 | }) 42 | container.Register(func() ITestInject { 43 | return &testInject{"ok2"} 44 | }, "ins2") 45 | 46 | webapi.RegisterController(&testInjectController{ 47 | BaseController: controller.BaseController{ 48 | Action: map[string]controller.Action{ 49 | "Hello1": {Method: "GET", Params: "ins2"}, 50 | }, 51 | }, 52 | }) 53 | 54 | webapi.RegisterGET("/testInjectMini/testMiniApiInject1", func(str string, val ITestInject) string { 55 | return val.Call() + str 56 | }) 57 | 58 | webapi.RegisterGET("/testInjectMini/testMiniApiInject2", func(str string, val ITestInject) string { 59 | return val.Call() + str 60 | }, "str", "ins2") 61 | 62 | go webapi.Run(":8082") 63 | time.Sleep(10 * time.Millisecond) 64 | 65 | // 测试MVC模式 66 | t.Run("/testinject/hello1", func(t *testing.T) { 67 | rsp, _ := http.Get("http://127.0.0.1:8082/testinject/hello1") 68 | body, _ := io.ReadAll(rsp.Body) 69 | _ = rsp.Body.Close() 70 | assert.Equal(t, "ok2", string(body)) 71 | assert.Equal(t, 200, rsp.StatusCode) 72 | }) 73 | 74 | // 测试mini模式 75 | t.Run("/testInjectMini/testMiniApiInject1", func(t *testing.T) { 76 | rsp, _ := http.Get("http://127.0.0.1:8082/testInjectMini/testMiniApiInject1?str=baby") 77 | body, _ := io.ReadAll(rsp.Body) 78 | _ = rsp.Body.Close() 79 | assert.Equal(t, "ok1baby", string(body)) 80 | assert.Equal(t, 200, rsp.StatusCode) 81 | }) 82 | 83 | // 测试mini模式 84 | t.Run("/testInjectMini/testMiniApiInject2", func(t *testing.T) { 85 | rsp, _ := http.Get("http://127.0.0.1:8082/testInjectMini/testMiniApiInject2?str=oldbaby") 86 | body, _ := io.ReadAll(rsp.Body) 87 | _ = rsp.Body.Close() 88 | assert.Equal(t, "ok2oldbaby", string(body)) 89 | assert.Equal(t, 200, rsp.StatusCode) 90 | }) 91 | } 92 | -------------------------------------------------------------------------------- /test/jwt_test.go: -------------------------------------------------------------------------------- 1 | package test 2 | 3 | import ( 4 | "crypto/tls" 5 | "io" 6 | "net/http" 7 | "testing" 8 | "time" 9 | 10 | "github.com/farseer-go/fs" 11 | "github.com/farseer-go/fs/configure" 12 | "github.com/farseer-go/webapi" 13 | "github.com/stretchr/testify/assert" 14 | ) 15 | 16 | func TestJwt(t *testing.T) { 17 | // 测试生成出来的token与head是否一致 18 | var buildToken string 19 | configure.SetDefault("WebApi.Jwt.Key", "123456888") 20 | configure.SetDefault("WebApi.Jwt.KeyType", "HS256") 21 | configure.SetDefault("WebApi.Jwt.HeaderName", "Auto_test") 22 | configure.SetDefault("WebApi.Jwt.InvalidStatusCode", 403) 23 | configure.SetDefault("WebApi.Jwt.InvalidMessage", "您没有权限访问") 24 | 25 | fs.Initialize[webapi.Module]("demo") 26 | 27 | // 颁发Token给到前端 28 | webapi.RegisterRoutes(webapi.Route{Url: "/jwt/build", Action: func() { 29 | claims := make(map[string]any) 30 | claims["farseer-go"] = "v0.8.0" 31 | buildToken, _ = webapi.GetHttpContext().Jwt.Build(claims) // 会写到http head中 32 | }}.POST()) 33 | 34 | webapi.RegisterRoutes(webapi.Route{Url: "/jwt/validate", Action: func() string { 35 | return "hello" 36 | }}.POST().UseJwt()) 37 | 38 | go webapi.Run(":8090") 39 | time.Sleep(10 * time.Millisecond) 40 | 41 | t.Run("test jwt build", func(t *testing.T) { 42 | rsp, _ := http.Post("http://127.0.0.1:8090/jwt/build", "application/json", nil) 43 | _ = rsp.Body.Close() 44 | token := rsp.Header.Get("Auto_test") 45 | assert.Equal(t, token, buildToken) 46 | }) 47 | 48 | t.Run("test jwt validate error", func(t *testing.T) { 49 | newRequest, _ := http.NewRequest("POST", "http://127.0.0.1:8090/jwt/validate", nil) 50 | newRequest.Header.Set("Auto_test", "123123123") 51 | client := &http.Client{ 52 | Transport: &http.Transport{ 53 | TLSClientConfig: &tls.Config{ 54 | InsecureSkipVerify: true, // 不验证 HTTPS 证书 55 | }, 56 | }, 57 | } 58 | rsp, _ := client.Do(newRequest) 59 | rspBytes, _ := io.ReadAll(rsp.Body) 60 | assert.Equal(t, configure.GetString("WebApi.Jwt.InvalidMessage"), string(rspBytes)) 61 | assert.Equal(t, configure.GetInt("WebApi.Jwt.InvalidStatusCode"), rsp.StatusCode) 62 | }) 63 | 64 | t.Run("test jwt validate success", func(t *testing.T) { 65 | newRequest, _ := http.NewRequest("POST", "http://127.0.0.1:8090/jwt/validate", nil) 66 | newRequest.Header.Set("Auto_test", buildToken) 67 | client := &http.Client{ 68 | Transport: &http.Transport{ 69 | TLSClientConfig: &tls.Config{ 70 | InsecureSkipVerify: true, // 不验证 HTTPS 证书 71 | }, 72 | }, 73 | } 74 | rsp, _ := client.Do(newRequest) 75 | rspBytes, _ := io.ReadAll(rsp.Body) 76 | assert.Equal(t, "hello", string(rspBytes)) 77 | assert.Equal(t, 200, rsp.StatusCode) 78 | }) 79 | } 80 | -------------------------------------------------------------------------------- /controller/handleMiddleware.go: -------------------------------------------------------------------------------- 1 | package controller 2 | 3 | import ( 4 | "github.com/farseer-go/fs/container" 5 | "github.com/farseer-go/fs/parse" 6 | "github.com/farseer-go/fs/trace" 7 | "github.com/farseer-go/webapi/context" 8 | "reflect" 9 | ) 10 | 11 | type HandleMiddleware struct { 12 | } 13 | 14 | func (receiver HandleMiddleware) Invoke(httpContext *context.HttpContext) { 15 | traceDetail := container.Resolve[trace.IManager]().TraceHand("执行路由") 16 | defer traceDetail.End(nil) 17 | 18 | // 实例化控制器 19 | controllerVal := reflect.New(httpContext.Route.Controller) 20 | 21 | // 初始化赋控制器 22 | receiver.initController(httpContext, controllerVal) 23 | 24 | // 自动绑定头部 25 | receiver.bindHeader(httpContext, controllerVal) 26 | 27 | actionMethod := controllerVal.MethodByName(httpContext.Route.ActionName) 28 | 29 | var callValues []reflect.Value 30 | // 是否要执行ActionFilter 31 | if httpContext.Route.IsImplActionFilter { 32 | actionFilter := controllerVal.Interface().(IActionFilter) 33 | actionFilter.OnActionExecuting() 34 | 35 | // 实现了check.ICheck（必须放在过滤器之后执行） 36 | httpContext.RequestParamCheck() 37 | callValues = actionMethod.Call(httpContext.Request.Params) // 调用action 38 | 39 | actionFilter.OnActionExecuted() 40 | } else { 41 | // 实现了check.ICheck（必须放在过滤器之后执行） 42 | httpContext.RequestParamCheck() 43 | callValues = actionMethod.Call(httpContext.Request.Params) // 调用action 44 | } 45 | 46 | httpContext.Response.SetValues(callValues...) 47 | } 48 | 49 | // 找到 "controller.BaseController" 字段，并初始化赋值 50 | func (receiver HandleMiddleware) initController(httpContext *context.HttpContext, controllerVal reflect.Value) { 51 | controllerElem := controllerVal.Elem() 52 | for i := 0; i < controllerElem.NumField(); i++ { 53 | fieldVal := controllerElem.Field(i) 54 | if fieldVal.Type().String() == "controller.BaseController" { 55 | fieldVal.Set(reflect.ValueOf(BaseController{HttpContext: httpContext})) 56 | return 57 | } 58 | } 59 | } 60 | 61 | // 绑定header 62 | func (receiver HandleMiddleware) bindHeader(httpContext *context.HttpContext, controllerVal reflect.Value) { 63 | // 没有设置绑定字段，则不需要绑定 64 | if httpContext.Route.AutoBindHeaderName == "" { 65 | return 66 | } 67 | 68 | controllerHeaderVal := controllerVal.Elem().FieldByName(httpContext.Route.AutoBindHeaderName) 69 | controllerHeaderType := controllerHeaderVal.Type() 70 | 71 | // 遍历需要将header绑定的结构体 72 | for headerIndex := 0; headerIndex < controllerHeaderVal.NumField(); headerIndex++ { 73 | headerFieldVal := controllerHeaderVal.Field(headerIndex) 74 | headerFieldType := headerFieldVal.Type() 75 | headerName := controllerHeaderType.Field(headerIndex).Tag.Get("webapi") 76 | if headerName == "" { 77 | headerName = controllerHeaderType.Field(headerIndex).Name 78 | } 79 | headerVal := httpContext.Header.GetValue(headerName) 80 | if headerVal == "" { 81 | continue 82 | } 83 | headerValue := parse.ConvertValue(headerVal, headerFieldType) 84 | headerFieldVal.Set(reflect.ValueOf(headerValue)) 85 | } 86 | } 87 | -------------------------------------------------------------------------------- /session-redis/context/httpSession.go: -------------------------------------------------------------------------------- 1 | package context 2 | 3 | import ( 4 | "github.com/farseer-go/cache" 5 | "github.com/farseer-go/cacheMemory" 6 | "github.com/farseer-go/fs/configure" 7 | "github.com/farseer-go/fs/container" 8 | "github.com/farseer-go/fs/sonyflake" 9 | "github.com/farseer-go/redis" 10 | "net/http" 11 | "strconv" 12 | "strings" 13 | "time" 14 | ) 15 | 16 | // session名称 17 | const sessionId = "SessionId" 18 | 19 | // SessionTimeout 自动过期时间，单位：秒 20 | var SessionTimeout = 1200 21 | 22 | // SessionEnable 开启Session 23 | var SessionEnable = false 24 | 25 | // 存储session每一项值 26 | type nameValue struct { 27 | Name string 28 | Value any 29 | } 30 | 31 | type HttpSession struct { 32 | id string 33 | store cache.ICacheManage[nameValue] 34 | } 35 | 36 | // InitSession 初始化httpSession 37 | func InitSession(w http.ResponseWriter, r *http.Request) *HttpSession { 38 | httpSession := &HttpSession{} 39 | 40 | c, _ := r.Cookie(sessionId) 41 | if c != nil { 42 | httpSession.id = c.Value 43 | } 44 | 45 | // 第一次请求 46 | if httpSession.id == "" { 47 | httpSession.id = strconv.FormatInt(sonyflake.GenerateId(), 10) 48 | // 写入Cookies 49 | http.SetCookie(w, &http.Cookie{ 50 | Name: sessionId, 51 | Value: httpSession.id, 52 | Path: "/", 53 | HttpOnly: true, 54 | }) 55 | } 56 | 57 | // 设置存储方式 58 | cacheId := "SessionId_" + httpSession.id 59 | if !container.IsRegister[cache.ICacheManage[nameValue]](cacheId) { 60 | ops := func(op *cache.Op) { 61 | op.SlidingExpiration(time.Duration(SessionTimeout) * time.Second) 62 | } 63 | // 根据配置，设置存储方式 64 | switch strings.ToLower(configure.GetString("Webapi.Session.Store")) { 65 | case "redis": 66 | httpSession.store = redis.SetProfiles[nameValue](cacheId, "Name", configure.GetString("Webapi.Session.StoreConfigName"), ops) 67 | default: 68 | httpSession.store = cacheMemory.SetProfiles[nameValue](cacheId, "Name", ops) 69 | } 70 | } else { 71 | httpSession.store = container.Resolve[cache.ICacheManage[nameValue]](cacheId) 72 | } 73 | return httpSession 74 | } 75 | 76 | // GetValue 获取Session 77 | func (r *HttpSession) GetValue(name string) any { 78 | item, _ := r.store.GetItem(name) 79 | return item.Value 80 | } 81 | 82 | // SetValue 设置Session 83 | func (r *HttpSession) SetValue(name string, val any) { 84 | r.store.SaveItem(nameValue{ 85 | Name: name, 86 | Value: val, 87 | }) 88 | } 89 | 90 | // Remove 删除Session 91 | func (r *HttpSession) Remove(name string) { 92 | r.store.Remove(name) 93 | } 94 | 95 | // Clear 清空Session 96 | func (r *HttpSession) Clear() { 97 | r.store.Clear() 98 | } 99 | 100 | // ClearSession 移除过期的Session对象 101 | func ClearSession() { 102 | if !SessionEnable { 103 | SessionEnable = true 104 | tick := time.NewTicker(60 * time.Second) 105 | for range tick.C { 106 | container.RemoveUnused[cache.ICacheManage[nameValue]](time.Duration(SessionTimeout) * time.Second) 107 | } 108 | } 109 | } 110 | -------------------------------------------------------------------------------- /context/httpResponse.go: -------------------------------------------------------------------------------- 1 | package context 2 | 3 | import ( 4 | "net/http" 5 | "reflect" 6 | 7 | "github.com/farseer-go/fs/snc" 8 | ) 9 | 10 | type HttpResponse struct { 11 | W http.ResponseWriter 12 | Body []any // Action执行的结果（Action返回值） 13 | BodyBytes []byte // 自定义输出结果 14 | httpCode int // http响应代码 15 | statusCode int // ApiResponse响应代码 16 | statusMessage string // ApiResponse响应提示 17 | } 18 | 19 | // GetHttpCode 获取响应的HttpCode 20 | func (receiver *HttpResponse) GetHttpCode() int { 21 | return receiver.httpCode 22 | } 23 | 24 | // SetHttpCode 将响应状态写入http流 25 | func (receiver *HttpResponse) SetHttpCode(httpCode int) { 26 | receiver.httpCode = httpCode 27 | } 28 | 29 | // Write 将响应内容写入http流 30 | func (receiver *HttpResponse) Write(content []byte) { 31 | receiver.BodyBytes = content 32 | } 33 | 34 | // WriteString 将响应内容写入http流 35 | func (receiver *HttpResponse) WriteString(content string) { 36 | receiver.BodyBytes = []byte(content) 37 | } 38 | 39 | // WriteJson 将响应内容转成json后写入http流 40 | func (receiver *HttpResponse) WriteJson(content any) { 41 | receiver.BodyBytes, _ = snc.Marshal(content) 42 | receiver.W.Header().Set("Content-Type", "application/json") 43 | } 44 | 45 | // AddHeader 添加头部 46 | func (receiver *HttpResponse) AddHeader(key, value string) { 47 | receiver.W.Header().Add(key, value) 48 | } 49 | 50 | // SetHeader 覆盖头部 51 | func (receiver *HttpResponse) SetHeader(key, value string) { 52 | receiver.W.Header().Set(key, value) 53 | } 54 | 55 | // DelHeader 删除头部 56 | func (receiver *HttpResponse) DelHeader(key string) { 57 | receiver.W.Header().Del(key) 58 | } 59 | 60 | // SetStatusCode 设置StatusCode 61 | func (receiver *HttpResponse) SetStatusCode(statusCode int) { 62 | receiver.statusCode = statusCode 63 | } 64 | 65 | // SetMessage 设计响应提示信息 66 | func (receiver *HttpResponse) SetMessage(statusCode int, statusMessage string) { 67 | receiver.statusCode = statusCode 68 | receiver.statusMessage = statusMessage 69 | } 70 | 71 | // Reject 拒绝服务 72 | func (receiver *HttpResponse) Reject(httpCode int, content string) { 73 | receiver.httpCode = httpCode 74 | receiver.statusCode = httpCode 75 | receiver.BodyBytes = []byte(content) 76 | } 77 | 78 | // GetStatus 获取statusCode、statusMessage 79 | func (receiver *HttpResponse) GetStatus() (int, string) { 80 | return receiver.statusCode, receiver.statusMessage 81 | } 82 | 83 | // SetValues 设置Body值 84 | func (receiver *HttpResponse) SetValues(callValues ...reflect.Value) { 85 | for _, value := range callValues { 86 | receiver.Body = append(receiver.Body, value.Interface()) 87 | } 88 | } 89 | 90 | // Redirect302 302重定向 91 | func (receiver *HttpResponse) Redirect302(location string) { 92 | receiver.httpCode = 302 93 | receiver.W.Header().Set("Location", location) 94 | } 95 | 96 | // Redirect301 301重定向 97 | func (receiver *HttpResponse) Redirect301(location string) { 98 | receiver.httpCode = 301 99 | receiver.W.Header().Set("Location", location) 100 | } 101 | -------------------------------------------------------------------------------- /run.go: -------------------------------------------------------------------------------- 1 | package webapi 2 | 3 | import ( 4 | "github.com/farseer-go/fs/modules" 5 | "github.com/farseer-go/webapi/context" 6 | "github.com/farseer-go/webapi/controller" 7 | ) 8 | 9 | var defaultApi *applicationBuilder 10 | 11 | func RegisterMiddleware(m context.IMiddleware) { 12 | // 需要先依赖模块 13 | modules.ThrowIfNotLoad(Module{}) 14 | defaultApi.RegisterMiddleware(m) 15 | } 16 | 17 | // RegisterRoutes 批量注册路由 18 | func RegisterRoutes(routes ...Route) { 19 | defaultApi.RegisterRoutes(routes...) 20 | } 21 | 22 | // RegisterController 自动注册控制器下的所有Action方法 23 | func RegisterController(c controller.IController) { 24 | // 需要先依赖模块 25 | modules.ThrowIfNotLoad(Module{}) 26 | defaultApi.RegisterController(c) 27 | } 28 | 29 | // RegisterPOST 注册单个Api（支持占位符，例如：/{cateId}/{Id}） 30 | func RegisterPOST(route string, actionFunc any, params ...string) { 31 | defaultApi.RegisterPOST(route, actionFunc, params...) 32 | } 33 | 34 | // RegisterGET 注册单个Api（支持占位符，例如：/{cateId}/{Id}） 35 | func RegisterGET(route string, actionFunc any, params ...string) { 36 | defaultApi.RegisterGET(route, actionFunc, params...) 37 | } 38 | 39 | // RegisterPUT 注册单个Api（支持占位符，例如：/{cateId}/{Id}） 40 | func RegisterPUT(route string, actionFunc any, params ...string) { 41 | defaultApi.RegisterPUT(route, actionFunc, params...) 42 | } 43 | 44 | // RegisterDELETE 注册单个Api（支持占位符，例如：/{cateId}/{Id}） 45 | func RegisterDELETE(route string, actionFunc any, params ...string) { 46 | defaultApi.RegisterDELETE(route, actionFunc, params...) 47 | } 48 | 49 | // Area 设置区域 50 | func Area(area string, f func()) { 51 | defaultApi.Area(area, f) 52 | } 53 | 54 | // UseCors 使用CORS中间件 55 | func UseCors() { 56 | defaultApi.UseCors() 57 | } 58 | 59 | // UseStaticFiles 支持静态目录，在根目录./wwwroot中的文件，直接以静态文件提供服务 60 | func UseStaticFiles() { 61 | // 需要先依赖模块 62 | modules.ThrowIfNotLoad(Module{}) 63 | 64 | defaultApi.UseStaticFiles() 65 | } 66 | 67 | // UsePprof 是否同时开启pprof 68 | func UsePprof() { 69 | defaultApi.UsePprof() 70 | } 71 | 72 | // UseSession 开启Session 73 | func UseSession() { 74 | defaultApi.UseSession() 75 | } 76 | 77 | func UseWebApi() { 78 | defaultApi.UseWebApi() 79 | } 80 | 81 | // UseApiResponse 让所有的返回值，包含在core.ApiResponse中 82 | func UseApiResponse() { 83 | defaultApi.UseApiResponse() 84 | } 85 | 86 | // UseValidate 使用字段验证器 87 | func UseValidate() { 88 | defaultApi.UseValidate() 89 | } 90 | 91 | // UseTLS 使用https 92 | func UseTLS(certFile, keyFile string) { 93 | defaultApi.UseTLS(certFile, keyFile) 94 | } 95 | 96 | // Run 运行Web服务（默认8888端口） 97 | func Run(params ...string) { 98 | // 需要先依赖模块 99 | modules.ThrowIfNotLoad(Module{}) 100 | defaultApi.Run(params...) 101 | } 102 | 103 | // PrintRoute 打印所有路由信息到控制台 104 | func PrintRoute() { 105 | defaultApi.PrintRoute() 106 | } 107 | 108 | // UseApiDoc 是否开启Api文档 109 | func UseApiDoc() { 110 | defaultApi.UseApiDoc() 111 | } 112 | 113 | // UseHealthCheck 【GET】开启健康检查（默认route = "/healthCheck"） 114 | func UseHealthCheck(routes ...string) { 115 | defaultApi.UseHealthCheck(routes...) 116 | } 117 | -------------------------------------------------------------------------------- /test/websocket_test.go: -------------------------------------------------------------------------------- 1 | package test 2 | 3 | import ( 4 | "net/http" 5 | "testing" 6 | "time" 7 | 8 | "github.com/farseer-go/fs" 9 | "github.com/farseer-go/fs/core" 10 | "github.com/farseer-go/fs/trace" 11 | "github.com/farseer-go/utils/ws" 12 | "github.com/farseer-go/webapi" 13 | "github.com/farseer-go/webapi/websocket" 14 | "github.com/stretchr/testify/assert" 15 | ) 16 | 17 | func TestWebsocket(t *testing.T) { 18 | fs.Initialize[webapi.Module]("demo") 19 | webapi.UseStaticFiles() 20 | webapi.UseApiResponse() 21 | webapi.RegisterRoutes(webapi.Route{Url: "/mini/api", Method: "GET", Action: func() any { 22 | return pageSizeRequest{PageSize: 3, PageIndex: 2} 23 | }}) 24 | 25 | // 场景一：客户端发一次消息，服务端返回一次消息 26 | webapi.RegisterRoutes(webapi.Route{Url: "/ws/api1", Method: "WS", Params: []string{"context", ""}, 27 | Action: func(context *websocket.Context[pageSizeRequest], manager trace.IManager) { 28 | // 验证头部 29 | val := context.GetHeader("Token") 30 | assert.Equal(t, "farseer-go", val) 31 | 32 | // 验证a、c 33 | assert.Equal(t, "b", context.HttpContext.Request.Form["a"]) 34 | assert.Equal(t, "d", context.HttpContext.Request.Form["c"]) 35 | 36 | req := context.Receiver() 37 | _ = context.Send("我收到消息啦：") 38 | 39 | req.PageSize++ 40 | req.PageIndex++ 41 | _ = context.Send(req) 42 | }}) 43 | 44 | // 场景二：客户端连接后，客户端每发一次消息，服务端持续返回新的消息 45 | webapi.RegisterRoutes(webapi.Route{Url: "/ws/api2", Method: "WS", Params: []string{"context", ""}, 46 | Action: func(context *websocket.Context[pageSizeRequest], manager trace.IManager) { 47 | context.ReceiverMessageFunc(500*time.Millisecond, func(message string) { 48 | if message == "1" { 49 | _ = context.Send("hello") 50 | } 51 | 52 | if message == "2" { 53 | _ = context.Send("world") 54 | } 55 | }) 56 | }}) 57 | 58 | go webapi.Run(":8096") 59 | time.Sleep(100 * time.Millisecond) 60 | 61 | t.Run("mini/api", func(t *testing.T) { 62 | rsp, _ := http.Get("http://127.0.0.1:8096/mini/api") 63 | apiResponse := core.NewApiResponseByReader[pageSizeRequest](rsp.Body) 64 | _ = rsp.Body.Close() 65 | assert.Equal(t, 3, apiResponse.Data.PageSize) 66 | assert.Equal(t, 2, apiResponse.Data.PageIndex) 67 | assert.Equal(t, 200, rsp.StatusCode) 68 | assert.Equal(t, 200, apiResponse.StatusCode) 69 | }) 70 | 71 | t.Run("/ws/api1", func(t *testing.T) { 72 | client, err := ws.NewClient("ws://127.0.0.1:8096/ws/api1?a=b&c=d", 1024, true) 73 | assert.Nil(t, err) 74 | 75 | // 设置头部 76 | client.SetHeader("token", "farseer-go") 77 | 78 | // 连接 79 | err = client.Connect() 80 | assert.Nil(t, err) 81 | 82 | // 发消息 83 | err = client.Send(pageSizeRequest{ 84 | PageSize: 200, 85 | PageIndex: 100, 86 | }) 87 | assert.Nil(t, err) 88 | 89 | // 接收服务端的消息 90 | msg, err := client.ReceiverMessage() 91 | assert.Nil(t, err) 92 | assert.Equal(t, msg, "我收到消息啦：") 93 | 94 | // 接收服务端的消息 95 | var request2 pageSizeRequest 96 | err = client.Receiver(&request2) 97 | assert.Nil(t, err) 98 | assert.Equal(t, 201, request2.PageSize) 99 | assert.Equal(t, 101, request2.PageIndex) 100 | 101 | time.Sleep(100 * time.Millisecond) 102 | // 服务端关闭后，尝试继续接收消息 103 | assert.Panics(t, func() { 104 | _, _ = client.ReceiverMessage() 105 | }) 106 | }) 107 | 108 | t.Run("/ws/api2", func(t *testing.T) { 109 | client, err := ws.NewClient("ws://127.0.0.1:8096/ws/api2", 1024, true) 110 | assert.Nil(t, err) 111 | 112 | // 连接 113 | err = client.Connect() 114 | assert.Nil(t, err) 115 | 116 | // 发送1 117 | _ = client.Send("1") 118 | 119 | msg, _ := client.ReceiverMessage() 120 | assert.Equal(t, msg, "hello") 121 | 122 | msg, _ = client.ReceiverMessage() 123 | assert.Equal(t, msg, "hello") 124 | 125 | _ = client.Send("2") 126 | 127 | msg, _ = client.ReceiverMessage() 128 | assert.Equal(t, msg, "world") 129 | 130 | msg, _ = client.ReceiverMessage() 131 | assert.Equal(t, msg, "world") 132 | }) 133 | } 134 | -------------------------------------------------------------------------------- /test/actionResult_test.go: -------------------------------------------------------------------------------- 1 | package test 2 | 3 | import ( 4 | "github.com/farseer-go/fs" 5 | "github.com/farseer-go/fs/configure" 6 | "github.com/farseer-go/fs/core" 7 | "github.com/farseer-go/webapi" 8 | "github.com/farseer-go/webapi/action" 9 | "github.com/stretchr/testify/assert" 10 | "io" 11 | "net/http" 12 | "net/url" 13 | "strconv" 14 | "testing" 15 | "time" 16 | ) 17 | 18 | func TestActionResult(t *testing.T) { 19 | fs.Initialize[webapi.Module]("demo") 20 | configure.SetDefault("Log.Component.webapi", true) 21 | webapi.RegisterGET("/redirect", func() any { 22 | return pageSizeRequest{PageSize: 3, PageIndex: 2} 23 | }) 24 | 25 | webapi.RegisterPOST("/mini/testActionResult", func(actionType int) action.IResult { 26 | switch actionType { 27 | case 0: 28 | return action.Redirect("/redirect") 29 | case 1: 30 | return action.View("") 31 | case 2: 32 | return action.View("testActionResult") 33 | case 3: 34 | return action.View("test.txt") 35 | case 4: 36 | return action.Content("ccc") 37 | case 5: 38 | return action.FileContent("./views/mini/test.log") 39 | } 40 | 41 | return action.Content("eee") 42 | }) 43 | webapi.UseApiResponse() 44 | 45 | go webapi.Run(":8088") 46 | time.Sleep(10 * time.Millisecond) 47 | 48 | t.Run("test-0", func(t *testing.T) { 49 | val := make(url.Values) 50 | val.Add("actionType", strconv.Itoa(0)) 51 | rsp, _ := http.PostForm("http://127.0.0.1:8088/mini/testActionResult", val) 52 | apiResponse := core.NewApiResponseByReader[pageSizeRequest](rsp.Body) 53 | _ = rsp.Body.Close() 54 | assert.Equal(t, 3, apiResponse.Data.PageSize) 55 | assert.Equal(t, 2, apiResponse.Data.PageIndex) 56 | assert.Equal(t, 200, rsp.StatusCode) 57 | assert.Equal(t, 200, apiResponse.StatusCode) 58 | }) 59 | 60 | t.Run("test-1", func(t *testing.T) { 61 | val := make(url.Values) 62 | val.Add("actionType", strconv.Itoa(1)) 63 | rsp, _ := http.PostForm("http://127.0.0.1:8088/mini/testActionResult", val) 64 | body, _ := io.ReadAll(rsp.Body) 65 | _ = rsp.Body.Close() 66 | assert.Equal(t, "aaa", string(body)) 67 | assert.Equal(t, 200, rsp.StatusCode) 68 | }) 69 | 70 | t.Run("test-2", func(t *testing.T) { 71 | val := make(url.Values) 72 | val.Add("actionType", strconv.Itoa(2)) 73 | rsp, _ := http.PostForm("http://127.0.0.1:8088/mini/testActionResult", val) 74 | body, _ := io.ReadAll(rsp.Body) 75 | _ = rsp.Body.Close() 76 | assert.Equal(t, "aaa", string(body)) 77 | assert.Equal(t, 200, rsp.StatusCode) 78 | }) 79 | 80 | t.Run("test-3", func(t *testing.T) { 81 | val := make(url.Values) 82 | val.Add("actionType", strconv.Itoa(3)) 83 | rsp, _ := http.PostForm("http://127.0.0.1:8088/mini/testActionResult", val) 84 | body, _ := io.ReadAll(rsp.Body) 85 | _ = rsp.Body.Close() 86 | assert.Equal(t, "bbb", string(body)) 87 | assert.Equal(t, 200, rsp.StatusCode) 88 | }) 89 | 90 | t.Run("test-4", func(t *testing.T) { 91 | val := make(url.Values) 92 | val.Add("actionType", strconv.Itoa(4)) 93 | rsp, _ := http.PostForm("http://127.0.0.1:8088/mini/testActionResult", val) 94 | body, _ := io.ReadAll(rsp.Body) 95 | _ = rsp.Body.Close() 96 | assert.Equal(t, "ccc", string(body)) 97 | assert.Equal(t, 200, rsp.StatusCode) 98 | }) 99 | 100 | t.Run("test-5", func(t *testing.T) { 101 | val := make(url.Values) 102 | val.Add("actionType", strconv.Itoa(5)) 103 | rsp, _ := http.PostForm("http://127.0.0.1:8088/mini/testActionResult", val) 104 | body, _ := io.ReadAll(rsp.Body) 105 | _ = rsp.Body.Close() 106 | assert.Equal(t, "ddd", string(body)) 107 | assert.Equal(t, 200, rsp.StatusCode) 108 | }) 109 | 110 | t.Run("test--1", func(t *testing.T) { 111 | val := make(url.Values) 112 | val.Add("actionType", strconv.Itoa(-1)) 113 | rsp, _ := http.PostForm("http://127.0.0.1:8088/mini/testActionResult", val) 114 | body, _ := io.ReadAll(rsp.Body) 115 | _ = rsp.Body.Close() 116 | assert.Equal(t, "eee", string(body)) 117 | assert.Equal(t, 200, rsp.StatusCode) 118 | }) 119 | } 120 | -------------------------------------------------------------------------------- /apiDoc.go: -------------------------------------------------------------------------------- 1 | package webapi 2 | 3 | import ( 4 | "fmt" 5 | "reflect" 6 | "strings" 7 | 8 | "github.com/farseer-go/collections" 9 | "github.com/farseer-go/fs/core" 10 | "github.com/farseer-go/fs/fastReflect" 11 | "github.com/farseer-go/fs/parse" 12 | "github.com/farseer-go/fs/snc" 13 | "github.com/farseer-go/fs/types" 14 | "github.com/farseer-go/webapi/action" 15 | "github.com/farseer-go/webapi/context" 16 | ) 17 | 18 | // UseApiDoc 是否开启Api文档 19 | func (r *applicationBuilder) UseApiDoc() { 20 | r.registerAction(Route{Url: "/doc/api", Method: "GET", Action: func() action.IResult { 21 | lstBody := collections.NewList[string]("\n") 22 | lstRoute := collections.NewList[context.HttpRoute]() 23 | for _, httpRoute := range r.mux.m { 24 | lstRoute.Add(*httpRoute) 25 | } 26 | 27 | // 遍历路由 28 | lstRoute.OrderBy(func(item context.HttpRoute) any { 29 | return item.RouteUrl 30 | }).Foreach(func(httpRoute *context.HttpRoute) { 31 | method := strings.Join(httpRoute.Method.ToArray(), "|") 32 | if httpRoute.RouteUrl == "/" && method == "" && httpRoute.Controller == nil && httpRoute.Action == nil { 33 | return 34 | } 35 | // API地址 36 | lstBody.Add(fmt.Sprintf("[%s]：%s
\n", method, r.hostAddress+httpRoute.RouteUrl, r.hostAddress+httpRoute.RouteUrl)) 37 | // 入参 38 | // 使用textarea 39 | lstBody.Add("") 60 | 61 | lstBody.Add("") 109 | lstBody.Add("
") 110 | }) 111 | lstBody.Add("") 112 | 113 | return action.Content(lstBody.ToString("")) 114 | }, Params: nil}) 115 | } 116 | -------------------------------------------------------------------------------- /context/httpJwt.go: -------------------------------------------------------------------------------- 1 | package context 2 | 3 | import ( 4 | "fmt" 5 | "net/http" 6 | "strings" 7 | 8 | "github.com/farseer-go/fs/configure" 9 | "github.com/farseer-go/fs/exception" 10 | "github.com/golang-jwt/jwt/v5" 11 | ) 12 | 13 | var headerName string // 前端提交Token，存放到header的name 14 | var jwtKey []byte // 生成token的秘钥 15 | var jwtKeyType string // 签名加密方式 16 | var jwtKeyMethod jwt.SigningMethod // sign method 17 | var InvalidStatusCode int // token无效时的状态码 18 | var InvalidMessage string // key type 19 | 20 | type HttpJwt struct { 21 | r *http.Request 22 | w http.ResponseWriter 23 | claims jwt.MapClaims 24 | } 25 | 26 | // InitJwt jwt初始化 27 | func InitJwt() { 28 | jwtKey = []byte(configure.GetString("WebApi.Jwt.Key")) 29 | jwtKeyType = configure.GetString("WebApi.Jwt.KeyType") 30 | headerName = configure.GetString("WebApi.Jwt.HeaderName") 31 | InvalidStatusCode = configure.GetInt("WebApi.Jwt.InvalidStatusCode") 32 | InvalidMessage = configure.GetString("WebApi.Jwt.InvalidMessage") 33 | 34 | if headerName == "" { 35 | headerName = "Authorization" 36 | } 37 | 38 | if InvalidStatusCode == 0 { 39 | InvalidStatusCode = 403 40 | } 41 | 42 | if InvalidMessage == "" { 43 | InvalidMessage = "您没有权限访问" 44 | } 45 | 46 | switch jwtKeyType { 47 | case "HS256": 48 | jwtKeyMethod = jwt.SigningMethodHS256 49 | case "HS384": 50 | jwtKeyMethod = jwt.SigningMethodHS384 51 | case "HS512": 52 | jwtKeyMethod = jwt.SigningMethodHS512 53 | 54 | case "RS256": 55 | jwtKeyMethod = jwt.SigningMethodRS256 56 | case "RS384": 57 | jwtKeyMethod = jwt.SigningMethodRS384 58 | case "RS512": 59 | jwtKeyMethod = jwt.SigningMethodRS512 60 | 61 | case "ES256": 62 | jwtKeyMethod = jwt.SigningMethodES256 63 | case "ES384": 64 | jwtKeyMethod = jwt.SigningMethodES384 65 | case "ES512": 66 | jwtKeyMethod = jwt.SigningMethodES512 67 | 68 | case "PS256": 69 | jwtKeyMethod = jwt.SigningMethodPS256 70 | case "PS384": 71 | jwtKeyMethod = jwt.SigningMethodPS384 72 | case "PS512": 73 | jwtKeyMethod = jwt.SigningMethodPS512 74 | 75 | case "EdDSA": 76 | jwtKeyMethod = jwt.SigningMethodEdDSA 77 | default: 78 | jwtKeyMethod = jwt.SigningMethodHS256 79 | } 80 | } 81 | 82 | // GetToken 获取前端提交过来的Token 83 | func (receiver *HttpJwt) GetToken() string { 84 | // 走ws协议 85 | if receiver.r.Header.Get("Upgrade") == "websocket" { 86 | return receiver.r.Form.Get(headerName) 87 | } 88 | 89 | // 优先通过header读取 90 | if token := receiver.r.Header.Get(headerName); token != "" { 91 | // 检查是否以 Bearer 开头（忽略大小写） 92 | if strings.HasPrefix(strings.ToLower(token), "bearer ") { 93 | // 分割后取 token 部分 94 | return strings.TrimSpace(token[7:]) 95 | } 96 | 97 | // 否则直接使用整个 header 作为 token 98 | return strings.TrimSpace(token) 99 | } 100 | 101 | // 走URL读取 102 | return receiver.r.Form.Get(headerName) 103 | } 104 | 105 | // Build 生成jwt token，并写入head 106 | func (receiver *HttpJwt) Build(claims map[string]any) (string, error) { 107 | // 生成token对象 108 | token := jwt.NewWithClaims(jwtKeyMethod, jwt.MapClaims(claims)) 109 | 110 | exception.ThrowWebExceptionBool(len(jwtKey) == 0, 403, "未设置jwt的秘钥，请到./farseer.yaml的WebApi.Jwt.Key节点中配置") 111 | 112 | sign, err := token.SignedString(jwtKey) // 带秘钥的签名 113 | 114 | // 成功生成后，写入到head 115 | if err == nil && receiver.w != nil { 116 | receiver.w.Header().Set(headerName, sign) 117 | } 118 | return sign, err 119 | } 120 | 121 | // Valid 验证前端提交过来的token是否正确 122 | func (receiver *HttpJwt) Valid() bool { 123 | t := receiver.GetToken() 124 | token, err := jwt.Parse(t, func(token *jwt.Token) (any, error) { 125 | // 验证加密方式 126 | if _, ok := token.Method.(*jwt.SigningMethodHMAC); !ok { 127 | return nil, fmt.Errorf("非预期的签名方法： %v", token.Header["alg"]) 128 | } 129 | return jwtKey, nil 130 | }) 131 | // 签名不对 132 | if err != nil { 133 | return false 134 | } 135 | 136 | if claims, ok := token.Claims.(jwt.MapClaims); ok && token.Valid { 137 | receiver.claims = claims 138 | return true 139 | } 140 | return false 141 | } 142 | 143 | // GetClaims 读取前端提交过来的Claims 144 | func (receiver *HttpJwt) GetClaims() jwt.MapClaims { 145 | // nil说明没有执行过验证 146 | if receiver.claims == nil { 147 | receiver.Valid() 148 | } 149 | return receiver.claims 150 | } 151 | 152 | // 清除token 153 | func (receiver *HttpJwt) Clear() { 154 | receiver.w.Header().Del(headerName) 155 | } 156 | 157 | //type MyCustomClaims struct { 158 | // Foo string `json:"foo"` 159 | // jwt.RegisteredClaims 160 | //} 161 | -------------------------------------------------------------------------------- /controller/register.go: -------------------------------------------------------------------------------- 1 | package controller 2 | 3 | import ( 4 | "github.com/farseer-go/collections" 5 | "github.com/farseer-go/fs/types" 6 | "github.com/farseer-go/webapi/check" 7 | "github.com/farseer-go/webapi/context" 8 | "github.com/farseer-go/webapi/middleware" 9 | "reflect" 10 | "strings" 11 | ) 12 | 13 | // Register 自动注册控制器下的所有Action方法 14 | func Register(area string, c IController) collections.List[*context.HttpRoute] { 15 | cVal := reflect.ValueOf(c) 16 | cType := cVal.Type() 17 | controllerType := reflect.Indirect(cVal).Type() 18 | controllerName := strings.TrimSuffix(controllerType.Name(), "Controller") 19 | actions := c.getAction() 20 | 21 | // 查找是否需要自动绑定header 22 | autoBindHeaderName := findAutoBindHeaderName(controllerType) 23 | 24 | // 是否实现了IActionFilter 25 | var actionFilter = reflect.TypeOf((*IActionFilter)(nil)).Elem() 26 | isImplActionFilter := cType.Implements(actionFilter) 27 | 28 | lst := collections.NewList[*context.HttpRoute]() 29 | // 遍历controller下的action函数 30 | for i := 0; i < cType.NumMethod(); i++ { 31 | actionMethod := cType.Method(i) 32 | // 如果是来自基类的方法、非导出类型，则跳过 33 | if actionMethod.IsExported() && !lstControllerMethodName.Contains(actionMethod.Name) { 34 | httpRoute := registerAction(area, actionMethod, actions, controllerName, controllerType, autoBindHeaderName, isImplActionFilter) 35 | if httpRoute != nil { 36 | lst.Add(httpRoute) 37 | } 38 | } 39 | } 40 | return lst 41 | } 42 | 43 | // 查找自动绑定header的字段 44 | func findAutoBindHeaderName(controllerType reflect.Type) string { 45 | var controllerFieldName string 46 | for i := 0; i < controllerType.NumField(); i++ { 47 | // 找到需要绑定头部的标记 48 | controllerFieldType := controllerType.Field(i) 49 | if controllerFieldType.Tag.Get("webapi") == "header" { 50 | controllerFieldName = controllerFieldType.Name 51 | break 52 | } 53 | } 54 | return controllerFieldName 55 | } 56 | 57 | // 注册Action 58 | func registerAction(area string, actionMethod reflect.Method, actions map[string]Action, controllerName string, controllerType reflect.Type, autoBindHeaderName string, isImplActionFilter bool) *context.HttpRoute { 59 | methodType := actionMethod.Type 60 | actionName := actionMethod.Name 61 | // 如果是ActionFilter过滤器，则跳过 62 | if isImplActionFilter && (actionName == "OnActionExecuting" || actionName == "OnActionExecuted") { 63 | return nil 64 | } 65 | 66 | // 控制器都是以方法的形式，因此第0个入参是接收器，应去除 67 | lstRequestParamType := collections.NewList(types.GetInParam(methodType)...) 68 | lstRequestParamType.RemoveAt(0) 69 | lstResponseParamType := collections.NewList(types.GetOutParam(methodType)...) 70 | 71 | // 设置Action默认参数 72 | if _, exists := actions[actionName]; !exists { 73 | actions[actionName] = Action{Method: "POST"} 74 | } 75 | 76 | // 多参数解析 77 | var paramNames []string 78 | if actions[actionName].Params != "" { 79 | paramNames = strings.Split(actions[actionName].Params, ",") 80 | } 81 | 82 | if actions[actionName].Method == "" { 83 | action := actions[actionName] 84 | action.Method = "POST" 85 | actions[actionName] = action 86 | } 87 | 88 | // 入参是否为DTO模式 89 | isDtoModel := types.IsDtoModelIgnoreInterface(lstRequestParamType.ToArray()) 90 | // 是否实现了ICheck 91 | var requestParamIsImplCheck bool 92 | if isDtoModel { 93 | // 是否实现了check.ICheck 94 | var checker = reflect.TypeOf((*check.ICheck)(nil)).Elem() 95 | requestParamIsImplCheck = lstRequestParamType.First().Implements(checker) 96 | } 97 | 98 | // 添加到路由表 99 | return &context.HttpRoute{ 100 | Schema: "http", 101 | RouteUrl: area + strings.ToLower(controllerName) + "/" + strings.ToLower(actionName), 102 | Action: methodType, 103 | Method: collections.NewList(strings.Split(strings.ToUpper(actions[actionName].Method), "|")...), 104 | RequestParamType: lstRequestParamType, 105 | ResponseBodyType: lstResponseParamType, 106 | RequestParamIsImplCheck: requestParamIsImplCheck, 107 | RequestParamIsModel: isDtoModel, 108 | ResponseBodyIsModel: types.IsDtoModel(lstResponseParamType.ToArray()), 109 | ParamNames: collections.NewList(paramNames...), 110 | HttpMiddleware: &middleware.Http{}, 111 | HandleMiddleware: &HandleMiddleware{}, 112 | IsGoBasicType: types.IsGoBasicType(lstResponseParamType.First()), 113 | 114 | AutoBindHeaderName: autoBindHeaderName, 115 | IsImplActionFilter: isImplActionFilter, 116 | Controller: controllerType, 117 | ControllerName: controllerName, 118 | ActionName: actionName, 119 | } 120 | } 121 | -------------------------------------------------------------------------------- /websocket/webSocketContext.go: -------------------------------------------------------------------------------- 1 | package websocket 2 | 3 | import ( 4 | ctx "context" 5 | 6 | "reflect" 7 | "time" 8 | 9 | "github.com/farseer-go/fs/container" 10 | "github.com/farseer-go/fs/exception" 11 | "github.com/farseer-go/fs/flog" 12 | "github.com/farseer-go/fs/parse" 13 | "github.com/farseer-go/fs/snc" 14 | "github.com/farseer-go/fs/trace" 15 | "github.com/farseer-go/webapi/context" 16 | "github.com/timandy/routine" 17 | "golang.org/x/net/websocket" 18 | ) 19 | 20 | // Context websocket上下文 21 | type Context[T any] struct { 22 | *BaseContext 23 | tType reflect.Type // 得到泛型T的类型 24 | } 25 | 26 | // ItemType 泛型类型 27 | func (receiver *Context[T]) ItemType() T { 28 | var t T 29 | return t 30 | } 31 | 32 | // SetContext 收到请求时，设置上下文（webapi使用） 33 | func (receiver *Context[T]) SetContext(httpContext *context.HttpContext) { 34 | var t T 35 | receiver.tType = reflect.TypeOf(t) 36 | receiver.BaseContext = &BaseContext{ 37 | HttpContext: httpContext, 38 | AutoExit: true, 39 | } 40 | receiver.Ctx, receiver.cancel = ctx.WithCancel(ctx.Background()) 41 | } 42 | 43 | // ReceiverFunc 当收到下一条消息时，会停止上一条消息的f()执行，然后再执行下一条消息的f()。如果没有收到消息，则会一直定时间隔执行f() 44 | func (receiver *Context[T]) ReceiverFunc(d time.Duration, f func(message *T)) { 45 | var c ctx.Context 46 | var cancel ctx.CancelFunc 47 | 48 | for { 49 | // 等待消息 50 | messageStr, messageData := receiver.receiver() 51 | // 停止上一轮的函数f 52 | if cancel != nil { 53 | cancel() 54 | } 55 | c, cancel = ctx.WithCancel(ctx.Background()) 56 | 57 | // 异步执行函数f 58 | routine.Go(func() { 59 | for { 60 | func() { 61 | // 创建链路追踪上下文 62 | trackContext := container.Resolve[trace.IManager]().EntryWebSocket(receiver.HttpContext.URI.Host, receiver.HttpContext.URI.Url, receiver.HttpContext.Header.ToMap(), receiver.HttpContext.URI.GetRealIp()) 63 | defer func() { 64 | container.Resolve[trace.IManager]().Push(trackContext, nil) 65 | }() 66 | 67 | trackContext.SetBody(messageStr, 0, "", nil) 68 | exception.Try(func() { 69 | f(&messageData) 70 | }) 71 | // .CatchWebException(func(exp exception.WebException) { 72 | // // 408为客户端断开了连接，此异常可以忽略 73 | // if exp.StatusCode != 408 { 74 | // err = errors.New(fmt.Sprint(exp)) 75 | // } 76 | // }).CatchException(func(exp any) { 77 | // err = errors.New(fmt.Sprint(exp)) 78 | // }) 79 | }() 80 | 81 | // 等待下一次执行 82 | select { 83 | case <-c.Done(): 84 | return 85 | case <-receiver.Ctx.Done(): 86 | return 87 | case <-time.NewTicker(d).C: 88 | } 89 | } 90 | }) 91 | } 92 | } 93 | 94 | // ForReceiverFunc 持续接收消息然后执行f()，然后再接收 95 | func (receiver *Context[T]) ForReceiverFunc(f func(message *T)) { 96 | // 执行函数f 97 | for { 98 | // 等待消息 99 | messageStr, messageData := receiver.receiver() 100 | // 创建链路追踪上下文 101 | trackContext := container.Resolve[trace.IManager]().EntryWebSocket(receiver.HttpContext.URI.Host, receiver.HttpContext.URI.Url, receiver.HttpContext.Header.ToMap(), receiver.HttpContext.URI.GetRealIp()) 102 | trackContext.SetBody(messageStr, 0, "", nil) 103 | exception.Try(func() { 104 | f(&messageData) 105 | }) 106 | // .CatchWebException(func(exp exception.WebException) { 107 | // // 408为客户端断开了连接，此异常可以忽略 108 | // if exp.StatusCode != 408 { 109 | // err = errors.New(fmt.Sprint(exp)) 110 | // } 111 | // }).CatchException(func(exp any) { 112 | // err = errors.New(fmt.Sprint(exp)) 113 | // }) 114 | container.Resolve[trace.IManager]().Push(trackContext, nil) 115 | } 116 | } 117 | 118 | // Receiver 接收消息 119 | func (receiver *Context[T]) Receiver() T { 120 | reopen: 121 | var t T 122 | switch receiver.tType.Kind() { 123 | case reflect.Struct: 124 | err := websocket.JSON.Receive(receiver.HttpContext.WebsocketConn, &t) 125 | if err != nil { 126 | receiver.errorIsClose(err) 127 | flog.Warningf("路由：%s 接收数据时，出现反序列失败：%s", receiver.HttpContext.Route.RouteUrl, err.Error()) 128 | goto reopen 129 | } 130 | default: 131 | var data string 132 | err := websocket.Message.Receive(receiver.HttpContext.WebsocketConn, &data) 133 | if err != nil { 134 | receiver.errorIsClose(err) 135 | flog.Warningf("路由：%s 接收数据时，出现异常：%s", receiver.HttpContext.Route.RouteUrl, err.Error()) 136 | goto reopen 137 | } 138 | return parse.Convert(data, t) 139 | } 140 | return t 141 | } 142 | 143 | // Receiver 接收消息 144 | func (receiver *Context[T]) receiver() (string, T) { 145 | reopen: 146 | var message string 147 | if err := websocket.Message.Receive(receiver.HttpContext.WebsocketConn, &message); err != nil { 148 | receiver.errorIsClose(err) 149 | flog.Warningf("路由：%s 接收数据时，出现异常：%s", receiver.HttpContext.Route.RouteUrl, err.Error()) 150 | goto reopen 151 | } 152 | 153 | // 序列化 154 | var t T 155 | if err := snc.Unmarshal([]byte(message), &t); err != nil { 156 | receiver.errorIsClose(err) 157 | flog.Warningf("路由：%s 接收数据时，出现反序列失败：%s", receiver.HttpContext.Route.RouteUrl, err.Error()) 158 | goto reopen 159 | } 160 | return message, parse.Convert(message, t) 161 | } 162 | -------------------------------------------------------------------------------- /context/httpRoute.go: -------------------------------------------------------------------------------- 1 | package context 2 | 3 | import ( 4 | "fmt" 5 | "net/http" 6 | "reflect" 7 | "strings" 8 | 9 | "github.com/farseer-go/collections" 10 | "github.com/farseer-go/fs/container" 11 | "github.com/farseer-go/fs/parse" 12 | "github.com/farseer-go/fs/snc" 13 | ) 14 | 15 | // HttpRoute 路由表 16 | type HttpRoute struct { 17 | RouteUrl string // 路由地址 18 | Controller reflect.Type // 控制器类型 19 | ControllerName string // 控制器名称 20 | Action any // action类型 21 | ActionName string // action名称 22 | RequestParamType collections.List[reflect.Type] // 入参 23 | ResponseBodyType collections.List[reflect.Type] // 出参 24 | Method collections.List[string] // method 25 | ParamNames collections.List[string] // 入参变量名称（显示指定） 26 | RequestParamIsImplCheck bool // 入参DTO是否实现了Check接口 27 | RequestParamIsModel bool // 入参是否为DTO结构 28 | ResponseBodyIsModel bool // 出参是否为DTO结构 29 | AutoBindHeaderName string // 自动绑定header的字段名称 30 | IsImplActionFilter bool // 是否实现了IActionFilter 31 | IsGoBasicType bool // 返回值只有一个时，是否为基础类型 32 | HttpMiddleware IMiddleware // 中间件入口（每个路由的管道都不一样） 33 | HandleMiddleware IMiddleware // handle中间件 34 | RouteRegexp *routeRegexp // 正则路由 35 | Handler http.Handler // api处理函数 36 | Filters []IFilter // 过滤器（对单个路由的执行单元） 37 | Schema string // http or ws 38 | } 39 | 40 | // JsonToParams json入参转成param 41 | func (receiver *HttpRoute) JsonToParams(request *HttpRequest) []reflect.Value { 42 | // dto 43 | if receiver.RequestParamIsModel { 44 | // 第一个参数，将json反序列化到dto 45 | firstParamType := receiver.RequestParamType.First() // 先取第一个参数 46 | val := reflect.New(firstParamType).Interface() 47 | _ = snc.Unmarshal(request.BodyBytes, val) 48 | returnVal := []reflect.Value{reflect.ValueOf(val).Elem()} 49 | 50 | // 第2个参数起，为interface类型，需要做注入操作 51 | return receiver.parseInterfaceParam(returnVal) 52 | } 53 | 54 | // 多参数 55 | return receiver.FormToParams(request.jsonToMap()) 56 | } 57 | 58 | // FormToParams 将map转成入参值 59 | func (receiver *HttpRoute) FormToParams(mapVal map[string]any) []reflect.Value { 60 | // dto模式 61 | if receiver.RequestParamIsModel { 62 | // 第一个参数，将json反序列化到dto 63 | firstParamType := receiver.RequestParamType.First() // 先取第一个参数 64 | // 反序列后的dto对象值 65 | dtoParamVal := reflect.New(firstParamType).Elem() 66 | for i := 0; i < firstParamType.NumField(); i++ { 67 | field := firstParamType.Field(i) 68 | if !field.IsExported() { 69 | continue 70 | } 71 | // 支持json标签 72 | key := strings.ToLower(field.Tag.Get("json")) 73 | if key == "" { 74 | key = strings.ToLower(field.Name) 75 | } 76 | kv, exists := mapVal[key] 77 | if exists { 78 | fieldVal := parse.ConvertValue(kv, dtoParamVal.Field(i).Type()) 79 | // dto中的字段赋值 80 | dtoParamVal.FieldByName(field.Name).Set(reflect.ValueOf(fieldVal)) 81 | } 82 | } 83 | returnVal := []reflect.Value{dtoParamVal} 84 | 85 | // 第2个参数起，为interface类型，需要做注入操作 86 | return receiver.parseInterfaceParam(returnVal) 87 | } 88 | 89 | // 非dto模式 90 | lstParams := make([]reflect.Value, receiver.RequestParamType.Count()) 91 | for i := 0; i < receiver.RequestParamType.Count(); i++ { 92 | fieldType := receiver.RequestParamType.Index(i) 93 | var val any 94 | // interface类型，则通过注入的方式 95 | if fieldType.Kind() == reflect.Interface { 96 | val = receiver.diParam(i) 97 | } else { 98 | val = reflect.New(fieldType).Elem().Interface() 99 | // 指定了参数名称 100 | if receiver.ParamNames.Count() > i { 101 | paramName := strings.ToLower(receiver.ParamNames.Index(i)) 102 | paramVal := mapVal[paramName] 103 | val = parse.Convert(paramVal, val) 104 | // 当实际只有一个接收参数时，不需要指定参数 105 | } else if receiver.ParamNames.Count() == 0 && len(mapVal) == 1 { 106 | for _, paramVal := range mapVal { 107 | val = parse.Convert(paramVal, val) 108 | } 109 | } 110 | } 111 | lstParams[i] = reflect.ValueOf(val) 112 | } 113 | return lstParams 114 | } 115 | 116 | // 第2个参数起，为interface类型，需要做注入操作 117 | func (receiver *HttpRoute) parseInterfaceParam(returnVal []reflect.Value) []reflect.Value { 118 | for i := 1; i < receiver.RequestParamType.Count(); i++ { 119 | val := reflect.ValueOf(receiver.diParam(i)) 120 | returnVal = append(returnVal, val) 121 | } 122 | return returnVal 123 | } 124 | 125 | func (receiver *HttpRoute) diParam(paramIndex int) any { 126 | // 如果是接口类型，则这里的名称为IocName 127 | paramName := "" 128 | if paramIndex < receiver.ParamNames.Count() { 129 | paramName = receiver.ParamNames.Index(paramIndex) 130 | } 131 | iocType := receiver.RequestParamType.Index(paramIndex) 132 | if !container.IsRegisterType(iocType, paramName) { 133 | panic(fmt.Sprintf("类型：%s 未注册到IOC", iocType.String())) 134 | } 135 | val, _ := container.ResolveType(iocType, paramName) 136 | return val 137 | } 138 | -------------------------------------------------------------------------------- /context/httpContext.go: -------------------------------------------------------------------------------- 1 | package context 2 | 3 | import ( 4 | "net/http" 5 | "reflect" 6 | "strings" 7 | 8 | "github.com/farseer-go/collections" 9 | "github.com/farseer-go/fs/asyncLocal" 10 | "github.com/farseer-go/webapi/check" 11 | "golang.org/x/net/websocket" 12 | ) 13 | 14 | var RoutineHttpContext = asyncLocal.New[*HttpContext]() 15 | 16 | type HttpContext struct { 17 | WebsocketConn *websocket.Conn // websocket 18 | Request *HttpRequest // Request 19 | Response *HttpResponse // Response 20 | Header collections.ReadonlyDictionary[string, string] // 头部信息 21 | ResponseHeader collections.ReadonlyDictionary[string, string] // 头部信息 22 | Cookie *HttpCookies // Cookies信息 23 | Session IHttpSession // Session信息 24 | Route *HttpRoute // 路由信息 25 | URI *HttpURL // URL信息 26 | Data *HttpData // 用于传递值 27 | Method string // 客户端提交时的Method 28 | ContentLength int64 // 客户端提交时的内容长度 29 | ContentType string // 客户端提交时的内容类型 30 | Exception error // 是否发生异常 31 | Jwt *HttpJwt // jwt验证 32 | Close bool 33 | TransferEncoding []string 34 | } 35 | 36 | // NewHttpContext 初始化上下文 37 | func NewHttpContext(httpRoute *HttpRoute, w http.ResponseWriter, r *http.Request) *HttpContext { 38 | var httpContext = HttpContext{ 39 | Request: &HttpRequest{ 40 | Body: r.Body, 41 | R: r, 42 | Form: make(map[string]any), 43 | Query: make(map[string]any), 44 | }, 45 | Response: &HttpResponse{ 46 | W: w, 47 | statusMessage: "成功", 48 | }, 49 | URI: &HttpURL{ 50 | Path: r.URL.Path, 51 | RemoteAddr: r.RemoteAddr, 52 | X_Forwarded_For: r.Header.Get("X-Forwarded-For"), 53 | X_Real_Ip: r.Header.Get("X-Real-Ip"), 54 | Host: r.Host, 55 | Proto: r.Proto, 56 | RequestURI: r.RequestURI, 57 | QueryString: r.URL.RawQuery, 58 | Query: make(map[string]any), 59 | Url: "http://" + r.Host + r.RequestURI, // 先默认https，后边在处理 60 | R: r, 61 | }, 62 | Data: &HttpData{value: collections.NewDictionary[string, any]()}, 63 | Method: r.Method, 64 | ContentLength: r.ContentLength, 65 | Close: r.Close, 66 | TransferEncoding: r.TransferEncoding, 67 | ContentType: "", 68 | Route: httpRoute, 69 | Cookie: initCookies(w, r), 70 | Jwt: &HttpJwt{ 71 | w: w, 72 | r: r, 73 | }, 74 | } 75 | 76 | if httpRoute.Schema == "ws" { 77 | if r.TLS != nil { 78 | httpContext.URI.Url = "wss://" + r.Host + r.RequestURI 79 | } else { 80 | httpContext.URI.Url = "ws://" + r.Host + r.RequestURI 81 | } 82 | } else if r.TLS != nil { 83 | httpContext.URI.Url = "https://" + r.Host + r.RequestURI 84 | } 85 | 86 | // header 87 | header := collections.NewDictionary[string, string]() 88 | for k, v := range r.Header { 89 | header.Add(k, strings.Join(v, ";")) 90 | } 91 | httpContext.Header = header.ToReadonlyDictionary() 92 | 93 | // ContentType 94 | for _, contentType := range strings.Split(httpContext.Header.GetValue("Content-Type"), ";") { 95 | if strings.Contains(contentType, "/") { 96 | httpContext.ContentType = contentType 97 | } 98 | } 99 | return &httpContext 100 | } 101 | 102 | func (receiver *HttpContext) SetWebsocket(conn *websocket.Conn) { 103 | receiver.WebsocketConn = conn 104 | } 105 | 106 | // ParseParams 转换成Handle函数需要的参数 107 | func (receiver *HttpContext) ParseParams() []reflect.Value { 108 | // 没有入参时，忽略request.body 109 | if receiver.Route.RequestParamType.Count() == 0 { 110 | return []reflect.Value{} 111 | } 112 | 113 | if receiver.Route.Schema == "ws" { 114 | contextWebSocket := reflect.New(receiver.Route.RequestParamType.First().Elem()) 115 | contextWebSocket.MethodByName("SetContext").Call([]reflect.Value{reflect.ValueOf(receiver)}) 116 | // 第2个参数起，为interface类型，需要做注入操作 117 | return receiver.Route.parseInterfaceParam([]reflect.Value{contextWebSocket}) 118 | } 119 | 120 | if receiver.Method == "GET" { 121 | return receiver.Route.FormToParams(receiver.Request.Query) 122 | } 123 | 124 | // application/json 125 | switch receiver.ContentType { 126 | case "application/json": 127 | return receiver.Route.JsonToParams(receiver.Request) 128 | default: //case "application/x-www-form-urlencoded", "multipart/form-data": 129 | return receiver.Route.FormToParams(receiver.Request.Query) // Query比Form有更齐全的值，所以不用Form 130 | } 131 | } 132 | 133 | // IsActionResult 是否为ActionResult类型 134 | func (receiver *HttpContext) IsActionResult() bool { 135 | return receiver.Route.ResponseBodyType.Count() == 1 && receiver.Route.ResponseBodyType.First().String() == "action.IResult" 136 | } 137 | 138 | // RequestParamCheck 实现了check.ICheck（必须放在过滤器之后执行） 139 | func (receiver *HttpContext) RequestParamCheck() { 140 | if receiver.Route.RequestParamIsImplCheck { 141 | dto := receiver.Request.Params[0] 142 | val := dto.Addr().Interface() 143 | val.(check.ICheck).Check() 144 | } 145 | } 146 | -------------------------------------------------------------------------------- /websocket/baseContext.go: -------------------------------------------------------------------------------- 1 | package websocket 2 | 3 | import ( 4 | ctx "context" 5 | 6 | "errors" 7 | "net" 8 | "time" 9 | 10 | "github.com/farseer-go/fs/asyncLocal" 11 | "github.com/farseer-go/fs/container" 12 | "github.com/farseer-go/fs/exception" 13 | "github.com/farseer-go/fs/fastReflect" 14 | "github.com/farseer-go/fs/flog" 15 | "github.com/farseer-go/fs/parse" 16 | "github.com/farseer-go/fs/snc" 17 | "github.com/farseer-go/fs/trace" 18 | "github.com/farseer-go/webapi/context" 19 | "github.com/timandy/routine" 20 | "golang.org/x/net/websocket" 21 | ) 22 | 23 | type BaseContext struct { 24 | Ctx ctx.Context // 用于通知应用端是否断开连接 25 | cancel ctx.CancelFunc // 用于通知Ctx，连接已断开 26 | AutoExit bool // 当断开连接时，自动退出 27 | HttpContext *context.HttpContext // 上下文 28 | isClose bool // 是否断开连接 29 | } 30 | 31 | // ReceiverMessage 接收消息 32 | func (receiver *BaseContext) ReceiverMessage() string { 33 | reopen: 34 | var data string 35 | err := websocket.Message.Receive(receiver.HttpContext.WebsocketConn, &data) 36 | if err != nil { 37 | receiver.errorIsClose(err) 38 | flog.Warningf("路由：%s 接收数据时，出现异常：%s", receiver.HttpContext.Route.RouteUrl, err.Error()) 39 | goto reopen 40 | } 41 | 42 | // InitContext 初始化同一协程上下文，避免在同一协程中多次初始化 43 | asyncLocal.InitContext() 44 | return data 45 | } 46 | 47 | // ForReceiverFunc 持续接收消息然后执行f()，然后再接收 48 | func (receiver *BaseContext) ForReceiverFunc(f func(message string)) { 49 | // 执行函数f 50 | for { 51 | // 等待消息 52 | message := receiver.ReceiverMessage() 53 | // 创建链路追踪上下文 54 | trackContext := container.Resolve[trace.IManager]().EntryWebSocket(receiver.HttpContext.URI.Host, receiver.HttpContext.URI.Url, receiver.HttpContext.Header.ToMap(), receiver.HttpContext.URI.GetRealIp()) 55 | trackContext.SetBody(message, 0, "", nil) 56 | exception.Try(func() { 57 | f(message) 58 | }) 59 | // .CatchWebException(func(exp exception.WebException) { 60 | // // 408为客户端断开了连接，此异常可以忽略 61 | // if exp.StatusCode != 408 { 62 | // err = errors.New(fmt.Sprint(exp)) 63 | // } 64 | // }).CatchException(func(exp any) { 65 | // err = errors.New(fmt.Sprint(exp)) 66 | // }) 67 | container.Resolve[trace.IManager]().Push(trackContext, nil) 68 | } 69 | } 70 | 71 | // ReceiverMessageFunc 接收消息。当收到消息后，会执行f() 72 | func (receiver *BaseContext) ReceiverMessageFunc(d time.Duration, f func(message string)) { 73 | var c ctx.Context 74 | var cancel ctx.CancelFunc 75 | 76 | for { 77 | // 等待消息 78 | message := receiver.ReceiverMessage() 79 | // 停止上一轮的函数f 80 | if cancel != nil { 81 | cancel() 82 | } 83 | c, cancel = ctx.WithCancel(ctx.Background()) 84 | 85 | // 异步执行函数f 86 | routine.Go(func() { 87 | for { 88 | func() { 89 | // 创建链路追踪上下文 90 | trackContext := container.Resolve[trace.IManager]().EntryWebSocket(receiver.HttpContext.URI.Host, receiver.HttpContext.URI.Url, receiver.HttpContext.Header.ToMap(), receiver.HttpContext.URI.GetRealIp()) 91 | defer func() { 92 | container.Resolve[trace.IManager]().Push(trackContext, nil) 93 | }() 94 | 95 | trackContext.SetBody(message, 0, "", nil) 96 | exception.Try(func() { 97 | f(message) 98 | }) 99 | // .CatchWebException(func(exp exception.WebException) { 100 | // // 408为客户端断开了连接，此异常可以忽略 101 | // if exp.StatusCode != 408 { 102 | // err = errors.New(fmt.Sprint(exp)) 103 | // } 104 | // }).CatchException(func(exp any) { 105 | // err = errors.New(fmt.Sprint(exp)) 106 | // }) 107 | }() 108 | // 等待下一次执行 109 | select { 110 | case <-c.Done(): 111 | return 112 | case <-receiver.Ctx.Done(): 113 | return 114 | case <-time.NewTicker(d).C: 115 | continue 116 | } 117 | } 118 | }) 119 | } 120 | } 121 | 122 | // Send 发送消息，如果msg不是go的基础类型，则会自动序列化成json 123 | func (receiver *BaseContext) Send(msg any) error { 124 | var err error 125 | var message string 126 | // 基础类型不需要进行序列化 127 | if fastReflect.PointerOf(msg).Type == fastReflect.GoBasicType { 128 | message = parse.ToString(msg) 129 | } else { 130 | // 其余类型，一律使用json 131 | marshal, _ := snc.Marshal(msg) 132 | message = string(marshal) 133 | } 134 | err = websocket.Message.Send(receiver.HttpContext.WebsocketConn, message) 135 | 136 | if err != nil { 137 | receiver.errorIsClose(err) 138 | flog.Warningf("路由：%s 发送数据时失败：%s", receiver.HttpContext.Route.RouteUrl, err.Error()) 139 | } 140 | 141 | // 如果使用了链路追踪，则记录异常 142 | if traceContext := trace.CurTraceContext.Get(); traceContext != nil { 143 | traceContext.SetResponseBody(message) 144 | traceContext.Error(err) 145 | } 146 | return err 147 | } 148 | 149 | // Close 关闭连接 150 | func (receiver *BaseContext) Close() { 151 | _ = receiver.HttpContext.WebsocketConn.Close() 152 | receiver.cancel() 153 | receiver.isClose = true 154 | } 155 | 156 | // GetHeader 获取头部 157 | func (receiver *BaseContext) GetHeader(key string) string { 158 | return receiver.HttpContext.Header.GetValue(key) 159 | } 160 | 161 | // IsClose 是否已断开连接 162 | func (receiver *BaseContext) IsClose() bool { 163 | return receiver.isClose 164 | } 165 | 166 | // 根据错误信息，判断是否为断开连接导致的 167 | func (receiver *BaseContext) errorIsClose(err error) { 168 | var opError *net.OpError 169 | if errors.As(err, &opError) || err.Error() == "EOF" { 170 | receiver.cancel() 171 | receiver.isClose = true 172 | if receiver.AutoExit { 173 | exception.ThrowWebException(408, "客户端已关闭") 174 | } 175 | } 176 | } 177 | 178 | // GetParam 获取来自URL的参数 179 | func (receiver *BaseContext) GetParam(key string) any { 180 | return receiver.HttpContext.Request.Form[key] 181 | } 182 | -------------------------------------------------------------------------------- /test/controller_test.go: -------------------------------------------------------------------------------- 1 | package test 2 | 3 | import ( 4 | "bytes" 5 | 6 | "fmt" 7 | "net/http" 8 | "net/url" 9 | "strconv" 10 | "testing" 11 | "time" 12 | 13 | "github.com/farseer-go/fs" 14 | "github.com/farseer-go/fs/configure" 15 | "github.com/farseer-go/fs/core" 16 | "github.com/farseer-go/fs/snc" 17 | "github.com/farseer-go/webapi" 18 | "github.com/farseer-go/webapi/controller" 19 | "github.com/farseer-go/webapi/middleware" 20 | "github.com/stretchr/testify/assert" 21 | ) 22 | 23 | type header struct { 24 | ContentType string `webapi:"Content-Type"` 25 | ContentType2 string 26 | } 27 | type TestHeaderController struct { 28 | controller.BaseController 29 | Header header `webapi:"header"` 30 | } 31 | 32 | func (r *TestHeaderController) Hello1(req pageSizeRequest) string { 33 | r.Response.SetMessage(200, "修改成功") 34 | return fmt.Sprintf("hello world pageSize=%d，pageIndex=%d", req.PageSize, req.PageIndex) 35 | } 36 | 37 | func (r *TestHeaderController) Hello2(pageSize int, pageIndex int) pageSizeRequest { 38 | return pageSizeRequest{ 39 | PageSize: pageSize, 40 | PageIndex: pageIndex, 41 | } 42 | } 43 | 44 | func (r *TestHeaderController) Hello3() (TValue string) { 45 | return r.HttpContext.Header.GetValue("Content-Type") 46 | } 47 | 48 | func (r *TestHeaderController) OnActionExecuting() { 49 | if r.HttpContext.Method != "GET" && r.Header.ContentType == "" { 50 | panic("测试失败，未获取到：Header.ContentType") 51 | } 52 | r.HttpContext.Response.AddHeader("Executing", "true") 53 | r.HttpContext.Response.SetHeader("Set-Header1", "true") 54 | r.HttpContext.Response.SetHeader("Set-Header2", "true") 55 | } 56 | 57 | func (r *TestHeaderController) OnActionExecuted() { 58 | r.HttpContext.Response.AddHeader("Executed", "true") 59 | r.HttpContext.Response.DelHeader("Set-Header2") 60 | } 61 | 62 | func TestController(t *testing.T) { 63 | fs.Initialize[webapi.Module]("demo") 64 | configure.SetDefault("Log.Component.webapi", true) 65 | webapi.Area("api/1.0", func() { 66 | // 自动注册控制器下的所有Action方法 67 | webapi.RegisterController(&TestHeaderController{ 68 | BaseController: controller.BaseController{ 69 | Action: map[string]controller.Action{ 70 | "Hello1": {Method: ""}, 71 | "Hello2": {Method: "POST", Params: "page_Size,pageIndex"}, 72 | "Hello3": {Method: "GET"}, 73 | }, 74 | }, 75 | }) 76 | }) 77 | 78 | webapi.UseCors() 79 | webapi.UseWebApi() 80 | webapi.UseStaticFiles() 81 | webapi.UseApiResponse() 82 | webapi.RegisterMiddleware(&middleware.UrlRewriting{}) 83 | 84 | go webapi.Run(":8079") 85 | time.Sleep(10 * time.Millisecond) 86 | 87 | t.Run("api/1.0/test/hello1", func(t *testing.T) { 88 | sizeRequest := pageSizeRequest{PageSize: 10, PageIndex: 2} 89 | marshal, _ := snc.Marshal(sizeRequest) 90 | rsp, _ := http.Post("http://127.0.0.1:8079/api/1.0/testheader/hello1", "application/json", bytes.NewReader(marshal)) 91 | apiResponse := core.NewApiResponseByReader[string](rsp.Body) 92 | _ = rsp.Body.Close() 93 | assert.Equal(t, fmt.Sprintf("hello world pageSize=%d，pageIndex=%d", sizeRequest.PageSize, sizeRequest.PageIndex), apiResponse.Data) 94 | assert.Equal(t, 200, apiResponse.StatusCode) 95 | assert.Equal(t, 200, rsp.StatusCode) 96 | assert.Equal(t, "true", rsp.Header.Get("Executing")) 97 | assert.Equal(t, "true", rsp.Header.Get("Executed")) 98 | assert.Equal(t, "true", rsp.Header.Get("Set-Header1")) 99 | assert.Equal(t, "", rsp.Header.Get("Set-Header2")) 100 | }) 101 | 102 | t.Run("api/1.0/test/hello1-GET", func(t *testing.T) { 103 | rsp, _ := http.Get("http://127.0.0.1:8079/api/1.0/testheader/hello1") 104 | assert.Equal(t, 405, rsp.StatusCode) 105 | assert.Equal(t, "", rsp.Header.Get("Executing")) 106 | assert.Equal(t, "", rsp.Header.Get("Executed")) 107 | assert.Equal(t, "", rsp.Header.Get("Set-Header1")) 108 | assert.Equal(t, "", rsp.Header.Get("Set-Header2")) 109 | }) 110 | 111 | t.Run("api/1.0/test/hello2-application/json", func(t *testing.T) { 112 | sizeRequest := pageSizeRequest{PageSize: 10, PageIndex: 2} 113 | marshal, _ := snc.Marshal(sizeRequest) 114 | rsp, _ := http.Post("http://127.0.0.1:8079/api/1.0/testheader/hello2", "application/json", bytes.NewReader(marshal)) 115 | apiResponse := core.NewApiResponseByReader[pageSizeRequest](rsp.Body) 116 | _ = rsp.Body.Close() 117 | controller := TestHeaderController{} 118 | assert.Equal(t, controller.Hello2(sizeRequest.PageSize, sizeRequest.PageIndex), apiResponse.Data) 119 | assert.Equal(t, 200, rsp.StatusCode) 120 | assert.Equal(t, 200, apiResponse.StatusCode) 121 | assert.Equal(t, "true", rsp.Header.Get("Executing")) 122 | assert.Equal(t, "true", rsp.Header.Get("Executed")) 123 | assert.Equal(t, "true", rsp.Header.Get("Set-Header1")) 124 | assert.Equal(t, "", rsp.Header.Get("Set-Header2")) 125 | }) 126 | 127 | t.Run("api/1.0/test/hello2-form", func(t *testing.T) { 128 | val := make(url.Values) 129 | val.Add("page_Size", strconv.Itoa(10)) 130 | val.Add("pageIndex", strconv.Itoa(2)) 131 | rsp, _ := http.PostForm("http://127.0.0.1:8079/api/1.0/testheader/hello2", val) 132 | apiResponse := core.NewApiResponseByReader[pageSizeRequest](rsp.Body) 133 | _ = rsp.Body.Close() 134 | controller := TestHeaderController{} 135 | assert.Equal(t, controller.Hello2(10, 2), apiResponse.Data) 136 | assert.Equal(t, 200, rsp.StatusCode) 137 | assert.Equal(t, 200, apiResponse.StatusCode) 138 | assert.Equal(t, "true", rsp.Header.Get("Executing")) 139 | assert.Equal(t, "true", rsp.Header.Get("Executed")) 140 | assert.Equal(t, "true", rsp.Header.Get("Set-Header1")) 141 | assert.Equal(t, "", rsp.Header.Get("Set-Header2")) 142 | }) 143 | 144 | t.Run("api/1.0/test/hello3", func(t *testing.T) { 145 | rsp, _ := http.Get("http://127.0.0.1:8079/api/1.0/testheader/hello3") 146 | apiResponse := core.NewApiResponseByReader[string](rsp.Body) 147 | _ = rsp.Body.Close() 148 | assert.Equal(t, "", apiResponse.Data) 149 | assert.Equal(t, 200, apiResponse.StatusCode) 150 | assert.Equal(t, 200, rsp.StatusCode) 151 | assert.Equal(t, "true", rsp.Header.Get("Executing")) 152 | assert.Equal(t, "true", rsp.Header.Get("Executed")) 153 | assert.Equal(t, "true", rsp.Header.Get("Set-Header1")) 154 | assert.Equal(t, "", rsp.Header.Get("Set-Header2")) 155 | }) 156 | } 157 | -------------------------------------------------------------------------------- /context/regexp.go: -------------------------------------------------------------------------------- 1 | package context 2 | 3 | import ( 4 | "bytes" 5 | "fmt" 6 | "github.com/farseer-go/fs/flog" 7 | "regexp" 8 | "strconv" 9 | "strings" 10 | ) 11 | 12 | type RouteRegexpOptions struct { 13 | StrictSlash bool 14 | UseEncodedPath bool 15 | } 16 | 17 | type RegexpType int 18 | 19 | const ( 20 | RegexpTypePath RegexpType = iota 21 | RegexpTypeHost 22 | RegexpTypePrefix 23 | RegexpTypeQuery 24 | ) 25 | 26 | // 获取默认正则 27 | func (receiver RegexpType) getDefaultPattern() string { 28 | if receiver == RegexpTypeQuery { 29 | return ".*" 30 | } 31 | 32 | if receiver == RegexpTypeHost { 33 | return "[^.]+" 34 | } 35 | 36 | // RegexpTypePath or RegexpTypePrefix 37 | return "[^/]+" 38 | } 39 | 40 | // routeRegexp stores a regexp to match a host or path and information to 41 | // collect and validate route variables. 42 | type routeRegexp struct { 43 | // The unmodified template. 44 | template string 45 | // The type of match 46 | regexpType RegexpType 47 | // Options for matching 48 | options RouteRegexpOptions 49 | // Expanded regexp. 50 | regexp *regexp.Regexp 51 | // Reverse template. 52 | reverse string 53 | // 路径中出现的正则变量名称 54 | varsN []string 55 | // Variable regexps (validators). 56 | varsR []*regexp.Regexp 57 | // Wildcard host-port (no strict port match in hostname) 58 | wildcardHostPort bool 59 | // 使用了正则匹配 60 | UseRegex bool 61 | } 62 | 63 | // NewRouteRegexp 构建支持正则的路由 64 | func NewRouteRegexp(tpl string, typ RegexpType, options RouteRegexpOptions) *routeRegexp { 65 | // 找出占位符位置 66 | placeholderIndexs, errBraces := getPlaceholderIndex(tpl) 67 | if errBraces != nil { 68 | flog.Panic(errBraces) 69 | return nil 70 | } 71 | 72 | // 复制原tpl 73 | template := tpl 74 | // 获取默认正则 75 | defaultPattern := typ.getDefaultPattern() 76 | // 如果不匹配，则只匹配 / 77 | if typ != RegexpTypePath { 78 | options.StrictSlash = false 79 | } 80 | 81 | // 末尾 / 82 | endSlash := false 83 | if options.StrictSlash && strings.HasSuffix(tpl, "/") { 84 | tpl = tpl[:len(tpl)-1] 85 | endSlash = true 86 | } 87 | // 匹配到的变量名称 88 | varsN := make([]string, len(placeholderIndexs)/2) 89 | // 匹配到的对应正则格式 90 | varsR := make([]*regexp.Regexp, len(placeholderIndexs)/2) 91 | // 整个Path的正则 92 | pattern := bytes.NewBufferString("") 93 | pattern.WriteByte('^') 94 | reverse := bytes.NewBufferString("") 95 | var end int 96 | var err error 97 | for i := 0; i < len(placeholderIndexs); i += 2 { 98 | // Set all values we are interested in. 99 | raw := tpl[end:placeholderIndexs[i]] 100 | end = placeholderIndexs[i+1] 101 | parts := strings.SplitN(tpl[placeholderIndexs[i]+1:end-1], ":", 2) 102 | name := parts[0] 103 | patt := defaultPattern 104 | if len(parts) == 2 { 105 | patt = parts[1] 106 | } 107 | // Name or pattern can't be empty. 108 | if name == "" || patt == "" { 109 | flog.Panicf("webapi: missing name or pattern in %q", tpl[placeholderIndexs[i]:end]) 110 | return nil 111 | } 112 | // Build the regexp pattern. 113 | fmt.Fprintf(pattern, "%s(?P<%s>%s)", regexp.QuoteMeta(raw), varGroupName(i/2), patt) 114 | 115 | // Build the reverse template. 116 | fmt.Fprintf(reverse, "%s%%s", raw) 117 | 118 | // Append variable name and compiled pattern. 119 | varsN[i/2] = name 120 | varsR[i/2], err = regexp.Compile(fmt.Sprintf("^%s$", patt)) 121 | if err != nil { 122 | flog.Panic(err) 123 | return nil 124 | } 125 | } 126 | // Add the remaining. 127 | raw := tpl[end:] 128 | pattern.WriteString(regexp.QuoteMeta(raw)) 129 | if options.StrictSlash { 130 | pattern.WriteString("[/]?") 131 | } 132 | if typ == RegexpTypeQuery { 133 | // Add the default pattern if the query value is empty 134 | if queryVal := strings.SplitN(template, "=", 2)[1]; queryVal == "" { 135 | pattern.WriteString(defaultPattern) 136 | } 137 | } 138 | if typ != RegexpTypePrefix { 139 | pattern.WriteByte('$') 140 | } 141 | 142 | var wildcardHostPort bool 143 | if typ == RegexpTypeHost { 144 | if !strings.Contains(pattern.String(), ":") { 145 | wildcardHostPort = true 146 | } 147 | } 148 | reverse.WriteString(raw) 149 | if endSlash { 150 | reverse.WriteByte('/') 151 | } 152 | // Compile full regexp. 153 | reg, errCompile := regexp.Compile(pattern.String()) 154 | if errCompile != nil { 155 | flog.Panic(errCompile) 156 | return nil 157 | } 158 | 159 | // Check for capturing groups which used to work in older versions 160 | if reg.NumSubexp() != len(placeholderIndexs)/2 { 161 | panic(fmt.Sprintf("route %s contains capture groups in its regexp. ", template) + 162 | "Only non-capturing groups are accepted: e.g. (?:pattern) instead of (pattern)") 163 | } 164 | 165 | // Done! 166 | return &routeRegexp{ 167 | template: template, 168 | regexpType: typ, 169 | options: options, 170 | regexp: reg, 171 | reverse: reverse.String(), 172 | varsN: varsN, 173 | varsR: varsR, 174 | wildcardHostPort: wildcardHostPort, 175 | UseRegex: len(varsN) > 0, 176 | } 177 | } 178 | 179 | // 从路由地址中找出{}的位置索引 180 | func getPlaceholderIndex(tpl string) ([]int, error) { 181 | // 当前层级 182 | var level int 183 | // 占位符位置 184 | var idx int 185 | // 多组占位符位置 186 | var idxs []int 187 | for i := 0; i < len(tpl); i++ { 188 | switch tpl[i] { 189 | case '{': 190 | if level++; level == 1 { 191 | idx = i 192 | } 193 | case '}': 194 | if level--; level == 0 { 195 | idxs = append(idxs, idx, i+1) 196 | } else if level < 0 { 197 | return nil, fmt.Errorf("webapi: unbalanced braces in %q", tpl) 198 | } 199 | } 200 | } 201 | // 占位符开头、结束不匹配 202 | if level != 0 { 203 | return nil, fmt.Errorf("webapi: unbalanced braces in %q", tpl) 204 | } 205 | return idxs, nil 206 | } 207 | 208 | // varGroupName builds a capturing group name for the indexed variable. 209 | func varGroupName(idx int) string { 210 | return "v" + strconv.Itoa(idx) 211 | } 212 | 213 | // Match 是否匹配 214 | func (receiver *routeRegexp) Match(path string) (map[string]string, bool) { 215 | if !receiver.regexp.MatchString(path) { 216 | return nil, false 217 | } 218 | 219 | matches := receiver.regexp.FindStringSubmatchIndex(path) 220 | if len(matches) > 0 { 221 | return extractVars(path, matches, receiver.varsN), true 222 | 223 | } 224 | return nil, true 225 | } 226 | 227 | // GetVarNames 返回路径中出现的正则变量名称 228 | func (receiver *routeRegexp) GetVarNames() []string { 229 | return receiver.varsN 230 | } 231 | func extractVars(path string, matches []int, names []string) map[string]string { 232 | output := make(map[string]string) 233 | for i, name := range names { 234 | output[name] = path[matches[2*i+2]:matches[2*i+3]] 235 | } 236 | 237 | return output 238 | } 239 | -------------------------------------------------------------------------------- /test/request_test.go: -------------------------------------------------------------------------------- 1 | package test 2 | 3 | import ( 4 | "bytes" 5 | 6 | "fmt" 7 | "net/http" 8 | "net/url" 9 | "strconv" 10 | "strings" 11 | "testing" 12 | "time" 13 | 14 | "github.com/farseer-go/fs" 15 | "github.com/farseer-go/fs/configure" 16 | "github.com/farseer-go/fs/core" 17 | "github.com/farseer-go/fs/snc" 18 | "github.com/farseer-go/webapi" 19 | "github.com/stretchr/testify/assert" 20 | ) 21 | 22 | type psRequest struct { 23 | PageSize int `json:"Page_size"` 24 | PageIndex int 25 | noExported string //测试不导出字段 26 | CheckResult int 27 | } 28 | 29 | // 测试check 30 | func (receiver *psRequest) Check() { 31 | receiver.CheckResult++ 32 | } 33 | 34 | func TestRequest(t *testing.T) { 35 | fs.Initialize[webapi.Module]("demo") 36 | configure.SetDefault("Log.Component.webapi", true) 37 | 38 | webapi.RegisterPOST("/dto", func(req psRequest) string { 39 | webapi.GetHttpContext().Response.SetMessage(200, "测试成功") 40 | return fmt.Sprintf("hello world pageSize=%d，pageIndex=%d，checkResult=%d", req.PageSize, req.PageIndex, req.CheckResult) 41 | }) 42 | 43 | webapi.RegisterGET("/empty", func() any { 44 | return psRequest{PageSize: 3, PageIndex: 2} 45 | }) 46 | 47 | webapi.RegisterPUT("/multiParam", func(pageSize int, pageIndex int) psRequest { 48 | return psRequest{ 49 | PageSize: pageSize, 50 | PageIndex: pageIndex, 51 | } 52 | }, "page_size", "pageIndex") 53 | 54 | webapi.RegisterPOST("/array", func(ids []int, enable bool) []int { 55 | return ids 56 | }, "ids", "enable") 57 | webapi.UseApiResponse() 58 | go webapi.Run(":8085") 59 | time.Sleep(10 * time.Millisecond) 60 | 61 | t.Run("dto-json", func(t *testing.T) { 62 | sizeRequest := psRequest{PageSize: 10, PageIndex: 2} 63 | marshal, _ := snc.Marshal(sizeRequest) 64 | rsp, _ := http.Post("http://127.0.0.1:8085/dto", "application/json", bytes.NewReader(marshal)) 65 | apiResponse := core.NewApiResponseByReader[string](rsp.Body) 66 | _ = rsp.Body.Close() 67 | 68 | expected := fmt.Sprintf("hello world pageSize=%d，pageIndex=%d，checkResult=1", sizeRequest.PageSize, sizeRequest.PageIndex) 69 | assert.Equal(t, expected, apiResponse.Data) 70 | assert.Equal(t, 200, rsp.StatusCode) 71 | assert.Equal(t, 200, apiResponse.StatusCode) 72 | assert.Equal(t, "测试成功", apiResponse.StatusMessage) 73 | }) 74 | 75 | t.Run("dto-form", func(t *testing.T) { 76 | val := make(url.Values) 77 | val.Add("page_Size", strconv.Itoa(10)) 78 | val.Add("pageIndex", strconv.Itoa(2)) 79 | rsp, _ := http.PostForm("http://127.0.0.1:8085/dto", val) 80 | 81 | apiResponse := core.NewApiResponseByReader[string](rsp.Body) 82 | _ = rsp.Body.Close() 83 | 84 | expected := fmt.Sprintf("hello world pageSize=%d，pageIndex=%d，checkResult=1", 10, 2) 85 | assert.Equal(t, expected, apiResponse.Data) 86 | assert.Equal(t, 200, rsp.StatusCode) 87 | assert.Equal(t, 200, apiResponse.StatusCode) 88 | assert.Equal(t, "测试成功", apiResponse.StatusMessage) 89 | }) 90 | 91 | t.Run("dto-formData", func(t *testing.T) { 92 | val := make(url.Values) 93 | val.Add("page_Size", strconv.Itoa(10)) 94 | val.Add("pageIndex", strconv.Itoa(2)) 95 | req, _ := http.NewRequest("POST", "http://127.0.0.1:8085/dto", strings.NewReader(val.Encode())) 96 | req.Header.Set("Content-Type", "multipart/form-data") 97 | rsp, _ := http.DefaultClient.Do(req) 98 | apiResponse := core.NewApiResponseByReader[string](rsp.Body) 99 | _ = rsp.Body.Close() 100 | 101 | expected := fmt.Sprintf("hello world pageSize=%d，pageIndex=%d，checkResult=1", 10, 2) 102 | assert.Equal(t, expected, apiResponse.Data) 103 | assert.Equal(t, 200, rsp.StatusCode) 104 | assert.Equal(t, 200, apiResponse.StatusCode) 105 | assert.Equal(t, "测试成功", apiResponse.StatusMessage) 106 | }) 107 | 108 | t.Run("empty", func(t *testing.T) { 109 | rsp, _ := http.Get("http://127.0.0.1:8085/empty") 110 | apiResponse := core.NewApiResponseByReader[psRequest](rsp.Body) 111 | _ = rsp.Body.Close() 112 | assert.Equal(t, 3, apiResponse.Data.PageSize) 113 | assert.Equal(t, 2, apiResponse.Data.PageIndex) 114 | assert.Equal(t, 200, rsp.StatusCode) 115 | assert.Equal(t, 200, apiResponse.StatusCode) 116 | }) 117 | 118 | t.Run("multiParam-json", func(t *testing.T) { 119 | sizeRequest := psRequest{PageSize: 10, PageIndex: 2} 120 | marshal, _ := snc.Marshal(sizeRequest) 121 | req, _ := http.NewRequest("PUT", "http://127.0.0.1:8085/multiParam", bytes.NewReader(marshal)) 122 | req.Header.Set("Content-Type", "application/json") 123 | rsp, _ := http.DefaultClient.Do(req) 124 | apiResponse := core.NewApiResponseByReader[psRequest](rsp.Body) 125 | _ = rsp.Body.Close() 126 | assert.Equal(t, psRequest{PageSize: sizeRequest.PageSize, PageIndex: sizeRequest.PageIndex}, apiResponse.Data) 127 | assert.Equal(t, 200, rsp.StatusCode) 128 | assert.Equal(t, 200, apiResponse.StatusCode) 129 | }) 130 | 131 | t.Run("multiParam-form", func(t *testing.T) { 132 | val := make(url.Values) 133 | val.Add("page_Size", strconv.Itoa(10)) 134 | val.Add("pageIndex", strconv.Itoa(2)) 135 | 136 | req, _ := http.NewRequest("PUT", "http://127.0.0.1:8085/multiParam", strings.NewReader(val.Encode())) 137 | req.Header.Set("Content-Type", "application/x-www-form-urlencoded") 138 | rsp, _ := http.DefaultClient.Do(req) 139 | apiResponse := core.NewApiResponseByReader[psRequest](rsp.Body) 140 | _ = rsp.Body.Close() 141 | assert.Equal(t, 10, apiResponse.Data.PageSize) 142 | assert.Equal(t, 2, apiResponse.Data.PageIndex) 143 | assert.Equal(t, 200, rsp.StatusCode) 144 | assert.Equal(t, 200, apiResponse.StatusCode) 145 | }) 146 | 147 | t.Run("multiParam-formData", func(t *testing.T) { 148 | val := make(url.Values) 149 | val.Add("page_Size", strconv.Itoa(10)) 150 | val.Add("pageIndex", strconv.Itoa(2)) 151 | 152 | req, _ := http.NewRequest("PUT", "http://127.0.0.1:8085/multiParam", strings.NewReader(val.Encode())) 153 | req.Header.Set("Content-Type", "multipart/form-data") 154 | rsp, _ := http.DefaultClient.Do(req) 155 | apiResponse := core.NewApiResponseByReader[psRequest](rsp.Body) 156 | _ = rsp.Body.Close() 157 | assert.Equal(t, 10, apiResponse.Data.PageSize) 158 | assert.Equal(t, 2, apiResponse.Data.PageIndex) 159 | assert.Equal(t, 200, rsp.StatusCode) 160 | assert.Equal(t, 200, apiResponse.StatusCode) 161 | }) 162 | 163 | t.Run("ids", func(t *testing.T) { 164 | type array struct { 165 | Ids []int 166 | Enable bool 167 | } 168 | b, _ := snc.Marshal(array{Ids: []int{1, 2, 3}, Enable: true}) 169 | rsp, _ := http.Post("http://127.0.0.1:8085/array", "application/json", bytes.NewReader(b)) 170 | apiResponse := core.NewApiResponseByReader[[]int](rsp.Body) 171 | _ = rsp.Body.Close() 172 | assert.Equal(t, []int{1, 2, 3}, apiResponse.Data) 173 | }) 174 | } 175 | -------------------------------------------------------------------------------- /serveMux.go: -------------------------------------------------------------------------------- 1 | package webapi 2 | 3 | import ( 4 | "net" 5 | "net/http" 6 | "net/url" 7 | "path" 8 | "sort" 9 | "strings" 10 | "sync" 11 | 12 | "github.com/farseer-go/collections" 13 | "github.com/farseer-go/fs/flog" 14 | "github.com/farseer-go/webapi/context" 15 | "github.com/farseer-go/webapi/middleware" 16 | "github.com/farseer-go/webapi/websocket" 17 | ) 18 | 19 | type serveMux struct { 20 | mu sync.RWMutex // lock 21 | m map[string]*context.HttpRoute // 完全地址匹配 22 | es []*context.HttpRoute // 前缀匹配 23 | hosts bool // whether any patterns contain hostnames 24 | regexpRoute []*context.HttpRoute // 正则匹配的路由 25 | } 26 | 27 | func (mux *serveMux) checkHandle(pattern string, handler http.Handler) { 28 | if pattern == "" { 29 | panic("webapi: invalid pattern") 30 | } 31 | if _, exist := mux.m[pattern]; exist { 32 | panic("webapi: multiple registrations for " + pattern) 33 | } 34 | 35 | if handler == nil { 36 | panic("webapi: nil handler") 37 | } 38 | 39 | if mux.m == nil { 40 | mux.m = make(map[string]*context.HttpRoute) 41 | } 42 | } 43 | 44 | // HandleRoute 注册路由 45 | func (mux *serveMux) HandleRoute(route *context.HttpRoute) { 46 | mux.mu.Lock() 47 | defer mux.mu.Unlock() 48 | 49 | if route.Method.Count() == 0 { 50 | route.Method = collections.NewList("GET") 51 | } 52 | 53 | // 正则路径匹配（如果有） 54 | route.RouteRegexp = context.NewRouteRegexp(route.RouteUrl, context.RegexpTypePath, context.RouteRegexpOptions{ 55 | StrictSlash: false, 56 | UseEncodedPath: false, 57 | }) 58 | 59 | // websocket 60 | if route.Schema == "ws" { 61 | route.Handler = websocket.SocketHandler(route) 62 | } else { // http 63 | route.Handler = HttpHandler(route) 64 | } 65 | 66 | // 检查规则 67 | mux.checkHandle(route.RouteUrl, route.Handler) 68 | 69 | // 完全地址匹配的路由 70 | mux.m[route.RouteUrl] = route 71 | 72 | if route.RouteUrl[len(route.RouteUrl)-1] == '/' { 73 | mux.es = appendSorted(mux.es, route) 74 | } 75 | 76 | if route.RouteUrl[0] != '/' { 77 | mux.hosts = true 78 | } 79 | 80 | // 如果使用了正则匹配 81 | if route.RouteRegexp.UseRegex { 82 | mux.regexpRoute = append(mux.regexpRoute, route) 83 | // 如果参数名称没有显示指定时，则自动按顺序指定 84 | if route.ParamNames.Count() == 0 { 85 | varNames := route.RouteRegexp.GetVarNames() 86 | for _, varName := range varNames { 87 | route.ParamNames.Add(varName) 88 | } 89 | } 90 | } 91 | } 92 | 93 | // HandleFunc registers the handler function for the given pattern. 94 | func (mux *serveMux) HandleFunc(pattern string, handler func(http.ResponseWriter, *http.Request)) { 95 | if handler == nil { 96 | panic("webapi: nil handler") 97 | } 98 | mux.Handle(pattern, http.HandlerFunc(handler)) 99 | } 100 | 101 | // Handle 添加一个请求的处理函数 102 | // If a handler already exists for pattern, Handle panics. 103 | func (mux *serveMux) Handle(pattern string, handler http.Handler) { 104 | mux.mu.Lock() 105 | defer mux.mu.Unlock() 106 | 107 | // 检查规则 108 | mux.checkHandle(pattern, handler) 109 | 110 | route := &context.HttpRoute{RouteUrl: pattern, Handler: handler} 111 | mux.m[pattern] = route 112 | 113 | if pattern[len(pattern)-1] == '/' { 114 | mux.es = appendSorted(mux.es, route) 115 | } 116 | 117 | if pattern[0] != '/' { 118 | mux.hosts = true 119 | } 120 | } 121 | 122 | // 当tcp收到发送请求时，会调用此方法 123 | func (mux *serveMux) ServeHTTP(w http.ResponseWriter, r *http.Request) { 124 | if r.RequestURI == "*" { 125 | if r.ProtoAtLeast(1, 1) { 126 | w.Header().Set("Connection", "close") 127 | } 128 | w.WriteHeader(http.StatusBadRequest) 129 | return 130 | } 131 | _ = r.ParseForm() 132 | h := mux.serveHTTPHandler(r) 133 | h.Handler.ServeHTTP(w, r) 134 | } 135 | 136 | func (mux *serveMux) serveHTTPHandler(r *http.Request) (route *context.HttpRoute) { 137 | // CONNECT requests are not canonicalized. 138 | if r.Method == "CONNECT" { 139 | // If r.URL.Path is /tree and its handler is not registered, 140 | // the /tree -> /tree/ redirect applies to CONNECT requests 141 | // but the path canonicalization does not. 142 | if u, ok := mux.redirectToPathSlash(r.URL.Host, r.URL.Path, r.URL); ok { 143 | return &context.HttpRoute{Handler: http.RedirectHandler(u.String(), http.StatusMovedPermanently)} 144 | } 145 | return mux.handler(r.Host, r.URL.Path, r) 146 | } 147 | 148 | // All other requests have any port stripped and path cleaned 149 | // before passing to mux.handler. 150 | host := stripHostPort(r.Host) 151 | path := cleanPath(r.URL.Path) 152 | 153 | // If the given path is /tree and its handler is not registered, 154 | // redirect for /tree/. 155 | if u, ok := mux.redirectToPathSlash(host, path, r.URL); ok { 156 | return &context.HttpRoute{Handler: http.RedirectHandler(u.String(), http.StatusMovedPermanently)} 157 | } 158 | 159 | if path != r.URL.Path { 160 | u := &url.URL{Path: path, RawQuery: r.URL.RawQuery} 161 | return &context.HttpRoute{Handler: http.RedirectHandler(u.String(), http.StatusMovedPermanently)} 162 | } 163 | 164 | return mux.handler(host, r.URL.Path, r) 165 | } 166 | 167 | // handler 找到pattern对应的Handler 168 | func (mux *serveMux) handler(host, path string, r *http.Request) (route *context.HttpRoute) { 169 | mux.mu.RLock() 170 | defer mux.mu.RUnlock() 171 | 172 | // Host-specific pattern takes precedence over generic ones 173 | if mux.hosts { 174 | route = mux.match(host+path, r) 175 | } 176 | if route == nil { 177 | route = mux.match(path, r) 178 | } 179 | if route == nil { 180 | route = &context.HttpRoute{Handler: http.NotFoundHandler()} 181 | flog.Debugf("%s %s%s 404", r.Method, r.Host, path) 182 | } 183 | return 184 | } 185 | 186 | // 找到匹配的路由 187 | func (mux *serveMux) match(path string, req *http.Request) *context.HttpRoute { 188 | // 完全匹配 189 | v, ok := mux.m[path] 190 | if ok { 191 | return v 192 | } 193 | 194 | // 正则匹配 195 | for _, r := range mux.regexpRoute { 196 | match, isMatch := r.RouteRegexp.Match(path) 197 | // 匹配到了 198 | if isMatch { 199 | for n, val := range match { 200 | req.Form.Add(n, val) 201 | } 202 | return r 203 | } 204 | } 205 | 206 | // 前缀匹配 207 | for _, r := range mux.es { 208 | if strings.HasPrefix(path, r.RouteUrl) { 209 | return r 210 | } 211 | } 212 | return nil 213 | } 214 | 215 | // 初始化中间件，统一初始化可以保证应用的路由设计跟中间件设置顺序没有要求 216 | func (mux *serveMux) initMiddleware(lstMiddleware collections.List[context.IMiddleware]) { 217 | middleware.InitMiddleware(mux.m, lstMiddleware) 218 | } 219 | 220 | func (mux *serveMux) redirectToPathSlash(host, path string, u *url.URL) (*url.URL, bool) { 221 | mux.mu.RLock() 222 | shouldRedirect := mux.shouldRedirectRLocked(host, path) 223 | mux.mu.RUnlock() 224 | if !shouldRedirect { 225 | return u, false 226 | } 227 | path = path + "/" 228 | u = &url.URL{Path: path, RawQuery: u.RawQuery} 229 | return u, true 230 | } 231 | 232 | func (mux *serveMux) shouldRedirectRLocked(host, path string) bool { 233 | p := []string{path, host + path} 234 | 235 | for _, c := range p { 236 | if _, exist := mux.m[c]; exist { 237 | return false 238 | } 239 | } 240 | 241 | n := len(path) 242 | if n == 0 { 243 | return false 244 | } 245 | for _, c := range p { 246 | if _, exist := mux.m[c+"/"]; exist { 247 | return path[n-1] != '/' 248 | } 249 | } 250 | 251 | return false 252 | } 253 | 254 | func cleanPath(p string) string { 255 | if p == "" { 256 | return "/" 257 | } 258 | if p[0] != '/' { 259 | p = "/" + p 260 | } 261 | np := path.Clean(p) 262 | // path.Clean removes trailing slash except for root; 263 | // put the trailing slash back if necessary. 264 | if p[len(p)-1] == '/' && np != "/" { 265 | // Fast path for common case of p being the string we want: 266 | if len(p) == len(np)+1 && strings.HasPrefix(p, np) { 267 | np = p 268 | } else { 269 | np += "/" 270 | } 271 | } 272 | return np 273 | } 274 | 275 | // stripHostPort returns h without any trailing ":". 276 | func stripHostPort(h string) string { 277 | // If no port on host, return unchanged 278 | if !strings.Contains(h, ":") { 279 | return h 280 | } 281 | host, _, err := net.SplitHostPort(h) 282 | if err != nil { 283 | return h // on error, return unchanged 284 | } 285 | return host 286 | } 287 | 288 | func appendSorted(es []*context.HttpRoute, e *context.HttpRoute) []*context.HttpRoute { 289 | n := len(es) 290 | i := sort.Search(n, func(i int) bool { 291 | return len(es[i].RouteUrl) < len(e.RouteUrl) 292 | }) 293 | if i == n { 294 | return append(es, e) 295 | } 296 | // we now know that i points at where we want to insert 297 | es = append(es, &context.HttpRoute{}) // try to grow the slice in place, any entry works. 298 | copy(es[i+1:], es[i:]) // Move shorter entries down 299 | es[i] = e 300 | return es 301 | } 302 | 303 | // GetHttpContext 在minimalApi模式下也可以获取到上下文 304 | func GetHttpContext() *context.HttpContext { 305 | return context.RoutineHttpContext.Get() 306 | } 307 | 308 | // GetRealIp 获取真实的ip地址 309 | func GetRealIp() string { 310 | httpCtx := GetHttpContext() 311 | if httpCtx == nil { 312 | return "127.0.0.1" 313 | } 314 | return httpCtx.URI.GetRealIp() 315 | } 316 | -------------------------------------------------------------------------------- /applicationBuilder.go: -------------------------------------------------------------------------------- 1 | package webapi 2 | 3 | import ( 4 | "fmt" 5 | "net/http" 6 | "net/http/pprof" 7 | "strconv" 8 | "strings" 9 | 10 | "github.com/farseer-go/collections" 11 | "github.com/farseer-go/fs/color" 12 | "github.com/farseer-go/fs/configure" 13 | "github.com/farseer-go/fs/container" 14 | "github.com/farseer-go/fs/core" 15 | "github.com/farseer-go/fs/core/eumLogLevel" 16 | "github.com/farseer-go/fs/exception" 17 | "github.com/farseer-go/fs/flog" 18 | "github.com/farseer-go/fs/modules" 19 | "github.com/farseer-go/webapi/context" 20 | "github.com/farseer-go/webapi/controller" 21 | "github.com/farseer-go/webapi/middleware" 22 | "github.com/farseer-go/webapi/minimal" 23 | "github.com/farseer-go/webapi/websocket" 24 | ) 25 | 26 | type applicationBuilder struct { 27 | area string 28 | mux *serveMux 29 | certFile string // https证书 30 | keyFile string // https证书 key 31 | tls bool // 是否使用https 32 | MiddlewareList collections.List[context.IMiddleware] // 注册的中间件 33 | printRoute bool // 打印所有路由信息到控制台 34 | useApiResponse bool // 是否使用了ApiResponse中间件 35 | addr string // 地址 36 | hostAddress string // 完整地址 37 | } 38 | 39 | func NewApplicationBuilder() *applicationBuilder { 40 | return &applicationBuilder{ 41 | area: "/", 42 | mux: new(serveMux), 43 | MiddlewareList: collections.NewList[context.IMiddleware](), 44 | } 45 | } 46 | 47 | func (r *applicationBuilder) RegisterMiddleware(m context.IMiddleware) { 48 | r.MiddlewareList.Add(m) 49 | } 50 | 51 | // RegisterPOST 注册单个Api（支持占位符，例如：/{cateId}/{Id}） 52 | func (r *applicationBuilder) RegisterPOST(route string, actionFunc any, params ...string) { 53 | r.registerAction(Route{Url: route, Method: "POST", Action: actionFunc, Params: params}) 54 | } 55 | 56 | // RegisterGET 注册单个Api（支持占位符，例如：/{cateId}/{Id}） 57 | func (r *applicationBuilder) RegisterGET(route string, actionFunc any, params ...string) { 58 | r.registerAction(Route{Url: route, Method: "GET", Action: actionFunc, Params: params}) 59 | } 60 | 61 | // RegisterPUT 注册单个Api（支持占位符，例如：/{cateId}/{Id}） 62 | func (r *applicationBuilder) RegisterPUT(route string, actionFunc any, params ...string) { 63 | r.registerAction(Route{Url: route, Method: "PUT", Action: actionFunc, Params: params}) 64 | } 65 | 66 | // RegisterDELETE 注册单个Api（支持占位符，例如：/{cateId}/{Id}） 67 | func (r *applicationBuilder) RegisterDELETE(route string, actionFunc any, params ...string) { 68 | r.registerAction(Route{Url: route, Method: "DELETE", Action: actionFunc, Params: params}) 69 | } 70 | 71 | // RegisterWS 注册WebSocket（支持占位符，例如：/{cateId}/{Id}） 72 | func (r *applicationBuilder) RegisterWS(route string, actionFunc any) { 73 | r.registerAction(Route{Url: route, Method: "WS", Action: actionFunc}) 74 | } 75 | 76 | // RegisterRoutes 批量注册路由 77 | func (r *applicationBuilder) RegisterRoutes(routes ...Route) { 78 | for i := 0; i < len(routes); i++ { 79 | if strings.ToUpper(routes[i].Method) == "WS" { 80 | r.registerWS(routes[i]) 81 | } else { 82 | r.registerAction(routes[i]) 83 | } 84 | } 85 | } 86 | 87 | // RegisterController 自动注册控制器下的所有Action方法 88 | func (r *applicationBuilder) RegisterController(c controller.IController) { 89 | lst := controller.Register(r.area, c) 90 | for i := 0; i < lst.Count(); i++ { 91 | r.mux.HandleRoute(lst.Index(i)) 92 | } 93 | } 94 | 95 | // registerAction 注册单个Api 96 | func (r *applicationBuilder) registerAction(route Route) { 97 | // 需要先依赖模块 98 | modules.ThrowIfNotLoad(Module{}) 99 | 100 | route.Url = strings.Trim(route.Url, " ") 101 | route.Url = strings.TrimLeft(route.Url, "/") 102 | if route.Url == "" { 103 | flog.Panicf("注册路由失败：%s必须设置值", color.Colors[eumLogLevel.Error]("routing")) 104 | } 105 | r.mux.HandleRoute(minimal.Register(r.area, route.Method, route.Url, route.Action, route.Filters, route.Params...)) 106 | } 107 | 108 | // registerWS 注册websocket 109 | func (r *applicationBuilder) registerWS(route Route) { 110 | // 需要先依赖模块 111 | modules.ThrowIfNotLoad(Module{}) 112 | 113 | route.Url = strings.Trim(route.Url, " ") 114 | route.Url = strings.TrimLeft(route.Url, "/") 115 | if route.Url == "" { 116 | flog.Panicf("注册websocket路由失败：%s必须设置值", color.Colors[eumLogLevel.Error]("routing")) 117 | } 118 | r.mux.HandleRoute(websocket.Register(r.area, route.Method, route.Url, route.Action, route.Filters, route.Params...)) 119 | } 120 | 121 | // Area 设置区域 122 | func (r *applicationBuilder) Area(area string, f func()) { 123 | if !strings.HasPrefix(area, "/") { 124 | area = "/" + area 125 | } 126 | if !strings.HasSuffix(area, "/") { 127 | area += "/" 128 | } 129 | r.area = area 130 | // 执行注册 131 | f() 132 | // 执行完后，恢复区域为"/" 133 | r.area = "/" 134 | } 135 | 136 | // UseCors 使用CORS中间件 137 | func (r *applicationBuilder) UseCors() { 138 | r.MiddlewareList.Insert(0, &middleware.Cors{}) 139 | } 140 | 141 | // UseStaticFiles 支持静态目录，在根目录./wwwroot中的文件，直接以静态文件提供服务 142 | func (r *applicationBuilder) UseStaticFiles() { 143 | // 默认wwwroot为静态目录 144 | r.mux.Handle("/", http.StripPrefix("/", http.FileServer(http.Dir("./wwwroot")))) 145 | } 146 | 147 | // UsePprof 是否同时开启pprof 148 | func (r *applicationBuilder) UsePprof() { 149 | r.mux.HandleFunc("/debug/pprof/", pprof.Index) 150 | r.mux.HandleFunc("/debug/pprof/cmdline", pprof.Cmdline) 151 | r.mux.HandleFunc("/debug/pprof/profile", pprof.Profile) 152 | r.mux.HandleFunc("/debug/pprof/symbol", pprof.Symbol) 153 | r.mux.HandleFunc("/debug/pprof/trace", pprof.Trace) 154 | } 155 | 156 | // UseSession 开启Session 157 | func (r *applicationBuilder) UseSession() { 158 | if !container.IsRegister[ISessionMiddlewareCreat]() { 159 | panic("要使用Session，请加载模块：session-redis") 160 | } 161 | r.RegisterMiddleware(container.Resolve[ISessionMiddlewareCreat]().Create()) 162 | } 163 | 164 | func (r *applicationBuilder) UseWebApi() { 165 | r.RegisterMiddleware(&middleware.UrlRewriting{}) 166 | } 167 | 168 | // UseApiResponse 支持ApiResponse结构 169 | func (r *applicationBuilder) UseApiResponse() { 170 | r.useApiResponse = true 171 | r.RegisterMiddleware(&middleware.ApiResponse{}) 172 | } 173 | 174 | // UseValidate 使用字段验证器 175 | func (r *applicationBuilder) UseValidate() { 176 | middleware.InitValidate() 177 | r.RegisterMiddleware(&middleware.Validate{}) 178 | } 179 | 180 | // UseTLS 使用https 181 | func (r *applicationBuilder) UseTLS(certFile, keyFile string) { 182 | r.certFile = certFile 183 | r.keyFile = keyFile 184 | r.tls = true 185 | } 186 | 187 | // Run 运行Web服务（默认8888端口） 188 | func (r *applicationBuilder) Run(params ...string) { 189 | // 设置监听地址 190 | if len(params) > 0 { 191 | r.addr = params[0] 192 | } 193 | if r.addr == "" { 194 | r.addr = configure.GetString("WebApi.Url") 195 | if r.addr == "" { 196 | r.addr = ":8888" 197 | } 198 | } 199 | r.addr = strings.TrimSuffix(r.addr, "/") 200 | 201 | // 初始化中间件 202 | r.mux.initMiddleware(r.MiddlewareList) 203 | if r.tls { 204 | r.hostAddress = fmt.Sprintf("https://127.0.0.1%s", r.addr) 205 | } else { 206 | r.hostAddress = fmt.Sprintf("http://127.0.0.1%s", r.addr) 207 | } 208 | 209 | // 打印路由地址 210 | r.print() 211 | 212 | if strings.HasPrefix(r.addr, ":") { 213 | flog.Infof("Web service（%s）is started：%s/", color.Red(core.Version), r.hostAddress) 214 | } 215 | 216 | if apiDoc, exists := r.mux.m["/doc/api"]; exists { 217 | flog.Infof("Api Document is：%s%s", r.hostAddress, apiDoc.RouteUrl) 218 | } 219 | if r.tls { 220 | flog.Info(http.ListenAndServeTLS(r.addr, r.certFile, r.keyFile, r.mux)) 221 | } else { 222 | flog.Info(http.ListenAndServe(r.addr, r.mux)) 223 | } 224 | } 225 | 226 | // 打印路由地址 227 | func (r *applicationBuilder) print() { 228 | if r.printRoute { 229 | lstRoute := collections.NewList[context.HttpRoute]() 230 | for _, httpRoute := range r.mux.m { 231 | if httpRoute.Controller == nil && httpRoute.Action == nil && httpRoute.RouteUrl == "/" && httpRoute.Method.Count() == 0 { 232 | continue 233 | } 234 | lstRoute.Add(*httpRoute) 235 | } 236 | lstRoute.OrderBy(func(item context.HttpRoute) any { 237 | return item.RouteUrl 238 | }).Where(func(item context.HttpRoute) bool { 239 | return item.RouteUrl != "/doc/api" 240 | }).For(func(index int, httpRoute *context.HttpRoute) { 241 | method := strings.Join(httpRoute.Method.ToArray(), "|") 242 | if method == "" { 243 | method = "GET" 244 | } 245 | fmt.Printf("%s：%s %s%s\n", color.Blue(strconv.Itoa(index+1)), color.Red(method), r.hostAddress, httpRoute.RouteUrl) 246 | }) 247 | fmt.Println("---------------------------------------") 248 | } 249 | } 250 | 251 | // PrintRoute 打印所有路由信息到控制台 252 | func (r *applicationBuilder) PrintRoute() { 253 | r.printRoute = true 254 | } 255 | 256 | // UseHealthCheck 【GET】开启健康检查（默认route = "/healthCheck"） 257 | func (r *applicationBuilder) UseHealthCheck(routes ...string) { 258 | if len(routes) == 0 { 259 | routes = []string{"/healthCheck"} 260 | } 261 | for _, route := range routes { 262 | r.RegisterGET(route, func() []string { 263 | healthChecks := container.ResolveAll[core.IHealthCheck]() 264 | lstError := collections.NewList[string]() 265 | lstSuccess := collections.NewList[string]() 266 | for _, healthCheck := range healthChecks { 267 | item, err := healthCheck.Check() 268 | if err == nil { 269 | lstSuccess.Add(item) 270 | } else { 271 | lstError.Add(err.Error()) 272 | } 273 | } 274 | exception.ThrowWebExceptionBool(lstError.Count() > 0, 403, lstError.ToString("，")) 275 | return lstSuccess.ToArray() 276 | }) 277 | } 278 | } 279 | --------------------------------------------------------------------------------