GoFr框架使用指南

GoFr是一个轻量级的Go语言微服务开发框架，由Gojek团队开发并开源。它提供了构建微服务所需的核心功能，同时保持简单和高效。下面我将介绍GoFr的主要特性及其使用方法。

主要特性

1. 内置HTTP服务器：基于标准库net/http的增强实现
2. 依赖注入：简化服务间依赖管理
3. 配置管理：支持多种配置源
4. 健康检查：内置健康检查端点
5. 日志系统：结构化日志输出
6. 中间件支持：灵活的中间件机制
7. 数据库支持：内置MySQL、PostgreSQL等数据库客户端

基础使用

安装

go get github.com/gofr-dev/gofr

简单HTTP服务示例

package main

import (
	"github.com/gofr-dev/gofr"
)

func main() {
	// 创建GoFr应用实例
	app := gofr.New()
	
	// 添加GET路由
	app.GET("/hello", func(c *gofr.Context) (interface{}, error) {
		return "Hello, World!", nil
	})
	
	// 启动服务，默认监听8000端口
	app.Run()
}

核心功能详解

1. 配置管理

GoFr支持多种配置源，包括环境变量、YAML文件和命令行参数。

app := gofr.New()

// 获取配置值
dbHost := app.Config.Get("DB_HOST")
dbPort := app.Config.Get("DB_PORT")

2. 依赖注入

type Service struct {
	Logger *gofr.Logger
}

func (s *Service) GetData() string {
	s.Logger.Info("Fetching data")
	return "sample data"
}

func main() {
	app := gofr.New()
	
	// 注册服务
	app.Dependency(&Service{Logger: app.Logger})
	
	app.GET("/data", func(c *gofr.Context) (interface{}, error) {
		var service *Service
		if err := c.GetService(&service); err != nil {
			return nil, err
		}
		
		return service.GetData(), nil
	})
	
	app.Run()
}

3. 数据库集成

app := gofr.New()

// 使用MySQL
db, err := app.MySQL()
if err != nil {
	app.Logger.Error("Failed to connect to MySQL:", err)
	return
}

app.GET("/users", func(c *gofr.Context) (interface{}, error) {
	var users []User
	err := db.SelectContext(c.Context, &users, "SELECT * FROM users")
	if err != nil {
		return nil, err
	}
	
	return users, nil
})

4. 中间件

func loggingMiddleware(next gofr.Handler) gofr.Handler {
	return func(c *gofr.Context) (interface{}, error) {
		c.Logger.Info("Request received: ", c.Request.Method, " ", c.Request.URL.Path)
		return next(c)
	}
}

func main() {
	app := gofr.New()
	
	// 全局中间件
	app.Use(loggingMiddleware)
	
	// 路由级别中间件
	app.GET("/secure", authMiddleware, func(c *gofr.Context) (interface{}, error) {
		return "Secure content", nil
	})
	
	app.Run()
}

5. 健康检查

GoFr自动提供以下健康检查端点：

• /health - 应用健康状态
• /health/ready - 就绪检查
• /health/live - 存活检查

高级功能

自定义健康检查

app := gofr.New()

// 添加自定义健康检查
app.AddHealthCheck("database", func() bool {
	// 检查数据库连接
	return true
})

app.AddHealthCheck("cache", func() bool {
	// 检查缓存连接
	return true
})

事件发布/订阅

app := gofr.New()

// 发布事件
app.PublishEvent("order.created", map[string]interface{}{
	"order_id": "123",
	"amount":   100.50,
})

// 订阅事件
app.Subscribe("order.created", func(event *gofr.Event) {
	app.Logger.Infof("Received order created event: %v", event.Payload)
})

最佳实践

1. 项目结构：

   /project
     ├── cmd/
     │   └── server/
     │       └── main.go
     ├── pkg/
     │   ├── handlers/
     │   ├── services/
     │   └── models/
     ├── configs/
     └── go.mod
   

2. 错误处理：

   app.GET("/user/:id", func(c *gofr.Context) (interface{}, error) {
       id := c.Param("id")
       if id == "" {
           return nil, gofr.Error("ID is required", gofr.ErrMissingParam)
       }
       
       user, err := getUser(id)
       if err != nil {
           return nil, gofr.Error("Failed to get user", err)
       }
       
       return user, nil
   })
   

3. 日志记录：

   app.Logger.Info("Application started")
   app.Logger.Debug("Debug information")
   app.Logger.Error("Error occurred", err)
   

总结

GoFr是一个功能齐全但保持简洁的微服务框架，特别适合需要快速开发但又不失灵活性的项目。它的设计哲学是"约定优于配置"，提供了合理的默认值，同时允许开发者在需要时进行自定义。

通过内置的健康检查、配置管理、依赖注入等功能，GoFr可以帮助开发者专注于业务逻辑而非基础设施代码。对于中小型微服务项目，GoFr是一个值得考虑的选择。