@Id and @GeneratedValue for primary keys in Spring Boot - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the purpose of the @Id annotation in Spring Boot?

The @Id annotation marks a field as the primary key of an entity. It tells Spring Boot which field uniquely identifies each record in the database.

beginner

What does the @GeneratedValue annotation do?

The @GeneratedValue annotation tells Spring Boot to automatically generate a value for the primary key when saving a new entity. It helps avoid manually setting unique IDs.

intermediate

Which strategy options can you use with @GeneratedValue?

Common strategies include AUTO (default, lets the provider choose), IDENTITY (database auto-increment), SEQUENCE (uses a database sequence), and TABLE (uses a table to generate IDs).

beginner

Why is it important to use @Id and @GeneratedValue together?

Using @Id identifies the primary key field, and @GeneratedValue automates its value creation. Together, they ensure each entity has a unique, automatically assigned ID.

beginner

Show a simple example of an entity with @Id and @GeneratedValue annotations.

Example:
<pre>
@Entity
public class User {
  @Id
  @GeneratedValue(strategy = GenerationType.AUTO)
  private Long id;
  private String name;
  // getters and setters
}</pre>

What does the @Id annotation specify in a Spring Boot entity?

A The primary key field

B A foreign key field

C A regular column

D A database table name

The @Id annotation marks the field as the primary key of the entity.

Which annotation automatically generates the primary key value?

A @GeneratedValue

B @Column

C @Entity

D @Table

@GeneratedValue tells Spring Boot to generate the primary key value automatically.

What is the default strategy for @GeneratedValue if none is specified?

A IDENTITY

B AUTO

C SEQUENCE

D TABLE

AUTO lets the persistence provider choose the best strategy automatically.

Which strategy uses a database sequence to generate IDs?

A IDENTITY

B AUTO

C SEQUENCE

D TABLE

SEQUENCE uses a database sequence object to generate unique IDs.

Why should you not manually assign values to a field annotated with @GeneratedValue?

A Because the field is read-only

B Because the database will ignore manual values

C Because it will cause duplicate keys

D Because the value is automatically generated and manual assignment can cause errors

Manual assignment can conflict with automatic generation and cause errors.

Explain how @Id and @GeneratedValue work together in a Spring Boot entity.

Think about how the database knows which field is the unique identifier and how it gets its value.

Describe the different strategies available for @GeneratedValue and when you might use each.

Consider how different databases handle ID generation.

Practice

1. What is the main purpose of the @Id annotation in a Spring Boot entity?

easy

A. To specify a foreign key relationship

B. To generate unique values automatically

C. To define a database table name

D. To mark the primary key field of the entity

Solution

1. Step 1: Understand the role of @Id

   The @Id annotation marks a field as the primary key in a database entity.

2. Step 2: Differentiate from other annotations

   @GeneratedValue generates values, but @Id specifically identifies the primary key field.

3. Final Answer:

   To mark the primary key field of the entity -> Option D

4. Quick Check:

   @Id marks primary key [OK]

Hint: Remember: @Id means 'this is the primary key' [OK]

Common Mistakes:

• Confusing @Id with @GeneratedValue
• Thinking @Id generates values automatically
• Using @Id to name tables

2. Which of the following is the correct way to use @GeneratedValue with GenerationType.IDENTITY in a Spring Boot entity?

easy

A. @GeneratedValue(strategy = GenerationType.AUTO)

B. @GeneratedValue(strategy = GenerationType.SEQUENCE)

C. @GeneratedValue(strategy = GenerationType.IDENTITY)

D. @GeneratedValue(strategy = GenerationType.TABLE)

Solution

1. Step 1: Identify the correct strategy for identity generation

   GenerationType.IDENTITY is used to let the database auto-increment the primary key.

2. Step 2: Match the annotation syntax

   The correct syntax is @GeneratedValue(strategy = GenerationType.IDENTITY).

3. Final Answer:

   @GeneratedValue(strategy = GenerationType.IDENTITY) -> Option C

4. Quick Check:

   Use GenerationType.IDENTITY with strategy = GenerationType.IDENTITY [OK]

Hint: Use strategy = GenerationType.IDENTITY for auto-increment keys [OK]

Common Mistakes:

• Using AUTO instead of IDENTITY for auto-increment
• Omitting the strategy parameter
• Confusing SEQUENCE with IDENTITY

3. Given the entity code below, what will be the value of user.getId() after saving a new user to the database?

 @Entity
 public class User {
   @Id
   @GeneratedValue(strategy = GenerationType.IDENTITY)
   private Long id;
   private String name;

   // getters and setters
 }

medium

A. A unique auto-generated Long value

B. null

C. The name of the user

D. An exception will be thrown

Solution

1. Step 1: Understand @GeneratedValue with IDENTITY

   This strategy lets the database generate a unique primary key value automatically when saving.

2. Step 2: Predict the value after saving

   After saving, user.getId() will hold the generated unique Long value assigned by the database.

3. Final Answer:

   A unique auto-generated Long value -> Option A

4. Quick Check:

   @GeneratedValue with IDENTITY creates unique IDs [OK]

Hint: After save, IDENTITY generates a unique Long ID automatically [OK]

Common Mistakes:

• Expecting id to be null after save
• Confusing id with other fields
• Assuming an error occurs without database setup

4. Consider this entity code snippet:

 @Entity
 public class Product {
   @Id
   @GeneratedValue
   private Long productId;

   private String name;
 }

What is the likely problem with this code?

medium

A. Missing strategy in @GeneratedValue may cause unexpected ID generation

B. The field productId should not be private

C. The @Id annotation is missing

D. The entity class must implement Serializable

Solution

1. Step 1: Check @GeneratedValue usage

   The @GeneratedValue annotation without specifying a strategy defaults to AUTO, which may behave differently depending on the database.

2. Step 2: Understand impact of missing strategy

   This can cause unexpected ID generation behavior if the database does not support the default strategy well.

3. Final Answer:

   Missing strategy in @GeneratedValue may cause unexpected ID generation -> Option A

4. Quick Check:

   Always specify strategy to avoid surprises [OK]

Hint: Always specify strategy in @GeneratedValue to avoid surprises [OK]

Common Mistakes:

• Thinking private fields cause errors
• Believing @Id is missing
• Assuming Serializable is mandatory

5. You want to create a Spring Boot entity with a primary key that uses a database sequence named user_seq. Which is the correct way to annotate the ID field?

hard

A. @Id @GeneratedValue(strategy = GenerationType.IDENTITY)

B. @Id @GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "user_seq") @SequenceGenerator(name = "user_seq", sequenceName = "user_seq", allocationSize = 1)

C. @Id @GeneratedValue(strategy = GenerationType.TABLE)

D. @Id @GeneratedValue(strategy = GenerationType.AUTO)

Solution

1. Step 1: Identify sequence generation requirements

   Using a database sequence requires GenerationType.SEQUENCE and a matching @SequenceGenerator annotation.

2. Step 2: Match annotations to sequence name

   The @SequenceGenerator defines the sequence name and allocation size, linked by the generator name in @GeneratedValue.

3. Final Answer:

   @Id @GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "user_seq") @SequenceGenerator(name = "user_seq", sequenceName = "user_seq", allocationSize = 1) -> Option B

4. Quick Check:

   Use SEQUENCE with @SequenceGenerator for DB sequences [OK]

Hint: Use @SequenceGenerator with SEQUENCE strategy for DB sequences [OK]

Common Mistakes:

• Using IDENTITY instead of SEQUENCE for sequences
• Omitting @SequenceGenerator annotation
• Confusing TABLE and AUTO strategies