json解析后如何列出未知字段

时间:2019-03-06 17:50:40

标签: json go go-reflect

假设我们有以下Go结构:

type Config struct {
    Name   string  `json:"name,omitempty"`
    Params []Param `json:"params,omitempty"`
}

type Param struct {
    Name  string `json:"name,omitempty"`
    Value string `json:"value,omitempty"`
}

和以下json:

{
    "name": "parabolic",
    "subdir": "pb",
    "params": [{
        "name": "input",
        "value": "in.csv"
    }, {
        "name": "output",
        "value": "out.csv",
        "tune": "fine"
    }]
}

我们将进行编组:

cfg := Config{}
if err := json.Unmarshal([]byte(cfgString), &cfg); err != nil {
    log.Fatalf("Error unmarshalling json: %v", err)
}
fmt.Println(cfg)

https://play.golang.org/p/HZgo0jxbQrp

输出为{parabolic [{input in.csv} {output out.csv}]},这很有意义-未知字段被忽略。

问题:如何找出哪些字段被忽略?

getIgnoredFields(cfg, cfgString)将返回["subdir", "params[1].tune"]

(有一个DisallowUnknownFields选项,但有所不同:此选项会导致Unmarshal错误,而问题是如何仍然解析JSON而没有错误并找出忽略了哪些字段)

1 个答案:

答案 0 :(得分:0)

不确定这是否是最好的方法,但是我所做的是:

  1. 如果当前级别的类型是map:

    1. 检查所有映射键是否已知。
      • 键可能是结构字段名称还是映射键。
      • 如果未知-添加到未知字段列表中
    2. 递归重复与每个键对应的值
  2. 如果当前级别类型为数组:

    1. 为每个元素递归运行

代码:

// ValidateUnknownFields checks that provided json
// matches provided struct. If that is not the case
// list of unknown fields is returned.
func ValidateUnknownFields(jsn []byte, strct interface{}) ([]string, error) {
    var obj interface{}
    err := json.Unmarshal(jsn, &obj)
    if err != nil {
        return nil, fmt.Errorf("error while unmarshaling json: %v", err)
    }
    return checkUnknownFields("", obj, reflect.ValueOf(strct)), nil
}

func checkUnknownFields(keyPref string, jsn interface{}, strct reflect.Value) []string {
    var uf []string
    switch concreteVal := jsn.(type) {
    case map[string]interface{}:
        // Iterate over map and check every value
        for field, val := range concreteVal {
            fullKey := fmt.Sprintf("%s.%s", keyPref, field)
            subStrct := getSubStruct(field, strct)
            if !subStrct.IsValid() {
                uf = append(uf, fullKey[1:])
            } else {
                subUf := checkUnknownFields(fullKey, val, subStrct)
                uf = append(uf, subUf...)
            }
        }
    case []interface{}:
        for i, val := range concreteVal {
            fullKey := fmt.Sprintf("%s[%v]", keyPref, i)
            subStrct := strct.Index(i)
            uf = append(uf, checkUnknownFields(fullKey, val, subStrct)...)
        }
    }
    return uf
}

完整版本:https://github.com/yb172/json-unknown/blob/master/validator.go