What is the purpose of the @GeneratedValue annotation?

The `@GeneratedValue` annotation in Java Persistence API (JPA) is used to specify that the primary key of an entity will be automatically generated by the underlying database. It ensures that unique identifiers are assigned to new entities without requiring manual intervention from the application.

Core Purpose

The primary purpose of @GeneratedValue is to delegate the responsibility of generating primary key values to the database. When an entity with an ID field annotated with @GeneratedValue is persisted, JPA instructs the database to create and assign a unique identifier for that entity. This simplifies application development by removing the need for developers to manually generate or manage primary key values, which can be complex in concurrent environments.

Key Attributes: strategy

The @GeneratedValue annotation has a mandatory strategy attribute, which specifies the generation strategy to be used. This attribute takes a value from the GenerationType enum, offering different mechanisms for ID generation based on database capabilities and application requirements.

Common Generation Strategies (`GenerationType`)

• AUTO: This is the default strategy. The persistence provider (e.g., Hibernate) chooses the appropriate generation strategy based on the dialect configured for the database. It might use identity columns, sequences, or a table generator.
• IDENTITY: This strategy relies on database identity columns, such as auto-increment columns in MySQL, SQL Server, and PostgreSQL. The database automatically assigns a unique ID upon insertion. This strategy means the entity ID is only available after the persist() operation and database commit.
• SEQUENCE: This strategy uses a database sequence to generate primary key values. It's commonly used with databases like Oracle and PostgreSQL. It often requires the @SequenceGenerator annotation for configuration.
• TABLE: This strategy uses a separate table to store and manage the generation of primary key values. It's database-independent but can be less performant due to requiring an additional database transaction to retrieve and update the ID state.

Example Usage

Here's an example of how @GeneratedValue can be used with the IDENTITY strategy for a simple Product entity:

@Entity
public class Product {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    private String name;
    private double price;

    // Getters and 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 double getPrice() {
        return price;
    }

    public void setPrice(double price) {
        this.price = price;
    }
}

In this example, when a new Product object is saved to the database, the id field will be automatically populated by the database using its identity column mechanism, thanks to the @GeneratedValue(strategy = GenerationType.IDENTITY) annotation.