JPA entity with @Entity annotation in Spring Boot

Introduction

The @Entity annotation marks a class as a database table. It helps Spring Boot know which classes to save and load from the database.

When you want to store user information like name and email in a database.

When you need to save product details for an online store.

When you want to keep track of orders or transactions in your app.

When you want to map Java objects to database tables automatically.

Syntax

Spring Boot

@Entity
public class ClassName {
    @Id
    private Long id;
    // other fields
}

The class must have a unique identifier marked with @Id.

The class name usually matches the table name but can be customized.

Examples

This example shows a simple User entity with id, name, and email fields.

Spring Boot

@Entity
public class User {
    @Id
    private Long id;
    private String name;
    private String email;
}

This example defines a Product entity with a productId as the unique key.

Spring Boot

@Entity
public class Product {
    @Id
    private Long productId;
    private String productName;
    private double price;
}

Sample Program

This is a complete JPA entity class named Book. It has an @Entity annotation to mark it as a database table. The id field is the unique identifier marked with @Id. It includes constructors, getters, setters, and a toString method for easy printing.

Spring Boot

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

@Entity
public class Book {
    @Id
    private Long id;
    private String title;
    private String author;

    public Book() {}

    public Book(Long id, String title, String author) {
        this.id = id;
        this.title = title;
        this.author = author;
    }

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public String getTitle() {
        return title;
    }

    public void setTitle(String title) {
        this.title = title;
    }

    public String getAuthor() {
        return author;
    }

    public void setAuthor(String author) {
        this.author = author;
    }

    @Override
    public String toString() {
        return "Book{id=" + id + ", title='" + title + "', author='" + author + "'}";
    }
}

Important Notes

Every entity needs a field annotated with @Id to serve as the primary key.

Use a no-argument constructor so frameworks can create instances easily.

Fields without annotations are mapped to columns with the same name by default.

Summary

@Entity marks a class as a database table.

Each entity needs a unique @Id field.

Entities help connect Java objects with database records automatically.

Practice

1. What is the main purpose of the @Entity annotation in a Spring Boot application?

easy

A. To mark a class as a database table for JPA

B. To create a REST API endpoint

C. To configure application properties

D. To define a service component

Solution

1. Step 1: Understand the role of @Entity

   The @Entity annotation tells Spring Boot and JPA that this class represents a table in the database.

2. Step 2: Differentiate from other annotations

   Other annotations like @RestController or @Service serve different purposes unrelated to database tables.

3. Final Answer:

   To mark a class as a database table for JPA -> Option A

4. Quick Check:

   @Entity marks database tables [OK]

Hint: Remember: @Entity means database table class [OK]

Common Mistakes:

• Confusing @Entity with @Service
• Thinking @Entity creates REST endpoints
• Assuming @Entity configures app settings

2. Which of the following is the correct way to declare a JPA entity class with an ID field?

easy

A. @Entity public class User { private Long id; }

B. public class User { private Long id; }

C. @Entity public class User { @Id private Long id; }

D. @Service public class User { @Id private Long id; }

Solution

1. Step 1: Check for @Entity annotation

   The class must have @Entity to be recognized as a JPA entity.

2. Step 2: Verify presence of @Id on a field

   Every entity needs a unique identifier marked with @Id to map the primary key.

3. Final Answer:

   @Entity public class User { @Id private Long id; } -> Option C

4. Quick Check:

   Entity + Id field = correct syntax [OK]

Hint: Entity needs @Entity and @Id on ID field [OK]

Common Mistakes:

• Missing @Entity annotation
• Forgetting @Id on the ID field
• Using @Service instead of @Entity

3. Given this entity class:

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

  public Product() {}
  public Product(Long id, String name) {
    this.id = id;
    this.name = name;
  }
  public String getName() { return name; }
}

What will happen if you save a Product with id=1 and name="Book" using JPA repository and then retrieve it?

medium

A. The Product is not saved because of missing @Column

B. You get a Product object with id=1 and name="Book"

C. You get a runtime error because no setter for name

D. You get a Product object with id=1 but name is null

Solution

1. Step 1: Understand JPA entity saving and retrieval

   JPA uses the @Entity class and its fields to save and load data. The constructor and getter allow access to fields.

2. Step 2: Check if missing setter affects retrieval

   JPA can set fields via reflection even without setters, so name will be loaded correctly.

3. Final Answer:

   You get a Product object with id=1 and name="Book" -> Option B

4. Quick Check:

   JPA loads fields even without setters [OK]

Hint: JPA sets fields directly; getters needed to read [OK]

Common Mistakes:

• Assuming missing setter causes runtime error
• Thinking @Column is mandatory for saving
• Believing name will be null without setter

4. Identify the error in this entity class:

@Entity
public class Customer {
  private Long id;
  private String email;

  public Long getId() { return id; }
  public String getEmail() { return email; }
}

medium

A. Missing @Entity annotation

B. Missing default constructor

C. Fields should be public

D. Missing @Id annotation on the id field

Solution

1. Step 1: Check for @Entity annotation

   The class has @Entity, so it is recognized as an entity.

2. Step 2: Verify presence of @Id annotation

   The id field lacks @Id, so JPA cannot identify the primary key, causing errors.

3. Final Answer:

   Missing @Id annotation on the id field -> Option D

4. Quick Check:

   Every entity needs @Id on primary key [OK]

Hint: Always put @Id on the primary key field [OK]

Common Mistakes:

• Assuming default constructor is mandatory (JPA provides one)
• Thinking fields must be public
• Ignoring missing @Id annotation

5. You want to create a JPA entity Order with a composite primary key made of orderId and productId. Which approach correctly applies the @Entity annotation and primary key setup?

hard

A. Use @Entity on Order and create a separate @Embeddable class for the composite key with @EmbeddedId in Order

B. Use @Entity on Order and mark both fields @Id without extra class

C. Use @Entity on Order and mark only one field @Id, ignore the other

D. Use @Entity on Order and define composite key in application.properties

Solution

1. Step 1: Understand composite keys in JPA

   JPA requires a separate class annotated with @Embeddable to represent composite keys.

2. Step 2: Use @EmbeddedId in the entity

   The entity class uses @EmbeddedId to include the composite key class as its primary key.

3. Final Answer:

   Use @Entity on Order and create a separate @Embeddable class for the composite key with @EmbeddedId in Order -> Option A

4. Quick Check:

   Composite key needs @Embeddable + @EmbeddedId [OK]

Hint: Composite keys need @Embeddable class + @EmbeddedId field [OK]

Common Mistakes:

• Marking multiple fields with @Id without composite key class
• Ignoring one key field in composite key
• Trying to configure keys in properties file