Message serialization in Spring Boot - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is message serialization in Spring Boot?

Message serialization is the process of converting an object into a format that can be easily sent over a network or stored, such as JSON or XML, so it can be reconstructed later.

beginner

Which Spring Boot module helps with automatic message serialization and deserialization?

Spring Boot uses the Spring Web module with libraries like Jackson to automatically convert Java objects to JSON and back.

intermediate

How does Spring Boot decide which format to use for message serialization?

Spring Boot uses the Content-Type header in HTTP requests and responses to decide the format, like application/json for JSON or application/xml for XML.

intermediate

What annotation can you use in Spring Boot to customize JSON serialization of a field?

You can use @JsonProperty to rename fields or @JsonIgnore to exclude fields from JSON serialization.

beginner

Why is message serialization important in REST APIs built with Spring Boot?

Serialization allows Java objects to be converted into a format like JSON so clients and servers can communicate easily over HTTP, making data exchange simple and standardized.

Which library does Spring Boot commonly use for JSON serialization?

A Jackson

B Hibernate

C Log4j

D JUnit

Jackson is the default library Spring Boot uses to convert Java objects to JSON and back.

What HTTP header helps Spring Boot determine the serialization format?

A Content-Type

B Authorization

C User-Agent

D Accept-Encoding

The Content-Type header tells Spring Boot what format to use for serializing or deserializing messages.

Which annotation excludes a field from JSON serialization in Spring Boot?

A @JsonProperty

B @JsonInclude

C @JsonIgnore

D @JsonFormat

@JsonIgnore tells Jackson to skip that field during serialization.

What is the main purpose of message serialization in Spring Boot REST APIs?

A To log messages

B To encrypt data

C To compile Java code

D To convert objects to a transmittable format

Serialization converts Java objects into formats like JSON so they can be sent over the network.

If a client sends a request with Content-Type: application/xml, what will Spring Boot do?

A Serialize the response as JSON

B Deserialize the request body as XML

C Ignore the Content-Type header

D Return an error

Spring Boot will try to deserialize the request body as XML based on the Content-Type header.

Explain how Spring Boot handles message serialization and deserialization in REST APIs.

Think about how data moves between client and server in a REST call.

Describe how you can customize JSON serialization of a Java object field in Spring Boot.

Consider annotations that control what appears in the JSON.

Practice

1. What is the main purpose of message serialization in Spring Boot?

easy

A. To handle user authentication and authorization

B. To compile Java code into bytecode

C. To convert objects into a format like JSON for easy data sharing

D. To manage database connections automatically

Solution

1. Step 1: Understand serialization concept

   Serialization means converting an object into a format that can be sent or stored, like JSON.

2. Step 2: Relate to Spring Boot usage

   Spring Boot uses serialization to send Java objects as JSON in REST APIs.

3. Final Answer:

   To convert objects into a format like JSON for easy data sharing -> Option C

4. Quick Check:

   Serialization = Convert objects to JSON [OK]

Hint: Serialization means turning objects into JSON or similar formats [OK]

Common Mistakes:

• Confusing serialization with compiling code
• Thinking serialization manages databases
• Mixing serialization with security features

2. Which of the following is the correct way to ensure a Java class is serializable by Spring Boot's default JSON serializer?

easy

A. Use @Entity annotation on the class

B. Make the class implement Serializable interface

C. Mark all fields as transient

D. Add public getters for all fields and a no-argument constructor

Solution

1. Step 1: Identify Spring Boot serialization requirements

   Spring Boot uses Jackson which requires public getters and a no-argument constructor to serialize objects properly.

2. Step 2: Evaluate options

   Implementing Serializable is not required for JSON serialization. Marking fields transient prevents serialization. @Entity is for database mapping, not serialization.

3. Final Answer:

   Add public getters for all fields and a no-argument constructor -> Option D

4. Quick Check:

   Getters + no-arg constructor = JSON serialization [OK]

Hint: Public getters and no-arg constructor enable JSON serialization [OK]

Common Mistakes:

• Thinking Serializable interface is needed for JSON
• Marking fields transient disables serialization
• Confusing @Entity with serialization setup

3. Given the following Spring Boot controller method, what will be the JSON output when accessing /user?

public record User(String name, int age) {}

@GetMapping("/user")
public User getUser() {
    return new User("Alice", 30);
}

medium

A. ["Alice",30]

B. {"name":"Alice","age":30}

C. {"User":{"name":"Alice","age":30}}

D. Error: Records cannot be serialized

Solution

1. Step 1: Understand record serialization in Spring Boot

   Spring Boot with Jackson supports Java records and serializes them as JSON objects with field names.

2. Step 2: Predict output for User record

   The record fields 'name' and 'age' become JSON keys with their values.

3. Final Answer:

   {"name":"Alice","age":30} -> Option B

4. Quick Check:

   Records serialize as JSON objects with fields [OK]

Hint: Java records serialize as JSON objects with field names [OK]

Common Mistakes:

• Expecting JSON array instead of object
• Thinking records cause serialization errors
• Assuming nested JSON with class name

4. Consider this Spring Boot REST controller snippet:

@GetMapping("/product")
public Product getProduct() {
    return new Product("Book", null);
}

public class Product {
    private String name;
    private String description;

    public Product(String name, String description) {
        this.name = name;
        this.description = description;
    }

    public String getName() { return name; }
    // Missing getter for description
}

What issue will occur when this endpoint is called?

medium

A. The JSON will include only the name field; description is missing

B. The JSON will include both name and description fields

C. A runtime error occurs due to missing getter

D. The endpoint will not compile

Solution

1. Step 1: Check serialization requirements

   Jackson serializes fields using public getters. Missing getter means that field is ignored in JSON output.

2. Step 2: Analyze given code

   Product class lacks getter for 'description', so JSON will only show 'name'. No runtime error or compile error occurs.

3. Final Answer:

   The JSON will include only the name field; description is missing -> Option A

4. Quick Check:

   Missing getter = field omitted in JSON [OK]

Hint: Missing getter means field won't appear in JSON output [OK]

Common Mistakes:

• Expecting runtime or compile error
• Assuming all fields serialize without getters
• Thinking null values cause errors

5. You want to customize JSON serialization in Spring Boot to exclude fields with null values from the output. Which approach is correct?

hard

A. Configure Jackson's ObjectMapper to set SerializationInclusion to NON_NULL

B. Mark all nullable fields as transient

C. Remove getters for nullable fields

D. Use @JsonIgnore on all fields

Solution

1. Step 1: Understand how to exclude null fields in JSON

   Jackson allows configuration to exclude null fields by setting SerializationInclusion to NON_NULL.

2. Step 2: Evaluate options

   Marking fields transient or removing getters prevents serialization entirely, not just null exclusion. @JsonIgnore excludes fields always.

3. Final Answer:

   Configure Jackson's ObjectMapper to set SerializationInclusion to NON_NULL -> Option A

4. Quick Check:

   Set SerializationInclusion = NON_NULL to skip nulls [OK]

Hint: Set ObjectMapper to exclude nulls with NON_NULL inclusion [OK]

Common Mistakes:

• Using transient to exclude nulls (excludes always)
• Removing getters breaks serialization
• Using @JsonIgnore excludes fields always