Uber FX 开源项目教程

Uber FX 开源项目教程

项目地址:https://gitcode.com/gh_mirrors/fx1/fx

1. 项目的目录结构及介绍

Uber FX 项目的目录结构如下：

fx/
├── app/
│   ├── app.go
│   └── options.go
├── fx.go
├── fx_test.go
├── go.mod
├── go.sum
├── LICENSE
├── README.md
└── examples/
    ├── basic/
    │   └── main.go
    ├── custom-lifecycle/
    │   └── main.go
    ├── named-values/
    │   └── main.go
    ├── optional-dependencies/
    │   └── main.go
    ├── provided-by/
    │   └── main.go
    ├── simple/
    │   └── main.go
    └── tagged/
        └── main.go

目录结构介绍

• app/: 包含应用程序的核心逻辑和选项配置。
  • app.go: 定义了应用程序的主要结构和功能。
  • options.go: 包含应用程序的配置选项。
• fx.go: 项目的主文件，定义了 FX 库的核心功能。
• fx_test.go: 包含项目的单元测试。
• go.mod 和 go.sum: Go 模块文件，用于管理项目的依赖。
• LICENSE: 项目的许可证文件。
• README.md: 项目的说明文档。
• examples/: 包含多个示例项目，展示了 FX 库的不同使用场景。

2. 项目的启动文件介绍

项目的启动文件主要是 fx.go，它定义了 FX 库的核心功能和启动逻辑。以下是 fx.go 文件的关键部分：

package fx

import (
	"context"
	"fmt"
	"os"
	"os/signal"
	"syscall"

	"go.uber.org/fx/fxevent"
	"go.uber.org/zap"
)

// App is the main structure of a FX application.
type App struct {
	lifecycle Lifecycle
	logger    *zap.Logger
}

// NewApp creates a new FX application.
func NewApp(options ...Option) *App {
	app := &App{
		logger: zap.NewExample(),
	}
	for _, opt := range options {
		opt(app)
	}
	return app
}

// Run starts the application.
func (app *App) Run() {
	ctx, cancel := context.WithCancel(context.Background())
	defer cancel()

	app.logger.Info("Starting application.")
	app.lifecycle.Start(ctx)

	ch := make(chan os.Signal, 1)
	signal.Notify(ch, syscall.SIGINT, syscall.SIGTERM)
	<-ch

	app.logger.Info("Stopping application.")
	app.lifecycle.Stop(ctx)
}

启动文件介绍

• NewApp 函数用于创建一个新的 FX 应用程序实例。
• Run 方法启动应用程序，并在接收到终止信号时停止应用程序。
• lifecycle 用于管理应用程序的生命周期事件。

3. 项目的配置文件介绍

Uber FX 项目没有明确的配置文件，但可以通过 options.go 文件中的选项来配置应用程序。以下是 options.go 文件的关键部分：

package app

import (
	"go.uber.org/fx"
	"go.uber.org/zap"
)

// Option is a function that configures the application.
type Option func(*App)

// WithLogger sets the logger for the application.
func WithLogger(logger *zap.Logger) Option {
	return func(app *App) {
		app.logger = logger
	}
}

// WithLifecycle sets the lifecycle for the application.
func WithLifecycle(lc fx.Lifecycle) Option {
	return func(app *App) {
		app.lifecycle = lc
	}
}

配置文件介绍

• Option 类型定义了配置应用程序的函数。
• WithLogger 和 WithLifecycle 函数用于设置应用程序的日志记录器和生命周期管理器。

通过这些选项，可以在创建应用程序实例时进行灵活的配置。

fx A dependency injection based application framework for Go. 项目地址: https://gitcode.com/gh_mirrors/fx1/fx