Việc sử dụng cho các thẻ trong Go là gì?

Trong Đặc tả ngôn ngữ Go , nó đề cập đến một tổng quan ngắn gọn về các thẻ:

Một khai báo trường có thể được theo sau bởi một chuỗi ký tự chuỗi tùy chọn, trở thành một thuộc tính cho tất cả các trường trong khai báo trường tương ứng. Các thẻ được hiển thị thông qua một giao diện phản chiếu nhưng bị bỏ qua.

// A struct corresponding to the TimeStamp protocol buffer.
// The tag strings define the protocol buffer field numbers.
struct {
  microsec  uint64 "field 1"
  serverIP6 uint64 "field 2"
  process   string "field 3"
}

Đây là một lời giải thích rất ngắn IMO, và tôi đã tự hỏi liệu có ai có thể cung cấp cho tôi những gì sử dụng các thẻ này không?

Thẻ cho một trường cho phép bạn đính kèm thông tin meta vào trường có thể thu được bằng phản xạ. Thông thường, nó được sử dụng để cung cấp thông tin chuyển đổi về cách trường cấu trúc được mã hóa hoặc giải mã từ định dạng khác (hoặc được lưu trữ / truy xuất từ ​​cơ sở dữ liệu), nhưng bạn có thể sử dụng nó để lưu trữ bất kỳ thông tin meta nào bạn muốn, hoặc dành cho mục đích khác gói hoặc để sử dụng của riêng bạn.

Như đã đề cập trong tài liệu về reflect.StructTag, theo quy ước, giá trị của chuỗi thẻ là một danh sách các key:"value"cặp được phân tách bằng dấu cách , ví dụ:

type User struct {
    Name string `json:"name" xml:"name"`
}

Các keythường biểu thị các gói mà sau này "value"là dành cho, ví dụ như jsoncác phím được chế biến / sử dụng bởi các encoding/jsongói.

Nếu nhiều thông tin được truyền vào "value", thông thường nó được chỉ định bằng cách tách nó bằng dấu phẩy ( ','), vd

Name string `json:"name,omitempty" xml:"name"`

Thông thường một giá trị dấu gạch ngang ( '-') cho "value"phương tiện để loại trừ trường khỏi quy trình (ví dụ: trong trường hợp của jsonnó có nghĩa là không soái ca hoặc không thống nhất trường đó).

Ví dụ về việc truy cập các thẻ tùy chỉnh của bạn bằng cách sử dụng sự phản chiếu

Chúng ta có thể sử dụng sự phản chiếu ( reflectgói) để truy cập các giá trị thẻ của các trường cấu trúc. Về cơ bản chúng ta cần có được Typecấu trúc của chúng ta, và sau đó chúng ta có thể truy vấn các trường, ví dụ như với Type.Field(i int)hoặc Type.FieldByName(name string). Các phương thức này trả về một giá trị trong StructFieldđó mô tả / đại diện cho một trường cấu trúc; và StructField.Taglà một giá trị của loại StructTagmô tả / đại diện cho một giá trị thẻ.

Trước đây chúng ta đã nói về "quy ước" . Công ước này có nghĩa rằng nếu bạn làm theo nó, bạn có thể sử dụng các StructTag.Get(key string)phương pháp mà phân tích giá trị của thẻ và trả về cho bạn những "value"của keybạn chỉ định. Quy ước được thực hiện / xây dựng theo Get()phương pháp này . Nếu bạn không tuân theo quy ước, Get()sẽ không thể phân tích key:"value"các cặp và tìm thấy những gì bạn đang tìm kiếm. Đó cũng không phải là vấn đề, nhưng sau đó bạn cần thực hiện logic phân tích cú pháp của riêng mình.

Ngoài ra, còn có StructTag.Lookup()(đã được thêm vào trong Mục 1.7), "giống như Get()nhưng phân biệt thẻ không chứa khóa đã cho với thẻ liên kết một chuỗi trống với khóa đã cho" .

Vì vậy, hãy xem một ví dụ đơn giản:

type User struct {
    Name  string `mytag:"MyName"`
    Email string `mytag:"MyEmail"`
}

u := User{"Bob", "bob@mycompany.com"}
t := reflect.TypeOf(u)

for _, fieldName := range []string{"Name", "Email"} {
    field, found := t.FieldByName(fieldName)
    if !found {
        continue
    }
    fmt.Printf("\nField: User.%s\n", fieldName)
    fmt.Printf("\tWhole tag value : %q\n", field.Tag)
    fmt.Printf("\tValue of 'mytag': %q\n", field.Tag.Get("mytag"))
}

Đầu ra (thử trên Sân chơi Go ):

Field: User.Name
    Whole tag value : "mytag:\"MyName\""
    Value of 'mytag': "MyName"

Field: User.Email
    Whole tag value : "mytag:\"MyEmail\""
    Value of 'mytag': "MyEmail"

GopherCon 2015 đã có một bài thuyết trình về các thẻ struct được gọi là:

Nhiều mặt của thẻ cấu trúc (slide) (và video )

Dưới đây là danh sách các khóa thẻ thường được sử dụng:

• json     - được sử dụng bởi encoding/jsongói, chi tiết tạijson.Marshal()
• xml      - được sử dụng bởi encoding/xmlgói, chi tiết tạixml.Marshal()
• bson     - được sử dụng bởi gobson , chi tiết tạibson.Marshal()
• protobuf - được sử dụng bởi github.com/golang/protobuf/proto, chi tiết trong tài liệu gói
• yaml     - được sử dụng bởi gopkg.in/yaml.v2gói, chi tiết tạiyaml.Marshal()
• db       - được sử dụng bởi github.com/jmoiron/sqlxgói; cũng được sử dụng bởi github.com/go-gorp/gorpgói
• orm      - được sử dụng bởi github.com/astaxie/beego/ormgói, chi tiết tại Mô hình - Beego ORM
• gorm     - được sử dụng bởi github.com/jinzhu/gormgói, các ví dụ có thể được tìm thấy trong tài liệu của họ: Mô hình
• valid    - được sử dụng bởi github.com/asaskevich/govalidatorgói, các ví dụ có thể được tìm thấy trong trang dự án
• datastore- được sử dụng bởi appengine/datastore(nền tảng Google App Engine, dịch vụ kho dữ liệu), chi tiết tại Thuộc tính
• schema   - được sử dụng github.com/gorilla/schemađể điền vào một structgiá trị biểu mẫu HTML, được nêu chi tiết trong tài liệu gói
• asn      - được sử dụng bởi encoding/asn1gói, chi tiết tại asn1.Marshal()vàasn1.Unmarshal()
• csv      - được sử dụng bởi github.com/gocarina/gocsvgói

Dưới đây là một ví dụ thực sự đơn giản về các thẻ được sử dụng cùng với encoding/jsongói để kiểm soát cách các trường được diễn giải trong quá trình mã hóa và giải mã:

Thử trực tiếp: http://play.golang.org/p/BMeR8p1cKf

package main

import (
    "fmt"
    "encoding/json"
)

type Person struct {
    FirstName  string `json:"first_name"`
    LastName   string `json:"last_name"`
    MiddleName string `json:"middle_name,omitempty"`
}

func main() {
    json_string := `
    {
        "first_name": "John",
        "last_name": "Smith"
    }`

    person := new(Person)
    json.Unmarshal([]byte(json_string), person)
    fmt.Println(person)

    new_json, _ := json.Marshal(person)
    fmt.Printf("%s\n", new_json)
}

// *Output*
// &{John Smith }
// {"first_name":"John","last_name":"Smith"}

Gói json có thể xem các thẻ cho trường và được cho biết cách ánh xạ json <=> trường cấu trúc và các tùy chọn bổ sung như liệu nó có nên bỏ qua các trường trống khi nối tiếp trở lại json không.

Về cơ bản, bất kỳ gói nào cũng có thể sử dụng sự phản chiếu trên các trường để xem xét các giá trị thẻ và hành động theo các giá trị đó. Có thêm một chút thông tin về chúng trong gói phản ánh
http://golang.org/pkg/reflect/#SturationTag :

Theo quy ước, các chuỗi thẻ là sự kết hợp của các cặp khóa được phân tách bằng không gian tùy chọn: các cặp "giá trị". Mỗi khóa là một chuỗi không trống bao gồm các ký tự không điều khiển khác với khoảng trắng (U + 0020 ''), trích dẫn (U + 0022 '"') và dấu hai chấm (U + 003A ':'). Mỗi giá trị được trích dẫn sử dụng các ký tự U + 0022 '"và cú pháp chuỗi ký tự.

Đó là một số loại thông số kỹ thuật chỉ định cách các gói xử lý với một trường được gắn thẻ.

ví dụ:

type User struct {
    FirstName string `json:"first_name"`
    LastName string `json:"last_name"`
}

thẻ json thông báo jsongói mà đầu ra được sắp xếp theo thứ tự của người dùng sau

u := User{
        FirstName: "some first name",
        LastName:  "some last name",
    }

sẽ như thế này:

{"first_name":"some first name","last_name":"some last name"}

ví dụ khác là các gormgói gói khai báo cách di chuyển cơ sở dữ liệu phải được thực hiện:

type User struct {
  gorm.Model
  Name         string
  Age          sql.NullInt64
  Birthday     *time.Time
  Email        string  `gorm:"type:varchar(100);unique_index"`
  Role         string  `gorm:"size:255"` // set field size to 255
  MemberNumber *string `gorm:"unique;not null"` // set member number to unique and not null
  Num          int     `gorm:"AUTO_INCREMENT"` // set num to auto incrementable
  Address      string  `gorm:"index:addr"` // create index with name `addr` for address
  IgnoreMe     int     `gorm:"-"` // ignore this field
}

Trong ví dụ này cho trường Emailcó thẻ gorm, chúng tôi tuyên bố rằng cột tương ứng trong cơ sở dữ liệu cho email trường phải có kiểu varchar và 100 độ dài tối đa và nó cũng phải có chỉ mục duy nhất.

ví dụ khác là bindingcác thẻ được sử dụng chủ yếu trong gingói.

type Login struct {
    User     string `form:"user" json:"user" xml:"user"  binding:"required"`
    Password string `form:"password" json:"password" xml:"password" binding:"required"`
}


var json Login
if err := c.ShouldBindJSON(&json); err != nil {
     c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
     return
}

thẻ ràng buộc trong ví dụ này đưa ra gợi ý cho gói gin rằng dữ liệu được gửi tới API phải có các trường người dùng và mật khẩu vì các trường này được gắn thẻ theo yêu cầu.

Vì vậy, thẻ tổng quát là dữ liệu mà các gói yêu cầu phải biết cách xử lý với dữ liệu của các loại cấu trúc khác nhau và cách tốt nhất để làm quen với các thẻ mà gói cần là ĐỌC TÀI LIỆU GÓI HOÀN TOÀN.