Documentation
¶
Overview ¶
Package enhance 提供类似 Spring Boot 的简洁启动入口
参考 Spring Boot 的 SpringApplication.run() 设计, 提供一行代码启动 Web 服务的能力。
示例(最简用法):
func main() {
enhance.Run()
}
示例(带配置选项):
func main() {
enhance.Run(
boot.WithAppName("my-app"),
boot.WithVersion("1.0.0"),
boot.WithProfiles("dev"),
)
}
示例(带模块):
func main() {
enhance.Run(
boot.WithModulesOption(WebModule, DatabaseModule),
)
}
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var Enhance = &EnhanceApp{}
Enhance 是 enhance 框架的主入口点
提供类似 Spring Boot 的简洁 API,一行代码启动应用。
示例:
func main() {
enhance.Run()
}
Functions ¶
func NewApplication ¶
func NewApplication(opts ...boot.BootOption) (*boot.Boot, error)
NewApplication 创建新的应用实例(不启动)
当你需要更多控制时使用,创建后可以手动调用 Start() 和 Stop()。
示例:
func main() {
app, err := enhance.NewApplication(
boot.WithAppName("my-app"),
)
if err != nil {
log.Fatal(err)
}
app.Start()
// ... 自定义逻辑
app.Stop()
}
func Run ¶
func Run(opts ...boot.BootOption)
Run 包级别的便捷函数,直接启动应用
这是最常用的入口点,一行代码启动整个应用。
示例:
func main() {
enhance.Run()
}
Types ¶
type EnhanceApp ¶
type EnhanceApp struct{}
EnhanceApp 应用启动器
封装 boot.Boot 的所有功能,提供更简洁的 API。
func (*EnhanceApp) Run ¶
func (e *EnhanceApp) Run(opts ...boot.BootOption)
Run 启动应用并等待信号(一行启动)
参考 Spring Boot 的 SpringApplication.run() 方法, 一行代码直接启动应用,自动加载 JSON 配置文件,阻塞直到应用 收到 SIGINT/SIGTERM 信号后自动优雅关闭。
默认行为:
- 自动加载 application.json 配置文件
- 自动执行 AutoConfiguration
- 自动启动所有 Starter
- 阻塞等待 SIGINT/SIGTERM 信号
- 收到信号后自动优雅关闭
示例(最简用法):
func main() {
enhance.Run()
}
示例(带选项):
func main() {
enhance.Run(
boot.WithAppName("my-app"),
boot.WithVersion("1.0.0"),
boot.WithProfiles("dev"),
)
}
示例(带模块):
func main() {
enhance.Run(
boot.WithAppName("my-app"),
boot.WithModulesOption(WebModule, DatabaseModule),
)
}
Directories
¶
| Path | Synopsis |
|---|---|
|
Package actuator 提供应用监控端点 Starter,用于 enhance 框架。
|
Package actuator 提供应用监控端点 Starter,用于 enhance 框架。 |
|
health
Package health 提供健康检查功能,用于 enhance 框架。
|
Package health 提供健康检查功能,用于 enhance 框架。 |
|
Package async 提供异步执行器功能,用于 enhance 框架。
|
Package async 提供异步执行器功能,用于 enhance 框架。 |
|
Package audit 提供审计日志功能,用于 enhance 框架。
|
Package audit 提供审计日志功能,用于 enhance 框架。 |
|
Package boot 提供应用启动器功能,用于 enhance 框架。
|
Package boot 提供应用启动器功能,用于 enhance 框架。 |
|
banner
Package banner 提供启动横幅功能,用于 enhance 框架。
|
Package banner 提供启动横幅功能,用于 enhance 框架。 |
|
failure
Package failure 提供应用启动失败分析功能,用于 enhance 框架。
|
Package failure 提供应用启动失败分析功能,用于 enhance 框架。 |
|
Package cache 提供缓存抽象层,用于 enhance 框架。
|
Package cache 提供缓存抽象层,用于 enhance 框架。 |
|
cmd
|
|
|
audit
command
Package main 提供 enhance 项目的 AI 可读性与可维护性审计工具。
|
Package main 提供 enhance 项目的 AI 可读性与可维护性审计工具。 |
|
demo/auto-configuration
command
Package main 演示 enhance 框架的自动配置机制
|
Package main 演示 enhance 框架的自动配置机制 |
|
demo/cache-local
command
Package main 演示本地缓存的使用
|
Package main 演示本地缓存的使用 |
|
demo/core-ioc
command
|
|
|
demo/event-driven
command
Package main 演示 enhance 框架的事件驱动架构
|
Package main 演示 enhance 框架的事件驱动架构 |
|
demo/lifecycle
command
Package main 演示 enhance 框架的 Bean 生命周期管理
|
Package main 演示 enhance 框架的 Bean 生命周期管理 |
|
demo/parent-child-container
command
Package main 演示 enhance 框架的父子容器功能
|
Package main 演示 enhance 框架的父子容器功能 |
|
demo/resilience
command
|
|
|
demo/scope
command
Package main 演示 enhance 框架的作用域(Scope)功能
|
Package main 演示 enhance 框架的作用域(Scope)功能 |
|
demo/shedule
command
|
|
|
demo/shedule-builder
command
|
|
|
demo/shedule-helper
command
|
|
|
demo/validation
command
|
|
|
demo/web-rest-api
command
Package main 演示如何使用 enhance 框架构建完整的 REST API
|
Package main 演示如何使用 enhance 框架构建完整的 REST API |
|
depscheck
command
Command depscheck detects dependency cycles across go.work modules.
|
Command depscheck detects dependency cycles across go.work modules. |
|
Package condition 提供条件化注册功能,用于 enhance 框架。
|
Package condition 提供条件化注册功能,用于 enhance 框架。 |
|
Package config 提供配置管理功能,用于 enhance 框架。
|
Package config 提供配置管理功能,用于 enhance 框架。 |
|
environment
Package environment 提供环境配置管理功能,用于 enhance 框架。
|
Package environment 提供环境配置管理功能,用于 enhance 框架。 |
|
refresh
Package refresh 提供配置刷新功能,用于 enhance 框架。
|
Package refresh 提供配置刷新功能,用于 enhance 框架。 |
|
root
Package config 提供配置管理功能,作为 config/environment 的上层封装。
|
Package config 提供配置管理功能,作为 config/environment 的上层封装。 |
|
Package context 提供应用上下文管理,用于 enhance 框架。
|
Package context 提供应用上下文管理,用于 enhance 框架。 |
|
Package core 提供了一个类型安全的依赖注入(DI)容器实现,灵感来自 Spring Framework 的 IoC 容器。
|
Package core 提供了一个类型安全的依赖注入(DI)容器实现,灵感来自 Spring Framework 的 IoC 容器。 |
|
binding
Package binding 提供了数据绑定和依赖注入的底层支持。
|
Package binding 提供了数据绑定和依赖注入的底层支持。 |
|
lifecycle
Package lifecycle 定义了 Bean 的生命周期管理接口和实现。
|
Package lifecycle 定义了 Bean 的生命周期管理接口和实现。 |
|
registry
Package registry 提供了 Bean 注册表的内部实现。
|
Package registry 提供了 Bean 注册表的内部实现。 |
|
scope
Package scope 定义了 Bean 的作用域管理接口和实现。
|
Package scope 定义了 Bean 的作用域管理接口和实现。 |
|
Package devtools 提供开发工具支持,用于 enhance 框架。
|
Package devtools 提供开发工具支持,用于 enhance 框架。 |
|
Package email 提供邮件发送功能,用于 enhance 框架。
|
Package email 提供邮件发送功能,用于 enhance 框架。 |
|
Package event 提供应用事件驱动支持,用于 enhance 框架。
|
Package event 提供应用事件驱动支持,用于 enhance 框架。 |
|
examples
|
|
|
enhanced-demo
command
Package main 演示 enhance 框架 P0/P1/P2 优化后的新特性。
|
Package main 演示 enhance 框架 P0/P1/P2 优化后的新特性。 |
|
Package exception 提供异常处理和错误响应功能,用于 enhance 框架。
|
Package exception 提供异常处理和错误响应功能,用于 enhance 框架。 |
|
Package i18n 提供国际化支持,用于 enhance 框架。
|
Package i18n 提供国际化支持,用于 enhance 框架。 |
|
Package lifecycle 提供生命周期管理功能,用于 enhance 框架。
|
Package lifecycle 提供生命周期管理功能,用于 enhance 框架。 |
|
Package log 提供日志管理功能,用于 enhance 框架。
|
Package log 提供日志管理功能,用于 enhance 框架。 |
|
Package metadata 提供元数据管理功能,用于 enhance 框架。
|
Package metadata 提供元数据管理功能,用于 enhance 框架。 |
|
Package metrics 提供指标收集和导出功能,用于 enhance 框架。
|
Package metrics 提供指标收集和导出功能,用于 enhance 框架。 |
|
Package mq 提供消息队列支持,用于 enhance 框架。
|
Package mq 提供消息队列支持,用于 enhance 框架。 |
|
observability
|
|
|
metrics
Package metrics 提供可观测性指标功能,用于 enhance 框架。
|
Package metrics 提供可观测性指标功能,用于 enhance 框架。 |
|
Package openapi 提供 OpenAPI 文档生成功能,用于 enhance 框架。
|
Package openapi 提供 OpenAPI 文档生成功能,用于 enhance 框架。 |
|
Package resilience 提供弹性容错功能,用于 enhance 框架。
|
Package resilience 提供弹性容错功能,用于 enhance 框架。 |
|
Package retry 提供独立的重试机制支持。
|
Package retry 提供独立的重试机制支持。 |
|
Package schedule 提供定时任务调度功能,用于 enhance 框架。
|
Package schedule 提供定时任务调度功能,用于 enhance 框架。 |
|
Package security 提供安全功能支持,用于 enhance 框架。
|
Package security 提供安全功能支持,用于 enhance 框架。 |
|
authentication
Package authentication 提供认证功能支持,用于 enhance 框架。
|
Package authentication 提供认证功能支持,用于 enhance 框架。 |
|
authorization
Package authorization 提供授权功能支持,用于 enhance 框架。
|
Package authorization 提供授权功能支持,用于 enhance 框架。 |
|
filter
Package filter 提供安全过滤器链抽象,用于 enhance 框架。
|
Package filter 提供安全过滤器链抽象,用于 enhance 框架。 |
|
Package spel 提供 Spring Expression Language (SpEL) 表达式支持,用于 enhance 框架。
|
Package spel 提供 Spring Expression Language (SpEL) 表达式支持,用于 enhance 框架。 |
|
starter
|
|
|
casbin
module
|
|
|
casbin-gorm
module
|
|
|
casbin-xorm
module
|
|
|
chi
module
|
|
|
echo
module
|
|
|
fiber
module
|
|
|
gin
module
|
|
|
gorm
module
|
|
|
jwt
module
|
|
|
kafka
module
|
|
|
otel
module
|
|
|
redis
module
|
|
|
xorm
module
|
|
|
zap
module
|
|
|
zerolog
module
|
|
|
Package tenant 提供多租户支持,用于 enhance 框架。
|
Package tenant 提供多租户支持,用于 enhance 框架。 |
|
Package testing 提供测试工具支持,用于 enhance 框架。
|
Package testing 提供测试工具支持,用于 enhance 框架。 |
|
Package tracing 提供分布式链路追踪自动配置。
|
Package tracing 提供分布式链路追踪自动配置。 |
|
Package validation 提供参数校验功能,用于 enhance 框架。
|
Package validation 提供参数校验功能,用于 enhance 框架。 |
|
Package web 提供 Web 框架支持,用于 enhance 框架。
|
Package web 提供 Web 框架支持,用于 enhance 框架。 |
|
binding
Package binding 提供 HTTP 参数绑定功能。
|
Package binding 提供 HTTP 参数绑定功能。 |
|
core
Package core 提供 Web 框架核心接口定义。
|
Package core 提供 Web 框架核心接口定义。 |
|
engine
Package engine 提供网络引擎工厂和注册表。
|
Package engine 提供网络引擎工厂和注册表。 |
|
engine/stdlib
Package stdlib 提供基于标准库 net/http 的引擎实现。
|
Package stdlib 提供基于标准库 net/http 的引擎实现。 |
|
middleware
Package middleware 提供 HTTP 中间件实现。
|
Package middleware 提供 HTTP 中间件实现。 |
|
mvc
Package mvc 提供 MVC 控制器支持。
|
Package mvc 提供 MVC 控制器支持。 |
|
server
Package server 提供 HTTP 服务器和客户端实现。
|
Package server 提供 HTTP 服务器和客户端实现。 |
|
tls
Package tls 提供 TLS 证书管理和加密工具,用于 enhance 框架。
|
Package tls 提供 TLS 证书管理和加密工具,用于 enhance 框架。 |
|
Package webtest 提供 Web 测试工具,用于 enhance 框架。
|
Package webtest 提供 Web 测试工具,用于 enhance 框架。 |
Click to show internal directories.
Click to hide internal directories.