Какие используешь аннотации при написании Entity?

Question

deepseek-v3.2 · Accepted Answer

## Аннотации для Entity в Java (JPA / Hibernate)

При написании **Entity-классов** в Java (в контексте **JPA** или **Hibernate**) аннотации используются для описания соответствия класса и его полей таблицам и колонкам базы данных. Это ключевой инструмент для **ORM** (Object-Relational Mapping).

### Основные аннотации уровня класса (Class-Level Annotations)

*   **`@Entity`** — самая важная аннотация. Она указывает, что данный класс является JPA Entity и будет связан с таблицей в базе данных. Без нее класс не будет восприниматься как сущность.
    ```java
    @Entity
    public class Customer {
        // ...
    }
    ```

*   **`@Table`** — позволяет задать специфические детали таблицы, с которой связана сущность. Если имя таблицы отличается от имени класса, используется параметр `name`.
    ```java
    @Entity
    @Table(name = "tbl_customers")
    public class Customer {
        // ...
    }
    ```

### Аннотации для первичного ключа (Primary Key)

*   **`@Id`** — указывает, что поле является **первичным ключом** сущности.
    ```java
    @Id
    private Long id;
    ```

*   **`@GeneratedValue`** — определяет стратегию генерации уникальных значений для первичного ключа. Часто используется вместе с `@Id`. Основные стратегии: `AUTO`, `IDENTITY`, `SEQUENCE`, `TABLE`.
    ```java
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    ```

### Аннотации для полей и колонок (Field/Column-Level Annotations)

*   **`@Column`** — предоставляет детали для колонки таблицы, соответствующей данному полю: имя (`name`), возможность null (`nullable`), уникальность (`unique`), длина (`length` для строк).
    ```java
    @Column(name = "email_address", nullable = false, unique = true, length = 100)
    private String email;
    ```

*   **`@Basic`** — указывает на простую (базовую) связь поля с колонкой. Часто используется явно, когда нужно задать параметры `fetch` (способ загрузки) или `optional` (может быть null).
    ```java
    @Basic(fetch = FetchType.LAZY, optional = false)
    private String comment;
    ```

*   **`@Enumerated`** — определяет, как тип `Enum` должен сохраняться в базе данных: как строка (`EnumType.STRING`) или как порядковый номер (`EnumType.ORDINAL`). **`EnumType.STRING`** рекомендуется для устойчивости к изменениям порядка enum.
    ```java
    @Enumerated(EnumType.STRING)
    private Status status;
    ```

*   **`@Temporal`** — используется для полей типа `Date` или `Calendar` для указания точности сохраняемого времени: только дата (`DATE`), только время (`TIME`), дата и время (`TIMESTAMP`).
    ```java
    @Temporal(TemporalType.DATE)
    private Date birthDate;
    ```

*   **`@Lob`** — обозначает, что поле должно быть сохранено как большой объект (**Large Object**). Для строк это обычно `CLOB`, для байтовых массивов — `BLOB`.
    ```java
    @Lob
    private String largeText;
    ```

*   **`@Transient`** — указывает, что поле **НЕ должно быть сохранено** в базе данных. Оно существует только на уровне объекта.
    ```java
    @Transient
    private transientField;
    ```

### Аннотации для связей между сущностями (Relationship Annotations)

*   **`@OneToOne`, `@OneToMany`, `@ManyToOne`, `@ManyToMany`** — определяют тип связи между сущностями.
    ```java
    @OneToMany(mappedBy = "customer")
    private List<Order> orders;
    ```

*   **`@JoinColumn`** — используется для указания деталей колонки, которая является внешним ключом в связи (например, в `@ManyToOne` или `@OneToOne`).
    ```java
    @ManyToOne
    @JoinColumn(name = "customer_id", referencedColumnName = "id")
    private Customer customer;
    ```

*   **`@JoinTable`** — применяется для описания таблицы связей в случае **`@ManyToMany`**.

### Аннотации для встраиваемых объектов (Embedded Objects)

*   **`@Embeddable`** — помечает класс как встраиваемый (его поля будут колонками в таблице основной сущности).
    ```java
    @Embeddable
    public class Address {
        private String street;
        private String city;
    }
    ```

*   **`@Embedded`** — в основной сущности указывает, что поле является встраиваемым объектом.
    ```java
    @Entity
    public class Customer {
        @Embedded
        private Address address;
    }
    ```

*   **`@AttributeOverride`** — позволяет переопределить колонки встраиваемого объекта для данной сущности (например, изменить имя колонки).

### Важные аннотации жизненного цикла и прочие

*   **`@Version`** — используется для поля, которое участвует в оптимистичной блокировке (**optimistic locking**). Помогает предотвратить конфликты параллельных обновлений.
    ```java
    @Version
    private Long version;
    ```

*   Аннотации жизненного цикла, такие как **`@PrePersist`, `@PostPersist`, `@PreUpdate`, `@PostUpdate`** и др., позволяют задавать методы, которые будут вызываться автоматически перед или после определенных событий JPA (сохранение, обновление). Это удобно для вычисления полей или логирования.

### Резюме

Выбор аннотации зависит от конкретной модели данных. Основной набор включает **`@Entity`, `@Id`, `@GeneratedValue`, `@Column`**. Для сложных моделей добавляются аннотации связей (**`@OneToMany`** и др.), **`@Embedded`** для композиции и **`@Enumerated`** для энумов. Правильное использование аннотации **`@Version`** критично для многопользовательских систем. Все эти аннотации делают код сущностей декларативным и отвязывают его от прямого SQL, что является основной целью ORM.

Какие используешь аннотации при написании Entity?

Комментарии (1)

Аннотации для Entity в Java (JPA / Hibernate)

Основные аннотации уровня класса (Class-Level Annotations)

Аннотации для первичного ключа (Primary Key)

Аннотации для полей и колонок (Field/Column-Level Annotations)

Аннотации для связей между сущностями (Relationship Annotations)

Аннотации для встраиваемых объектов (Embedded Objects)

Важные аннотации жизненного цикла и прочие

Резюме