applicationBuilder.go

package webapi

import (
	"fmt"
	"net/http"
	"net/http/pprof"
	"strconv"
	"strings"

	"github.com/farseer-go/collections"
	"github.com/farseer-go/fs/configure"
	"github.com/farseer-go/fs/container"
	"github.com/farseer-go/fs/core"
	"github.com/farseer-go/fs/core/eumLogLevel"
	"github.com/farseer-go/fs/exception"
	"github.com/farseer-go/fs/flog"
	"github.com/farseer-go/fs/modules"
	"github.com/farseer-go/webapi/context"
	"github.com/farseer-go/webapi/controller"
	"github.com/farseer-go/webapi/middleware"
	"github.com/farseer-go/webapi/minimal"
	"github.com/farseer-go/webapi/websocket"
)

type applicationBuilder struct {
	area           string
	mux            *serveMux
	certFile       string                                // https证书
	keyFile        string                                // https证书 key
	tls            bool                                  // 是否使用https
	MiddlewareList collections.List[context.IMiddleware] // 注册的中间件
	printRoute     bool                                  // 打印所有路由信息到控制台
	useApiResponse bool                                  // 是否使用了ApiResponse中间件
	addr           string                                // 地址
	hostAddress    string                                // 完整地址
}

func NewApplicationBuilder() *applicationBuilder {
	return &applicationBuilder{
		area:           "/",
		mux:            new(serveMux),
		MiddlewareList: collections.NewList[context.IMiddleware](),
	}
}

func (r *applicationBuilder) RegisterMiddleware(m context.IMiddleware) {
	r.MiddlewareList.Add(m)
}

// RegisterPOST 注册单个Api（支持占位符，例如：/{cateId}/{Id}）
func (r *applicationBuilder) RegisterPOST(route string, actionFunc any, params ...string) {
	r.registerAction(Route{Url: route, Method: "POST", Action: actionFunc, Params: params})
}

// RegisterGET 注册单个Api（支持占位符，例如：/{cateId}/{Id}）
func (r *applicationBuilder) RegisterGET(route string, actionFunc any, params ...string) {
	r.registerAction(Route{Url: route, Method: "GET", Action: actionFunc, Params: params})
}

// RegisterPUT 注册单个Api（支持占位符，例如：/{cateId}/{Id}）
func (r *applicationBuilder) RegisterPUT(route string, actionFunc any, params ...string) {
	r.registerAction(Route{Url: route, Method: "PUT", Action: actionFunc, Params: params})
}

// RegisterDELETE 注册单个Api（支持占位符，例如：/{cateId}/{Id}）
func (r *applicationBuilder) RegisterDELETE(route string, actionFunc any, params ...string) {
	r.registerAction(Route{Url: route, Method: "DELETE", Action: actionFunc, Params: params})
}

// RegisterWS 注册WebSocket（支持占位符，例如：/{cateId}/{Id}）
func (r *applicationBuilder) RegisterWS(route string, actionFunc any) {
	r.registerAction(Route{Url: route, Method: "WS", Action: actionFunc})
}

// RegisterRoutes 批量注册路由
func (r *applicationBuilder) RegisterRoutes(routes ...Route) {
	for i := 0; i < len(routes); i++ {
		if strings.ToUpper(routes[i].Method) == "WS" {
			r.registerWS(routes[i])
		} else {
			r.registerAction(routes[i])
		}
	}
}

// RegisterController 自动注册控制器下的所有Action方法
func (r *applicationBuilder) RegisterController(c controller.IController) {
	lst := controller.Register(r.area, c)
	for i := 0; i < lst.Count(); i++ {
		r.mux.HandleRoute(lst.Index(i))
	}
}

// registerAction 注册单个Api
func (r *applicationBuilder) registerAction(route Route) {
	// 需要先依赖模块
	modules.ThrowIfNotLoad(Module{})

	route.Url = strings.Trim(route.Url, " ")
	route.Url = strings.TrimLeft(route.Url, "/")
	if route.Url == "" {
		flog.Panicf("注册路由失败：%s必须设置值", flog.Colors[eumLogLevel.Error]("routing"))
	}
	r.mux.HandleRoute(minimal.Register(r.area, route.Method, route.Url, route.Action, route.Filters, route.Params...))
}

// registerWS 注册websocket
func (r *applicationBuilder) registerWS(route Route) {
	// 需要先依赖模块
	modules.ThrowIfNotLoad(Module{})

	route.Url = strings.Trim(route.Url, " ")
	route.Url = strings.TrimLeft(route.Url, "/")
	if route.Url == "" {
		flog.Panicf("注册websocket路由失败：%s必须设置值", flog.Colors[eumLogLevel.Error]("routing"))
	}
	r.mux.HandleRoute(websocket.Register(r.area, route.Method, route.Url, route.Action, route.Filters, route.Params...))
}

// Area 设置区域
func (r *applicationBuilder) Area(area string, f func()) {
	if !strings.HasPrefix(area, "/") {
		area = "/" + area
	}
	if !strings.HasSuffix(area, "/") {
		area += "/"
	}
	r.area = area
	// 执行注册
	f()
	// 执行完后，恢复区域为"/"
	r.area = "/"
}

// UseCors 使用CORS中间件
func (r *applicationBuilder) UseCors() {
	r.MiddlewareList.Insert(0, &middleware.Cors{})
}

// UseStaticFiles 支持静态目录，在根目录./wwwroot中的文件，直接以静态文件提供服务
func (r *applicationBuilder) UseStaticFiles() {
	// 默认wwwroot为静态目录
	r.mux.Handle("/", http.StripPrefix("/", http.FileServer(http.Dir("./wwwroot"))))
}

// UsePprof 是否同时开启pprof
func (r *applicationBuilder) UsePprof() {
	r.mux.HandleFunc("/debug/pprof/", pprof.Index)
	r.mux.HandleFunc("/debug/pprof/cmdline", pprof.Cmdline)
	r.mux.HandleFunc("/debug/pprof/profile", pprof.Profile)
	r.mux.HandleFunc("/debug/pprof/symbol", pprof.Symbol)
	r.mux.HandleFunc("/debug/pprof/trace", pprof.Trace)
}

// UseSession 开启Session
func (r *applicationBuilder) UseSession() {
	if !container.IsRegister[ISessionMiddlewareCreat]() {
		panic("要使用Session，请加载模块：session-redis")
	}
	r.RegisterMiddleware(container.Resolve[ISessionMiddlewareCreat]().Create())
}

func (r *applicationBuilder) UseWebApi() {
	r.RegisterMiddleware(&middleware.UrlRewriting{})
}

// UseApiResponse 支持ApiResponse结构
func (r *applicationBuilder) UseApiResponse() {
	r.useApiResponse = true
	r.RegisterMiddleware(&middleware.ApiResponse{})
}

// UseValidate 使用字段验证器
func (r *applicationBuilder) UseValidate() {
	middleware.InitValidate()
	r.RegisterMiddleware(&middleware.Validate{})
}

// UseTLS 使用https
func (r *applicationBuilder) UseTLS(certFile, keyFile string) {
	r.certFile = certFile
	r.keyFile = keyFile
	r.tls = true
}

// Run 运行Web服务（默认8888端口）
func (r *applicationBuilder) Run(params ...string) {
	// 设置监听地址
	if len(params) > 0 {
		r.addr = params[0]
	}
	if r.addr == "" {
		r.addr = configure.GetString("WebApi.Url")
		if r.addr == "" {
			r.addr = ":8888"
		}
	}
	r.addr = strings.TrimSuffix(r.addr, "/")

	// 初始化中间件
	r.mux.initMiddleware(r.MiddlewareList)
	if r.tls {
		r.hostAddress = fmt.Sprintf("https://127.0.0.1%s", r.addr)
	} else {
		r.hostAddress = fmt.Sprintf("http://127.0.0.1%s", r.addr)
	}

	// 打印路由地址
	r.print()

	if strings.HasPrefix(r.addr, ":") {
		flog.Infof("Web service is started：%s/", r.hostAddress)
	}

	if apiDoc, exists := r.mux.m["/doc/api"]; exists {
		flog.Infof("Api Document is：%s%s", r.hostAddress, apiDoc.RouteUrl)
	}
	if r.tls {
		flog.Info(http.ListenAndServeTLS(r.addr, r.certFile, r.keyFile, r.mux))
	} else {
		flog.Info(http.ListenAndServe(r.addr, r.mux))
	}
}

// 打印路由地址
func (r *applicationBuilder) print() {
	if r.printRoute {
		lstRoute := collections.NewList[context.HttpRoute]()
		for _, httpRoute := range r.mux.m {
			if httpRoute.Controller == nil && httpRoute.Action == nil && httpRoute.RouteUrl == "/" && httpRoute.Method.Count() == 0 {
				continue
			}
			lstRoute.Add(*httpRoute)
		}
		lstRoute.OrderBy(func(item context.HttpRoute) any {
			return item.RouteUrl
		}).Where(func(item context.HttpRoute) bool {
			return item.RouteUrl != "/doc/api"
		}).For(func(index int, httpRoute *context.HttpRoute) {
			method := strings.Join(httpRoute.Method.ToArray(), "|")
			if method == "" {
				method = "GET"
			}
			fmt.Printf("%s：%s %s%s\n", flog.Blue(strconv.Itoa(index+1)), flog.Red(method), r.hostAddress, httpRoute.RouteUrl)
		})
		fmt.Println("---------------------------------------")
	}
}

// PrintRoute 打印所有路由信息到控制台
func (r *applicationBuilder) PrintRoute() {
	r.printRoute = true
}

// UseHealthCheck 【GET】开启健康检查（默认route = "/healthCheck"）
func (r *applicationBuilder) UseHealthCheck(routes ...string) {
	if len(routes) == 0 {
		routes = []string{"/healthCheck"}
	}
	for _, route := range routes {
		r.RegisterGET(route, func() []string {
			healthChecks := container.ResolveAll[core.IHealthCheck]()
			lstError := collections.NewList[string]()
			lstSuccess := collections.NewList[string]()
			for _, healthCheck := range healthChecks {
				item, err := healthCheck.Check()
				if err == nil {
					lstSuccess.Add(item)
				} else {
					lstError.Add(err.Error())
				}
			}
			exception.ThrowWebExceptionBool(lstError.Count() > 0, 403, lstError.ToString("，"))
			return lstSuccess.ToArray()
		})
	}
}