app

Documentation

Index

• type Application
  • func NewApplication(options []fx.Option, config *viper.Viper, log *zap.Logger) *Application
  • func (a *Application) AppendContainer(opts ...fx.Option)
  • func (a *Application) Config() *viper.Viper
  • func (a *Application) Container() []fx.Option
  • func (a *Application) FxApp(app *fx.App) *fx.App
  • func (a *Application) Logger() *zap.Logger
  • func (a *Application) Metrics() Metrics
  • func (a *Application) Run(params ...string)
• type ApplicationBuilder
  • func NewBuilder() *ApplicationBuilder
  • func (b *ApplicationBuilder) AddBackgroundService(ctor any) *ApplicationBuilder
  • func (b *ApplicationBuilder) AddConfig(fn func(options *config.Options)) *ApplicationBuilder
  • func (b *ApplicationBuilder) AddServices(opts ...fx.Option) *ApplicationBuilder
  • func (b *ApplicationBuilder) Build() *Application
  • func (b *ApplicationBuilder) Config() *viper.Viper
  • func (b *ApplicationBuilder) ConfigureOptions(provider any) *ApplicationBuilder
• type BackgroundService
• type Config
• type DefaultMetrics
  • func (m *DefaultMetrics) GetCounter(key string) int64
  • func (m *DefaultMetrics) Increment(key string)
• type Metrics

Types

type Application

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

Application 应用

func NewApplication

func NewApplication(options []fx.Option, config *viper.Viper, log *zap.Logger) *Application

NewApplication 创建一个应用

func (*Application) AppendContainer

func (a *Application) AppendContainer(opts ...fx.Option)

func (*Application) Config

func (a *Application) Config() *viper.Viper

Config 获取配置实例

func (*Application) Container

func (a *Application) Container() []fx.Option

func (*Application) FxApp

func (a *Application) FxApp(app *fx.App) *fx.App

func (*Application) Logger

func (a *Application) Logger() *zap.Logger

Logger 获取日志实例

func (*Application) Metrics

func (a *Application) Metrics() Metrics

Metrics 获取指标实例

func (*Application) Run

func (a *Application) Run(params ...string)

Run 运行应用

type ApplicationBuilder

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

ApplicationBuilder 应用构建器

func NewBuilder

func NewBuilder() *ApplicationBuilder

NewBuilder 创建一个新的应用构建器

func (*ApplicationBuilder) AddBackgroundService

func (b *ApplicationBuilder) AddBackgroundService(ctor any) *ApplicationBuilder

AddBackgroundService 添加后台服务

func (*ApplicationBuilder) AddConfig

func (b *ApplicationBuilder) AddConfig(fn func(options *config.Options)) *ApplicationBuilder

AddConfig 用户加载配置文件、环境变量、命令行参数。 配置添加后即生效,priority: 命令行 > 环境变量 > 配置文件

func (*ApplicationBuilder) AddServices

func (b *ApplicationBuilder) AddServices(opts ...fx.Option) *ApplicationBuilder

AddServices 服务注册

func (*ApplicationBuilder) Build

func (b *ApplicationBuilder) Build() *Application

Build 构建应用实例

func (*ApplicationBuilder) Config

func (b *ApplicationBuilder) Config() *viper.Viper

Config 返回配置实例,配置阶段也可读取配置

func (*ApplicationBuilder) ConfigureOptions

func (b *ApplicationBuilder) ConfigureOptions(provider any) *ApplicationBuilder

ConfigureOptions 配置选项(暂未实现)

type BackgroundService

type BackgroundService interface {
	Start(ctx context.Context) error
	Stop(ctx context.Context) error
}

BackgroundService 定义后台任务标准接口

type Config

type Config struct {
	Level      string // 日志级别 debug, info, warn, error
	Filename   string // 日志文件路径
	MaxSize    int    // 每个日志文件最大尺寸,单位MB
	MaxBackups int    // 保留的旧日志文件最大数量
	MaxAge     int    // 保留的旧日志文件最大天数
	Compress   bool   // 是否压缩旧日志文件
	Console    bool   // 是否输出到控制台
}

Config 日志配置

type DefaultMetrics

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

func (*DefaultMetrics) GetCounter

func (m *DefaultMetrics) GetCounter(key string) int64

GetCounter 获取当前计数器值

func (*DefaultMetrics) Increment

func (m *DefaultMetrics) Increment(key string)

Increment 计数器+1

type Metrics

type Metrics interface {
	Increment(key string)
	GetCounter(key string) int64
}

Metrics 定义了计数器行为接口