Files
common/mongo/mongo.go

610 lines
16 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"
"reflect"
2025-11-25 13:47:20 +08:00
"time"
"gitee.com/red-future---jilin-g/common/beans"
"gitee.com/red-future---jilin-g/common/log/model/entity"
"gitee.com/red-future---jilin-g/common/redis"
2025-11-25 11:51:16 +08:00
"gitee.com/red-future---jilin-g/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
)
2026-01-09 19:45:50 +08:00
// =============================================================================
// 向后兼容的MongoDB结构体
// =============================================================================
type MongoDB struct {
Cache bool
dataSource string // 数据源名称,默认为 "default"
}
func DB(cache ...bool) *MongoDB {
b := true
if len(cache) > 0 {
b = cache[0]
2025-12-19 15:17:19 +08:00
}
2026-01-09 19:45:50 +08:00
return &MongoDB{
Cache: b,
dataSource: "default",
}
}
2025-12-19 15:17:19 +08:00
2026-01-09 19:45:50 +08:00
// WithDataSource 指定使用的数据源
func (m *MongoDB) WithDataSource(name string) *MongoDB {
m.dataSource = name
return m
2025-12-19 15:17:19 +08:00
}
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
)
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 获取当前使用的数据源
func (m *MongoDB) getDataSource() (DataSource, error) {
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
}
2025-11-25 11:51:16 +08:00
// Find 查询多条记录
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
}
filter["isDeleted"] = false
filterKey := fmt.Sprintf("%+v", filter)
optionsKey := fmt.Sprintf("%+v%+v", page, orderBy)
redisKey := fmt.Sprintf(redis.List, user.TenantId, collection, filterKey, optionsKey)
2025-12-30 09:29:36 +08:00
if m.Cache {
var resultStr *gvar.Var
2026-01-16 13:42:15 +08:00
resultStr, err = redis.RedisClient.Get(ctx, redisKey)
if err != nil {
return
}
if !resultStr.IsEmpty() {
if err = resultStr.Structs(result); err != nil {
return
}
total = int64(len(resultStr.Array()))
return
}
}
filter["tenantId"] = user.TenantId
limit := int64(PageSize)
skip := int64(0)
if page != nil {
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)
} else {
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.Cache {
2026-01-16 13:42:15 +08:00
err = redis.RedisClient.SetEX(ctx, redisKey, result, int64(time.Hour))
if err != nil {
return
}
}
2025-11-25 11:51:16 +08:00
return
}
// FindOne 查询1条记录
2025-12-30 09:29:36 +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(redis.One, user.TenantId, collection, filterKey)
2025-12-30 09:29:36 +08:00
if m.Cache {
var resultStr *gvar.Var
2026-01-16 13:42:15 +08:00
resultStr, err = redis.RedisClient.Get(ctx, redisKey)
if err != nil {
return
}
if !g.IsEmpty(resultStr) {
err = gconv.Scan(resultStr, result)
if err != nil {
return err
}
return
}
}
if !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
}
2025-12-30 09:29:36 +08:00
if m.Cache {
2026-01-16 13:42:15 +08:00
err = redis.RedisClient.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
func (m *MongoDB) CleanRedis(ctx context.Context, filter bson.M, tenantId interface{}, collection string) (err error) {
listKeys := fmt.Sprintf(redis.CleanList, tenantId, collection)
2026-01-16 13:42:15 +08:00
keys, err := redis.RedisClient.Keys(ctx, listKeys)
if err != nil {
return
}
for _, key := range keys {
2026-01-16 13:42:15 +08:00
_, err = redis.RedisClient.Del(ctx, key)
if err != nil {
return
}
}
countKeys := fmt.Sprintf(redis.CleanCount, tenantId, collection)
2026-01-16 13:42:15 +08:00
keys, err = redis.RedisClient.Keys(ctx, countKeys)
if err != nil {
return
}
for _, key := range keys {
2026-01-16 13:42:15 +08:00
_, err = redis.RedisClient.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(redis.One, tenantId, collection, filterKey)
2026-01-16 13:42:15 +08:00
_, err = redis.RedisClient.Del(ctx, oneKey)
if err != nil {
return
}
return
}
2025-11-25 11:51:16 +08:00
func (m *MongoDB) log(ctx context.Context, filter bson.M, collection string, data interface{}, userName, tenantId interface{}, operationType string) {
_ = logPool.AddWithRecover(ctx, func(ctx context.Context) {
log := &entity.OperationLog{
ServiceName: serverName,
Collection: collection,
CollectionID: filter["_id"].(string),
Operation: operationType,
IPAddress: g.RequestFromCtx(ctx).GetClientIp(),
Data: data,
}
log.Creator = userName
now := &gtime.Now().Time
log.CreatedAt = now
log.UpdatedAt = now
log.TenantId = tenantId
if _, err := redis.AddToStream(ctx, logRedisKey, log); err != nil {
glog.Error(ctx, "mongoLog-AddToStream err: %v", err)
}
}, func(ctx context.Context, exception error) {
glog.Error(ctx, "mongoLog-AddWithRecover err: %v", exception)
})
return
}
2025-11-25 11:51:16 +08:00
// Delete 删除记录
2025-12-30 09:29:36 +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
2025-11-25 11:51:16 +08:00
r, err := db.Collection(collection).DeleteMany(ctx, filter, opts...)
if err != nil {
return
}
count = r.DeletedCount
err = m.CleanRedis(ctx, filter, user.TenantId, collection)
2025-11-25 11:51:16 +08:00
return
}
// Update 修改记录
2025-12-30 09:29:36 +08:00
func (m *MongoDB) Update(ctx context.Context, filter bson.M, update bson.M, collection string, opts ...options.Lister[options.UpdateManyOptions]) (result *mongo.UpdateResult, err error) {
2026-01-09 19:45:50 +08:00
source, err := m.getDataSource()
if err != nil {
return nil, err
}
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
}
2025-12-02 15:56:57 +08:00
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 = bson.M{"$set": setDoc}
result, err = db.Collection(collection).UpdateMany(ctx, filter, update, opts...)
2025-11-25 11:51:16 +08:00
if err != nil {
return
}
err = m.CleanRedis(ctx, filter, user.TenantId, collection)
2025-11-25 11:51:16 +08:00
return
}
// RandomSoftDelete 随机软删除个文档的 _id
2025-12-30 09:29:36 +08:00
func (m *MongoDB) RandomSoftDelete(ctx context.Context, limit int, collection string, opts ...options.Lister[options.UpdateManyOptions]) (result *mongo.UpdateResult, err error) {
2026-01-09 19:45:50 +08:00
source, err := m.getDataSource()
if err != nil {
return nil, err
}
db := source.Database()
_ = opts
pipeline := mongo.Pipeline{
bson.D{{Key: "$addFields", Value: bson.D{{Key: "random", Value: bson.M{"$rand": bson.M{}}}}}},
bson.D{{Key: "$match", Value: bson.D{{Key: "isDeleted", Value: false}}}},
bson.D{{Key: "$sort", Value: bson.D{{Key: "random", Value: -1}}}},
bson.D{{Key: "$limit", Value: limit}},
bson.D{{Key: "$project", Value: bson.D{{Key: "_id", Value: 1}}}},
}
cursor, err := db.Collection(collection).Aggregate(ctx, pipeline)
if err != nil {
return
}
defer cursor.Close(ctx)
2026-01-09 19:45:50 +08:00
var idsToUpdate []bson.ObjectID
for cursor.Next(ctx) {
var result bson.M
if err := cursor.Decode(&result); err != nil {
return nil, err
}
id := result["_id"].(bson.ObjectID)
idsToUpdate = append(idsToUpdate, id)
}
if err := cursor.Err(); err != nil {
return nil, err
}
fmt.Printf("准备更新的随机文档ID: %v\n", idsToUpdate)
2026-01-09 19:45:50 +08:00
if len(idsToUpdate) > 0 {
filter := bson.D{{Key: "_id", Value: bson.D{{Key: "$in", Value: idsToUpdate}}}}
update := bson.D{{Key: "$set", Value: bson.D{{Key: "isDeleted", Value: true}}}}
_, err = db.Collection(collection).UpdateMany(ctx, filter, update)
if err != nil {
return
}
}
return
}
// SaveOrUpdate 批量增加或修改
2025-12-30 09:29:36 +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
}
2025-11-25 13:47:20 +08:00
// Insert 插入多条记录
2025-12-30 09:29:36 +08:00
func (m *MongoDB) Insert(ctx context.Context, documents []interface{}, collection string, opts ...options.Lister[options.InsertManyOptions]) (ids []interface{}, err error) {
2026-01-09 19:45:50 +08:00
source, err := m.getDataSource()
if err != nil {
return nil, err
}
db := source.Database()
2025-12-30 10:52:12 +08:00
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) {
doc["creator"] = user.UserName
}
if !g.IsEmpty(user.UserName) {
doc["updater"] = user.UserName
}
if !g.IsEmpty(user.TenantId) {
doc["tenantId"] = user.TenantId
}
doc["createdAt"] = gtime.Now().Time
doc["updatedAt"] = gtime.Now().Time
doc["isDeleted"] = false
docs = append(docs, doc)
}
r, err := db.Collection(collection).InsertMany(ctx, docs, opts...)
2025-11-25 11:51:16 +08:00
if err != nil {
return
}
ids = r.InsertedIDs
err = m.CleanRedis(ctx, bson.M{}, user.TenantId, collection)
2025-11-25 11:51:16 +08:00
return
}
2025-11-25 16:37:29 +08:00
2026-01-09 19:45:50 +08:00
// Count 查询总数
2025-12-30 09:29:36 +08:00
func (m *MongoDB) Count(ctx context.Context, filter bson.M, collection string) (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-12-30 10:52:12 +08:00
user, err := utils.GetUserInfo(ctx)
if err != nil {
return
}
filter["isDeleted"] = false
delete(filter, "tenantId")
filterKey := fmt.Sprintf("%+v", filter)
redisKey := fmt.Sprintf(redis.Count, user.TenantId, collection, filterKey)
2025-12-30 09:29:36 +08:00
if m.Cache {
var resultStr *gvar.Var
2026-01-16 13:42:15 +08:00
resultStr, err = redis.RedisClient.Get(ctx, redisKey)
if err != nil {
return
}
if !g.IsEmpty(resultStr) {
count = gconv.Int64(resultStr)
return
}
}
2025-11-25 16:37:29 +08:00
count, err = db.Collection(collection).CountDocuments(ctx, filter)
2025-12-30 09:29:36 +08:00
if m.Cache {
2026-01-16 13:42:15 +08:00
err = redis.RedisClient.SetEX(ctx, redisKey, count, int64(time.Hour))
if err != nil {
return
}
}
2025-11-25 16:37:29 +08:00
return
2025-11-28 14:01:08 +08:00
}
func BuildUpdateFilter(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
}
// EntityToBson 将 *entity/entity 转换为 bson.M
func EntityToBson(entity interface{}) (bson.M, error) {
return EntityToBsonWithFilter(entity, false)
}
// EntityToBsonWithFilter 将 *entity/entity 转换为 bson.M并可选择是否过滤空值
func EntityToBsonWithFilter(entity interface{}, filterEmpty bool) (bson.M, error) {
if entity == nil {
return nil, fmt.Errorf("传入的 entity 实例为 nil")
}
bsonBytes, err := bson.Marshal(entity)
if err != nil {
return nil, fmt.Errorf("entity 序列化为 BSON 字节流失败:%w", err)
}
var bsonMap bson.M
err = bson.Unmarshal(bsonBytes, &bsonMap)
if err != nil {
return nil, fmt.Errorf("BSON 字节流反序列化为 bson.M 失败:%w", err)
}
if filterEmpty {
for key, value := range bsonMap {
if isEmptyWithZero(value) {
delete(bsonMap, key)
}
}
}
return bsonMap, nil
}
// isEmptyWithZero 判断是否为空值,但保留 int 类型的 0 值
func isEmptyWithZero(value interface{}) bool {
if value == nil {
return true
}
rv := reflect.ValueOf(value)
kind := rv.Kind()
if kind == reflect.Ptr {
if rv.IsNil() {
return true
}
kind = rv.Elem().Kind()
}
switch kind {
case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64,
reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64,
reflect.Float32, reflect.Float64:
return false
default:
return g.IsEmpty(value)
}
}