apps

package

v1.0.2 Latest Latest Go to latest Published: Jun 12, 2025 License: Apache-2.0 Imports: 18 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

gitee.com/captials-team/ubdframe

Links

Open Source Insights

README ¶

App说明

app是用于快速构建整体应用而分割的各类app独立模块

可独立使用或可作为插件使用，也可只使用其部分功能或能力

UserApp

提供用户相关的基础功能

见文档

AdminApp

提供后台管理站用户相关的基础功能

见文档

WebApp

支持web渲染功能，代理转发功能

见文档

通用说明

Swagger-API文档生成

各应用下相应存在 gen_docs.sh 脚本，用于生成各个app的api文档

若无该脚本则说明该app无api应用，如web应用

Documentation ¶

Index ¶

type ApiServer
- func NewApiServer(engine *gin.Engine, conf configstc.ServerConfig) *ApiServer
type App
- func NewApp(di *dig.Container, name string) *App
type AppManager
- func NewAppManager(di *dig.Container, logger v1log.ILog) *AppManager

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type ApiServer ¶

type ApiServer struct {
	// contains filtered or unexported fields
}

func NewApiServer ¶

func NewApiServer(engine *gin.Engine, conf configstc.ServerConfig) *ApiServer

func (*ApiServer) Engine ¶

func (s *ApiServer) Engine() *gin.Engine

func (*ApiServer) InitRouterForServer ¶

func (s *ApiServer) InitRouterForServer(a ...interfaces.ItfGinApiServer)

InitRouterForServer 注册路由

func (*ApiServer) Module ¶ added in v1.0.2

func (s *ApiServer) Module() bool

func (*ApiServer) Name ¶

func (s *ApiServer) Name() string

func (*ApiServer) Server ¶ added in v1.0.2

func (s *ApiServer) Server() *http.Server

func (*ApiServer) Start ¶

func (s *ApiServer) Start() error

func (*ApiServer) Stop ¶

func (s *ApiServer) Stop() error

func (*ApiServer) WithCors ¶ added in v1.0.2

func (s *ApiServer) WithCors(configs ...cors.Config)

WithCors 设置跨域

func (*ApiServer) WithModule ¶

func (s *ApiServer) WithModule(t bool)

func (*ApiServer) WithName ¶

func (s *ApiServer) WithName(name string)

type App ¶

type App struct {
	// contains filtered or unexported fields
}

func NewApp ¶

func NewApp(di *dig.Container, name string) *App

func (*App) Name ¶

func (app *App) Name() string

func (*App) Start ¶

func (app *App) Start() error

func (*App) Stop ¶

func (app *App) Stop() error

func (*App) WithApiServer ¶

func (app *App) WithApiServer(s interfaces.ItfApiServer) *App

WithApiServer 指定apiServer

func (*App) WithModule ¶

func (app *App) WithModule(t bool) *App

WithModule 是否以模块处理

func (*App) WithName ¶

func (app *App) WithName(name string) *App

func (*App) WithServer ¶ added in v1.0.2

func (app *App) WithServer(s interfaces.ItfApiServer) *App

WithServer 指定任意Server

func (*App) WithWorker ¶

func (app *App) WithWorker(s interfaces.ItfWorker) *App

WithWorker 指定worker

type AppManager ¶

type AppManager struct {
	// contains filtered or unexported fields
}

func NewAppManager ¶

func NewAppManager(di *dig.Container, logger v1log.ILog) *AppManager

func (*AppManager) Start ¶

func (mgr *AppManager) Start() error

Start 启动，启动所有application，会阻塞直到有退出问题

func (*AppManager) Stop ¶

func (mgr *AppManager) Stop() error

func (*AppManager) WithApp ¶

func (mgr *AppManager) WithApp(app interfaces.ItfApp)

func (*AppManager) WithSignalExit ¶

func (mgr *AppManager) WithSignalExit(signs ...os.Signal)

WithSignalExit 收到系统信号后退出所有app

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
adminapp @externalDocs.description OpenAPI @externalDocs.url https://swagger.io/resources/open-api/	@externalDocs.description OpenAPI @externalDocs.url https://swagger.io/resources/open-api/
controllers/http
docs Package docs Code generated by swaggo/swag.	Package docs Code generated by swaggo/swag.
basedataapp @externalDocs.description OpenAPI @externalDocs.url https://swagger.io/resources/open-api/	@externalDocs.description OpenAPI @externalDocs.url https://swagger.io/resources/open-api/
controllers/grpc
controllers/http
docs Package docs Code generated by swaggo/swag.	Package docs Code generated by swaggo/swag.
blockapp @externalDocs.description OpenAPI @externalDocs.url https://swagger.io/resources/open-api/	@externalDocs.description OpenAPI @externalDocs.url https://swagger.io/resources/open-api/
controllers/http
docs Package docs Code generated by swaggo/swag.	Package docs Code generated by swaggo/swag.
iotapp @externalDocs.description OpenAPI @externalDocs.url https://swagger.io/resources/open-api/	@externalDocs.description OpenAPI @externalDocs.url https://swagger.io/resources/open-api/
controllers/http
docs Package docs Code generated by swaggo/swag.	Package docs Code generated by swaggo/swag.
jobapp @externalDocs.description OpenAPI @externalDocs.url https://swagger.io/resources/open-api/	@externalDocs.description OpenAPI @externalDocs.url https://swagger.io/resources/open-api/
controllers/http
docs Package docs Code generated by swaggo/swag.	Package docs Code generated by swaggo/swag.
workers
ossapp @externalDocs.description OpenAPI @externalDocs.url https://swagger.io/resources/open-api/	@externalDocs.description OpenAPI @externalDocs.url https://swagger.io/resources/open-api/
controllers/http
docs Package docs Code generated by swaggo/swag.	Package docs Code generated by swaggo/swag.
settingapp @externalDocs.description OpenAPI @externalDocs.url https://swagger.io/resources/open-api/	@externalDocs.description OpenAPI @externalDocs.url https://swagger.io/resources/open-api/
controllers/http
docs Package docs Code generated by swaggo/swag.	Package docs Code generated by swaggo/swag.
userapp @externalDocs.description OpenAPI @externalDocs.url https://swagger.io/resources/open-api/	@externalDocs.description OpenAPI @externalDocs.url https://swagger.io/resources/open-api/
controllers/grpc
controllers/http
docs Package docs Code generated by swaggo/swag.	Package docs Code generated by swaggo/swag.
webapp @externalDocs.description OpenAPI @externalDocs.url https://swagger.io/resources/open-api/	@externalDocs.description OpenAPI @externalDocs.url https://swagger.io/resources/open-api/
wssapp
workers

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL