Yokai框架简介与使用指南

Yokai是一个轻量级的Go语言模块化后端应用框架，专注于可观测性和插件化架构。它提供了开箱即用的日志、指标、链路追踪等可观测性功能，同时支持通过插件机制扩展功能。

核心特性

1. 模块化设计：通过插件机制灵活扩展功能
2. 内置可观测性：集成日志、指标、分布式追踪
3. 配置管理：支持多种配置源和环境变量
4. 依赖注入：简化组件管理
5. 中间件支持：HTTP和gRPC中间件

基础使用示例

安装

go get github.com/yokaiio/yokai

最小应用示例

package main

import (
	"context"
	"github.com/yokaiio/yokai/core"
	"github.com/yokaiio/yokai/fxcore"
	"go.uber.org/fx"
)

func main() {
	app := fxcore.New(
		core.Module,
		fx.Invoke(func(lifecycle fx.Lifecycle) {
			lifecycle.Append(fx.Hook{
				OnStart: func(ctx context.Context) error {
					println("Application started")
					return nil
				},
				OnStop: func(ctx context.Context) error {
					println("Application stopped")
					return nil
				},
			})
		}),
	)

	app.Run()
}

可观测性集成

日志配置

package main

import (
	"github.com/yokaiio/yokai/core"
	"github.com/yokaiio/yokai/fxcore"
	"github.com/yokaiio/yokai/log"
	"go.uber.org/fx"
	"go.uber.org/zap"
)

func main() {
	app := fxcore.New(
		core.Module,
		log.Module,
		fx.Invoke(func(logger *zap.Logger) {
			logger.Info("Application started with logging")
		}),
	)

	app.Run()
}

指标监控

package main

import (
	"github.com/yokaiio/yokai/fxcore"
	"github.com/yokaiio/yokai/metrics"
	"go.uber.org/fx"
)

func main() {
	app := fxcore.New(
		core.Module,
		metrics.Module,
		fx.Invoke(func(metrics metrics.Metrics) {
			// 记录自定义指标
			metrics.Counter("requests.count").Inc()
		}),
	)

	app.Run()
}

HTTP服务器示例

package main

import (
	"net/http"

	"github.com/yokaiio/yokai/core"
	"github.com/yokaiio/yokai/fxcore"
	"github.com/yokaiio/yokai/httpserver"
	"go.uber.org/fx"
)

func main() {
	app := fxcore.New(
		core.Module,
		httpserver.Module,
		fx.Invoke(func(server *httpserver.Server) {
			server.Router().HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
				w.Write([]byte("Hello, Yokai!"))
			})
		}),
	)

	app.Run()
}

自定义插件开发

package myplugin

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

type MyService struct {
	logger *zap.Logger
}

func NewMyService(logger *zap.Logger) *MyService {
	return &MyService{logger: logger}
}

func (s *MyService) DoSomething() {
	s.logger.Info("Doing something important")
}

var Module = fx.Module("myplugin",
	fx.Provide(NewMyService),
	fx.Invoke(func(s *MyService) {
		s.DoSomething()
	}),
)

// 在主程序中使用
// app := fxcore.New(
//     core.Module,
//     myplugin.Module,
// )

配置管理

Yokai支持通过多种方式管理配置：

package main

import (
	"github.com/yokaiio/yokai/core"
	"github.com/yokaiio/yokai/config"
	"github.com/yokaiio/yokai/fxcore"
	"go.uber.org/fx"
)

type AppConfig struct {
	Server struct {
		Port int `yaml:"port"`
	} `yaml:"server"`
}

func main() {
	app := fxcore.New(
		core.Module,
		config.Module,
		fx.Invoke(func(cfg *config.Config) {
			var appCfg AppConfig
			if err := cfg.Unmarshal(&appCfg); err != nil {
				panic(err)
			}
			println("Server port:", appCfg.Server.Port)
		}),
	)

	app.Run()
}

最佳实践

1. 模块划分：按功能划分模块，保持高内聚低耦合
2. 配置分离：将配置与代码分离，支持多环境
3. 可观测性：合理使用日志、指标和追踪
4. 错误处理：统一错误处理机制
5. 依赖管理：利用依赖注入管理组件生命周期

Yokai框架通过其模块化设计和内置的可观测性功能，为Go开发者提供了一个灵活且强大的后端应用开发平台。通过插件机制，开发者可以轻松扩展框架功能，同时保持代码的整洁和可维护性。