Как вывести список неизвестных полей после разбора json - PullRequest
0 голосов
/ 06 марта 2019

Представьте, что у нас есть следующие структуры 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 голосов
/ 13 марта 2019

Не уверен, что это лучший способ, но я сделал следующее:

  1. Если тип текущего уровня - карта:

    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

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...