Event publishing with ApplicationEventPublisher in Spring Boot - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is ApplicationEventPublisher in Spring Boot?

It is a Spring interface used to publish events to listeners within the application context. It helps components communicate by sending and receiving events.

beginner

How do you publish a custom event using ApplicationEventPublisher?

You create a custom event class, inject ApplicationEventPublisher in your component, then call publishEvent(yourEvent) to send the event.

beginner

What annotation is used to listen for events published by ApplicationEventPublisher?

The @EventListener annotation marks a method to listen for specific events published in the application context.

intermediate

Why use events and ApplicationEventPublisher instead of direct method calls?

Events decouple components, allowing them to communicate without knowing each other directly. This improves modularity and flexibility.

intermediate

What happens if no listener is registered for an event published with ApplicationEventPublisher?

The event is published but no action occurs. Spring does not throw an error if no listener handles the event.

Which method is used to publish an event with ApplicationEventPublisher?

A sendEvent()

B fireEvent()

C publishEvent()

D triggerEvent()

The correct method to publish events is publishEvent().

Which annotation marks a method to listen for Spring events?

A @EventListener

B @OnEvent

C @Subscribe

D @ListenEvent

Spring uses @EventListener to mark event listener methods.

What must you do before publishing a custom event?

A Annotate the event class with @Event

B Register the event in XML config

C Implement EventPublisher interface

D Create a class extending ApplicationEvent or any object

You create a custom event class, often extending ApplicationEvent or using any object as event payload.

What is a key benefit of using events in Spring Boot?

A Decoupling components for better modularity

B Faster database queries

C Automatic UI updates

D Simplifies multithreading

Events help decouple components, making the app easier to maintain and extend.

If no listener is registered for an event, what happens when it is published?

A An exception is thrown

B The event is ignored silently

C The application crashes

D The event is queued for later

Spring silently ignores events with no listeners; no error occurs.

Explain how to publish and listen to a custom event using ApplicationEventPublisher in Spring Boot.

Think about the steps from creating the event to handling it.

Describe the advantages of using event publishing with ApplicationEventPublisher over direct method calls.

Consider how events help components work independently.

Practice

1. What is the primary role of ApplicationEventPublisher in a Spring Boot application?

easy

A. To manage HTTP requests and responses

B. To listen and handle events automatically

C. To configure database connections

D. To send or publish events within the application

Solution

1. Step 1: Understand the purpose of ApplicationEventPublisher

   This interface is designed to publish events to listeners within the Spring application context.

2. Step 2: Differentiate from listeners and other components

   Listeners handle events, but ApplicationEventPublisher only sends or publishes them.

3. Final Answer:

   To send or publish events within the application -> Option D

4. Quick Check:

   Event sending = ApplicationEventPublisher [OK]

Hint: Publisher sends events; listeners receive them [OK]

Common Mistakes:

• Confusing publisher with listener
• Thinking it manages HTTP or database
• Assuming it handles event processing

2. Which of the following is the correct way to inject ApplicationEventPublisher in a Spring Boot component?

easy

A. @Autowired private ApplicationEventPublisher publisher;

B. private ApplicationEventPublisher publisher = new ApplicationEventPublisher();

C. @Inject ApplicationEventPublisher publisher = null;

D. ApplicationEventPublisher publisher = ApplicationEventPublisher.getInstance();

Solution

1. Step 1: Recall Spring dependency injection syntax

   Spring uses @Autowired to inject beans automatically into components.

2. Step 2: Check each option for correctness

   @Autowired private ApplicationEventPublisher publisher; uses @Autowired correctly. private ApplicationEventPublisher publisher = new ApplicationEventPublisher(); tries to instantiate interface (not allowed). @Inject ApplicationEventPublisher publisher = null; mixes @Inject with assignment (not typical in Spring). ApplicationEventPublisher publisher = ApplicationEventPublisher.getInstance(); uses a non-existent getInstance method.

3. Final Answer:

   @Autowired private ApplicationEventPublisher publisher; -> Option A

4. Quick Check:

   @Autowired injects beans properly [OK]

Hint: Use @Autowired for Spring bean injection [OK]

Common Mistakes:

• Trying to instantiate ApplicationEventPublisher directly
• Mixing injection annotations incorrectly
• Using static getInstance() which doesn't exist

3. Given the following code snippet, what will be printed when publishEvent() is called?

public class MyEvent extends ApplicationEvent {
    public MyEvent(Object source) { super(source); }
}

@Component
public class MyPublisher {
    @Autowired
    private ApplicationEventPublisher publisher;

    public void publishEvent() {
        publisher.publishEvent(new MyEvent(this));
    }
}

@Component
public class MyListener {
    @EventListener
    public void handleMyEvent(MyEvent event) {
        System.out.println("Event received");
    }
}

medium

A. No output

B. Compilation error

C. Event received

D. Runtime exception

Solution

1. Step 1: Understand event publishing and listening

   The publisher sends a MyEvent instance. The listener listens for MyEvent and prints "Event received".

2. Step 2: Confirm no errors in code

   Code uses correct annotations and event class extending ApplicationEvent, so no errors or exceptions.

3. Final Answer:

   Event received -> Option C

4. Quick Check:

   Listener prints message on event [OK]

Hint: Listener prints message when event is published [OK]

Common Mistakes:

• Forgetting @EventListener annotation
• Not extending ApplicationEvent in event class
• Expecting output without publishing event

4. Identify the error in the following Spring Boot event publishing code:

@Component
public class EventSender {
    private ApplicationEventPublisher publisher;

    public void send() {
        publisher.publishEvent(new CustomEvent(this));
    }
}

public class CustomEvent extends ApplicationEvent {
    public CustomEvent(Object source) { super(source); }
}

medium

A. send method should be static

B. ApplicationEventPublisher is not injected, so publisher is null

C. publishEvent method does not exist

D. CustomEvent does not extend ApplicationEvent

Solution

1. Step 1: Check ApplicationEventPublisher usage

   The publisher field is declared but never injected or assigned, so it remains null.

2. Step 2: Consequence of null publisher

   Calling publishEvent on null causes NullPointerException at runtime.

3. Final Answer:

   ApplicationEventPublisher is not injected, so publisher is null -> Option B

4. Quick Check:

   Missing injection causes null publisher [OK]

Hint: Always inject ApplicationEventPublisher before use [OK]

Common Mistakes:

• Forgetting @Autowired on publisher
• Assuming interface can be instantiated
• Thinking method must be static

5. You want to publish a custom event UserCreatedEvent and ensure multiple listeners react differently. Which approach correctly implements this in Spring Boot?

hard

A. Create UserCreatedEvent extending ApplicationEvent, inject ApplicationEventPublisher, publish event, and annotate multiple methods with @EventListener for UserCreatedEvent

B. Create UserCreatedEvent as a simple POJO, call listeners manually without publishing events

C. Use ApplicationEventPublisher to publish String messages instead of event objects

D. Create UserCreatedEvent but do not extend ApplicationEvent; rely on @EventListener to catch any object

Solution

1. Step 1: Define event class properly

   Custom events should extend ApplicationEvent for Spring to recognize them.

2. Step 2: Publish event and create multiple listeners

   Inject ApplicationEventPublisher to publish event. Use @EventListener on multiple methods to react differently.

3. Step 3: Evaluate other options

   Create UserCreatedEvent as a simple POJO, call listeners manually without publishing events skips event system, losing decoupling. Use ApplicationEventPublisher to publish String messages instead of event objects misuses publisher with Strings. Create UserCreatedEvent but do not extend ApplicationEvent; rely on @EventListener to catch any object breaks event contract, listeners may not work.

4. Final Answer:

   Create UserCreatedEvent extending ApplicationEvent, inject ApplicationEventPublisher, publish event, and annotate multiple methods with @EventListener for UserCreatedEvent -> Option A

5. Quick Check:

   Proper event class + publisher + listeners = correct [OK]

Hint: Extend ApplicationEvent and use @EventListener for multiple reactions [OK]

Common Mistakes:

• Not extending ApplicationEvent for custom events
• Calling listeners manually instead of publishing
• Publishing wrong object types like String