如何在解组 MongoDB 文档时忽略空值？

Question

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

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

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

更改此结构中声明的类型不是一个选项，问题就在这里；在我无法完全控制的 MongoDB 数据库中，某些文档已插入空值，而最初我并不期待空值。像这样的东西：

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

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

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

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

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

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

Answer 1

问题是当前的 bson 编解码器不支持编码/解码string到/从null.

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

自定义解码器由类型描述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值时，nullawareStrDecoder将调用此注册的解码器来处理转换，它接受 bsonnull值并设置 Go 空字符串""。

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

2. 处理null任何类型的值：“类型中立”空感知解码器

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

我们可以（并且应该）做的是创建一个单独的“类型中立”自定义解码器，null它只处理s，如果 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为我们要处理null的所有类型注册一个值。这并不难。我们只列出我们想要的类型（或这些类型的值），我们可以用一个简单的循环来处理所有事情：

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,int和注册了空感知解码器int32，但是您可以根据自己的喜好扩展此列表，只需将所需类型的值添加到customValues上面的切片即可。