带firestore结构体标签的Go结构体如何通过json.Marshal转为map

术语说明 #

你之前以“annotation”称呼的这类结构体字段标注，在Go语言中的标准术语是结构体标签（Struct Tag），它是依附在结构体字段定义后的元信息，主要用于为序列化、ORM、数据校验等逻辑提供自定义的字段映射规则和配置。

firestore标签结构体转map的实现方案 #

该需求完全可以实现，有两种常用实现方案：

• 方案一：使用Firestore官方SDK提供的序列化能力
  直接引入cloud.google.com/go/firestore包，调用其内置的Marshal方法即可直接按照firestore标签将结构体转为对应键名的map，示例代码如下：

  import "cloud.google.com/go/firestore"
  
  // 假设已经完成user实例赋值
  user := User{
      Uid: "10001",
      FcmToken: "dK1xHp7RzQw...",
  }
  dataMap, err := firestore.Marshal(user)
  // 得到的dataMap类型为map[string]interface{}，键名对应结构体上的firestore标签值：uid、fcmtoken
  

• 方案二：自行通过反射实现（无需引入Firestore依赖）
  如果你不想引入完整的Firestore SDK，可以通过Go的反射能力自行解析结构体标签实现转换，示例实现代码如下：

  import (
      "errors"
      "reflect"
      "strings"
  )
  
  func StructToFirestoreMap(v interface{}) (map[string]interface{}, error) {
      result := make(map[string]interface{})
      val := reflect.ValueOf(v)
      
      // 处理指针类型输入
      if val.Kind() == reflect.Ptr {
          if val.IsNil() {
              return nil, errors.New("input struct pointer is nil")
          }
          val = val.Elem()
      }
  
      if val.Kind() != reflect.Struct {
          return nil, errors.New("input parameter is not a struct or struct pointer")
      }
  
      structType := val.Type()
      for i := 0; i < structType.NumField(); i++ {
          field := structType.Field(i)
          firestoreTag := field.Tag.Get("firestore")
          
          // 跳过无标签、标签指定忽略的字段
          if firestoreTag == "" || firestoreTag == "-" {
              continue
          }
          
          // 处理标签中的omitempty等附加选项，仅取映射的字段名
          tagKey, _, _ := strings.Cut(firestoreTag, ",")
          if tagKey == "" {
              continue
          }
          
          // 如需处理omitempty逻辑，可在此处加判断字段是否为零值，是则跳过
          result[tagKey] = val.Field(i).Interface()
      }
  
      return result, nil
  }
  

  上述函数支持直接传入结构体或者结构体指针，返回对应的map，如有嵌套结构体、omitempty过滤等需求，可以基于上述逻辑自行扩展。

内容的提问来源于stack exchange，提问作者user17362526