Upgrading to 4.7
Unfortunately, but necessarily, Axon Framework 4.7.0 introduces a few breaking changes. If you migrate from 4.6.x (or earlier) versions, you may need to make some adjustments to your code. If you start a greenfield Axon Framework project, there is nothing to worry about. You may safely skip the following information.
The breaking changes are related to the migration from
javax to jakarta packages both in Axon Framework and other frameworks often used together with Axon. Depending on what you were using with 4.6.x version, there are three possible migration paths:- 1.From
javaxtojavax: This is what you may want if you don’t want Spring 6 and Spring Boot 3 support and expect things to stay the same. - 2.From
javaxtojakarta: This is what you will want if you also upgrade to Spring 6, Spring Boot 3, or another framework that depends onjakartapackages. - 3.From
jakartatojakarta: This is what you will want if you have already moved to the optional[module-name]-jakartamodules in Axon Framework 4.6.x.
Next to the full scenario descriptions, you are also able to use OpenRewrite migration recipes provided by the Framework. Please go to the migration automation section for more details.
FromjakartatojavaxWhile technically possible, thejakartatojavaxmigration is not something you should do. If you have already made an effort to switch to the new packages, it makes no sense to go back.
Zero Axon ConfigurationIf you don't have any manual configuration and use the framework'saxon-spring-boot-starter, that the upgrade to 4.7 is seamless.
Adjust packages in
import statements and FQCNs according to the new locations mentioned below:Axon 4.6.x | Axon 4.7.x |
|---|---|
org.axonframework.common.jpa.EntityManagerProvider | org.axonframework.common.legacyjpa.EntityManagerProvider |
org.axonframework.common.jpa.PagingJpaQueryIterable | org.axonframework.common.legacyjpa.PagingJpaQueryIterable |
org.axonframework.common.jpa.SimpleEntityManagerProvider | org.axonframework.common.legacyjpa.SimpleEntityManagerProvider |
org.axonframework.eventhandling.deadletter.jpa.DeadLetterJpaConverter | org.axonframework.eventhandling.deadletter.legacyjpa.DeadLetterJpaConverter |
org.axonframework.eventhandling.deadletter.jpa.EventMessageDeadLetterJpaConverter | org.axonframework.eventhandling.deadletter.legacyjpa.EventMessageDeadLetterJpaConverter |
org.axonframework.eventhandling.deadletter.jpa.JpaDeadLetter | org.axonframework.eventhandling.deadletter.legacyjpa.JpaDeadLetter |
org.axonframework.eventhandling.deadletter.jpa.JpaSequencedDeadLetterQueue | org.axonframework.eventhandling.deadletter.legacyjpa.JpaSequencedDeadLetterQueue |
org.axonframework.eventhandling.tokenstore.jpa.JpaTokenStore | org.axonframework.eventhandling.tokenstore.legacyjpa.JpaTokenStore |
org.axonframework.eventsourcing.eventstore.jpa.JpaEventStorageEngine | org.axonframework.eventsourcing.eventstore.legacyjpa.JpaEventStorageEngine |
org.axonframework.eventsourcing.eventstore.jpa.SQLErrorCodesResolver | org.axonframework.eventsourcing.eventstore.legacyjpa.SQLErrorCodesResolver |
org.axonframework.messaging.interceptors.BeanValidationInterceptor | org.axonframework.messaging.interceptors.legacyvalidation.BeanValidationInterceptor |
org.axonframework.messaging.interceptors.JSR303ViolationException | org.axonframework.messaging.interceptors.legacyvalidation.JSR303ViolationException |
org.axonframework.modelling.command.GenericJpaRepository | org.axonframework.modelling.command.legacyjpa.GenericJpaRepository |
org.axonframework.modelling.saga.repository.jpa.JpaSagaStore | org.axonframework.modelling.saga.repository.legacyjpa.JpaSagaStore |
org.axonframework.springboot.autoconfig.JpaAutoConfiguration | org.axonframework.springboot.autoconfig.legacyjpa.JpaJavaxAutoConfiguration |
org.axonframework.springboot.autoconfig.JpaEventStoreAutoConfiguration | org.axonframework.springboot.autoconfig.legacyjpa.JpaJavaxEventStoreAutoConfiguration |
org.axonframework.springboot.util.jpa.ContainerManagedEntityManagerProvider | org.axonframework.springboot.util.legacyjpa.ContainerManagedEntityManagerProvider |
If you have customized the
TokenEntry or AbstractTokenEntry, rebase your changes on the current TokenEntry. This is required since the AbstractTokenEntry has been deprecated in favor of the TokenEntry.If you have customized the
SagaEntry or AbstractSagaEntry, rebase your changes on the current SagaEntry. This is required since the AbstractSagaEntry has been deprecated in favor of the SagaEntry.Remove most mentions of
javax in your codebase and replace them with respective jakarta ones. Note that not every reference of javax is deprecated as part of the Javax-to-Jakarta switch, such as some javax.annotation and javax.cache mentions. You can find an exhaustive list of unaffected packages here.If you are using any other frameworks together with Axon Framework (such as Spring, Hibernate, etc.) make sure to upgrade those to the respective versions supporting
jakarta namespace.If you migrate to Hibernate 6 and did not customize the sequence generator of the Framework's
domain_event_entry and association_value_entry, you need to deal with Hibernates adjusted default sequence generator. In this case, your environment uses a so-called hibernate_sequence that is used for all your tables. However, Hibernate 6 will construct dedicated sequences per table using a sequence generator.Although we strongly recommend that you use a dedicated sequence generator per table, the easiest way forward to switch back this new default of Hibernate:
`persistence.xml` configuration
Spring Boot application properties
<persistence>
<persistence-unit name="my-persistence-unit">
<!-- omitting other configuration for simplicity... -->
<properties>
<!-- ensure backward compatibility -->
<property name="hibernate.id.db_structure_naming_strategy" value="legacy"/>
<!-- omitting other properties for simplicity... -->
</properties>
</persistence-unit>
</persistence>
spring.jpa.properties.hibernate.id.db_structure_naming_strategy=legacy
#omitting other properties for simplicity...
In your dependency configuration (Maven, Gradle, etc.) replace the
jakarta-specific Axon Framework modules with the default ones:Axon 4.6.x | Axon 4.7.x |
|---|---|
axon-configuration-jakarta | axon-configuration |
axon-eventsourcing-jakarta | axon-eventsourcing |
axon-messaging-jakarta | axon-messaging |
axon-modelling-jakarta | axon-modelling |
The steps above explain in detail what you need to do to upgrade to Axon Framework 4.7. If you want to automate some of these steps, there are two OpenRewrite migration recipes you can use:
- 1.Upgrade to Axon Framework 4.7 Jakarta - A recipe to upgrade from an Axon Framework Javax-specific project to Jakarta.
- 2.Upgrade to Axon Framework 4.7 Javax - A recipe to upgrade an Axon Framework Javax-specific project and remain on Javax.
For example, if you want to upgrade to 4.7 and stick with Javax, you can run the following command:
mvn -U org.openrewrite.maven:rewrite-maven-plugin:4.40.0:run \
-Drewrite.recipeArtifactCoordinates=org.axonframework:axon-migration:LATEST \
-DactiveRecipes=org.axonframework.migration.UpgradeAxonFramework_4_7_Javax
Can I combine recipes?The mentioned recipes above only allow you to upgrade Axon Framework-specific code. However, you can combine recipes into a single command to, for example, upgrade to Spring Boot 3 and Axon Framework 4.7 in one go:mvn -U org.openrewrite.maven:rewrite-maven-plugin:4.40.0:run \-Drewrite.recipeArtifactCoordinates=org.openrewrite.recipe:rewrite-spring:4.33.0,org.axonframework:axon-migration:LATEST \-DactiveRecipes=org.openrewrite.java.spring.boot3.UpgradeSpringBoot_3_0,org.axonframework.migration.UpgradeAxonFramework_4_7_Jakarta
Last modified 3mo ago