首页 > 解决方案 > 如何在解组 MongoDB 文档时忽略空值?

问题描述

我想知道是否有任何方法可以让我在将 MongoDB 文档解组为 Go 结构时忽略空类型。

现在我有一些自动生成的 Go 结构,如下所示:

type User struct {
  Name  string `bson:"name"`
  Email string `bson:"email"`
}

更改此结构中声明的类型不是一种选择,这就是问题所在;在我没有完全控制权的 MongoDB 数据库中,一些文档已经插入了空值,最初我并不期望空值。像这样的东西:

{
  "name": "John Doe",
  "email": null
}

由于在我的结构中声明的字符串类型不是指针,它们无法接收nil值,因此每当我尝试在我的结构中解组此文档时,它都会返回错误。

防止将此类文档插入数据库将是理想的解决方案,但对于我的用例,忽略空值也是可以接受的。因此,在解组文档后,我的 User 实例将如下所示

User {
  Name:  "John Doe",
  Email: "",
}

我试图找到一些注释标志,或者可以传递给方法Find/的选项,FindOne甚至可能是一个查询参数,以防止从数据库返回任何包含空值的字段。直到现在都没有任何成功。

mongo-go-driver 中是否有针对此问题的内置解决方案?

标签: mongodbgomongodb-querybsonmongo-go

解决方案


问题是当前的 bson 编解码器不支持编码/解码stringinto/from null

string处理这个问题的一种方法是为我们处理值的类型创建一个自定义解码器null:我们只使用空字符串(更重要的是不报告错误)。

自定义解码器由 type 描述bsoncodec.ValueDecoder。它们可以在 a 注册,例如bsoncodec.Registry使用 a 。bsoncodec.RegistryBuilder

注册表可以在多个级别设置/应用,甚至可以设置/应用到一个整体mongo.Client,或者一个mongo.Database或只是一个mongo.Collection,当获取它们时,作为它们选项的一部分,例如options.ClientOptions.SetRegistry()

首先让我们看看我们string如何为 .

1.处理null字符串

首先,让我们创建一个自定义字符串解码器,可以将 anull转换为 (n 空) 字符串:

import (
    "go.mongodb.org/mongo-driver/bson/bsoncodec"
    "go.mongodb.org/mongo-driver/bson/bsonrw"
    "go.mongodb.org/mongo-driver/bson/bsontype"
)

type nullawareStrDecoder struct{}

func (nullawareStrDecoder) DecodeValue(dctx bsoncodec.DecodeContext, vr bsonrw.ValueReader, val reflect.Value) error {
    if !val.CanSet() || val.Kind() != reflect.String {
        return errors.New("bad type or not settable")
    }
    var str string
    var err error
    switch vr.Type() {
    case bsontype.String:
        if str, err = vr.ReadString(); err != nil {
            return err
        }
    case bsontype.Null: // THIS IS THE MISSING PIECE TO HANDLE NULL!
        if err = vr.ReadNull(); err != nil {
            return err
        }
    default:
        return fmt.Errorf("cannot decode %v into a string type", vr.Type())
    }

    val.SetString(str)
    return nil
}

好的,现在让我们看看如何将这个自定义字符串解码器用于mongo.Client

clientOpts := options.Client().
    ApplyURI("mongodb://localhost:27017/").
    SetRegistry(
        bson.NewRegistryBuilder().
            RegisterDecoder(reflect.TypeOf(""), nullawareStrDecoder{}).
            Build(),
    )
client, err := mongo.Connect(ctx, clientOpts)

从现在开始,使用 this client,每当您将结果解码为值时,都会调用string这个注册的解码器来处理转换,它接受 bson值并将 Go 设置为空字符串。nullawareStrDecodernull""

但我们可以做得更好……继续阅读……

2. 处理null任何类型的值:“type-neutral”null-aware 解码器

一种方法是创建一个单独的自定义解码器,并为我们希望处理的每种类型注册它。这似乎是很多工作。

相反,我们可以(并且应该)做的是创建一个“类型中立”的自定义解码器,它只处理nulls,如果 BSON 值不是null,则应该调用默认解码器来处理非null值。

这非常简单:

type nullawareDecoder struct {
    defDecoder bsoncodec.ValueDecoder
    zeroValue  reflect.Value
}

func (d *nullawareDecoder) DecodeValue(dctx bsoncodec.DecodeContext, vr bsonrw.ValueReader, val reflect.Value) error {
    if vr.Type() != bsontype.Null {
        return d.defDecoder.DecodeValue(dctx, vr, val)
    }

    if !val.CanSet() {
        return errors.New("value not settable")
    }
    if err := vr.ReadNull(); err != nil {
        return err
    }
    // Set the zero value of val's type:
    val.Set(d.zeroValue)
    return nil
}

我们只需要弄清楚使用什么nullawareDecoder.defDecoder。为此,我们可以使用默认注册表:bson.DefaultRegistry,我们可以查找各个类型的默认解码器。凉爽的。

所以我们现在要做的是nullawareDecoder为我们想要处理nulls 的所有类型注册一个我们的值。这并不难。我们只列出我们想要的类型(或这些类型的值),我们可以通过一个简单的循环来处理所有问题:

customValues := []interface{}{
    "",       // string
    int(0),   // int
    int32(0), // int32
}

rb := bson.NewRegistryBuilder()
for _, v := range customValues {
    t := reflect.TypeOf(v)
    defDecoder, err := bson.DefaultRegistry.LookupDecoder(t)
    if err != nil {
        panic(err)
    }
    rb.RegisterDecoder(t, &nullawareDecoder{defDecoder, reflect.Zero(t)})
}

clientOpts := options.Client().
    ApplyURI("mongodb://localhost:27017/").
    SetRegistry(rb.Build())
client, err := mongo.Connect(ctx, clientOpts)

在上面的示例中,我为和注册了空感知解码器string,但是您可以根据自己的喜好扩展此列表,只需将所需类型的值添加到上面的切片中。intint32customValues


推荐阅读