Какие должны быть параметры у класса для того, чтобы Hibernate его использовал

Требования к классу для использования Hibernate

Для того чтобы Hibernate мог работать с классом и преобразовывать его в таблицу базы данных, класс должен соответствовать определённым параметрам и правилам. Это либо аннотации JPA/Hibernate, либо XML конфигурация.

Обязательные требования

1. Аннотация @Entity

Класс должен быть помечен аннотацией @Entity из пакета javax.persistence или jakarta.persistence:

import javax.persistence.Entity;
import javax.persistence.Table;

@Entity
@Table(name = "users") // опционально, если имя отличается от имени класса
public class User {
    // поля и методы
}

Эта аннотация говорит Hibernate, что класс является сущностью (entity) и должен быть отображен на таблицу БД.

2. Аннотация @Id

Класс должен иметь первичный ключ (primary key), помеченный аннотацией @Id:

@Entity
public class User {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    
    private String name;
    private String email;
}

• @Id — указывает на поле, являющееся первичным ключом
• @GeneratedValue — определяет стратегию генерации значения (IDENTITY, SEQUENCE, TABLE, UUID)

3. Конструктор по умолчанию (no-arg constructor)

Класс должен иметь публичный конструктор без аргументов:

@Entity
public class User {
    @Id
    private Long id;
    private String name;
    
    // ОБЯЗАТЕЛЬНО: конструктор без параметров
    public User() {
    }
    
    // Опционально: конструктор с параметрами
    public User(String name) {
        this.name = name;
    }
}

Hibernate использует reflection для создания объектов и требует конструктор без аргументов. Если добавить конструктор с параметрами, конструктор по умолчанию не будет создан автоматически, и нужно его добавить вручную.

Правила для полей

1. Видимость полей

Поля должны быть private и иметь getter/setter (или использовать Lombok @Data):

@Entity
public class User {
    @Id
    private Long id;
    
    private String name;
    private String email;
    private int age;
    
    // Getter и setter обязательны
    public Long getId() { return id; }
    public void setId(Long id) { this.id = id; }
    
    public String getName() { return name; }
    public void setName(String name) { this.name = name; }
    
    public String getEmail() { return email; }
    public void setEmail(String email) { this.email = email; }
    
    public int getAge() { return age; }
    public void setAge(int age) { this.age = age; }
}

Или с Lombok:

import lombok.Data;

@Entity
@Data // автоматически генерирует getter, setter, equals, hashCode, toString
public class User {
    @Id
    private Long id;
    private String name;
    private String email;
    private int age;
    
    public User() {} // всё ещё нужен конструктор по умолчанию
}

2. Типы полей

Поля должны быть сериализуемыми или иметь специальные аннотации для типов, не поддерживаемых по умолчанию:

@Entity
public class User {
    @Id
    private Long id;
    
    // Примитивные типы и их обёртки
    private String name;           // String
    private int age;                // примитив
    private Integer score;          // обёртка Integer
    private double salary;          // double
    private boolean isActive;       // boolean
    private LocalDate birthDate;    // Java 8 Date/Time
    
    // Требует аннотации
    @Lob // для больших текстов
    private String description;
    
    @Column(columnDefinition = "JSONB")
    private String metadata;        // для JSON
    
    // Коллекции и объекты требуют аннотаций для ассоциаций
    @OneToMany
    private List<Post> posts;       // ассоциация One-to-Many
}

3. Аннотация @Column (опциональна)

Для управления отображением полей на столбцы:

@Entity
public class User {
    @Id
    private Long id;
    
    @Column(
        name = "user_name",      // имя столбца в БД (если отличается)
        nullable = false,         // NOT NULL ограничение
        unique = true,            // UNIQUE ограничение
        length = 255,             // длина VARCHAR
        columnDefinition = "VARCHAR(100) DEFAULT Unknown"
    )
    private String name;
    
    @Column(name = "email_address", nullable = false, unique = true)
    private String email;
    
    @Column(nullable = true) // может быть NULL
    private String middleName;
}

Рекомендуемые требования

1. Реализация интерфейса Serializable

import java.io.Serializable;

@Entity
public class User implements Serializable {
    private static final long serialVersionUID = 1L;
    
    @Id
    private Long id;
    private String name;
}

Хотя это не обязательно для Hibernate, это рекомендуется для кэширования, сессионного хранилища и распределённых систем.

2. Методы equals() и hashCode()

@Entity
public class User {
    @Id
    private Long id;
    private String email;
    
    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (!(o instanceof User)) return false;
        User user = (User) o;
        return Objects.equals(id, user.id);
    }
    
    @Override
    public int hashCode() {
        return Objects.hash(id);
    }
}

Важны для коллекций (Set, Map) и сравнения объектов.

3. Версионирование для оптимистичной блокировки

@Entity
public class User {
    @Id
    private Long id;
    
    @Version // для обработки конкурентного доступа
    private Long version;
    
    private String name;
}

Полный пример корректного класса

import javax.persistence.*;
import java.io.Serializable;
import java.time.LocalDate;
import java.util.Objects;

@Entity
@Table(name = "users", uniqueConstraints = {
    @UniqueConstraint(columnNames = "email")
})
public class User implements Serializable {
    private static final long serialVersionUID = 1L;
    
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    
    @Column(nullable = false, length = 255)
    private String name;
    
    @Column(nullable = false, unique = true)
    private String email;
    
    @Column(nullable = true)
    private LocalDate birthDate;
    
    @Version
    private Long version;
    
    // Конструктор по умолчанию
    public User() {
    }
    
    // Конструктор с основными полями
    public User(String name, String email) {
        this.name = name;
        this.email = email;
    }
    
    // Getters и Setters
    public Long getId() { return id; }
    public void setId(Long id) { this.id = id; }
    
    public String getName() { return name; }
    public void setName(String name) { this.name = name; }
    
    public String getEmail() { return email; }
    public void setEmail(String email) { this.email = email; }
    
    public LocalDate getBirthDate() { return birthDate; }
    public void setBirthDate(LocalDate birthDate) { this.birthDate = birthDate; }
    
    public Long getVersion() { return version; }
    public void setVersion(Long version) { this.version = version; }
    
    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (!(o instanceof User)) return false;
        User user = (User) o;
        return Objects.equals(id, user.id) && Objects.equals(email, user.email);
    }
    
    @Override
    public int hashCode() {
        return Objects.hash(id, email);
    }
    
    @Override
    public String toString() {
        return "User{" +
                "id=" + id +
                ", name=" + name +
                ", email=" + email +
                ", birthDate=" + birthDate +
                ", version=" + version +
                "}";
    }
}

Чеклист для проверки класса

• Класс помечен @Entity
• Есть поле с @Id и стратегией генерации
• Есть публичный конструктор без аргументов
• Все поля имеют getter/setter
• Типы полей поддерживаются Hibernate
• Используются @Column для контроля отображения
• Реализованы equals() и hashCode()
• Класс реализует Serializable (если требуется кэширование)

Соблюдение этих требований гарантирует, что Hibernate корректно будет работать с вашим классом и отображать его на таблицу БД.