使用ardanlabs/service构建生产级可扩展Web服务

ardanlabs/service是Go语言中一个优秀的Web服务启动工具包，它提供了一套完整的生产级Web服务框架，包含日志、配置、监控、优雅关闭等企业级功能。

核心特性

1. 内置标准化的服务生命周期管理
2. 集成优雅关闭(graceful shutdown)机制
3. 提供统一的配置管理
4. 内置健康检查、指标和跟踪支持
5. 结构化日志记录
6. 支持多路复用(mux)的HTTP服务器

基本使用示例

package main

import (
	"context"
	"net/http"

	"github.com/ardanlabs/service/app/services/sales-api/handlers"
	"github.com/ardanlabs/service/business/web/v1/debug"
	"github.com/ardanlabs/service/foundation/logger"
	"github.com/ardanlabs/service/foundation/web"
)

func main() {
	// 初始化日志
	log := logger.New("SALES-API")

	// 创建服务
	service := web.NewApp(
		log,
		web.WithShutdownFunc(func(ctx context.Context) {
			// 自定义关闭逻辑
			log.Info(ctx, "shutdown started")
		}),
	)

	// 注册路由
	service.Handle(http.MethodGet, "/ready", handlers.Ready)
	service.Handle(http.MethodGet, "/live", handlers.Live)
	
	// 注册调试路由
	debugMux := debug.StandardLibraryMux()
	service.Handle(http.MethodGet, "/debug/", http.StripPrefix("/debug", debugMux))

	// 启动服务
	if err := service.Run(context.Background()); err != nil {
		log.Error(context.Background(), "shutdown", "msg", err)
		return
	}
}

配置管理

ardanlabs/service提供了统一的配置管理方式：

import (
	"github.com/ardanlabs/conf/v3"
)

type Config struct {
	Web struct {
		APIHost         string        `conf:"default:0.0.0.0:3000"`
		DebugHost       string        `conf:"default:0.0.0.0:4000"`
		ReadTimeout     time.Duration `conf:"default:5s"`
		WriteTimeout    time.Duration `conf:"default:10s"`
		IdleTimeout     time.Duration `conf:"default:120s"`
		ShutdownTimeout time.Duration `conf:"default:20s"`
	}
}

func main() {
	cfg := Config{}
	
	help, err := conf.Parse("SALES", &cfg)
	if err != nil {
		log.Fatalf("parsing config: %v", err)
	}
	
	// 使用配置启动服务
	service := web.NewApp(
		log,
		web.WithServerOptions(
			web.WithReadTimeout(cfg.Web.ReadTimeout),
			web.WithWriteTimeout(cfg.Web.WriteTimeout),
			web.WithIdleTimeout(cfg.Web.IdleTimeout),
		),
	)
}

中间件支持

// 自定义中间件
func middlewareExample(next web.HandlerFunc) web.HandlerFunc {
	return func(ctx context.Context, w http.ResponseWriter, r *http.Request) error {
		// 前置处理
		log.Info(ctx, "middleware: before")
		
		// 调用下一个处理程序
		err := next(ctx, w, r)
		
		// 后置处理
		log.Info(ctx, "middleware: after")
		
		return err
	}
}

// 注册带中间件的路由
service.Handle(http.MethodGet, "/example", handlers.Example, middlewareExample)

数据库集成

import (
	"github.com/ardanlabs/service/business/core/user/stores/userdb"
	"github.com/ardanlabs/service/business/data/dbsql/pgx"
)

func main() {
	// 配置数据库
	dbConfig := pgx.Config{
		User:         "postgres",
		Password:     "postgres",
		Host:         "localhost",
		Name:         "postgres",
		MaxIdleConns: 2,
		MaxOpenConns: 0,
		DisableTLS:   true,
	}
	
	// 创建数据库连接
	db, err := pgx.Open(dbConfig)
	if err != nil {
		log.Fatalf("opening database connection: %v", err)
	}
	
	// 创建用户存储
	userCore := userdb.NewStore(log, db)
	
	// 创建API处理器
	api := handlers.API{
		User: userCore,
	}
	
	// 注册路由
	service.Handle(http.MethodGet, "/users", api.Query)
	service.Handle(http.MethodPost, "/users", api.Create)
}

监控和健康检查

import (
	"github.com/ardanlabs/service/business/web/v1/mid"
	"github.com/ardanlabs/service/foundation/web"
)

func main() {
	// 添加监控中间件
	service.Use(
		mid.Logger(log),
		mid.Errors(log),
		mid.Metrics(),
		mid.Panics(log),
	)
	
	// 健康检查路由
	service.Handle(http.MethodGet, "/health", handlers.Health)
	
	// 指标路由
	service.Handle(http.MethodGet, "/metrics", handlers.Metrics)
}

生产环境最佳实践

1. 日志配置：确保在生产环境中配置适当的日志级别和输出格式
2. 优雅关闭：实现完整的优雅关闭逻辑，包括数据库连接关闭等
3. 监控集成：集成Prometheus或其他监控工具
4. 配置管理：使用环境变量或配置中心管理敏感信息
5. 错误处理：实现统一的错误处理中间件

ardanlabs/service提供了一套完整的生产级Web服务解决方案，通过合理的配置和使用，可以快速构建出高可用、可扩展的Web服务。