Wer ist der optimale Java Bean Mapper?

Ich hatte ein Problem. Ich hatte einen Webservice zu implementieren.

Dabei musste ich die interne Objekthierarchie einer Anwendung auf ca. 23 Servicemethoden mappen. Zusätzlich musste der Webservice aus einem komplexen Objektgeflecht bestückt werden.

Hätte ich dieses Mapping von Hand programmiert, wäre ich Wochen damit beschäftigt gewesen. Eine Lösung dieses Problems sind die Java Bean Mapper.

In diesem Beitrag zeige ich, welche Java Bean Mapper es gibt und welche Probleme damit gelöst bzw. aufgetreten sind.

Zusätzlich habe ich die Performanz der Java Bean Mappers miteinander verglichen.

Die Aufgabe

… ist ein typisches Problem aus der Praxis. Das Mappen von strukturierten Daten an Schnittstellen bzw. in Endpoints.

Dort werden die Daten der Schnittstelle auf die interne Objekthierarchie der Anwendung gemappt.

Dabei können bei einer umfangreichen Schnittstelle mit einem komplexen Sachverhalt recht aufwändige Objektgeflechte entstehen. Erschwerend kommt noch die Verschiedenartigkeit der aneinandergrenzenden Anwendungsschichten (Persistenz-, Domain-, Service-, REST- oder Web-API) hinzu.

Werden diese Objektgeflechte von Hand gemappt, sind Fehler vorprogrammiert. Daher wird immer die Frage nach einem automatischen Mapping gestellt.

Zur Lösung des Problems fiel meine Wahl auf den Klassiker – Dozer.

Leider stellte sich recht schnell heraus, dass die Performanz dieses Mappers nicht ausreichend für die Lösung des Problems war.

Probleme über Probleme

Bei der Suche nach alternativen Java Bean Mapper traten weitere Hindernisse auf.

• Einige Mapper kamen mit den generierten JAXB-Klassen nicht zurecht, da die JAXB-Klassen nicht nach dem Java Bean Standard generiert werden. Die Collections haben keinen Setter Methoden und die Getter Methoden liefern immer eine Collection zurück.

public class XmlTable implements Serializable {
    protected List<XmlRow> rows;

    public List<XmlRow> getRows() {
        if (rows == null) {
            rows = new ArrayList<XmlRow>();
        }
        return this.rows;
    }

}

• Auch die erweiterte Generierung der JAXB-Klassen mit dem XJC-Plugin jaxb2-basics half nicht weiter.
• Dieses Plugin generiert für die Collections Setter Methoden. Aber bei einem nicht gesetzten Property wird die Setter Methode mit null aufgerufen. Daran stört sich aber die Methode addAll().

    public void setRows(List<XmlRow> value) {
        this.rows = null;
        List<XmlRow> draftl = this.getRows();
        draftl.addAll(value);
    }

• Einige Mapper können nicht rekursiv durch die Objekthierarchie iterieren.
• Somit wurden die in Collections enthaltenen Objekte nicht gemappt – sondern nur kopiert. Dadurch landeten nicht die erwarteten Klassen in den gemappten Objekten.
• Ein Beispiel ist das Mappen einer DomainTable auf eine XmlTable. Beide Klassen haben ein Property rows. Im Falle der DomainTable ist das Property vom Typ List<DomainRow> rows; und der XmlTable vom Typ List<XmlRow> rows;. Nach dem Mappen von DomainTable auf die XmlTable befindet sich im Property Objekte vom Typ DomainRow.

Die Testimplementation

Wie hab ich den Test aufgebaut?

Der Test besteht aus zwei Testläufen, die die obengenannten Probleme berücksichtigt.

1. Die Objekthierarchie wird vollständig mit Daten gefüllt.
   Leider können nicht alle Java Bean Mapper bei diesem Test eingeschossen werden. Die Mapper, die die obengenannten Probleme haben, wurden hier nicht berücksichtigt.
2. Die Objekthierarchie wird teilweise mit Daten gefüllt.
   Bei diesem einfachen Test konnten alle Java Bean Mapper berücksichtigt werden. Allerdings ist die Aussagefähigkeit dieses Tests in der Praxis fraglich, da wesentliche Funktionen fehlen.

Die Links zum Quellcode finden Sie weiter unten.

Die Objekthierarchie

In diesem Beispiel werden zwei Objekthierarchien (JAXB– und JPA-Klassen) aufeinander gemappt. Es wird der Standard Jakarta EE 10 verwendet.

Die Eingangsdatenstruktur wurde aus der WSDL (https://xmlns.frank-rahn.de/ws/test/1.0) einmalig per JAXB generiert. Die generierten Klassen wurden danach im Source-Verzeichnis abgelegt.

Die Ausgangsdatenstruktur besteht aus JPA Entities.

In den folgenden UML-Diagrammen sind die Objekthierarchien der JAXB– und JPA-Klassen dargestellt.

Der JUnit Test

In der Klasse AbstractPerformanceTest wird in der Methode runTestWithMapper() für jeden Java Bean Mapper das Mapping durchgeführt. Für jeden Durchlauf werden die Daten erfasst. Vor jeder Messreihe werden alle Mapper 10-mal aufgerufen, um den Test bzw. die Implementationen einzuschwingen. Der eigentliche Test läuft dann 10 Minuten.

Es wird die durchschnittliche Dauer in Abhängigkeit von der Anzahl der Durchläufe ermittelt.

Zusätzlich werden folgende Kenndaten über die Dauer ermittelt.

• Minimaler Wert
• Maximaler Wert
• Letzter gemessener Wert
• Arithmetischer Mittelwert
• Standardabweichung

Die Ergebnisse werden in einem Excel-Sheet dargestellt. Die Dauer wird in Millisekunden angegeben.

Im folgenden Klassendiagramm ist die Objekthierarchie des JUnit-Tests dargestellt.

Die getesteten Java Bean Mapper mit Bewertung und Hinweise zur Implementierung

Bei der Implementierung habe ich darauf geachtet, dass keine Technik zum Einsatz kommt, die eine direkte Änderung des Quellcodes der JAXB- bzw. JPA-Klassen erzwungen hätte. Z. B. durch den Einsatz einer speziellen Annotation eines Mapper Frameworks.

Die folgenden Java Bean Mapper wurden von mir untersucht.

ByHand

Der Java Bean Mapper ByHand ist kein automatisch generierter Mapper.

Dieser Java Bean Mapper ist eine Implementierung von Hand (hand coded). Hierbei wird jedes einzelne Property von einem Java Bean in ein anderes Java Bean, ggf. mit Typkonvertierung, übertragen.

Das Erstellen dieses Mappers ist sehr zeitintensiv und fehleranfällig. Eigentlich eine Aufgabe für einen dressierten Affen. Allerdings können alle fachlichen Aspekte individuell berücksichtigt werden.

Diese Art von Mappern liefert die beste Performanz.

/**
 * Der Mapper per "ByHand".
 *
 * @author Frank W. Rahn
 */
@Component("ByHand")
@Order(0)
public class ByHandTestBeansMapperBean extends AbstractTestBeansMapperBean {

  /**
   * {@inheritDoc}
   *
   * @see TestBeansMapperBean#map(DomainTable)
   */
  @Override
  public XmlTable map(DomainTable source) throws Exception {
    return map(createXmlTable(), source);
  }

  /**
   * {@inheritDoc}
   *
   * @see TestBeansMapperBean#map(XmlTable)
   */
  @Override
  public DomainTable map(XmlTable source) throws Exception {
    return map(new DomainTable(), source);
  }

  private DomainRow map(DomainRow target, XmlRow source) {
    // Mapping String
    target.setColumn00(source.getColumn00());
    target.setColumn01(source.getColumn01());
    target.setColumn02(source.getColumn02());
    target.setColumn03(source.getColumn03());
    target.setColumn04(source.getColumn04());
    target.setColumn05(source.getColumn05());
    target.setColumn06(source.getColumn06());
    target.setColumn07(source.getColumn07());
    target.setColumn08(source.getColumn08());
    target.setColumn09(source.getColumn09());

    // Mapping int
    target.setColumn10(source.getColumn10());
    target.setColumn11(source.getColumn11());
    target.setColumn12(source.getColumn12());
    target.setColumn13(source.getColumn13());
    target.setColumn14(source.getColumn14());
    target.setColumn15(source.getColumn15());
    target.setColumn16(source.getColumn16());
    target.setColumn17(source.getColumn17());
    target.setColumn18(source.getColumn18());
    target.setColumn19(source.getColumn19());

    // Mapping boolean
    target.setColumn20(source.isColumn20());
    target.setColumn21(source.isColumn21());
    target.setColumn22(source.getColumn22());
    target.setColumn23(source.isColumn23());
    target.setColumn24(source.isColumn24());
    target.setColumn25(source.isColumn25());
    target.setColumn26(source.isColumn26());
    target.setColumn27(source.isColumn27());
    target.setColumn28(source.isColumn28());
    target.setColumn29(source.isColumn29());

    // Mapping long
    target.setColumn30(source.getColumn30());
    target.setColumn31(source.getColumn31());
    target.setColumn32(source.getColumn32());
    target.setColumn33(source.getColumn33());
    target.setColumn34(source.getColumn34());
    target.setColumn35(source.getColumn35());
    target.setColumn36(source.getColumn36());
    target.setColumn37(source.getColumn37());
    target.setColumn38(source.getColumn38());
    target.setColumn39(source.getColumn39());

    // Mapping BigDecimal
    target.setColumn40(source.getColumn40());
    target.setColumn41(source.getColumn41());
    target.setColumn42(source.getColumn42());
    target.setColumn43(source.getColumn43());
    target.setColumn44(source.getColumn44());
    target.setColumn45(source.getColumn45());
    target.setColumn46(source.getColumn46());
    target.setColumn47(source.getColumn47());
    target.setColumn48(source.getColumn48());
    target.setColumn49(source.getColumn49());

    // Mapping Calendar
    target.setColumn50(source.getColumn50());
    target.setColumn51(source.getColumn51());
    target.setColumn52(source.getColumn52());
    target.setColumn53(source.getColumn53());
    target.setColumn54(source.getColumn54());
    target.setColumn55(source.getColumn55());
    target.setColumn56(source.getColumn56());
    target.setColumn57(source.getColumn57());
    target.setColumn58(source.getColumn58());
    target.setColumn59(source.getColumn59());

    // Mapping String
    target.setColumn60(source.getColumn60());
    target.setColumn61(source.getColumn61());
    target.setColumn62(source.getColumn62());
    target.setColumn63(source.getColumn63());
    target.setColumn64(source.getColumn64());
    target.setColumn65(source.getColumn65());
    target.setColumn66(source.getColumn66());
    target.setColumn67(source.getColumn67());
    target.setColumn68(source.getColumn68());
    target.setColumn69(source.getColumn69());

    // Mapping int
    target.setColumn70(source.getColumn70());
    target.setColumn71(source.getColumn71());
    target.setColumn72(source.getColumn72());
    target.setColumn73(source.getColumn73());
    target.setColumn74(source.getColumn74());
    target.setColumn75(source.getColumn75());
    target.setColumn76(source.getColumn76());
    target.setColumn77(source.getColumn77());
    target.setColumn78(source.getColumn78());
    target.setColumn79(source.getColumn79());

    // Mapping String[]
    if (source.getColumns() != null) {
      target.setColumns(new ArrayList<>(source.getColumns()));
    }

    return target;
  }

  private DomainTable map(DomainTable target, XmlTable source) {
    target.setName(source.getName());

    if (source.getDate() != null) {
      target.setDate(source.getDate().getTime());
    }

    if (source.getRows().isEmpty()) {
      target.setRows(new ArrayList<DomainRow>());
    } else {
      List<DomainRow> rows = new ArrayList<>();
      for (XmlRow xmlRow : source.getRows()) {
        rows.add(map(new DomainRow(), xmlRow));
      }
      target.setRows(rows);
    }

    return target;
  }

  private XmlRow map(XmlRow target, DomainRow source) {
    // Mapping String
    target.setColumn00(source.getColumn00());
    target.setColumn01(source.getColumn01());
    target.setColumn02(source.getColumn02());
    target.setColumn03(source.getColumn03());
    target.setColumn04(source.getColumn04());
    target.setColumn05(source.getColumn05());
    target.setColumn06(source.getColumn06());
    target.setColumn07(source.getColumn07());
    target.setColumn08(source.getColumn08());
    target.setColumn09(source.getColumn09());

    // Mapping int
    target.setColumn10(source.getColumn10());
    target.setColumn11(source.getColumn11());
    target.setColumn12(source.getColumn12());
    target.setColumn13(source.getColumn13());
    target.setColumn14(source.getColumn14());
    target.setColumn15(source.getColumn15());
    target.setColumn16(source.getColumn16());
    target.setColumn17(source.getColumn17());
    target.setColumn18(source.getColumn18());
    target.setColumn19(source.getColumn19());

    // Mapping boolean
    target.setColumn20(source.isColumn20());
    target.setColumn21(source.isColumn21());
    target.setColumn22(source.getColumn22());
    target.setColumn23(source.isColumn23());
    target.setColumn24(source.isColumn24());
    target.setColumn25(source.isColumn25());
    target.setColumn26(source.isColumn26());
    target.setColumn27(source.isColumn27());
    target.setColumn28(source.isColumn28());
    target.setColumn29(source.isColumn29());

    // Mapping long
    target.setColumn30(source.getColumn30());
    target.setColumn31(source.getColumn31());
    target.setColumn32(source.getColumn32());
    target.setColumn33(source.getColumn33());
    target.setColumn34(source.getColumn34());
    target.setColumn35(source.getColumn35());
    target.setColumn36(source.getColumn36());
    target.setColumn37(source.getColumn37());
    target.setColumn38(source.getColumn38());
    target.setColumn39(source.getColumn39());

    // Mapping BigDecimal
    target.setColumn40(source.getColumn40());
    target.setColumn41(source.getColumn41());
    target.setColumn42(source.getColumn42());
    target.setColumn43(source.getColumn43());
    target.setColumn44(source.getColumn44());
    target.setColumn45(source.getColumn45());
    target.setColumn46(source.getColumn46());
    target.setColumn47(source.getColumn47());
    target.setColumn48(source.getColumn48());
    target.setColumn49(source.getColumn49());

    // Mapping Calendar
    target.setColumn50(source.getColumn50());
    target.setColumn51(source.getColumn51());
    target.setColumn52(source.getColumn52());
    target.setColumn53(source.getColumn53());
    target.setColumn54(source.getColumn54());
    target.setColumn55(source.getColumn55());
    target.setColumn56(source.getColumn56());
    target.setColumn57(source.getColumn57());
    target.setColumn58(source.getColumn58());
    target.setColumn59(source.getColumn59());

    // Mapping String
    target.setColumn60(source.getColumn60());
    target.setColumn61(source.getColumn61());
    target.setColumn62(source.getColumn62());
    target.setColumn63(source.getColumn63());
    target.setColumn64(source.getColumn64());
    target.setColumn65(source.getColumn65());
    target.setColumn66(source.getColumn66());
    target.setColumn67(source.getColumn67());
    target.setColumn68(source.getColumn68());
    target.setColumn69(source.getColumn69());

    // Mapping int
    target.setColumn70(source.getColumn70());
    target.setColumn71(source.getColumn71());
    target.setColumn72(source.getColumn72());
    target.setColumn73(source.getColumn73());
    target.setColumn74(source.getColumn74());
    target.setColumn75(source.getColumn75());
    target.setColumn76(source.getColumn76());
    target.setColumn77(source.getColumn77());
    target.setColumn78(source.getColumn78());
    target.setColumn79(source.getColumn79());

    // Mapping String[]
    if (source.getColumns() == null) {
      target.setColumns(null);
    } else {
      target.setColumns(new ArrayList<>(source.getColumns()));
    }

    return target;
  }

  private XmlTable map(XmlTable target, DomainTable source) {
    target.setName(source.getName());

    if (source.getDate() != null) {
      Calendar calendar = Calendar.getInstance();
      calendar.setTime(source.getDate());
      target.setDate(calendar);
    }

    if (source.getRows() != null) {
      for (DomainRow domainRow : source.getRows()) {
        target.getRows().add(map(createXmlRow(), domainRow));
      }
    }

    return target;
  }

}

Apache Commons BeanUtils

Dieser Java Bean Mapper ist Teil der Bibliothek Apache Commons BeanUtils der Apache Software Foundation. Dieses Projekt stellt nützliche Tools rund um den Standard JavaBeans Component API java.beans.Introspector zu Verfügung und verwendet zum Mappen Reflection (reflection-based).

Der Mapper besteht aus der Klasse org.apache.commons.beanutils.BeanUtils. Dieser Mapper kann das zumappende Objekt nicht rekursive bearbeiten und ist auf die Setter Methode angewiesen – ohne diese kann er die Werte nicht mappen.

Daher kann er nur für einfache und nicht tiefgreifende Mappings verwendet werden.

In diesen Fällen allerdings liefert er eine gute Performanz und ist sehr einfach eingesetzt.

/**
 * Der Mapper für {@link BeanUtils}.
 *
 * @author Frank W. Rahn
 */
@Component("Commons-BeanUtils")
@Order(1)
public class CommonsBeanUtilsTestBeansMapperBean extends AbstractTestBeansMapperBean {

  /**
   * {@inheritDoc}
   *
   * @see TestBeansMapperBean#map(DomainTable)
   */
  @Override
  public XmlTable map(DomainTable source) throws Exception {
    XmlTable target = createXmlTable();
    BeanUtils.copyProperties(target, source);
    return target;
  }

  /**
   * {@inheritDoc}
   *
   * @see TestBeansMapperBean#map(XmlTable)
   */
  @Override
  public DomainTable map(XmlTable source) throws Exception {
    DomainTable target = new DomainTable();
    BeanUtils.copyProperties(target, source);
    return target;
  }

}

Spring Framework BeanUtils

Dieser Java Bean Mapper ist Teil vom Spring Framework und wird intern vom Spring Framework selber verwendet.

Der Mapper besteht aus der Klasse org.springframework.beans.BeanUtils. Diese Klasse nutzt den Standard JavaBeans Component API java.beans.Introspector und verwendet Reflection (reflection-based).

Dieser Mapper arbeitet ähnlich wie die Apache Common BeanUtils, hat die gleichen Probleme und liefert die gleiche Performanz.

Update (01.01.2020): Seit der Spring Framework Version 5.3 hat sich das Vorgehen beim Mappen von Collection geändert. Die generischen Typinformationen werden jetzt berücksichtigt. Dadurch werden Collection nur noch gemappt, wenn der generische Typ passt. Vorher war die Klasse der Collection entscheidend.

/**
 * Der Mapper für {@link BeanUtils}.
 *
 * @author Frank W. Rahn
 */
@Component("Spring-BeanUtils")
@Order(2)
public class SpringBeanUtilsTestBeansMapperBean extends AbstractTestBeansMapperBean {

  /**
   * {@inheritDoc}
   *
   * @see TestBeansMapperBean#map(DomainTable)
   */
  @Override
  public XmlTable map(DomainTable source) throws Exception {
    XmlTable target = createXmlTable();
    BeanUtils.copyProperties(source, target);
    return target;
  }

  /**
   * {@inheritDoc}
   *
   * @see TestBeansMapperBean#map(XmlTable)
   */
  @Override
  public DomainTable map(XmlTable source) throws Exception {
    DomainTable target = new DomainTable();
    BeanUtils.copyProperties(source, target);
    return target;
  }

}

Dozer

Der Java Bean Mapper Dozer ist ein komplettes Mapping Framework.

Dozer verwendet den Standard JavaBeans Component API java.beans.Introspector und Reflection (reflection-based) zum Erzeugen der Mapper und kann die Objekte rekursiv durcharbeiten.

Dozer kann über eine XML-Datei umfangreich konfiguriert werden. Die Möglichkeiten der Konfiguration dieses Mappers lassen keine Wünsche offen.

Wie beim Mapper ByHand können alle individuellen fachlichen Aspekte berücksichtigt werden. Die Konfiguration geht schnell vonstatten.

Leider liefert dieser Mapper aber auch die schlechteste Performanz.

/**
 * Der Mapper für {@link Mapper}.
 *
 * @author Frank W. Rahn
 */
@Component("Dozer")
@Order(3)
public class DozerTestBeansMapperBean extends AbstractTestBeansMapperBean {

  private Mapper dozer;

  /**
   * Initialisiere diese Spring-Bean.
   */
  @PostConstruct
  public void initialize() {
    dozer = DozerBeanMapperBuilder.create()
        // Bekannt geben, dass die Xml*-Klassen JAXB Objekte sind
        .withMappingBuilder(new BeanMappingBuilder() {
          @Override
          protected void configure() {
            mapping(new TypeDefinition(DomainTable.class),
                new TypeDefinition(XmlTable.class).beanFactory(JAXBBeanFactory.class));
          }
        })
        .withMappingBuilder(new BeanMappingBuilder() {
          @Override
          protected void configure() {
            mapping(new TypeDefinition(DomainRow.class),
                new TypeDefinition(XmlRow.class).beanFactory(JAXBBeanFactory.class));
          }
        })
        .build();
  }

  @Override
  public XmlTable map(DomainTable source) throws Exception {
    return dozer.map(source, XmlTable.class);
  }

  @Override
  public DomainTable map(XmlTable source) throws Exception {
    return dozer.map(source, DomainTable.class);
  }
}

Update (Fehlende Versionen 6.0.0 bis 6.5.0): Hier ist mir leider ein Fehler unterlaufen. Wenn ich in diesen Beitrag aktualisieren, schaue ich immer in den zentralen Maven-Repositories nach, ob dort neue Versionen veröffentlicht wurden. Dabei verwende ich die Maven-Suche mit dem Artefaktnamen. In diesem Punkt habe ich leider die Änderung im Artefaktnamen (net.sf.dozer:dozer → com.github.dozermapper:dozer-core) übersehen und so hat sich nie die Versionsnummer geändert.

Update (07.04.2021): Dieser Mapper wird nicht mehr weiterentwickelt.

The project is currently not active and will more than likely be deprecated in the future.

https://github.com/DozerMapper/dozer/blob/master/README.md#project-activity

Orika

Der Java Bean Mapper Orika ist ähnlich wie Dozer ein Mapping Framework.

Im Grunde stellt Orika einen Replacment von Dozer mit gleichem Funktionsumfang dar.

Allerdings verwendet Orika die Bytecode Generierung von Javassist zum Erzeugen der Mapper. Dadurch hat Orika, bei gleichem Funktionsumfang, eine deutlich bessere Performanz als Dozer. Allerdings können die generierten Mapper nicht debuggt werden.

/**
 * Der Mapper für {@link MapperFacade}.
 *
 * @author Frank W. Rahn
 */
@Component("Orika")
@Order(4)
public class OrikaTestBeansMapperBean extends AbstractTestBeansMapperBean {

  private MapperFacade orika;

  /**
   * Initialisiere diese Spring-Bean.
   */
  @PostConstruct
  public void initialize() {
    MapperFactory factory = new DefaultMapperFactory.Builder().build();
    orika = factory.getMapperFacade();
  }

  /**
   * {@inheritDoc}
   *
   * @see TestBeansMapperBean#map(DomainTable)
   */
  @Override
  public XmlTable map(DomainTable source) throws Exception {
    return orika.map(source, XmlTable.class);
  }

  /**
   * {@inheritDoc}
   *
   * @see TestBeansMapperBean#map(XmlTable)
   */
  @Override
  public DomainTable map(XmlTable source) throws Exception {
    return orika.map(source, DomainTable.class);
  }

}

MapStruct

Der Java Bean Mapper MapStruct ist auch ein Mapping Framework.

Allerdings geht dieser Mapper einen kompletten neuen Weg.

Er verwendet einen Annotation Processor (APT) zum Erzeugen von Mappern für die einzelnen Java Beans. Diese generierten Mapper sind richtige Java-Klassen – können also im Fehlerfall auch debuggt werden.

Als Ausgangsbasis dient dem Prozessor ein Interface oder eine abstrakte Basisklasse.

Falls Sie sich für eine abstrakte Basisklasse entscheiden, kann diese Klasse eine individuelle Implementierungen liefern. Damit erreicht dieses Mapping den vollständigen Funktionsumfang wie der Mapper ByHand. Allerdings auch zu einem höheren Implementierungsaufwand im Gegensatz zu Dozer oder Orika.

Diese Interfaces müssen geschrieben werden. Bei einer umfangreichen Objekthierarchie benötigt das Schreiben der Interfaces seine Zeit.

Die dadurch gewonnene Performanz hebt diesen Nachteil allerdings vollständig auf. Dieser Mapper wurde nur geringfügig (im Bereich von Millisekunden) durch den Mapper ByHand geschlagen. Der wesentlich mühseliger zu programmieren ist.

/**
 * Der Mapper für MapStruct.
 *
 * @author Frank W. Rahn
 */
@Component("MapStruct")
@Order(5)
public class MapStructTestBeansMapperBean extends AbstractTestBeansMapperBean {

  @Autowired
  private TestBeansMapper testBeansMapper;

  /**
   * {@inheritDoc}
   *
   * @see TestBeansMapperBean#map(DomainTable)
   */
  @Override
  public XmlTable map(DomainTable source) throws Exception {
    return testBeansMapper.domainTableToXmlTable(source);
  }

  /**
   * {@inheritDoc}
   *
   * @see TestBeansMapperBean#map(XmlTable)
   */
  @Override
  public DomainTable map(XmlTable source) throws Exception {
    return testBeansMapper.xmlTableToDomainTable(source);
  }

}

ModelMapper

Die Berücksichtigung des Java Bean Mapper ModelMapper wurde in den Kommentaren gewünscht.

Dieser Mapper ähnelt in der Funktionsweise den schon vorher beschriebenen Mappern Orika und Dozer. Dieser Mapper verwendet die Bytecode Generierung von cglib. Das Debuggen der erzeugten Mapper gestaltet sich dadurch schwierig.

Dieser Mapper bietet eine API für spezifische Anwendungsfälle an.

/**
 * Der Mapper für {@link ModelMapper}.
 *
 * @author Frank W. Rahn
 */
@Component("ModelMapper")
@Order(6)
public class ModelMapperTestBeansMapperBean extends AbstractTestBeansMapperBean {

  private ModelMapper modelMapper;

  /**
   * Initialisiere diese Spring-Bean.
   */
  @PostConstruct
  public void initialize() {
    modelMapper = new ModelMapper();
  }

  /**
   * {@inheritDoc}
   *
   * @see TestBeansMapperBean#map(DomainTable)
   */
  @Override
  public XmlTable map(DomainTable source) throws Exception {
    return modelMapper.map(source, XmlTable.class);
  }

  /**
   * {@inheritDoc}
   *
   * @see TestBeansMapperBean#map(XmlTable)
   */
  @Override
  public DomainTable map(XmlTable source) throws Exception {
    return modelMapper.map(source, DomainTable.class);
  }

}

JMapper Framework

Die Berücksichtigung des Java Bean Mapper JMapper Framework wurde in den Kommentaren gewünscht.

Dieser Mapper ähnelt einwenig dem Mapper MapStruct. Auch bei diesem Mapper muss zwingend eine Konfiguration erstellt werden. Beim JMapper kann zwischen drei Konfigurationsvarianten gewählt werden.

• Der Verwendung von Annotationen an den Klassen
• Eine Konfiguration basierend auf einer XML Datei
• Der JMapper API, welche eine programmatische Konfiguration ermöglicht

Ich habe mich in diesem Beispiel für die Variante JMapper API entschieden.

Der JMapper verwendet die Bytecode Generierung von Javassist zum Erzeugen der Mapper. Das Debuggen der erzeugten Mapper gestaltet sich dadurch schwierig.

Die Performanz dieses Mappers ist beeindruckend. Er kann locker mit dem Mapper ByHand mithalten und ist einfacher umzusetzen als der Mapper MapStruct.

Weitere Features dieses Mappers sind …

• Relationales Mapping von mehreren Klassen auf eine Klasse (Many to One) und umgekehrt (One to Many)
• Vererbung von Konfigurationen

/**
 * Der Mapper für {@link JMapper}.
 *
 * @author Frank W. Rahn
 */
@Component("JMapper")
@Order(7)
public class JMapperTestBeansMapperBean extends AbstractTestBeansMapperBean {

  private JMapper<XmlTable, DomainTable> domainToXmlMapper;

  private JMapper<DomainTable, XmlTable> xmlToDomainMapper;

  /**
   * Initialisiere diese Spring-Bean.
   */
  @PostConstruct
  public void initialize() {
    JMapperAPI jMapperAPI = new JMapperAPI()
      .add(mappedClass(XmlTable.class).add(global())
        .add(conversion("dateToCalendar").from("date").to("date")
          .body("java.util.Calendar c = java.util.Calendar.getInstance(); c.setTime(${source}); return c;")))
      .add(mappedClass(XmlRow.class).add(global()))
      .add(mappedClass(DomainTable.class).add(global().excludedAttributes("id"))
        .add(conversion("calendarToDate").from("date").to("date").body("return ${source}.getTime();"))
        .add(attribute("rows").value("rows").targetClasses(DomainRow.class)))
      .add(mappedClass(DomainRow.class).add(global().excludedAttributes("id")));

    domainToXmlMapper = new JMapper<>(XmlTable.class, DomainTable.class, jMapperAPI);
    xmlToDomainMapper = new JMapper<>(DomainTable.class, XmlTable.class, jMapperAPI);
  }

  /**
   * {@inheritDoc}
   *
   * @see TestBeansMapperBean#map(DomainTable)
   */
  @Override
  public XmlTable map(DomainTable source) throws Exception {
    return domainToXmlMapper.getDestination(source);
  }

  /**
   * {@inheritDoc}
   *
   * @see TestBeansMapperBean#map(XmlTable)
   */
  @Override
  public DomainTable map(XmlTable source) throws Exception {
    return xmlToDomainMapper.getDestination(source);
  }

}

Update (01.01.2021): Dieser Mapper wird nicht mehr weiterentwickelt. Der Entwickler schrieb im GitHub Issue 88 dazu:

… I’ve lost interest in JMapper …

https://github.com/jmapper-framework/jmapper-core/issues/88

Update (10.12.2022): Wie in den Kommentaren beschrieben, ist dieser Mapper nicht unter Java 17 lauffähig. Daher werde ich diesen Mapper nicht mehr berücksichtigen.

Selma

Die Berücksichtigung des Java Bean Mapper Selma wurde in den Kommentaren gewünscht.

Dieser Mapper verwendet einen Annotation Processor (APT) zum Erzeugen der Mapper und ähnelt damit dem schon vorher beschriebenen Mapper MapStruct.

Im Gegensatz zu MapStruct ist der Aufwand für die Implementierung etwas geringer, da nicht für jedes Mapping eine neue Methode definiert werden muss.

/**
 * Der Mapper für {@link Selma}.
 *
 * @author Frank W. Rahn
 */
@Component("Selma")
@Order(8)
public class SelmaTestBeansMapperBean extends AbstractTestBeansMapperBean {

  @Autowired
  private TestBeansMapper mapper;

  /**
   * {@inheritDoc}
   *
   * @see TestBeansMapperBean#map(DomainTable)
   */
  @Override
  public XmlTable map(DomainTable source) throws Exception {
    return mapper.asXmlTable(source);
  }

  /**
   * {@inheritDoc}
   *
   * @see TestBeansMapperBean#map(XmlTable)
   */
  @Override
  public DomainTable map(XmlTable source) throws Exception {
    return mapper.asDomainTable(source);
  }

}

Update (03.01.2021): Seit dem Umstieg auf das OpenJDK v11 (64 Bit, AdoptOpenJDK Hotspot) werden in Eclipse v4.16.0 zwei Fehler angezeigt – trotzdem wird der Mapper generiert. Maven liefert dazu keine Meldungen. Diese Meldungen können ignoriert werden. Dazu gibt es auch eine Meldung in GitHub Issue 204: Migration Java 8 -> Java 11: mapper: java.lang.NullPointerException.

Error while searching builder for field name on InOutType{in=de.rahn.performance.testbeans.DomainTable, out=https.xmlns_frank_rahn_de.types.testtypes._1.XmlTable, outPutAsParam=false} mapper: java.lang.NullPointerException
Error while searching builder for field name on InOutType{in=https.xmlns_frank_rahn_de.types.testtypes._1.XmlTable, out=de.rahn.performance.testbeans.DomainTable, outPutAsParam=false} mapper: java.lang.NullPointerException

Update (04.01.2022): Mittlerweile bin ich von AdoptOpenJDK wieder auf das Standard OpenJDK zurückgewechselt, da dieses sich unter Ubuntu besser ins System (Stichwort: Zertifikate, …) integriert. Wenn ich die Tests in Eclipse ausführe, tritt leider ein Fehler auf. Die Unterobjekte werden nicht mehr gemappt. Ich hab dazu das Erstellen der Messungen verändert. Ab der Version v1.5.3 werden die Excel-Sheets per Maven auf der Kommandozeile erzeugt (Siehe Durchführung der Messungen). Da gibt es den Fehler, wie in Eclipse, nicht.

reMap

Die Berücksichtigung des Java Bean Mapper reMap wurde in den Kommentaren gewünscht.

reMap verwendet die Bytecode Generierung von cglib zur Erzeugung von Mappern. Das Debuggen der erzeugten Mapper gestaltet sich dadurch schwierig.

Der Schwerpunkt von reMap liegt in der Robustheit und einem minimalen Verwaltungsaufwand für Tests.

Durch das Hauptaugenmerk auf Robustheit müssen mehr Angaben zum Mapping gemacht werden, als bei anderen Mappern nötig ist. Aber es ist gewollt, dass hier wenige Automatik greift und einiges dem Compiler überlassen wird.

/**
 * Der Mapper für {@link Mapper}.
 *
 * @author Tom Hombergs
 */
@Component("reMap")
@Order(9)
public class ReMapTestBeansMapperBean implements TestBeansMapperBean {

  protected Mapper<DomainTable, XmlTable> domainToXmlTableMapper;

  protected Mapper<XmlTable, DomainTable> xmlToDomainTableMapper;

  /**
   * {@inheritDoc}
   *
   * @see TestBeansMapperBean#getMapperName()
   */
  @Override
  public String getMapperName() {
    return "reMap";
  }

  /**
   * Initialisiere diese Spring-Bean.
   */
  @PostConstruct
  public ReMapTestBeansMapperBean initialize() {
    Mapper<DomainRow, XmlRow> domainToXmlRowMapper = Mapping.from(DomainRow.class).to(XmlRow.class).mapper();
    Mapper<XmlRow, DomainRow> xmlToDomainRowMapper = Mapping.from(XmlRow.class).to(DomainRow.class).mapper();

    // @formatter:off
    domainToXmlTableMapper = Mapping
      .from(DomainTable.class)
      .to(XmlTable.class)
      .replace(DomainTable::getDate, XmlTable::getDate)
        .with(dateToCalendar())
      .useMapper(domainToXmlRowMapper)
      .mapper();

    xmlToDomainTableMapper = Mapping
      .from(XmlTable.class)
      .to(DomainTable.class)
      .replace(XmlTable::getDate, DomainTable::getDate)
        .with(calendarToDate())
      .useMapper(xmlToDomainRowMapper).mapper();
    // @formatter:on

    return this;
  }

  /**
   * {@inheritDoc}
   *
   * @see TestBeansMapperBean#map(DomainTable)
   */
  @Override
  public XmlTable map(DomainTable source) throws Exception {
    return domainToXmlTableMapper.map(source);
  }

  /**
   * {@inheritDoc}
   *
   * @see TestBeansMapperBean#map(XmlTable)
   */
  @Override
  public DomainTable map(XmlTable source) throws Exception {
    return xmlToDomainTableMapper.map(source);
  }

  /**
   * @return ein Transformer von {@link Date} nach {@link Calendar}
   */
  protected Function<Date, Calendar> dateToCalendar() {
    return source -> {
      if (source == null) {
        return null;
      }

      Calendar c = Calendar.getInstance();
      c.setTime(source);
      return c;
    };
  }

  /**
   * @return ein Transformer von {@link Calendar} nach {@link Date}
   */
  protected Function<Calendar, Date> calendarToDate() {
    return source -> {
      if (source == null) {
        return null;
      }

      return source.getTime();
    };
  }

}

Im folgenden Quellcode die Beispiele für die Tests des Mappers.

/**
 * Test des Mappers für reMap.
 *
 * @author Tom Hombergs
 */
public class ReMapTestBeansMapperBeanTest extends AbstractTestBeansMapperBeanTest {

  /**
   * @throws java.lang.Exception
   */
  @Before
  public void setUp() throws Exception {
    mapperBean = new ReMapTestBeansMapperBean().initialize();
  }

  /**
   * Teste den Mapper.
   */
  @Test
  public void testDomainToXmlTableMapper() throws Exception {
    ReMapTestBeansMapperBean reMapTestBeansMapperBean = (ReMapTestBeansMapperBean) mapperBean;

    // @formatter:off
    AssertMapping.of(reMapTestBeansMapperBean.domainToXmlTableMapper)
      .expectReplace(DomainTable::getDate, XmlTable::getDate)
        .andTest(reMapTestBeansMapperBean.dateToCalendar())
      .ensure();
    // @formatter:on
  }

  /**
   * Teste den Mapper.
   */
  @Test
  public void testXmlToDomainTableMapper() throws Exception {
    ReMapTestBeansMapperBean reMapTestBeansMapperBean = (ReMapTestBeansMapperBean) mapperBean;

    // @formatter:off
    AssertMapping.of(reMapTestBeansMapperBean.xmlToDomainTableMapper)
      .expectReplace(XmlTable::getDate, DomainTable::getDate)
        .andTest(reMapTestBeansMapperBean.calendarToDate())
      .ensure();
    // @formatter:on
  }

}

Das Fazit

In der folgenden Tabelle sind die Durchschnittswerte für ein Mapping mit vollständig gefüllter Objekthierarchie in Millisekunden angegeben. Die Veränderungen zur vorherigen Messung sind Fett markiert.

Die nicht mehr weiterentwickelten Mapper werden so lange weiter getestet, wie sie funktionieren.

Der Link „Anmerkungen“ zeigt auf zusätzlichen Informationen, wie z. B. Inaktivität oder wichtige Änderungen.

 
Alle Tests, mit den unterschiedlichen Rahmenbedingungen, sind im GitHub-Verzeichnis zu finden.

Excel Arbeitsmappe: Das zweite Tabellenblatt enthält die Messwerte. Auf dem ersten Tabellenblatt sind die Messwerte des Einschwingvorgangs.

Die Maven-Befehle zur Durchführung der Tests befinden sind in diesem Kapitel Durchführen der Messungen beschrieben.

Die Umfragen

 
Der Quellcode und Download

Quellcode ansehen bei GitHub:
Java Bean Mapper

Download einer ZIP-Datei von GitHub:
Java Bean Mapper

Die Maven Befehle

Eclipse Konfiguration neu erzeugen: $ mvn eclipse:clean eclipse:eclipse

Es wird das Eclipse Plug-in M2Eclipse verwendet.

Die Anwendungen bauen: $ mvn clean install

Durchführen der Messungen

Auf der Konsole in das Root-Verzeichnis des Projektes wechseln und die folgenden Befehle ausführen.

$ mvn clean install
$ cd bean-mapper-test/
$ mvn -Dtest=PerformanceTestWithCompleteFixtures test
$ mvn -Dtest=PerformanceTestWithIncompleteFixtures test