GORM多租户数据库管理的插件库gorm-multitenancy使用指南

概述

gorm-multitenancy提供了一个Go框架，用于构建多租户应用程序，简化租户管理和模型迁移。它通过一个与GORM兼容的统一、数据库无关的API抽象了多租户的复杂性。

多租户实现方法

数据库多租户有三种常见方法：

• 共享数据库，共享模式
• 共享数据库，独立模式
• 独立数据库

根据使用的数据库，该包使用"共享数据库，独立模式"或"独立数据库"策略，通过提供定制的驱动程序确保与现有数据库配置的平滑集成。

特性

• GORM集成：简化GORM在多租户环境中的使用
• 自定义数据库驱动程序：增强现有驱动程序以便轻松设置多租户
• HTTP中间件：为Web应用程序提供简单的租户上下文管理中间件

支持的数据库

安装

安装核心包：

go get -u github.com/bartventer/gorm-multitenancy/v8

安装数据库特定驱动：

# PostgreSQL
go get -u github.com/bartventer/gorm-multitenancy/postgres/v8

# MySQL
go get -u github.com/bartventer/gorm-multitenancy/mysql/v8

可选安装路由特定中间件：

# Echo
go get -u github.com/bartventer/gorm-multitenancy/middleware/echo/v8

# Gin
go get -u github.com/bartventer/gorm-multitenancy/middleware/gin/v8

# Iris
go get -u github.com/bartventer/gorm-multitenancy/middleware/iris/v8

# Net/HTTP
go get -u github.com/bartventer/gorm-multitenancy/middleware/nethttp/v8

使用示例

PostgreSQL示例

package main

import (
	"fmt"
	"log"

	"github.com/bartventer/gorm-multitenancy/datastore"
	"github.com/bartventer/gorm-multitenancy/postgres/v8"
	"gorm.io/gorm"
)

// Tenant模型
type Tenant struct {
	gorm.Model
	Name string `gorm:"unique;not null"`
}

// User模型
type User struct {
	gorm.Model
	Name     string
	TenantID uint // 租户ID字段
}

func main() {
	// 初始化主数据库连接
	mainDB, err := postgres.Open("host=localhost user=postgres password=postgres dbname=main_db port=5432 sslmode=disable")
	if err != nil {
		log.Fatal(err)
	}

	// 创建多租户配置
	config := &datastore.Config{
		TenantModel:      Tenant{}, // 租户模型
		TenantIDField:    "TenantID", // 租户ID字段名
		PublicSchemaName: "public", // 公共模式名
	}

	// 初始化多租户DB
	multiTenantDB, err := postgres.New(mainDB, config)
	if err != nil {
		log.Fatal(err)
	}

	// 自动迁移模型
	err = multiTenantDB.AutoMigrate(&Tenant{}, &User{})
	if err != nil {
		log.Fatal(err)
	}

	// 创建租户
	tenant := Tenant{Name: "tenant1"}
	if err := multiTenantDB.Create(&tenant).Error; err != nil {
		log.Fatal(err)
	}

	// 设置当前租户上下文
	multiTenantDB = multiTenantDB.WithContext(datastore.NewTenantContext(tenant.ID))

	// 为当前租户创建用户
	user := User{Name: "John Doe", TenantID: tenant.ID}
	if err := multiTenantDB.Create(&user).Error; err != nil {
		log.Fatal(err)
	}

	fmt.Println("User created successfully for tenant:", tenant.Name)
}

Gin中间件示例

package main

import (
	"github.com/bartventer/gorm-multitenancy/datastore"
	"github.com/bartventer/gorm-multitenancy/middleware/gin/v8"
	"github.com/bartventer/gorm-multitenancy/postgres/v8"
	"github.com/gin-gonic/gin"
	"gorm.io/gorm"
)

var multiTenantDB *datastore.MultiTenantDB

func main() {
	// 初始化数据库连接和多租户配置(同上)
	
	r := gin.Default()
	
	// 使用多租户中间件
	r.Use(ginmulti.TenantMiddleware(multiTenantDB, func(c *gin.Context) (string, error) {
		// 从请求中获取租户ID，例如从header、query参数或JWT token中
		tenantID := c.GetHeader("X-Tenant-ID")
		return tenantID, nil
	}))
	
	r.GET("/users", func(c *gin.Context) {
		// 从上下文中获取DB实例
		db := ginmulti.TenantDBFromContext(c)
		
		var users []User
		if err := db.Find(&users).Error; err != nil {
			c.JSON(500, gin.H{"error": err.Error()})
			return
		}
		
		c.JSON(200, users)
	})
	
	r.Run(":8080")
}

注意事项

1. 确保在创建租户特定数据时设置了正确的租户上下文
2. 对于PostgreSQL，模式名称不能包含大写字母
3. 对于MySQL，确保数据库用户有创建新数据库的权限

通过使用gorm-multitenancy，您可以轻松地为您的Golang应用程序添加多租户支持，同时保持代码的简洁和可维护性。