Prestazioni dei framework di mappatura Java

1. Introduzione

La creazione di applicazioni Java di grandi dimensioni composte da più livelli richiede l'utilizzo di più modelli come il modello di persistenza, il modello di dominio oi cosiddetti DTO. L'utilizzo di più modelli per diversi livelli di applicazione richiederà di fornire un modo di mappatura tra i bean.

Fare questo manualmente può creare rapidamente molto codice boilerplate e consumare molto tempo. Fortunatamente per noi, esistono più framework di mappatura degli oggetti per Java.

In questo tutorial, confronteremo le prestazioni dei più popolari framework di mappatura Java.

2. Mapping Framework

2.1. Dozer

Dozer è un framework di mappatura che utilizza la ricorsione per copiare i dati da un oggetto a un altro . Il framework è in grado non solo di copiare proprietà tra i bean, ma può anche convertire automaticamente tra diversi tipi.

Per utilizzare il framework Dozer dobbiamo aggiungere tale dipendenza al nostro progetto:

 com.github.dozermapper dozer-core 6.5.0 

Ulteriori informazioni sull'utilizzo del framework Dozer sono disponibili in questo articolo.

La documentazione del framework può essere trovata qui.

2.2. Orika

Orika è un framework di mappatura bean to bean che copia ricorsivamente i dati da un oggetto a un altro .

Il principio generale di lavoro dell'Orika è simile a Dozer. La principale differenza tra i due è il fatto che Orika utilizza la generazione di bytecode . Ciò consente di generare mappatori più veloci con un sovraccarico minimo.

Per usarlo,dobbiamo aggiungere tale dipendenza al nostro progetto:

 ma.glasnost.orika orika-core 1.5.4 

Informazioni più dettagliate sull'utilizzo di Orika possono essere trovate in questo articolo.

La documentazione effettiva del framework può essere trovata qui.

2.3. MapStruct

MapStruct è un generatore di codice che genera automaticamente classi di bean mapper.

MapStruct ha anche la capacità di convertire tra diversi tipi di dati. Ulteriori informazioni su come utilizzarlo sono disponibili in questo articolo.

Per aggiungere MapStructal nostro progetto dobbiamo includere la seguente dipendenza:

 org.mapstruct mapstruct 1.3.1.Final 

La documentazione del framework può essere trovata qui.

2.4. ModelMapper

ModelMapper è un framework che mira a semplificare la mappatura degli oggetti, determinando il modo in cui gli oggetti vengono mappati tra loro in base alle convenzioni. Fornisce API indipendenti dai tipi e dal refactoring.

Ulteriori informazioni sul framework sono disponibili nella documentazione.

Per includere ModelMapper nel nostro progetto dobbiamo aggiungere la seguente dipendenza:

 org.modelmapper modelmapper 2.3.8 

2.5. JMapper

JMapper è il framework di mappatura che mira a fornire una mappatura facile da usare e ad alte prestazioni tra Java Beans.

Il framework mira ad applicare il principio DRY utilizzando Annotazioni e mappatura relazionale.

Il framework consente diversi modi di configurazione: basato su annotazioni, XML o basato su API.

Maggiori informazioni sul framework possono essere trovate nella sua documentazione.

Per includere JMapper nel nostro progetto dobbiamo aggiungere la sua dipendenza:

 com.googlecode.jmapper-framework jmapper-core 1.6.1.CR2 

3. Modello di prova

Per essere in grado di testare correttamente la mappatura, è necessario disporre di modelli di origine e di destinazione. Abbiamo creato due modelli di test.

First one is just a simple POJO with one String field, this allowed us to compare frameworks in simpler cases and check whether anything changes if we use more complicated beans.

The simple source model looks like below:

public class SourceCode { String code; // getter and setter }

And its destination is quite similar:

public class DestinationCode { String code; // getter and setter }

The real-life example of source bean looks like that:

public class SourceOrder { private String orderFinishDate; private PaymentType paymentType; private Discount discount; private DeliveryData deliveryData; private User orderingUser; private List orderedProducts; private Shop offeringShop; private int orderId; private OrderStatus status; private LocalDate orderDate; // standard getters and setters }

And the target class looks like below:

public class Order { private User orderingUser; private List orderedProducts; private OrderStatus orderStatus; private LocalDate orderDate; private LocalDate orderFinishDate; private PaymentType paymentType; private Discount discount; private int shopId; private DeliveryData deliveryData; private Shop offeringShop; // standard getters and setters }

The whole model structure can be found here.

4. Converters

To simplify the design of the testing setup, we've created the Converter interface:

public interface Converter { Order convert(SourceOrder sourceOrder); DestinationCode convert(SourceCode sourceCode); }

And all our custom mappers will implement this interface.

4.1. OrikaConverter

Orika allows for full API implementation, this greatly simplifies the creation of the mapper:

public class OrikaConverter implements Converter{ private MapperFacade mapperFacade; public OrikaConverter() { MapperFactory mapperFactory = new DefaultMapperFactory .Builder().build(); mapperFactory.classMap(Order.class, SourceOrder.class) .field("orderStatus", "status").byDefault().register(); mapperFacade = mapperFactory.getMapperFacade(); } @Override public Order convert(SourceOrder sourceOrder) { return mapperFacade.map(sourceOrder, Order.class); } @Override public DestinationCode convert(SourceCode sourceCode) { return mapperFacade.map(sourceCode, DestinationCode.class); } }

4.2. DozerConverter

Dozer requires XML mapping file, with the following sections:

  com.baeldung.performancetests.model.source.SourceOrder com.baeldung.performancetests.model.destination.Order  status orderStatus    com.baeldung.performancetests.model.source.SourceCode com.baeldung.performancetests.model.destination.DestinationCode  

After defining the XML mapping, we can use it from code:

public class DozerConverter implements Converter { private final Mapper mapper; public DozerConverter() { this.mapper = DozerBeanMapperBuilder.create() .withMappingFiles("dozer-mapping.xml") .build(); } @Override public Order convert(SourceOrder sourceOrder) { return mapper.map(sourceOrder,Order.class); } @Override public DestinationCode convert(SourceCode sourceCode) { return mapper.map(sourceCode, DestinationCode.class); } }

4.3. MapStructConverter

MapStruct definition is quite simple as it's entirely based on code generation:

@Mapper public interface MapStructConverter extends Converter { MapStructConverter MAPPER = Mappers.getMapper(MapStructConverter.class); @Mapping(source = "status", target = "orderStatus") @Override Order convert(SourceOrder sourceOrder); @Override DestinationCode convert(SourceCode sourceCode); }

4.4. JMapperConverter

JMapperConverter requires more work to do. After implementing the interface:

public class JMapperConverter implements Converter { JMapper realLifeMapper; JMapper simpleMapper; public JMapperConverter() { JMapperAPI api = new JMapperAPI() .add(JMapperAPI.mappedClass(Order.class)); realLifeMapper = new JMapper(Order.class, SourceOrder.class, api); JMapperAPI simpleApi = new JMapperAPI() .add(JMapperAPI.mappedClass(DestinationCode.class)); simpleMapper = new JMapper( DestinationCode.class, SourceCode.class, simpleApi); } @Override public Order convert(SourceOrder sourceOrder) { return (Order) realLifeMapper.getDestination(sourceOrder); } @Override public DestinationCode convert(SourceCode sourceCode) { return (DestinationCode) simpleMapper.getDestination(sourceCode); } }

We also need to add @JMap annotations to each field of the target class. Also, JMapper can't convert between enum types on its own and it requires us to create custom mapping functions :

@JMapConversion(from = "paymentType", to = "paymentType") public PaymentType conversion(com.baeldung.performancetests.model.source.PaymentType type) { PaymentType paymentType = null; switch(type) { case CARD: paymentType = PaymentType.CARD; break; case CASH: paymentType = PaymentType.CASH; break; case TRANSFER: paymentType = PaymentType.TRANSFER; break; } return paymentType; }

4.5. ModelMapperConverter

ModelMapperConverter requires us to only provide the classes that we want to map:

public class ModelMapperConverter implements Converter { private ModelMapper modelMapper; public ModelMapperConverter() { modelMapper = new ModelMapper(); } @Override public Order convert(SourceOrder sourceOrder) { return modelMapper.map(sourceOrder, Order.class); } @Override public DestinationCode convert(SourceCode sourceCode) { return modelMapper.map(sourceCode, DestinationCode.class); } }

5. Simple Model Testing

For the performance testing, we can use Java Microbenchmark Harness, more information about how to use it can be found in this article.

We've created a separate benchmark for each Converter with specifying BenchmarkMode to Mode.All.

5.1. AverageTime

JMH returned the following results for average running time (the lesser the better) :

Framework Name Average running time (in ms per operation)
MapStruct 10 -5
JMapper 10 -5
Orika 0.001
ModelMapper 0.001
Dozer 0.002

This benchmark shows clearly that both MapStruct and JMapper have the best average working times.

5.2. Throughput

In this mode, the benchmark returns the number of operations per second. We have received the following results (more is better) :

Framework Name Throughput (in operations per ms)
MapStruct 133719
JMapper 106978
Orika 1800
ModelMapper 978
Dozer 471

In throughput mode, MapStruct was the fastest of the tested frameworks, with JMapper a close second.

5.3. SingleShotTime

This mode allows measuring the time of single operation from it's beginning to the end. The benchmark gave the following result (less is better):

Framework Name Single Shot Time (in ms per operation)
JMapper 0.015
MapStruct 0.450
Dozer 2.094
Orika 2.898
ModelMapper 4.837

Here, we see that JMapper returns better result than MapStruct.

5.4. SampleTime

This mode allows sampling of the time of each operation. The results for three different percentiles look like below:

Sample Time (in milliseconds per operation)
Framework Name p0.90 p0.999 p1.0
JMapper 10-4 0.001 2.6
MapStruct 10-4 0.001 3
Orika 0.001 0.010 4
ModelMapper 0.002 0.015 3.2
Dozer 0.003 0.021 25

All benchmarks have shown that MapStruct and JMapper are both good choices depending on the scenario.

6. Real-Life Model Testing

For the performance testing, we can use Java Microbenchmark Harness, more information about how to use it can be found in this article.

We have created a separate benchmark for each Converter with specifying BenchmarkMode to Mode.All.

6.1. AverageTime

JMH returned the following results for average running time (less is better) :

Framework Name Average running time (in ms per operation)
MapStruct 10 -4
JMapper 10 -4
Orika 0.004
ModelMapper 0.059
Dozer 0.103

6.2. Throughput

In this mode, the benchmark returns the number of operations per second. For each of the mappers we've received the following results (more is better) :

Framework Name Throughput (in operations per ms)
JMapper 7691
MapStruct 7120
Orika 281
ModelMapper 19
Dozer 10

6.3. SingleShotTime

This mode allows measuring the time of single operation from it's beginning to the end. The benchmark gave the following results (less is better):

Framework Name Single Shot Time (in ms per operation)
JMapper 0.253
MapStruct 0.532
Dozer 9.495
ModelMapper 16.288
Orika 18.081

6.4. SampleTime

This mode allows sampling of the time of each operation. Sampling results are split into percentiles, we'll present results for three different percentiles p0.90, p0.999, and p1.00:

Sample Time (in milliseconds per operation)
Framework Name p0.90 p0.999 p1.0
JMapper 10-3 0.008 64
MapStruct 10-3 0.010 68
Orika 0.006 0.278 32
ModelMapper 0.083 2.398 97
Dozer 0.146 4.526 118

While the exact results of the simple example and the real-life example were clearly different, but they do follow more or less the same trend. In both examples, we saw a close contest between JMapper and MapStruct for the top spot.

6.5. Conclusion

Based on the real-life model testing we performed in this section, we can see that the best performance clearly belongs to JMapper, although MapStruct is a close second. In the same tests, we see that Dozer is consistently at the bottom of our results table, except for SingleShotTime.

7. Summary

In this article, we've conducted performance tests of five popular Java bean mapping frameworks: ModelMapper, MapStruct, Orika, Dozer, and JMapper.

Come sempre, è possibile trovare esempi di codice su GitHub.