Skip to content

GH-3954: Add warning about @PostConstruct timing with NewTopic beans #4069

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 3, 2025
Merged

GH-3954: Add warning about @PostConstruct timing with NewTopic beans #4069

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
90c414c
GH-3954: Add warning about @PostConstruct timing with NewTopic beans
Chaedie Aug 30, 2025
0f8b7d9
Docs: Improve messaging component guidance based on review feedback
Chaedie Sep 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions spring-kafka-docs/src/main/antora/modules/ROOT/pages/kafka/sending-messages.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,19 @@ If the topic is configured to use `LOG_APPEND_TIME`, the user-specified timestam
The `metrics` and `partitionsFor` methods delegate to the same methods on the underlying javadoc:org.apache.kafka.clients.producer.Producer[].
The `execute` method provides direct access to the underlying javadoc:org.apache.kafka.clients.producer.Producer[].

[NOTE]
====
When sending messages from Spring components, avoid using `@PostConstruct` methods
if you rely on automatic topic creation via `NewTopic` beans. `@PostConstruct` runs
before the application context is fully ready, which may cause
`UnknownTopicOrPartitionException` on clean brokers.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All good, but, please, consider to fix your change according to best practice rules we try to follow: https://asciidoctor.org/docs/asciidoc-recommended-practices/#one-sentence-per-line.

It also would be great to make the text as "personless".
Use the language which would not be like pointing to someone.
In other words try to avoid "you", "we", "they" etc.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for advice.
I revised documentation.


Instead, consider:
- Using an `ApplicationListener<ContextRefreshedEvent>` to send after the context is fully refreshed.
- Implementing `SmartLifecycle` and starting after `KafkaAdmin`.
- Or pre-creating topics externally.
====

To use the template, you can configure a producer factory and provide it in the template's constructor.
The following example shows how to do so:

Expand Down