Как скрыть поля структуры при сериализации в JSON в Go?

Использование тегов JSON для скрытия полей

В Go для управления сериализацией структур в JSON используются теги полей. Чтобы скрыть поле при выводе в JSON, нужно указать тег json:"-". Поле останется в структуре, но не будет включено в JSON-вывод.

type User struct {
    ID         int    `json:"id"`
    Name       string `json:"name"`
    Email      string `json:"email"`
    Password   string `json:"-"`
    InternalID string `json:"-"`
}

func main() {
    user := User{
        ID: 1,
        Name: "Иван",
        Email: "ivan@example.com",
        Password: "secret123",
        InternalID: "int-001",
    }

    jsonData, _ := json.Marshal(user)
    fmt.Println(string(jsonData))
    // Выводит: {"id":1,"name":"Иван","email":"ivan@example.com"}
}

Создание отдельной структуры для ответа

Если вам нужно гибко управлять набором полей для разных ситуаций, лучше создать отдельную структуру для JSON-ответа:

type User struct {
    ID         int
    Name       string
    Email      string
    Password   string
    InternalID string
}

type UserResponse struct {
    ID    int    `json:"id"`
    Name  string `json:"name"`
    Email string `json:"email"`
}

func (u *User) ToResponse() UserResponse {
    return UserResponse{
        ID:    u.ID,
        Name:  u.Name,
        Email: u.Email,
    }
}

func main() {
    user := User{
        ID: 1,
        Name: "Иван",
        Email: "ivan@example.com",
        Password: "secret123",
        InternalID: "int-001",
    }

    jsonData, _ := json.Marshal(user.ToResponse())
    fmt.Println(string(jsonData))
    // Выводит: {"id":1,"name":"Иван","email":"ivan@example.com"}
}

Использование пустых интерфейсов и динамических структур

Для более сложных случаев можно использовать map[string]interface{} или структуры с тегами omitempty:

type User struct {
    ID         int    `json:"id"`
    Name       string `json:"name,omitempty"`
    Email      string `json:"email,omitempty"`
    Password   string `json:"password,omitempty"`
    InternalID string `json:"internal_id,omitempty"`
}

// Поле будет включено только если его значение не равно нулевому для типа
// Для строк omitempty пропускает пустые строки

Кастомная сериализация через интерфейс Marshaler

Самый гибкий способ — реализовать интерфейс json.Marshaler:

type User struct {
    ID         int
    Name       string
    Email      string
    Password   string
    InternalID string
}

func (u User) MarshalJSON() ([]byte, error) {
    return json.Marshal(struct {
        ID    int    `json:"id"`
        Name  string `json:"name"`
        Email string `json:"email"`
    }{
        ID:    u.ID,
        Name:  u.Name,
        Email: u.Email,
    })
}

func main() {
    user := User{
        ID: 1,
        Name: "Иван",
        Email: "ivan@example.com",
        Password: "secret123",
        InternalID: "int-001",
    }

    jsonData, _ := json.Marshal(user)
    fmt.Println(string(jsonData))
    // Выводит: {"id":1,"name":"Иван","email":"ivan@example.com"}
}

Рекомендации

• Для простых случаев используйте тег json:"-" — это самый лаконичный способ.
• Для разных представлений (админ, пользователь, публичный) создавайте отдельные структуры ответа.
• Для сложной логики используйте кастомную реализацию MarshalJSON.
• Избегайте использования пустых интерфейсов без необходимости — это снижает производительность и типобезопасность.

Выберите подход, который лучше всего подходит для вашей задачи. В большинстве случаев достаточно тега json:"-" или отдельной структуры ответа.

type BaseUser struct {
    ID    int    `json:"id"`
    Name  string `json:"name"`
    Email string `json:"email"`
}

type User struct {
    BaseUser
    Password   string `json:"-"`
    InternalID string `json:"-"`
}

func main() {
    user := User{
        BaseUser: BaseUser{
            ID: 1,
            Name: "Иван",
            Email: "ivan@example.com",
        },
        Password: "secret123",
        InternalID: "int-001",
    }

    jsonData, _ := json.Marshal(user)
    fmt.Println(string(jsonData))
    // Выводит: {"id":1,"name":"Иван","email":"ivan@example.com"}
}

type User struct {
    BaseUser
    Password   string `json:"password,omitempty"`
    InternalID string `json:"internal_id,omitempty"`
}