@Entity Annotation in Spring Boot: What It Is and How It Works

The @Entity annotation in Spring Boot marks a Java class as a database entity, meaning it represents a table in a database. It tells Spring and JPA to manage this class for storing and retrieving data automatically.

How It Works

Think of the @Entity annotation as a label that tells Spring Boot, "This class is special because it matches a table in your database." When you add this annotation to a class, Spring Boot uses it to create, read, update, and delete records in the corresponding table without you writing SQL queries manually.

Imagine you have a spreadsheet where each row is a person’s data. The @Entity class is like the template for each row. Spring Boot uses this template to know what columns exist and how to fill them with data.

Example

This example shows a simple @Entity class named Person that maps to a database table. It has an ID and a name field.

java

import jakarta.persistence.Entity;
import jakarta.persistence.Id;

@Entity
public class Person {
    @Id
    private Long id;
    private String name;

    public Person() {}

    public Person(Long id, String name) {
        this.id = id;
        this.name = name;
    }

    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;
    }
}

Output

No direct output; this class maps to a database table named 'Person' with columns 'id' and 'name'.

When to Use

Use @Entity when you want to connect your Java classes to database tables so you can save and load data easily. It is perfect for applications that need to store user info, products, orders, or any data that fits into tables.

For example, in an online store app, you would use @Entity for classes like Product, Customer, and Order to manage their data in the database automatically.

Key Points

• @Entity marks a class as a database table representation.
• It works with JPA to handle database operations automatically.
• Each entity needs a unique identifier marked with @Id.
• Helps avoid writing SQL by hand for common data tasks.

Key Takeaways

@Entity tells Spring Boot a class maps to a database table.

Every entity class must have a unique ID field annotated with @Id.

Spring Boot uses @Entity to automate database CRUD operations.

Use @Entity for any data you want to save and retrieve from a database.