Files
common/db/mongo/mongo.go

686 lines
19 KiB
Go
Raw Normal View History

2026-01-09 19:45:50 +08:00
// =============================================================================
2026-01-09 21:08:31 +08:00
// MongoDB 业务操作封装
// 提供向后兼容的CRUD操作方法支持多数据源
2026-01-09 19:45:50 +08:00
// =============================================================================
2025-11-25 11:51:16 +08:00
package mongo
import (
"context"
"errors"
"fmt"
2025-11-25 13:47:20 +08:00
"time"
2026-02-24 15:42:36 +08:00
"gitea.com/red-future/common/log/consts"
2026-02-04 10:35:20 +08:00
"go.mongodb.org/mongo-driver/v2/event"
2026-01-26 09:02:49 +08:00
2026-02-24 15:42:36 +08:00
"gitea.com/red-future/common/beans"
"gitea.com/red-future/common/log/model/entity"
"gitea.com/red-future/common/utils"
2026-01-09 19:45:50 +08:00
"github.com/gogf/gf/v2/container/gvar"
2025-11-25 11:51:16 +08:00
"github.com/gogf/gf/v2/errors/gerror"
"github.com/gogf/gf/v2/frame/g"
"github.com/gogf/gf/v2/os/glog"
2026-01-09 19:45:50 +08:00
"github.com/gogf/gf/v2/os/grpool"
"github.com/gogf/gf/v2/os/gtime"
"github.com/gogf/gf/v2/util/gconv"
2025-11-25 13:47:20 +08:00
"go.mongodb.org/mongo-driver/v2/bson"
"go.mongodb.org/mongo-driver/v2/mongo"
"go.mongodb.org/mongo-driver/v2/mongo/options"
2025-11-25 11:51:16 +08:00
)
// Redis 数据缓存 Key 常量
const (
CleanList = "list:tenantId-%v:collection-%s:*" // 清理列表Key
CleanCount = "count:tenantId-%v:collection-%s:*" // 清理计数Key
List = "list:tenantId-%v:collection-%s:filter:%s:options:%s" // 列表查询Key
Count = "count:tenantId-%v:collection-%s:filter:%s" // 计数查询Key
One = "one:tenantId-%v:collection-%s:filter:%s" // 单条查询Key
)
2026-01-09 19:45:50 +08:00
// =============================================================================
// 向后兼容的MongoDB结构体
// =============================================================================
2026-02-04 10:35:20 +08:00
type mongoDB struct {
noCache bool
2026-01-09 19:45:50 +08:00
dataSource string // 数据源名称,默认为 "default"
noTenantId bool // 是否跳过租户过滤
2026-01-09 19:45:50 +08:00
}
2026-02-04 10:35:20 +08:00
func DB(cache ...bool) *mongoDB {
return &mongoDB{
noCache: false,
2026-01-09 19:45:50 +08:00
dataSource: "default",
noTenantId: false,
2026-01-09 19:45:50 +08:00
}
}
2025-12-19 15:17:19 +08:00
2026-02-04 10:35:20 +08:00
// commandMonitor 命令监控器
func commandMonitor() *event.CommandMonitor {
return &event.CommandMonitor{
// 命令执行前触发
Started: func(ctx context.Context, evt *event.CommandStartedEvent) {
// 1. 安全获取集合名:先判断字段是否存在,避免空值调用
collectionName := "无" // 默认值
collectionVal := evt.Command.Lookup("collection")
if !g.IsEmpty(collectionVal) { // 先检查是否为nil
collectionName = collectionVal.StringValue()
}
// 2. 打印标准化日志(避免字段缺失导致的格式错乱)
2026-02-04 10:35:20 +08:00
fmt.Printf("[%s] 开始执行命令 | 数据库: %s | 集合: %s | 命令: %+v\n",
time.Now().Format("2006-01-02 15:04:05"),
evt.DatabaseName,
collectionName,
2026-02-04 10:35:20 +08:00
evt.Command,
)
// 也可以在这里添加:参数校验、权限检查、链路追踪埋点等
// 例如将开始时间存入ctx供后续结束时计算耗时
ctx = context.WithValue(ctx, "cmd_start_time", time.Now())
},
// 命令执行成功后触发
Succeeded: func(ctx context.Context, evt *event.CommandSucceededEvent) {
// 从ctx中获取开始时间计算执行耗时
startTime, ok := ctx.Value("cmd_start_time").(time.Time)
if ok {
elapsed := time.Since(startTime)
fmt.Printf("[%s] 命令执行成功 | 耗时: %s | 结果: %+v\n",
time.Now().Format("2006-01-02 15:04:05"),
elapsed,
evt.Reply,
)
}
// 也可以在这里添加:日志入库、性能指标上报、结果校验等
},
// 命令执行失败后触发
Failed: func(ctx context.Context, evt *event.CommandFailedEvent) {
fmt.Printf("[%s] 命令执行失败 | 错误: %s | 耗时: %s\n",
time.Now().Format("2006-01-02 15:04:05"),
evt.Failure,
evt.Duration,
)
// 也可以在这里添加:错误告警、重试逻辑、异常日志记录等
},
}
}
2026-01-09 19:45:50 +08:00
// WithDataSource 指定使用的数据源
2026-02-04 10:35:20 +08:00
func (m *mongoDB) WithDataSource(name string) *mongoDB {
2026-01-09 19:45:50 +08:00
m.dataSource = name
return m
2025-12-19 15:17:19 +08:00
}
// NoCache 不使用缓存
2026-02-04 10:35:20 +08:00
func (m *mongoDB) NoCache() *mongoDB {
m.noCache = true
return m
}
// NoTenantId 不使用租户过滤
2026-02-04 10:35:20 +08:00
func (m *mongoDB) NoTenantId() *mongoDB {
m.noTenantId = true
return m
}
2026-01-09 19:45:50 +08:00
// =============================================================================
// 向后兼容的全局变量和方法
// =============================================================================
2026-01-09 19:45:50 +08:00
var (
manager = GetManager()
logPool *grpool.Pool
serverName string
LogRedisKey string
2026-01-09 19:45:50 +08:00
)
// FieldInfo 定义字段信息结构体
type FieldInfo struct {
FieldName string
FieldValue interface{}
}
2026-01-09 19:45:50 +08:00
const PageSize = 20
// GetDB 获取默认数据源的数据库实例(向后兼容)
func GetDB() *mongo.Database {
source, err := manager.GetDataSource("default")
if err != nil {
return nil
}
return source.Database()
}
// =============================================================================
// MongoDB 操作方法(支持多数据源)
// =============================================================================
2025-12-19 15:17:19 +08:00
2026-01-09 19:45:50 +08:00
// getDataSource 获取当前使用的数据源
2026-02-04 10:35:20 +08:00
func (m *mongoDB) getDataSource() (DataSource, error) {
2026-01-09 19:45:50 +08:00
if m.dataSource == "" {
m.dataSource = "default"
2025-12-19 15:17:19 +08:00
}
2026-01-09 19:45:50 +08:00
return manager.GetDataSource(m.dataSource)
2025-11-25 11:51:16 +08:00
}
// Count 查询总数
2026-02-04 10:35:20 +08:00
func (m *mongoDB) Count(ctx context.Context, filter bson.M, collection string) (count int64, err error) {
source, err := m.getDataSource()
if err != nil {
return 0, err
}
db := source.Database()
user, err := utils.GetUserInfo(ctx)
if err != nil {
return
}
filter["isDeleted"] = false
delete(filter, "tenantId")
filterKey := fmt.Sprintf("%+v", filter)
redisKey := fmt.Sprintf(Count, user.TenantId, collection, filterKey)
if !m.noCache {
var resultStr *gvar.Var
resultStr, err = g.Redis().Get(ctx, redisKey)
if err != nil {
return
}
if !g.IsEmpty(resultStr) {
count = gconv.Int64(resultStr)
return
}
}
// 如果没有调用 noTenantId则添加 tenantId 过滤
if !m.noTenantId && !g.IsEmpty(user.TenantId) {
filter["tenantId"] = user.TenantId
}
count, err = db.Collection(collection).CountDocuments(ctx, filter)
if !m.noCache {
err = g.Redis().SetEX(ctx, redisKey, count, int64(time.Hour))
if err != nil {
return
}
}
return
}
2025-11-25 11:51:16 +08:00
// Find 查询多条记录
2026-02-04 10:35:20 +08:00
func (m *mongoDB) Find(ctx context.Context, filter bson.M, result interface{}, collection string, page *beans.Page, orderBy []beans.OrderBy) (total int64, err error) {
2026-01-09 19:45:50 +08:00
source, err := m.getDataSource()
if err != nil {
return 0, err
}
db := source.Database()
if err = utils.ValidStructPtr(result); err != nil {
return
}
2025-12-30 10:52:12 +08:00
user, err := utils.GetUserInfo(ctx)
if err != nil {
return
}
if g.IsEmpty(filter["isDeleted"]) {
filter["isDeleted"] = false
}
filterKey := fmt.Sprintf("%+v", filter)
optionsKey := fmt.Sprintf("%+v%+v", page, orderBy)
redisKey := fmt.Sprintf(List, user.TenantId, collection, filterKey, optionsKey)
if !m.noCache {
var resultStr *gvar.Var
resultStr, err = g.Redis().Get(ctx, redisKey)
if err != nil {
return
}
if !resultStr.IsEmpty() {
if err = resultStr.Structs(result); err != nil {
return
}
total = int64(len(resultStr.Array()))
return
}
}
// 如果没有调用 noTenantId则添加 tenantId 过滤
if !m.noTenantId && !g.IsEmpty(user.TenantId) {
filter["tenantId"] = user.TenantId
}
limit := int64(PageSize)
skip := int64(0)
if page != nil && !g.IsEmpty(page.PageNum) && !g.IsEmpty(page.PageSize) {
limit = page.PageSize
if limit == -1 {
skip = 0
} else {
skip = (page.PageNum - 1) * limit
}
}
opt := options.Find().SetSkip(skip)
if limit != -1 {
opt.SetLimit(limit)
total, err = m.Count(ctx, filter, collection)
if err != nil || total == 0 {
return
}
}
if orderBy == nil {
opt.SetSort(bson.M{"createdAt": -1})
} else {
orderBson := bson.D{}
for _, v := range orderBy {
if v.Order == beans.Asc {
2026-01-09 19:45:50 +08:00
orderBson = append(orderBson, bson.E{Key: v.Field, Value: 1})
} else {
2026-01-09 19:45:50 +08:00
orderBson = append(orderBson, bson.E{Key: v.Field, Value: -1})
}
}
opt.SetSort(orderBson)
}
cur, err := db.Collection(collection).Find(ctx, filter, opt)
2025-11-25 11:51:16 +08:00
if err != nil {
return
}
if limit == -1 {
total = int64(cur.RemainingBatchLength())
}
defer cur.Close(ctx)
if err = cur.All(ctx, result); err != nil {
2025-12-30 09:29:36 +08:00
return
}
if !m.noCache {
err = g.Redis().SetEX(ctx, redisKey, result, int64(time.Hour))
if err != nil {
return
}
}
2025-11-25 11:51:16 +08:00
return
}
// FindOne 查询1条记录
2026-02-04 10:35:20 +08:00
func (m *mongoDB) FindOne(ctx context.Context, filter bson.M, result interface{}, collection string, opts ...options.Lister[options.FindOneOptions]) (err error) {
2026-01-09 19:45:50 +08:00
source, err := m.getDataSource()
if err != nil {
return err
}
db := source.Database()
if len(filter) == 0 {
err = gerror.New("缺少查询条件")
return
}
2025-11-25 11:51:16 +08:00
if err = utils.ValidStructPtr(result); err != nil {
return
}
2025-12-30 10:52:12 +08:00
user, err := utils.GetUserInfo(ctx)
if err != nil {
return
}
filter["isDeleted"] = false
filterKey := fmt.Sprintf("%+v", filter)
redisKey := fmt.Sprintf(One, user.TenantId, collection, filterKey)
if !m.noCache {
var resultStr *gvar.Var
resultStr, err = g.Redis().Get(ctx, redisKey)
if err != nil {
return
}
if !g.IsEmpty(resultStr) {
err = gconv.Scan(resultStr, result)
if err != nil {
return err
}
return
}
}
// 如果没有调用 noTenantId则添加 tenantId 过滤
if !m.noTenantId && !g.IsEmpty(user.TenantId) {
filter["tenantId"] = user.TenantId
}
2025-11-25 11:51:16 +08:00
cur := db.Collection(collection).FindOne(ctx, filter, opts...)
err = cur.Decode(result)
if errors.Is(err, mongo.ErrNoDocuments) {
2025-11-25 11:51:16 +08:00
err = nil
}
if !m.noCache {
err = g.Redis().SetEX(ctx, redisKey, result, int64(time.Hour))
if err != nil {
return err
}
}
2025-11-25 11:51:16 +08:00
return
}
2026-01-09 19:45:50 +08:00
// getDeletedData 获取要删除的数据
2026-02-04 10:35:20 +08:00
func (m *mongoDB) getDeletedData(ctx context.Context, filter bson.M, collection string) (deletedIDs []bson.ObjectID, deletedData []bson.M, err error) {
// 查询要删除的数据
_, err = m.Find(ctx, filter, &deletedData, collection, nil, nil)
// 从查询结果中获取 _id
for _, doc := range deletedData {
deletedIDs = append(deletedIDs, doc["_id"].(bson.ObjectID))
}
return
}
2026-02-04 10:35:20 +08:00
func (m *mongoDB) CleanRedis(ctx context.Context, filter bson.M, tenantId interface{}, collection string) (err error) {
listKeys := fmt.Sprintf(CleanList, tenantId, collection)
keys, err := g.Redis().Keys(ctx, listKeys)
if err != nil {
return
}
for _, key := range keys {
_, err = g.Redis().Del(ctx, key)
if err != nil {
return
}
}
countKeys := fmt.Sprintf(CleanCount, tenantId, collection)
keys, err = g.Redis().Keys(ctx, countKeys)
if err != nil {
return
}
for _, key := range keys {
_, err = g.Redis().Del(ctx, key)
if err != nil {
return
}
}
2025-12-15 18:15:23 +08:00
filter["isDeleted"] = false
delete(filter, "tenantId")
filterKey := fmt.Sprintf("%+v", filter)
oneKey := fmt.Sprintf(One, tenantId, collection, filterKey)
_, err = g.Redis().Del(ctx, oneKey)
if err != nil {
return
}
return
}
2025-11-25 11:51:16 +08:00
2026-02-04 10:35:20 +08:00
func (m *mongoDB) log(ctx context.Context, ids []bson.ObjectID, filter bson.M, collection string, data interface{}, userName, tenantId interface{}, operationType consts.OperationType) {
// 提前获取 IP 地址,避免异步任务执行时请求已结束
var ipAddress string
if request := g.RequestFromCtx(ctx); request != nil {
ipAddress = request.GetClientIp()
}
if operationType != consts.OperationInsert && operationType != consts.OperationDelete {
if !g.IsEmpty(filter["_id"]) {
objectID := filter["_id"].(*bson.ObjectID)
ids = append(ids, *objectID)
} else {
var err error
if ids, _, err = m.getDeletedData(ctx, filter, collection); err != nil {
return
}
}
}
log := &entity.OperationLog{
ServiceName: serverName,
Collection: collection,
CollectionID: ids,
Operation: string(operationType),
IPAddress: ipAddress,
Data: data,
}
log.Creator = userName
log.Updater = userName
now := &gtime.Now().Time
log.CreatedAt = now
log.UpdatedAt = now
log.TenantId = tenantId
// 将结构体转换为 map
values := gconv.Map(log)
// XADD streamKey * field1 value1 field2 value2 ...
args := make([]interface{}, 0, len(values)*2+2)
args = append(args, LogRedisKey, "*") // "*" 自动生成ID
for key, val := range values {
args = append(args, key, val)
}
_, err := g.Redis().Do(ctx, "XADD", args...)
if err != nil {
glog.Error(ctx, "mongoLog-AddToStream err: %v", err)
}
return
}
// Insert 插入多条记录
2026-02-04 10:35:20 +08:00
func (m *mongoDB) Insert(ctx context.Context, documents []interface{}, collection string, opts ...options.Lister[options.InsertManyOptions]) (ids []interface{}, err error) {
source, err := m.getDataSource()
if err != nil {
return nil, err
}
db := source.Database()
user, err := utils.GetUserInfo(ctx)
if err != nil {
return
}
docs := make([]interface{}, 0, len(documents))
for _, document := range documents {
doc := gconv.Map(document)
delete(doc, "id")
if !g.IsEmpty(user.UserName) && g.IsEmpty(doc["creator"]) {
doc["creator"] = user.UserName
}
if !g.IsEmpty(user.UserName) && g.IsEmpty(doc["updater"]) {
doc["updater"] = user.UserName
}
if !g.IsEmpty(user.TenantId) && g.IsEmpty(doc["tenantId"]) {
doc["tenantId"] = user.TenantId
}
if g.IsEmpty(doc["createdAt"]) {
doc["createdAt"] = gtime.Now().Time
}
if g.IsEmpty(doc["updatedAt"]) {
doc["updatedAt"] = gtime.Now().Time
}
doc["isDeleted"] = false
docs = append(docs, doc)
}
r, err := db.Collection(collection).InsertMany(ctx, docs, opts...)
if err != nil {
return
}
ids = r.InsertedIDs
err = m.CleanRedis(ctx, bson.M{}, user.TenantId, collection)
//写日志
if collection != consts.OperationLogCollection {
objectIds := make([]bson.ObjectID, 0)
for _, id := range ids {
objectIds = append(objectIds, id.(bson.ObjectID))
}
m.log(ctx, objectIds, nil, collection, nil, user.UserName, user.TenantId, consts.OperationInsert)
}
return
}
2025-11-25 11:51:16 +08:00
// Delete 删除记录
2026-02-04 10:35:20 +08:00
func (m *mongoDB) Delete(ctx context.Context, filter bson.M, collection string, opts ...options.Lister[options.DeleteManyOptions]) (count int64, err error) {
2026-01-09 19:45:50 +08:00
source, err := m.getDataSource()
if err != nil {
return 0, err
}
db := source.Database()
2025-11-28 17:13:16 +08:00
if len(filter) == 0 {
err = gerror.New("缺少查询条件")
return
}
2025-12-30 10:52:12 +08:00
user, err := utils.GetUserInfo(ctx)
if err != nil {
return
}
filter["tenantId"] = user.TenantId
// 获取要删除的数据
ds, ms, err := m.getDeletedData(ctx, filter, collection)
if err != nil {
return
}
// 执行删除操作
2025-11-25 11:51:16 +08:00
r, err := db.Collection(collection).DeleteMany(ctx, filter, opts...)
if err != nil {
return
}
count = r.DeletedCount
// 清理redis
err = m.CleanRedis(ctx, filter, user.TenantId, collection)
// 写日志
m.log(ctx, ds, nil, collection, ms, user.UserName, user.TenantId, consts.OperationDelete)
2025-11-25 11:51:16 +08:00
return
}
// DeleteSoft 假删除记录
2026-02-04 10:35:20 +08:00
func (m *mongoDB) DeleteSoft(ctx context.Context, filter bson.M, collection string, opts ...options.Lister[options.UpdateManyOptions]) (modifiedCount int64, err error) {
update := bson.M{"$set": bson.M{"isDeleted": true}}
return m.Update(ctx, filter, update, collection, opts...)
}
2025-11-25 11:51:16 +08:00
// Update 修改记录
2026-02-04 10:35:20 +08:00
func (m *mongoDB) Update(ctx context.Context, filter bson.M, update bson.M, collection string, opts ...options.Lister[options.UpdateManyOptions]) (modifiedCount int64, err error) {
2026-01-09 19:45:50 +08:00
source, err := m.getDataSource()
if err != nil {
2026-01-26 09:02:49 +08:00
return 0, err
2026-01-09 19:45:50 +08:00
}
db := source.Database()
2025-11-28 17:13:16 +08:00
if len(filter) == 0 {
err = gerror.New("缺少查询条件")
return
}
filter["isDeleted"] = false
2025-12-30 10:52:12 +08:00
user, err := utils.GetUserInfo(ctx)
if err != nil {
return
}
if !g.IsEmpty(user.TenantId) {
filter["tenantId"] = user.TenantId
}
// 遍历 update 中的所有操作符和字段,存放到 list 中
fieldList := make([]FieldInfo, 0)
for _, doc := range update {
if m, ok := doc.(bson.M); ok {
for fieldName, fieldValue := range m {
// 获取到字段名和字段值
fieldList = append(fieldList, FieldInfo{
FieldName: fieldName,
FieldValue: fieldValue,
})
}
}
}
setDoc := bson.M{}
if !g.IsEmpty(update["$set"]) {
setDoc = update["$set"].(bson.M)
}
if !g.IsEmpty(user.UserName) {
setDoc["updater"] = user.UserName
}
2025-12-02 15:56:57 +08:00
setDoc["updatedAt"] = gtime.Now().Time
update["$set"] = setDoc
2026-01-26 09:02:49 +08:00
result, err := db.Collection(collection).UpdateMany(ctx, filter, update, opts...)
2025-11-25 11:51:16 +08:00
if err != nil {
return
}
2026-01-26 09:02:49 +08:00
modifiedCount = result.ModifiedCount
// 清理redis
err = m.CleanRedis(ctx, filter, user.TenantId, collection)
// 写日志
if !g.IsEmpty(setDoc["isDeleted"]) && gconv.Bool(setDoc["isDeleted"]) {
filter["isDeleted"] = true
m.log(ctx, nil, filter, collection, nil, user.UserName, user.TenantId, consts.OperationDeleteSoft)
} else {
m.log(ctx, nil, filter, collection, fieldList, user.UserName, user.TenantId, consts.OperationUpdate)
}
2025-11-25 11:51:16 +08:00
return
}
// SaveOrUpdate 批量增加或修改
2026-02-04 10:35:20 +08:00
func (m *mongoDB) SaveOrUpdate(ctx context.Context, filter []bson.M, update []bson.M, collection string, opts ...options.Lister[options.UpdateManyOptions]) (result *mongo.BulkWriteResult, err error) {
2026-01-09 19:45:50 +08:00
source, err := m.getDataSource()
if err != nil {
return nil, err
}
db := source.Database()
if len(filter) == 0 || len(update) == 0 {
err = gerror.New("缺少查询条件或更新数据")
return
}
if len(filter) != len(update) {
err = gerror.New("查询条件和更新数据的数量必须一致")
return
}
2025-12-30 10:52:12 +08:00
user, err := utils.GetUserInfo(ctx)
if err != nil {
return
}
2026-01-09 19:45:50 +08:00
var models []mongo.WriteModel
for i := 0; i < len(filter); i++ {
filter[i]["isDeleted"] = false
if !g.IsEmpty(user.TenantId) {
filter[i]["tenantId"] = user.TenantId
}
if setDoc, exists := update[i]["$set"].(bson.M); exists {
if !g.IsEmpty(user.UserName) {
setDoc["updater"] = user.UserName
}
setDoc["updatedAt"] = gtime.Now().Time
} else {
setDoc := bson.M{}
if !g.IsEmpty(user.UserName) {
setDoc["updater"] = user.UserName
}
setDoc["updatedAt"] = gtime.Now().Time
update[i]["$set"] = setDoc
}
updateModel := mongo.NewUpdateOneModel()
updateModel.SetFilter(filter[i])
updateModel.SetUpdate(update[i])
2026-01-09 19:45:50 +08:00
updateModel.SetUpsert(true)
if len(opts) > 0 {
for _, opt := range opts {
var updateOpts options.UpdateManyOptions
optFuncs := opt.List()
for _, fn := range optFuncs {
fn(&updateOpts)
}
if updateOpts.Upsert != nil {
updateModel.SetUpsert(*updateOpts.Upsert)
}
}
}
models = append(models, updateModel)
}
2026-01-09 19:45:50 +08:00
bulkOpts := options.BulkWrite().SetOrdered(false)
bulkResult, err := db.Collection(collection).BulkWrite(ctx, models, bulkOpts)
if err != nil {
return nil, err
}
2026-01-09 19:45:50 +08:00
for _, filterItem := range filter {
err = m.CleanRedis(ctx, filterItem, user.TenantId, collection)
if err != nil {
glog.Warning(ctx, "清理Redis缓存失败:", err)
}
}
return bulkResult, nil
}
func BuildUpdateData(ctx context.Context, req interface{}) (filter bson.M, err error) {
_ = ctx
filter = bson.M{}
reqMap := gconv.Map(req)
for mk, mv := range reqMap {
if mk != "id" && !g.IsEmpty(mv) {
filter[mk] = mv
}
}
return
}