Удаление полей из структуры или их скрытие в JSON-ответе в Go

Проблема и её контекст

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

Решение 1: Использование json:",omitempty" и нулевых значений

Самый простой способ — пометить поле тегом omitempty. Если поле имеет нулевое значение для своего типа (пустая строка для string, 0 для int, false для bool, nil для указателей), оно будет исключено из JSON.

type User struct {
    ID       int     `json:"id"`
    Username string  `json:"username"`
    Email    string  `json:"email"`
    Password string  `json:"password,omitempty"` // скрыто, если пустая строка
    Role     string  `json:"role,omitempty"`     // скрыто, если пустая строка
}

Теперь, если вы не заполните Password или Role (оставите пустые строки), они не попадут в JSON. Для админа вы можете заполнить эти поля, и они будут включены.

Минус: Если поле Password может быть пустым по логике приложения (например, пользователь не задал пароль), то omitempty не даст отличить "нет значения" от "значение пусто".

Решение 2: Использование указателей (лучший подход)

Используйте указатели на типы (*string, *int и т.д.). Если указатель равен nil, поле не будет включено в JSON. Это позволяет явно контролировать наличие поля.

type User struct {
    ID       int     `json:"id"`
    Username string  `json:"username"`
    Email    string  `json:"email"`
    Password *string `json:"password,omitempty"` // nil — не включать
    Role     *string `json:"role,omitempty"`     // nil — не включать
}

При создании ответа для обычного пользователя:

user := User{
    ID:       1,
    Username: "ivan",
    Email:    "ivan@example.com",
    // Password и Role остаются nil — не попадут в JSON
}
jsonData, _ := json.Marshal(user)
// {"id":1,"username":"ivan","email":"ivan@example.com"}

Для админа:

password := "secret123"
role := "admin"
user := User{
    ID:       1,
    Username: "ivan",
    Email:    "ivan@example.com",
    Password: &password,
    Role:     &role,
}
jsonData, _ := json.Marshal(user)
// {"id":1,"username":"ivan","email":"ivan@example.com","password":"secret123","role":"admin"}

Решение 3: Кастомная сериализация через интерфейс json.Marshaler

Если вам нужна сложная логика (например, скрыть поле Role для роли "user", но показать для "admin"), реализуйте интерфейс json.Marshaler:

type User struct {
    ID       int    `json:"id"`
    Username string `json:"username"`
    Email    string `json:"email"`
    Password string `json:"-"`
    Role     string `json:"-"`
    isAdmin  bool   // внутреннее поле, не сериализуется
}

func (u User) MarshalJSON() ([]byte, error) {
    // Создаём временную карту или структуру
    m := map[string]interface{}{
        "id":       u.ID,
        "username": u.Username,
        "email":    u.Email,
    }
    if u.isAdmin {
        m["password"] = u.Password
        m["role"] = u.Role
    }
    return json.Marshal(m)
}

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

• Для простых случаев — используйте omitempty с указателями (Решение 2). Это идиоматично и читаемо.
• Для сложной логики — реализуйте MarshalJSON (Решение 3).
• Избегайте создания отдельных структур для каждого варианта — это приводит к дублированию и ошибкам.

Также обратите внимание: в Go принято не сериализовать чувствительные данные (пароли) вообще. Лучше хранить их в отдельной структуре или вообще не возвращать через API.

type UserBase struct {
    ID       int    `json:"id"`
    Username string `json:"username"`
    Email    string `json:"email"`
}

type UserPublic struct {
    UserBase
    // только публичные поля
}

type UserAdmin struct {
    UserBase
    Password string `json:"password"`
    Role     string `json:"role"`
}

func ToPublicUser(u User) UserPublic {
    return UserPublic{UserBase: u.UserBase}
}

func ToAdminUser(u User) UserAdmin {
    return UserAdmin{
        UserBase: u.UserBase,
        Password: u.Password,
        Role:     u.Role,
    }
}