从结构中删除字段或将其隐藏在JSON响应中

我已经在Go中创建了一个API，该API在被调用后会执行查询，创建一个结构实例，然后将该结构编码为JSON，然后再发送回调用方。现在，我希望允许调用者通过传递“字段” GET参数来选择他们想要返回的特定字段。

这意味着根据字段值，我的结构将发生变化。有什么方法可以从结构中删除字段？或者至少将它们动态隐藏在JSON响应中？（注意：有时我有空值，因此JSON omitEmpty标记在这里不起作用）如果这两种方法都不可行，是否有更好的处理方法的建议？提前致谢。

我正在使用的结构的较小版本如下：

type SearchResult struct {
    Date        string      `json:"date"`
    IdCompany   int         `json:"idCompany"`
    Company     string      `json:"company"`
    IdIndustry  interface{} `json:"idIndustry"`
    Industry    string      `json:"industry"`
    IdContinent interface{} `json:"idContinent"`
    Continent   string      `json:"continent"`
    IdCountry   interface{} `json:"idCountry"`
    Country     string      `json:"country"`
    IdState     interface{} `json:"idState"`
    State       string      `json:"state"`
    IdCity      interface{} `json:"idCity"`
    City        string      `json:"city"`
} //SearchResult

type SearchResults struct {
    NumberResults int            `json:"numberResults"`
    Results       []SearchResult `json:"results"`
} //type SearchResults

然后，我像这样编码并输出响应：

err := json.NewEncoder(c.ResponseWriter).Encode(&msg)

编辑：我注意到一些不赞成票，并再次查看了此问答。大多数人似乎错过了OP要求根据呼叫者提供的字段列表动态选择字段的想法。您不能使用静态定义的json struct标签执行此操作。

如果你想要的是总是跳过场JSON编码，那么当然使用json:"-"忽略场（也注意到，这是不是如果你的领域不导出必需的-这些领域始终由JSON编码器忽略）。但这不是OP的问题。

引用对json:"-"答案的评论：

这个[ json:"-"答案]是大多数到这里搜索的人都想要的答案，但这不是问题的答案。

在这种情况下，我将使用map [string] interface {}而不是结构。您可以通过调用delete地图上的内置字段来轻松删除字段。

也就是说，如果您不能仅首先查询所请求的字段。

使用`json：“-”`

// Field is ignored by this package.
Field int `json:"-"`

// Field appears in JSON as key "myName".
Field int `json:"myName"`

// Field appears in JSON as key "myName" and
// the field is omitted from the object if its value is empty,
// as defined above.
Field int `json:"myName,omitempty"`

// Field appears in JSON as key "Field" (the default), but
// the field is skipped if empty.
// Note the leading comma.
Field int `json:",omitempty"`

doc：http：//golang.org/pkg/encoding/json/#Marshal

另一种方法是使用带有标记的指针结构,omitempty。如果指针为nil，则不会将字段编组。

这种方法不需要额外的反射或地图的低效使用。

与jorelli使用此方法的示例相同：http ://play.golang.org/p/JJNa0m2_nw

您可以reflect通过在字段标签上反映并选择json标签值，使用该包来选择所需的字段。定义您SearchResult所的方法键入选择你想要的领域，将它们作为一个map[string]interface{}，然后元帅说，而不是SearchResult所结构本身。这是如何定义该方法的示例：

func fieldSet(fields ...string) map[string]bool {
    set := make(map[string]bool, len(fields))
    for _, s := range fields {
        set[s] = true
    }
    return set
}

func (s *SearchResult) SelectFields(fields ...string) map[string]interface{} {
    fs := fieldSet(fields...)
    rt, rv := reflect.TypeOf(*s), reflect.ValueOf(*s)
    out := make(map[string]interface{}, rt.NumField())
    for i := 0; i < rt.NumField(); i++ {
        field := rt.Field(i)
        jsonKey := field.Tag.Get("json")
        if fs[jsonKey] {
            out[jsonKey] = rv.Field(i).Interface()
        }
    }
    return out
}

这是一个可运行的解决方案，显示了如何调用此方法并整理您的选择：http : //play.golang.org/p/1K9xjQRnO8

我刚刚发布了sheriff，它根据在struct字段上标注的标签将结构转换为地图。然后，您可以封送（JSON或其他）生成的地图。它可能不允许您仅序列化调用方请求的字段集，但我想使用一组组将使您涵盖大多数情况。直接使用组代替字段将最有可能增加缓存能力。

例：

package main

import (
    "encoding/json"
    "fmt"
    "log"

    "github.com/hashicorp/go-version"
    "github.com/liip/sheriff"
)

type User struct {
    Username string   `json:"username" groups:"api"`
    Email    string   `json:"email" groups:"personal"`
    Name     string   `json:"name" groups:"api"`
    Roles    []string `json:"roles" groups:"api" since:"2"`
}

func main() {
    user := User{
        Username: "alice",
        Email:    "alice@example.org",
        Name:     "Alice",
        Roles:    []string{"user", "admin"},
    }

    v2, err := version.NewVersion("2.0.0")
    if err != nil {
        log.Panic(err)
    }

    o := &sheriff.Options{
        Groups:     []string{"api"},
        ApiVersion: v2,
    }

    data, err := sheriff.Marshal(o, user)
    if err != nil {
        log.Panic(err)
    }

    output, err := json.MarshalIndent(data, "", "  ")
    if err != nil {
        log.Panic(err)
    }
    fmt.Printf("%s", output)
}

采取三种成分：

1. 该reflect程序包遍历结构的所有字段。

2. 一种if说法拿起你想要的字段Marshal，以及

3. 该encoding/json包Marshal你喜欢的领域。

制备：

1. 将它们按适当比例混合。使用reflect.TypeOf(your_struct).Field(i).Name()得到的名字i的日场your_struct。

2. 使用reflect.ValueOf(your_struct).Field(i)得到一个类型Value的代表性i的日场your_struct。

3. 使用fieldValue.Interface()检索实际值（upcasted到类型接口{}）的fieldValue类型的Value（注意支架使用-所述接口（）方法产生interface{}

如果幸运的是在此过程中没有烧毁任何晶体管或断路器，则应该得到以下信息：

func MarshalOnlyFields(structa interface{},
    includeFields map[string]bool) (jsona []byte, status error) {
    value := reflect.ValueOf(structa)
    typa := reflect.TypeOf(structa)
    size := value.NumField()
    jsona = append(jsona, '{')
    for i := 0; i < size; i++ {
        structValue := value.Field(i)
        var fieldName string = typa.Field(i).Name
        if marshalledField, marshalStatus := json.Marshal((structValue).Interface()); marshalStatus != nil {
            return []byte{}, marshalStatus
        } else {
            if includeFields[fieldName] {
                jsona = append(jsona, '"')
                jsona = append(jsona, []byte(fieldName)...)
                jsona = append(jsona, '"')
                jsona = append(jsona, ':')
                jsona = append(jsona, (marshalledField)...)
                if i+1 != len(includeFields) {
                    jsona = append(jsona, ',')
                }
            }
        }
    }
    jsona = append(jsona, '}')
    return
}

服务：

例如，使用任意结构和map[string]bool您要包含的字段

type magic struct {
    Magic1 int
    Magic2 string
    Magic3 [2]int
}

func main() {
    var magic = magic{0, "tusia", [2]int{0, 1}}
    if json, status := MarshalOnlyFields(magic, map[string]bool{"Magic1": true}); status != nil {
        println("error")
    } else {
        fmt.Println(string(json))
    }

}

祝您好胃口！

您可以使用标记属性“ omitifempty”，也可以使用可选的字段指针，并保留要跳过的字段未初始化。

我也遇到了这个问题，起初我只是想在我的http处理程序中专门化响应。我的第一种方法是创建一个程序包，将一个结构的信息复制到另一个结构，然后封送该第二个结构。我使用反射来完成该程序包，因此，从不喜欢这种方法，而且我也不是动态的。

所以我决定修改encoding / json包来做到这一点。的功能Marshal，MarshalIndent并(Encoder) Encode另外获得一个

type F map[string]F

我想模拟封送所需的字段的JSON，因此它仅封送地图中的字段。

https://github.com/JuanTorr/jsont

package main

import (
    "fmt"
    "log"
    "net/http"

    "github.com/JuanTorr/jsont"
)

type SearchResult struct {
    Date        string      `json:"date"`
    IdCompany   int         `json:"idCompany"`
    Company     string      `json:"company"`
    IdIndustry  interface{} `json:"idIndustry"`
    Industry    string      `json:"industry"`
    IdContinent interface{} `json:"idContinent"`
    Continent   string      `json:"continent"`
    IdCountry   interface{} `json:"idCountry"`
    Country     string      `json:"country"`
    IdState     interface{} `json:"idState"`
    State       string      `json:"state"`
    IdCity      interface{} `json:"idCity"`
    City        string      `json:"city"`
} //SearchResult

type SearchResults struct {
    NumberResults int            `json:"numberResults"`
    Results       []SearchResult `json:"results"`
} //type SearchResults
func main() {
    msg := SearchResults{
        NumberResults: 2,
        Results: []SearchResult{
            {
                Date:        "12-12-12",
                IdCompany:   1,
                Company:     "alfa",
                IdIndustry:  1,
                Industry:    "IT",
                IdContinent: 1,
                Continent:   "america",
                IdCountry:   1,
                Country:     "México",
                IdState:     1,
                State:       "CDMX",
                IdCity:      1,
                City:        "Atz",
            },
            {
                Date:        "12-12-12",
                IdCompany:   2,
                Company:     "beta",
                IdIndustry:  1,
                Industry:    "IT",
                IdContinent: 1,
                Continent:   "america",
                IdCountry:   2,
                Country:     "USA",
                IdState:     2,
                State:       "TX",
                IdCity:      2,
                City:        "XYZ",
            },
        },
    }
    fmt.Println(msg)
    http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {

        //{"numberResults":2,"results":[{"date":"12-12-12","idCompany":1,"idIndustry":1,"country":"México"},{"date":"12-12-12","idCompany":2,"idIndustry":1,"country":"USA"}]}
        err := jsont.NewEncoder(w).Encode(msg, jsont.F{
            "numberResults": nil,
            "results": jsont.F{
                "date":       nil,
                "idCompany":  nil,
                "idIndustry": nil,
                "country":    nil,
            },
        })
        if err != nil {
            log.Fatal(err)
        }
    })

    http.ListenAndServe(":3009", nil)
}

现在的问题有点老了，但是前一阵子我遇到了同样的问题，而且由于我发现没有简便的方法可以实现此目的，因此我建立了一个库。它允许轻松地map[string]interface{}从静态结构生成a 。

https://github.com/tuvistavie/structomap

我没有相同的问题，但相似。下面的代码也可以解决您的问题，当然，如果您不介意性能问题。在对系统实施这种解决方案之前，我建议您尽可能重新设计结构。发送可变结构响应是过度设计。我相信响应结构代表了请求和资源之间的契约，它不应该是依赖请求。（我可以将不需要的字段设为null。在某些情况下，我们必须实施此设计，如果您认为自己在这种情况下，这里是我使用的播放链接和代码。

type User2 struct {
    ID       int    `groups:"id" json:"id,omitempty"`
    Username string `groups:"username" json:"username,omitempty"`
    Nickname string `groups:"nickname" json:"nickname,omitempty"`
}

type User struct {
    ID       int    `groups:"private,public" json:"id,omitempty"`
    Username string `groups:"private" json:"username,omitempty"`
    Nickname string `groups:"public" json:"nickname,omitempty"`
}

var (
    tagName = "groups"
)

//OmitFields sets fields nil by checking their tag group value and access control tags(acTags)
func OmitFields(obj interface{}, acTags []string) {
    //nilV := reflect.Value{}
    sv := reflect.ValueOf(obj).Elem()
    st := sv.Type()
    if sv.Kind() == reflect.Struct {
        for i := 0; i < st.NumField(); i++ {
            fieldVal := sv.Field(i)
            if fieldVal.CanSet() {
                tagStr := st.Field(i).Tag.Get(tagName)
                if len(tagStr) == 0 {
                    continue
                }
                tagList := strings.Split(strings.Replace(tagStr, " ", "", -1), ",")
                //fmt.Println(tagList)
                // ContainsCommonItem checks whether there is at least one common item in arrays
                if !ContainsCommonItem(tagList, acTags) {
                    fieldVal.Set(reflect.Zero(fieldVal.Type()))
                }
            }
        }
    }
}

//ContainsCommonItem checks if arrays have at least one equal item
func ContainsCommonItem(arr1 []string, arr2 []string) bool {
    for i := 0; i < len(arr1); i++ {
        for j := 0; j < len(arr2); j++ {
            if arr1[i] == arr2[j] {
                return true
            }
        }
    }
    return false
}
func main() {
    u := User{ID: 1, Username: "very secret", Nickname: "hinzir"}
    //assume authenticated user doesn't has permission to access private fields
    OmitFields(&u, []string{"public"}) 
    bytes, _ := json.Marshal(&u)
    fmt.Println(string(bytes))


    u2 := User2{ID: 1, Username: "very secret", Nickname: "hinzir"}
    //you want to filter fields by field names
    OmitFields(&u2, []string{"id", "nickname"}) 
    bytes, _ = json.Marshal(&u2)
    fmt.Println(string(bytes))

}

我创建了此函数，以通过忽略某些字段将结构转换为JSON字符串。希望会有所帮助。

func GetJSONString(obj interface{}, ignoreFields ...string) (string, error) {
    toJson, err := json.Marshal(obj)
    if err != nil {
        return "", err
    }

    if len(ignoreFields) == 0 {
        return string(toJson), nil
    }

    toMap := map[string]interface{}{}
    json.Unmarshal([]byte(string(toJson)), &toMap)

    for _, field := range ignoreFields {
        delete(toMap, field)
    }

    toJson, err = json.Marshal(toMap)
    if err != nil {
        return "", err
    }
    return string(toJson), nil
}

示例：https：//play.golang.org/p/nmq7MFF47Gp