go gin 框架怎么编写所有控制器都能获取的公共数据

Gin框架中编写所有控制器都能获取的公共数据，主要可以通过中间件、上下文(Context)对象、全局变量或者是单例服务等手段来实现。中间件是处理此类任务的常见方法，它能够在处理请求之前或之后执行特定的逻辑，并将数据注入到上下文中，以便后续的控制器能够使用。此外，还可以定义全局变量或者单例服务，并在控制器中主动获取这些数据。

接下来，我们将重点说明如何通过中间件来实现这个功能。

一、使用中间件设置公共数据

中间件可以在请求被处理之前预先加载特定的数据，这些数据随后将被所有的控制器共享。

创建中间件

首先，需要创建一个中间件函数，该函数会将公共数据设置到每个请求的上下文中。

func PublicDataMiddleware() gin.HandlerFunc {
    return func(c *gin.Context) {
        // 填充公共数据
        commonData := map[string]interface{}{
            "appName":    "My Gin App",
            "appVersion": "1.0.0",
        }
        // 将公共数据设置到上下文中
        c.Set("publicData", commonData)
        // 继续处理请求
        c.Next()
    }
}

在Gin引擎中注册中间件

注册中间件，确保在请求处理流程中被执行。

func mAIn() {
    r := gin.Default()
    // 注册公共数据中间件
    r.Use(PublicDataMiddleware())
    // ... 其他路由和控制器 ...
    r.Run()
}

二、在控制器中访问公共数据

在使用了中间件后，控制器中可以通过上下文对象访问设置在中间件中的公共数据。

在控制器中获取公共数据

定义控制器函数，并通过c.Get方法从上下文中获取中间件设置的公共数据。

func SomeController(c *gin.Context) {
    // 从上下文中获取公共数据
    publicData, exists := c.Get("publicData")
    if !exists {
        // 如果需要，处理数据不存在的情况
        c.JSON(500, gin.H{"message": "Internal Server Error"})
        return
    }
    // 使用公共数据处理业务逻辑
    // ...
    // 将结果返回给客户端
    c.JSON(200, gin.H{
        "message": "Success",
        "data":    publicData,
    })
}

三、全局变量和单例服务

虽然不是特别推荐，但也可以将公共数据保存在全局变量中，或者通过单例模式创建一个服务类来管理这些数据。

定义全局变量或单例服务

var GlobalCommonData = map[string]interface{}{
    "appName":    "My Gin App",
    "appVersion": "1.0.0",
}

或者

type CommonDataService struct {
    data map[string]interface{}
}
var (
    // 确保只有一个实例
    instance *CommonDataService
    once     sync.Once
)
// 获取单例服务实例
func GetCommonDataService() *CommonDataService {
    once.Do(func() {
        instance = &CommonDataService{
            data: map[string]interface{}{
                "appName":    "My Gin App",
                "appVersion": "1.0.0",
            },
        }
    })
    return instance
}

在控制器中使用全局变量或单例服务

func SomeControllerWithGlobalData(c *gin.Context) {
    // 直接使用全局变量
    c.JSON(200, gin.H{
        "message": "Success",
        "data":    GlobalCommonData,
    })
}
func SomeControllerWithSingleton(c *gin.Context) {
    // 通过单例服务获取数据
    commonDataService := GetCommonDataService()
    c.JSON(200, gin.H{
        "message": "Success",
        "data":    commonDataService.data,
    })
}