Skip to content

Commit 6f5ef5e

Browse files
committed
Moved doc contents from Extension section in old ref gudide to antora format
1 parent 71175a7 commit 6f5ef5e

File tree

4 files changed

+32
-0
lines changed

4 files changed

+32
-0
lines changed
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
:navtitle: Compiling to Native
2+
= Compiling to Native
3+
4+
Before you set up this extension, it's important to read through the link:https://docs.spring.io/spring-boot/docs/current/reference/html/native-image.html[documentation,window=_blank,role=external] from Spring itself. There are some known limitations that might require additional changes to the application. In addition, this extension needs to be added by adding the following dependency:
5+
6+
7+
[sources,xml]
8+
----
9+
<dependency>
10+
<groupId>org.axonframework.extensions.spring-aot</groupId>
11+
<artifactId>axon-spring-aot</artifactId>
12+
<version>4.8.0</version>
13+
</dependency>
14+
----
15+
16+
This should be enough to have additional hints with ahead of time compilation to successfully build and run your Axon application.
17+
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
:navtitle: Spring Ahead of Time
2+
= Spring Ahead of Time
3+
4+
link:https://docs.spring.io/spring-boot/docs/current/reference/html/native-image.html#native-image.introducing-graalvm-native-images.understanding-aot-processing[Spring AOT processing,window=_blank,role=external] is part of the process to create a native binary from a Spring (Boot) application. This extension will help in adding a lot of hints which are needed for Axon Framework. Please note this extension can only be used with Spring Boot 3, as such it requires at least Java 17.
5+
6+
Besides the extension, it might be necessary to make more changes to successfully compile and run an application as a native image. For example, when a message isn't used in a handler. This is quite common when the application is split, and the application sending certain messages is not the same as the application handling the messages. In those cases these messages need to be added to the link:https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/context/annotation/ImportRuntimeHints.html[`ImportRuntimeHints`,window=_blank,role=external] annotation. Otherwise, these messages can't be deserialized, leading to errors at runtime.
7+
8+
If something is not working or only works with additional hints, and it's Axon-specific, please let us know either at link:https://github.com/AxonFramework/extension-spring-aot/issues[GitHub,window=_blank,role=external] or link:https://discuss.axoniq.io/c/axonframework/[Discuss,window=_blank,role=external].
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
:navtitle: Performance Tips
2+
= Performance Tips
3+
4+
It can be beneficial to move from JPA implementations to JDBC implementations. This likely decreases both the time it takes to compile the image and the time to start the image.
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
* xref::index.adoc[]
2+
** xref::compile-to-native.adoc[]
3+
** xref::performance.adoc[]

0 commit comments

Comments
 (0)