The Project | About Us | Contribute | Donations | License

HOME

In this section, we will delve into creating JPA (Java Persistence API) entities in a Spring Boot application. JPA entities are the backbone of any data-driven application, representing the data stored in your database in a Java object-oriented manner.

Key Concepts

JPA Entity: A lightweight, persistent domain object that typically represents a table in a relational database.
Annotations: Used to map Java classes to database tables and Java fields to database columns.
Primary Key: A unique identifier for each entity instance.
Relationships: Define how entities relate to each other (e.g., One-to-One, One-to-Many, Many-to-One, Many-to-Many).

Step-by-Step Guide

Define the Entity Class

An entity class is a simple Java class annotated with @Entity. This annotation tells JPA that the class should be mapped to a database table.

import javax.persistence.Entity;
import javax.persistence.Id;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;

@Entity
public class User {
    
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    
    private String username;
    private String email;
    
    // Getters and Setters
    public Long getId() {
        return id;
    }

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

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getEmail() {
        return email;
    }

    public void setEmail(String email) {
        this.email = email;
    }
}

Explanation

@Entity: Marks the class as a JPA entity.
@Id: Specifies the primary key of the entity.
@GeneratedValue(strategy = GenerationType.IDENTITY): Indicates that the primary key should be generated automatically by the database.

Mapping Fields to Columns

By default, JPA maps the fields of the entity to columns with the same name in the database table. You can customize this mapping using the @Column annotation.

import javax.persistence.Column;

@Entity
public class User {
    
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    
    @Column(name = "user_name", nullable = false, unique = true)
    private String username;
    
    @Column(name = "email_address", nullable = false)
    private String email;
    
    // Getters and Setters
}

Explanation

@Column(name = "user_name", nullable = false, unique = true): Maps the username field to the user_name column in the database. The nullable = false attribute ensures that the column cannot be null, and unique = true ensures that the value is unique.

Defining Relationships

Entities often have relationships with other entities. These relationships are defined using annotations such as @OneToOne, @OneToMany, @ManyToOne, and @ManyToMany.

One-to-Many Relationship

import javax.persistence.OneToMany;
import java.util.List;

@Entity
public class User {
    
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    
    private String username;
    private String email;
    
    @OneToMany(mappedBy = "user")
    private List<Post> posts;
    
    // Getters and Setters
}

import javax.persistence.Entity;
import javax.persistence.Id;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.ManyToOne;

@Entity
public class Post {
    
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    
    private String title;
    private String content;
    
    @ManyToOne
    private User user;
    
    // Getters and Setters
}

Explanation

@OneToMany(mappedBy = "user"): Indicates a one-to-many relationship between User and Post. The mappedBy attribute specifies the field in the Post entity that owns the relationship.
@ManyToOne: Indicates a many-to-one relationship from Post to User.

Practical Exercise

Task

Create a Book entity and an Author entity with a one-to-many relationship. Each author can write multiple books, but each book is written by one author.

Solution

import javax.persistence.Entity;
import javax.persistence.Id;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.OneToMany;
import java.util.List;

@Entity
public class Author {
    
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    
    private String name;
    
    @OneToMany(mappedBy = "author")
    private List<Book> books;
    
    // Getters and Setters
}

import javax.persistence.Entity;
import javax.persistence.Id;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.ManyToOne;

@Entity
public class Book {
    
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    
    private String title;
    
    @ManyToOne
    private Author author;
    
    // Getters and Setters
}

Explanation

Author entity has a one-to-many relationship with the Book entity.
Book entity has a many-to-one relationship with the Author entity.

Common Mistakes

Forgetting to Annotate the Class with @Entity: This will result in the class not being recognized as an entity.
Not Defining a Primary Key: Every entity must have a primary key.
Incorrect Mapping of Relationships: Ensure that the mappedBy attribute is correctly set to avoid issues with bidirectional relationships.

Summary

In this section, we covered the basics of creating JPA entities in a Spring Boot application. We learned how to define entity classes, map fields to database columns, and establish relationships between entities. By understanding these concepts, you can effectively model your application's data layer using JPA.

Next, we will explore how to use Spring Data repositories to interact with these entities in the database.

Creating JPA Entities

Key Concepts

Step-by-Step Guide

Define the Entity Class

Explanation

Mapping Fields to Columns

Explanation

Defining Relationships

One-to-Many Relationship

Explanation

Practical Exercise

Task

Solution

Explanation

Common Mistakes

Summary

Spring Boot Course

Module 1: Introduction to Spring Boot

Module 2: Spring Boot Basics

Module 3: Building RESTful Web Services

Module 4: Data Access with Spring Boot

Module 5: Spring Boot Security

Module 6: Testing in Spring Boot

Module 7: Advanced Spring Boot Features

Module 8: Deploying Spring Boot Applications

Module 9: Performance and Monitoring

Module 10: Best Practices and Tips