Golang : Struct field tags and what is their purpose?
Got a curious question asked by a colleague today on what's the purpose on field tags inside a struct. For the uninitiated, field tags look like this :
type Employee struct {
Name string `json:"name" xml:"name"`
Age int `json:"age,omitempty" xml:"age,omitempty"`
}
the [json:"name" xml:"name"] is what a Golang programmer refer to field tags.
Basically, it is a form of meta-data that instruct your software on how to handle data fields inside the structure during compile-time or runtime. For the example code above, the instruction is to map the Name and Age data fields to their equivalent field names should the program generate JSON or XML files. The tag instruction omitempty
instruct the JSON or XML code generated to ignore the empty data fields should the Age field is empty.
Apart from the most common field tags for JSON and XML. You may encounter the schema
field tags use by http://godoc.org/github.com/gorilla/schema or the datastore
field tags - used by Google App Engine.
See also : Golang : When to use init() function?
By Adam Ng
IF you gain some knowledge or the information here solved your programming problem. Please consider donating to the less fortunate or some charities that you like. Apart from donation, planting trees, volunteering or reducing your carbon footprint will be great too.
Advertisement
Tutorials
+5.4k WARNING: UNPROTECTED PRIVATE KEY FILE! error message
+11.3k Golang : Remove or trim extra comma from CSV
+13.2k Golang : Overwrite previous output with count down timer
+7k Golang : Add build version and other information in executables
+8.4k Golang : Quadratic example
+20.4k Golang : Convert seconds to minutes and remainder seconds
+9.4k Golang : Flip coin example
+8.2k Golang : How to control fmt or log print format?
+38.8k Golang : How do I convert int to uint8?
+44.3k Golang : Marshal and unmarshal json.RawMessage struct example
+4.4k Unix/Linux/MacOSx : How to remove an environment variable ?