Bean-Mapping mit MapStruct

Transkript

1 Bean-Mapping mit MapStruct Thomas 1

2 Java und Beans, eine lange Geschichte 1995 Form Beans 1998 DTOs 1999 POJOs 2000 JPA- Entities 2006 Typsicheres, schnelles Bean- Mapping! 1997 JavaBeans 2005 JAXB- Entities

3 Alte Architekturen (J2EE) 3

4 Was Java EE 5+ und JPA versprechen 4

5 Die moderne Realität 5

6 Das = "KUNDEN") public class Kunde Long id; long kundennummer; String KundenArt kundenart; public class KundeDTO { long id; String kundennummer; String name; String kundenart; Getter und Setter! Getter und Setter! 6

7 kann aufwendig werden DTO JPA- Entity REST- Entity JAXB- Entity View- Bean 7

8 Mapping-Implementation wie? Selbst programmiert alle Getter/Setter von Hand aufrufen eigene Reflection-Routinen Reflection-Bibliotheken: Apache BeanUtils Dozer Probleme: Aufwand, fehlende Typsicherheit, Performance 8

9 Performance Performance! 9

10 MapStruct MapStruct: Annotations-Prozessor, der Mapping-Code generiert Keine Reflection! Typsicher und schnell Mind. Java 6, spezielle Unterstützung für Java 8 Minimale Laufzeitabhängigkeit (< 20 K) Je nach Komponentenmodell gar keine Abhängigkeit 10

11 Artefakte (Dependencies)

12 Beispiel JPA-Entity nach DTO Alle public-properties sollen gemappt werden (auch = "KUNDEN") public class Kunde Long id; long kundennummer; String KundenArt kundenart; public class KundeDTO { long id; String kundennummer; String name; String kundenart; Getter und Setter! Getter und Setter! 12

13 Beispiel Wünsch Dir was! import = "cdi") public interface KundeMapper { Kann global per Property festgelegt werden. Auch z.b. für Spring. KundeDTO kunde2kundedto(kunde private KundeMapper mapper; KundeDTO dto = mapper.kunde2kundedto( kunde ); 13

14 Beispiel Implementierung? Wie erzeugen wir aus dem Interface die Mapping-Implementierung? Speichern z.b. in Eclipse. Genauer: Compiler-Aufruf (geht also auch bei javac) Annotations-Prozessor erledigt den Rest! 14

15 Beispiel Live-Demo! Wie erzeugen wir aus dem Interface die Mapping-Implementierung? Speichern z.b. in Eclipse. Genauer: Compiler-Aufruf (geht also auch bei javac) Annotations-Prozessor erledigt den Rest! Live Demo 15

16 Beispiel generierter value = "org.mapstruct.ap.mappingprocessor", date = " T21:56: ", comments = "version: Final, compiler: Eclipse JDT (IDE) " public class KundeMapperImpl implements KundeMapper public KundeDTO kunde2kundedto(kunde kunde) { if ( kunde == null ) { return null; date- und comments- Attribute können unterdrückt werden Mapper sind Thread-sicher! KundeDTO kundedto = new KundeDTO(); kundedto.setname( kunde.getname() ); kundedto.setkundennummer( String.valueOf( kunde.getkundennummer() ) ); if ( kunde.getkundenart()!= null ) { kundedto.setkundenart( kunde.getkundenart().tostring() ); if ( kunde.getid()!= null ) { kundedto.setid( kunde.getid() ); return kundedto; 16

17 Kein Injection-Container? Kein Problem! import org.mapstruct.mapper; import org.mapstruct.factory.mappers; Dann wird ein kleines Runtime-JAR (ca. 16 K) = "default") public interface KundeMapper { KundeMapper INSTANCE = Mappers.getMapper(KundeMapper.class); KundeDTO kunde2kundedto(kunde kunde); KundeDTO dto = KundeMapper.INSTANCE.kunde2KundeDto( kunde ); 17

18 Typsicherheit WARN/ERROR/IGNORE konfigurierbar (pro Mapper bzw. global) 18

19 Properties umbenennen, ignorieren, public interface = "kundennummer", source = = "name", ignore = = "datum", dateformat = "dd.mm.yyyy") ) KundeDTO kunde2kundedto(kunde kunde); 19

20 public interface KundeMapper target="kundennummer", target="name", dependson={"vorname","nachname") KundeDTO kunde2kundedto(kunde kunde); setkundennummer() wird nach setkundenart() aufgerufen Keine zugesicherte Reihenfolge innerhalb des Arrays 20

21 Updates und Reverse public interface KundeMapper { Alternativ Target- Typ als Rückgabe (für ) KundeDTO kunde2kundedto(kunde kunde); void updatekundedto( Kunde KundeDTO dto); Max. ein Mapping-Target Kunde kundedto2kunde(kundedto dto); 21

22 Mappings public interface KundeMapper ) KundeDTO kunde2kundedto(kunde = ) void updatekundedto( Kunde KundeDTO = ) Kunde kundedto2kunde(kundedto dto); 22

23 Mappings (Konfigurationen) zentral mappinginheritancestrategy= MappingInheritanceStrategy.AUTO_INHERIT_FROM_CONFIG ) public interface MeineKonfiguration ) BasisDTO entity2dto(basisentity entity); Hier wird noch kein Mapping-Code public interface KundeMapper ) KundeDTO kunde2kundedto(kunde kunde); 23

24 Objektgraphen mappen public class Kunde { Adresse adresse; public class KundeDTO { AdressDTO adresse; Getter und Setter! Getter und public interface KundeMapper { KundeDTO kunde2kundedto(kunde kunde); AdresseDTO adresse2adressedto(adresse adresse); 24

25 Eigener Mapping-Code public abstract class KundeMapper ) public abstract KundeDTO kunde2kundedto(kunde k); public AdresseDTO adresse2adressedto(adresse adr) { eigener Mapping-Code Alternativ mit Interface und Java-8-Default-Methoden. 25

26 Eigener Mapping-Code (2) Eigene Mapping-Klasse muss dasselbe Komponentenmodell wie der MapStruct-Mapper verwenden oder einen Default-Konstruktor public interface KundeMapper ) KundeDTO kunde2kundedto(kunde kunde); 26

27 Exceptions beim Mapping public class MeinAdresseMapper { public AdresseDTO adressetoadressedto(adresse adresse) throws AdresseException, SchwereException { Nicht deklarierte Checked-Exceptions werden als RuntimeExceptions weiter public interface KundeMapper { KundeDTO kunde2kundedto(kunde k) throws AdresseException; 27

28 Bean-Fabriken public class DtoFactory { public KundeDTO createkundedto() { return new KundeDTO(); public class EntityFactory { public <T extends BaseEntity> T createentity(@targettype Class<T> entityclass) { return EntityFactory.class) public interface KundeMapper { KundeDTO kunde2kundedto(kunde kunde); Kunde kundedto2kunde(kundedto dto); 28

29 Mehrere Quell-Objekte Beans public interface KundeMapper { Bel. Verschachtelungstiefe (null-checks bei jedem source="gewicht") Lieferanschrift buildlieferanschrift( Kunde kunde, Adresse adresse, Integer gewicht); Bel. viele Quell-Parameter 29

30 null-mapping anpassen Bei null-quell-wert wird im Ziel standardmäßig null gesetzt. Mit nullvaluemappingstrategy = NullValueMappingStrategy.RETURN_DEFAULT werden stattdessen Default-Werte gesetzt (für primitive Type, Listen etc.) Verfügbar etc. 30

31 Default-Werte und public interface KundeMapper target="beschreibung", constant="mein String") KundeDTO kunde2kundedto(kunde kunde); Auch für Zahlen, formatierte Datumswerte und selbstgeschriebene String2xxx-Mapper 31

32 Autom. (implizite) Typumwandlung Primitive Typen Wrapper (inkl. null-checks) int Integer etc. int/long/byte Integer etc. Primitive Typen & Wrapper String int/integer/boolean String etc. enum String BigInteger/BigDecimal Primitive/Wrapper/String 32

33 Autom. Typumwandlung (JAXB) JAXBElement<T> T List<JAXBElement<T>> List<T> XMLGregorianCalendar Date/Calendar 33

34 Autom. Typumwandlung (Datum+Zeit) Date/Calendar/XMLGregorianCalendar String / dateformat Joda String / dateformat Joda Date, Calendar java.time String / dateformat java.time Date, Calendar 34

35 Formatierung public interface KundeMapper dateformat="dd.mm.yyyy") KundeDTO kunde2kundedto(kunde List<String> datelist2stringlist(list<date> list); Ebenso Map<String,String> mapknrdatum(map<long,date> map); 35

36 Arrays und public interface KundeMapper { KundeDTO kunde2kundedto(kunde kunde); List<KundeDTO> kunden2dtos(list<kunde> kunden); KundeDTO[] kunden2dtos(kunde[] kunden); KundeDTO[] kundenlist2dtoarray(list<kunde> kunden); List<KundeDTO> kundenarray2dtolist(kunde[] kunden); Set<String> ints2strings(set<integer> ints); 36

37 Enum-Werte public interface KundeMapper { KundeDTO kunde2kundedto(kunde source="normal") DtoKundenArt kundenart2dtokundenart(kundenart art); 37

38 Viele weitere Möglichkeiten Anpassbar: Namen der generierten Packages und Impl-Klassen Namen der verwendeten Zugriffsmethoden (Getter/Setter/Adder etc.) Java-Expressions zur Target-Wert-Berechnung. Mehrdeutige Target-Bean-Typen per Qualifier auswählbar. Hooks für den Mapping-Lebenszyklus Decorators für Mapper 38

39 Eclipse-Plugin Derzeit Code-Completion und einige Quick-Fixes. Refactoring-Support ist geplant. 39

40 MapStruct Fazit Hervorragend produktiv einsetzbar! Und wer Code-Generatoren nicht traut, kann zur Not den generierten Mapping-Code einchecken und von Hand weiterentwickeln. Generierter Code ist performant, einfach und lesbar. Flexible (Custom-)Mappings. Einfache Einbindung in div. Komponentenmodelle. Gute Dokumentation. 40

41 Neugierig geworden? 41

42 Danke! 42

43 Fragen? Vielen Dank! 43