Introduction aux transactions en Java et Spring

1. Introduction

Dans ce didacticiel, nous allons comprendre ce que l'on entend par transactions en Java. Nous comprendrons ainsi comment effectuer des transactions locales de ressources et des transactions globales. Cela nous permettra également d'explorer différentes façons de gérer les transactions en Java et Spring.

2. Qu'est-ce qu'une transaction?

Les transactions en Java, comme en général, font référence à une série d'actions qui doivent toutes aboutir. Par conséquent, si une ou plusieurs actions échouent, toutes les autres actions doivent revenir en arrière en laissant l'état de l'application inchangé . Cela est nécessaire pour garantir que l'intégrité de l'état de l'application n'est jamais compromise.

En outre, ces transactions peuvent impliquer une ou plusieurs ressources telles que la base de données, la file d'attente de messages, donnant lieu à différentes manières d'effectuer des actions dans le cadre d'une transaction. Il s'agit notamment d'effectuer des transactions locales de ressources avec des ressources individuelles. Alternativement, plusieurs ressources peuvent participer à une transaction globale.

3. Transactions locales de ressources

Nous allons d'abord explorer comment utiliser les transactions en Java tout en travaillant avec des ressources individuelles. Ici, nous pouvons avoir plusieurs actions individuelles que nous effectuons avec une ressource telle qu'une base de données . Mais nous voulons peut-être qu'ils se produisent comme un tout unifié, comme dans une unité de travail indivisible. En d'autres termes, nous voulons que ces actions se déroulent en une seule transaction.

En Java, nous avons plusieurs façons d'accéder et de fonctionner sur une ressource comme une base de données. Par conséquent, la façon dont nous traitons les transactions n'est pas non plus la même. Dans cette section, nous verrons comment nous pouvons utiliser des transactions avec certaines de ces bibliothèques en Java qui sont assez souvent utilisées.

3.1. JDBC

Java Database Connectivity (JDBC) est l'API en Java qui définit comment accéder aux bases de données en Java . Différents fournisseurs de bases de données fournissent des pilotes JDBC pour se connecter à la base de données d'une manière indépendante du fournisseur. Nous récupérons donc une connexion à partir d'un pilote pour effectuer différentes opérations sur la base de données:

JDBC nous fournit les options pour exécuter des instructions dans le cadre d'une transaction. Le comportement par défaut d'une connexion est l'auto-commit . Pour clarifier, cela signifie que chaque instruction est traitée comme une transaction et est automatiquement validée juste après l'exécution.

Cependant, si nous souhaitons regrouper plusieurs instructions en une seule transaction, cela est également possible:

Connection connection = DriverManager.getConnection(CONNECTION_URL, USER, PASSWORD); try { connection.setAutoCommit(false); PreparedStatement firstStatement = connection .prepareStatement("firstQuery"); firstStatement.executeUpdate(); PreparedStatement secondStatement = connection .prepareStatement("secondQuery"); secondStatement.executeUpdate(); connection.commit(); } catch (Exception e) { connection.rollback(); }

Ici, nous avons désactivé le mode de validation automatique de Connection . Par conséquent, nous pouvons définir manuellement la limite de la transaction et effectuer une validation ou une annulation . JDBC nous permet également de définir un point de sauvegarde qui nous donne plus de contrôle sur la quantité à restaurer.

3.2. JPA

Java Persistence API (JPA) est une spécification en Java qui peut être utilisée pour combler le fossé entre les modèles de domaine orientés objet et les systèmes de base de données relationnelle . Ainsi, plusieurs implémentations de JPA sont disponibles auprès de tiers comme Hibernate, EclipseLink et iBatis.

Dans JPA, nous pouvons définir des classes régulières comme une entité qui leur fournit une identité persistante. La classe EntityManager fournit l'interface nécessaire pour travailler avec plusieurs entités dans un contexte de persistance . Le contexte de persistance peut être considéré comme un cache de premier niveau où les entités sont gérées:

Le contexte de persistance ici peut être de deux types, à portée de transaction ou à portée étendue. Un contexte de persistance à portée de transaction est lié à une seule transaction. Alors que le contexte de persistance à portée étendue peut s'étendre sur plusieurs transactions. La portée par défaut d'un contexte de persistance est la portée de la transaction .

Voyons comment créer un EntityManager et définir manuellement une limite de transaction:

EntityManagerFactory entityManagerFactory = Persistence.createEntityManagerFactory("jpa-example"); EntityManager entityManager = entityManagerFactory.createEntityManager(); try { entityManager.getTransaction().begin(); entityManager.persist(firstEntity); entityManager.persist(secondEntity); entityManager.getTransaction().commit(); } catch (Exceotion e) { entityManager.getTransaction().rollback(); }

Ici, nous créons un EntityManager à partir d' EntityManagerFactory dans le contexte d'un contexte de persistance à portée de transaction. Ensuite, nous définissons la limite de transaction avec les méthodes begin , commit et rollback .

3.3. JMS

Java Messaging Service (JMS) est une spécification Java qui permet aux applications de communiquer de manière asynchrone à l'aide de messages . L'API nous permet de créer, d'envoyer, de recevoir et de lire des messages à partir d'une file d'attente ou d'un sujet. Il existe plusieurs services de messagerie conformes aux spécifications JMS, notamment OpenMQ et ActiveMQ.

L'API JMS prend en charge le regroupement de plusieurs opérations d'envoi ou de réception en une seule transaction. Cependant, en raison de la nature de l'architecture d'intégration basée sur les messages, la production et la consommation d'un message ne peuvent pas faire partie de la même transaction . La portée de la transaction reste entre le client et le fournisseur JMS:

JMS nous permet de créer une session à partir d'une connexion que nous obtenons à partir d'une ConnectionFactory spécifique au fournisseur . Nous avons la possibilité de créer une session qui est traitée ou non . Pour les non-transaction session s , nous pouvons encore définir un mode de reconnaissance approprié aussi bien.

Voyons comment nous pouvons créer une session traitée pour envoyer plusieurs messages dans le cadre d'une transaction:

ActiveMQConnectionFactory connectionFactory = new ActiveMQConnectionFactory(CONNECTION_URL); Connection connection = = connectionFactory.createConnection(); connection.start(); try { Session session = connection.createSession(true, 0); Destination = destination = session.createTopic("TEST.FOO"); MessageProducer producer = session.createProducer(destination); producer.send(firstMessage); producer.send(secondMessage); session.commit(); } catch (Exception e) { session.rollback(); }

Ici, nous créons un MessageProducer pour la destination du type de sujet. Nous obtenons la destination de la session que nous avons créée précédemment. Nous utilisons en outre Session pour définir les limites des transactions à l'aide des méthodes commit et rollback .

4. Transactions mondiales

Comme nous l'avons vu, les transactions locales de ressources nous permettent d'effectuer plusieurs opérations au sein d'une seule ressource dans un tout unifié. Mais, assez souvent, nous traitons des opérations qui couvrent plusieurs ressources . Par exemple, opération dans deux bases de données différentes ou une base de données et une file d'attente de messages. Ici, le support des transactions locales au sein des ressources ne nous suffira pas.

Ce dont nous avons besoin dans ces scénarios, c'est d' un mécanisme mondial pour délimiter les transactions couvrant plusieurs ressources participantes . Ceci est souvent connu sous le nom de transactions distribuées et des spécifications ont été proposées pour les traiter efficacement.

La spécification XA est l'une de ces spécifications qui définit un gestionnaire de transactions pour contrôler les transactions sur plusieurs ressources . Java a un support assez mature pour les transactions distribuées conformes à la spécification XA via les composants JTA et JTS.

4.1. JTA

Java Transaction API (JTA) is a Java Enterprise Edition API developed under the Java Community Process. It enables Java applications and application servers to perform distributed transactions across XA resources. JTA is modeled around XA architecture, leveraging two-phase commit.

JTA specifies standard Java interfaces between a transaction manager and the other parties in a distributed transaction:

Let's understand some of the key interfaces highlighted above:

  • TransactionManager: An interface which allows an application server to demarcate and control transactions
  • UserTransaction: This interface allows an application program to demarcate and control transactions explicitly
  • XAResource: The purpose of this interface is to allow a transaction manager to work with resource managers for XA-compliant resources

4.2. JTS

Java Transaction Service (JTS) is a specification for building the transaction manager that maps to the OMG OTS specification. JTS uses the standard CORBA ORB/TS interfaces and Internet Inter-ORB Protocol (IIOP) for transaction context propagation between JTS transaction managers.

At a high level, it supports the Java Transaction API (JTA). A JTS transaction manager provides transaction services to the parties involved in a distributed transaction:

Services that JTS provides to an application are largely transparent and hence we may not even notice them in the application architecture. JTS is architected around an application server which abstracts all transaction semantics from the application programs.

5. JTA Transaction Management

Now it's time to understand how we can manage a distributed transaction using JTA. Distributed transactions are not trivial solutions and hence have cost implications as well. Moreover, there are multiple options that we can choose from to include JTA in our application. Hence, our choice must be in the view of overall application architecture and aspirations.

5.1. JTA in Application Server

As we have seen earlier, JTA architecture relies on the application server to facilitate a number of transaction-related operations. One of the key services it relies on the server to provide is a naming service through JNDI. This is where XA resources like data sources are bound to and retrieved from.

Apart from this, we have a choice in terms of how we want to manage the transaction boundary in our application. This gives rise to two types of transactions within the Java application server:

  • Container-managed Transaction: As the name suggests, here the transaction boundary is set by the application server. This simplifies the development of Enterprise Java Beans (EJB) as it does not include statements related to transaction demarcation and relies solely on the container to do so. However, this does not provide enough flexibility for the application.
  • Bean-managed Transaction: Contrary to the container-managed transaction, in a bean-managed transaction EJBs contain the explicit statements to define the transaction demarcation. This provides precise control to the application in marking the boundaries of the transaction, albeit at the cost of more complexity.

One of the main drawbacks of performing transactions in the context of an application server is that the application becomes tightly coupled with the server. This has implications with respect to testability, manageability, and portability of the application. This is more profound in microservice architecture where the emphasis is more on developing server-neutral applications.

5.2. JTA Standalone

The problems we discussed in the last section have provided a huge momentum towards creating solutions for distributed transactions that does not rely on an application server. There are several options available to us in this regard, like using transaction support with Spring or use a transaction manager like Atomikos.

Let's see how we can use a transaction manager like Atomikos to facilitate a distributed transaction with a database and a message queue. One of the key aspects of a distributed transaction is enlisting and delisting the participating resources with the transaction monitor. Atomikos takes care of this for us. All we have to do is use Atomikos-provided abstractions:

AtomikosDataSourceBean atomikosDataSourceBean = new AtomikosDataSourceBean(); atomikosDataSourceBean.setXaDataSourceClassName("com.mysql.cj.jdbc.MysqlXADataSource"); DataSource dataSource = atomikosDataSourceBean;

Here, we are creating an instance of AtomikosDataSourceBean and registering the vendor-specific XADataSource. From here on, we can continue using this like any other DataSource and get the benefits of distributed transactions.

Similarly, we have an abstraction for message queue which takes care of registering the vendor-specific XA resource with the transaction monitor automatically:

AtomikosConnectionFactoryBean atomikosConnectionFactoryBean = new AtomikosConnectionFactoryBean(); atomikosConnectionFactoryBean.setXaConnectionFactory(new ActiveMQXAConnectionFactory()); ConnectionFactory connectionFactory = atomikosConnectionFactoryBean;

Here, we are creating an instance of AtomikosConnectionFactoryBean and registering the XAConnectionFactory from an XA-enabled JMS vendor. After this, we can continue to use this as a regular ConnectionFactory.

Now, Atomikos provides us the last piece of the puzzle to bring everything together, an instance of UserTransaction:

UserTransaction userTransaction = new UserTransactionImp();

Now, we are ready to create an application with distributed transaction spanning across our database and the message queue:

try { userTransaction.begin(); java.sql.Connection dbConnection = dataSource.getConnection(); PreparedStatement preparedStatement = dbConnection.prepareStatement(SQL_INSERT); preparedStatement.executeUpdate(); javax.jms.Connection mbConnection = connectionFactory.createConnection(); Session session = mbConnection.createSession(true, 0); Destination destination = session.createTopic("TEST.FOO"); MessageProducer producer = session.createProducer(destination); producer.send(MESSAGE); userTransaction.commit(); } catch (Exception e) { userTransaction.rollback(); }

Here, we are using the methods begin and commit in the class UserTransaction to demarcate the transaction boundary. This includes saving a record in the database as well as publishing a message to the message queue.

6. Transactions Support in Spring

We have seen that handling transactions are rather an involved task which includes a lot of boilerplate coding and configurations. Moreover, each resource has its own way of handling local transactions. In Java, JTA abstracts us from these variations but further brings provider-specific details and the complexity of the application server.

Spring platform provides us a much cleaner way of handling transactions, both resource local and global transactions in Java. This together with the other benefits of Spring creates a compelling case for using Spring to handle transactions. Moreover, it's quite easy to configure and switch a transaction manager with Spring, which can be server provided or standalone.

Spring provides us this seamless abstraction by creating a proxy for the methods with transactional code. The proxy manages the transaction state on behalf of the code with the help of TransactionManager:

The central interface here is PlatformTransactionManager which has a number of different implementations available. It provides abstractions over JDBC (DataSource), JMS, JPA, JTA, and many other resources.

6.1. Configurations

Let's see how we can configure Spring to use Atomikos as a transaction manager and provide transactional support for JPA and JMS. We'll begin by defining a PlatformTransactionManager of the type JTA:

@Bean public PlatformTransactionManager platformTransactionManager() throws Throwable { return new JtaTransactionManager( userTransaction(), transactionManager()); }

Here, we are providing instances of UserTransaction and TransactionManager to JTATransactionManager. These instances are provided by a transaction manager library like Atomikos:

@Bean public UserTransaction userTransaction() { return new UserTransactionImp(); } @Bean(initMethod = "init", destroyMethod = "close") public TransactionManager transactionManager() { return new UserTransactionManager(); }

The classes UserTransactionImp and UserTransactionManager are provided by Atomikos here.

Further, we need to define the JmsTemplete which the core class allowing synchronous JMS access in Spring:

@Bean public JmsTemplate jmsTemplate() throws Throwable { return new JmsTemplate(connectionFactory()); }

Here, ConnectionFactory is provided by Atomikos where it enables distributed transaction for Connection provided by it:

@Bean(initMethod = "init", destroyMethod = "close") public ConnectionFactory connectionFactory() { ActiveMQXAConnectionFactory activeMQXAConnectionFactory = new ActiveMQXAConnectionFactory(); activeMQXAConnectionFactory.setBrokerURL("tcp://localhost:61616"); AtomikosConnectionFactoryBean atomikosConnectionFactoryBean = new AtomikosConnectionFactoryBean(); atomikosConnectionFactoryBean.setUniqueResourceName("xamq"); atomikosConnectionFactoryBean.setLocalTransactionMode(false); atomikosConnectionFactoryBean.setXaConnectionFactory(activeMQXAConnectionFactory); return atomikosConnectionFactoryBean; }

So, as we can see, here we are wrapping a JMS provider-specific XAConnectionFactory with AtomikosConnectionFactoryBean.

Next, we need to define an AbstractEntityManagerFactoryBean that is responsible for creating JPA EntityManagerFactory bean in Spring:

@Bean public LocalContainerEntityManagerFactoryBean entityManager() throws SQLException { LocalContainerEntityManagerFactoryBean entityManager = new LocalContainerEntityManagerFactoryBean(); entityManager.setDataSource(dataSource()); Properties properties = new Properties(); properties.setProperty( "javax.persistence.transactionType", "jta"); entityManager.setJpaProperties(properties); return entityManager; }

As before, the DataSource that we set in the LocalContainerEntityManagerFactoryBean here is provided by Atomikos with distributed transactions enabled:

@Bean(initMethod = "init", destroyMethod = "close") public DataSource dataSource() throws SQLException { MysqlXADataSource mysqlXaDataSource = new MysqlXADataSource(); mysqlXaDataSource.setUrl("jdbc:mysql://127.0.0.1:3306/test"); AtomikosDataSourceBean xaDataSource = new AtomikosDataSourceBean(); xaDataSource.setXaDataSource(mysqlXaDataSource); xaDataSource.setUniqueResourceName("xads"); return xaDataSource; }

Here again, we are wrapping the provider-specific XADataSource in AtomikosDataSourceBean.

6.2. Transaction Management

Having gone through all the configurations in the last section, we must feel quite overwhelmed! We may even question the benefits of using Spring after all. But do remember that all this configuration has enabled us abstraction from most of the provider-specific boilerplate and our actual application code does not need to be aware of that at all.

So, now we are ready to explore how to use transactions in Spring where we intend to update the database and publish messages. Spring provides us two ways to achieve this with their own benefits to choose from. Let's understand how we can make use of them:

  • Declarative Support

The easiest way to use transactions in Spring is with declarative support. Here, we have a convenience annotation available to be applied at the method or even at the class. This simply enables global transaction for our code:

@PersistenceContext EntityManager entityManager; @Autowired JmsTemplate jmsTemplate; @Transactional(propagation = Propagation.REQUIRED) public void process(ENTITY, MESSAGE) { entityManager.persist(ENTITY); jmsTemplate.convertAndSend(DESTINATION, MESSAGE); }

The simple code above is sufficient to allow a save-operation in the database and a publish-operation in message queue within a JTA transaction.

  • Programmatic Support

While the declarative support is quite elegant and simple, it does not offer us the benefit of controlling the transaction boundary more precisely. Hence, if we do have a certain need to achieve that, Spring offers programmatic support to demarcate transaction boundary:

@Autowired private PlatformTransactionManager transactionManager; public void process(ENTITY, MESSAGE) { TransactionTemplate transactionTemplate = new TransactionTemplate(transactionManager); transactionTemplate.executeWithoutResult(status -> { entityManager.persist(ENTITY); jmsTemplate.convertAndSend(DESTINATION, MESSAGE); }); }

So, as we can see, we have to create a TransactionTemplate with the available PlatformTransactionManager. Then we can use the TransactionTemplete to process a bunch of statements within a global transaction.

7. Afterthoughts

As we have seen that handling transactions, particularly those that span across multiple resources are complex. Moreover, transactions are inherently blocking which is detrimental to latency and throughput of an application. Further, testing and maintaining code with distributed transactions is not easy, especially if the transaction depends on the underlying application server. So, all in all, it's best to avoid transactions at all if we can!

But that is far from reality. In short, in real-world applications, we do often have a legitimate need for transactions. Although it's possible to rethink the application architecture without transactions, it may not always be possible. Hence, we must adopt certain best practices when working with transactions in Java to make our applications better:

  • One of the fundamental shifts we should adopt is to use standalone transaction managers instead of those provided by an application server. This alone can simplify our application greatly. Moreover, it's much suited for cloud-native microservice architecture.
  • Further, an abstraction layer like Spring can help us contain the direct impact of providers like JPA or JTA providers. So, this can enable us to switch between providers without much impact on our business logic. Moreover, it takes away the low-level responsibilities of managing the transaction state from us.
  • Lastly, we should be careful in picking the transaction boundary in our code. Since transactions are blocking, it's always better to keep the transaction boundary as restricted as possible. If necessary we should prefer programmatic over declarative control for transactions.

8. Conclusion

Pour résumer, dans ce didacticiel, nous avons abordé les transactions dans le contexte de Java. Nous avons pris en charge les transactions locales de ressources individuelles en Java pour différentes ressources. Nous avons également examiné les moyens de réaliser des transactions mondiales en Java.

De plus, nous avons utilisé différentes méthodes pour gérer les transactions globales en Java. De plus, nous avons compris comment Spring nous facilite l'utilisation des transactions en Java.

Enfin, nous avons passé en revue certaines des meilleures pratiques lors de l'utilisation de transactions en Java.