Bean-Mapping mit MapStruct

Transkript

1 Machst Du noch Reflection oder annotierst Du schon? Bean-Mapping mit MapStruct Thomas Much 1

2 20 Jahre Java, 18 Jahre Beans JavaBeans JAXBEntities JPAPOJOs Entities Form Beans DTOs Typsicheres, schnelles BeanMapping! 2

3 Alte Architekturen 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, Typunsicherheit, Performance 8

9 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 9

10 Achtung, Beta! Seit 2013 in Entwicklung Aktuelle Version Beta4 Finale Version bald erwartet 10

11 Artefakte (Dependencies)

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

13 Beispiel MapStruct minimal import org.mapstruct.mapper; import public interface KundeMapper { KundeMapper INSTANCE = Mappers.getMapper(KundeMapper.class); KundeDTO kunde2kundedto(kunde kunde); Live Demo KundeDTO dto = KundeMapper.INSTANCE.kunde2KundeDto( kunde ); 13

14 Beispiel generierter value = "org.mapstruct.ap.mappingprocessor", date = " T22:01: ", comments = "version: Beta4, 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; 14

15 Typsicherheit 15

16 Meldungen für Target-Properties Alternativ global per System-Property konfigurieren 16

17 Mapper in Komponentenmodellen default cdi spring value = "org.mapstruct.ap.mappingprocessor", public class KundeMapperImpl implements KundeMapper { 17

18 Updates Beans public interface KundeMapper { Alternativ Target- Typ als Rückgabe (für fluent-aufrufe) void updatekundefromdto( KundeDTO Kunde kunde); Max. ein Mapping-Target 18

19 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); 19

20 Unterschiedliche public interface target="kundenname") ) KundeDTO kunde2kundedto(kunde target="postleitzahl") AdresseDTO adresse2adressedto(adresse adresse); 20

21 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 21

22 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 22

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

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

25 Autom. Typumwandlung public interface KundeMapper dateformat="dd.mm.yyyy") KundeDTO kunde2kundedto(kunde List<String> datelist2stringlist(list<date> list); 25

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

27 Arrays und public interface KundeMapper { CollectionMappingStrategy (Setter vs. Adder) konfigurierbar 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); 27

28 Maps public interface KundeMapper { KundeDTO kunde2kundedto(kunde kunde); Ebenso Map<String,String> mapknrdatum(map<long,date> map); 28

29 enum-werte public interface KundeMapper { KundeDTO kunde2kundedto(kunde source="normal") DtoKundenArt kundenart2dtokundenart(kundenart art); 29

30 Eigener Mapping-Code public abstract class KundeMapper ) public abstract KundeDTO kunde2kundedto(kunde k); public AdresseDTO adresse2adressedto(adresse adr) { eigener Mapping-Code 30

31 Eigener Mapping-Code (2) Eigene Mapping-Klasse muss dasselbe Komponentenmodell wie der MapStruct-Mapper public interface KundeMapper ) KundeDTO kunde2kundedto(kunde kunde); 31

32 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); 32

33 Exceptions beim Mapping public class SelbstgeschriebenerMapper { public KundenArt long2kundenart(long zahl) throws KundenArtException, SchwereException { Nicht deklarierte Checked-Exceptions werden als RuntimeExceptions weiter public interface KundeMapper { Kunde dto2kunde(kundedto dto) throws KundenArtException; 33

34 Konstante Werte im Ziel public interface KundeMapper target="stringattribut", constant="mein target="intattribut", target="longwrapperattribut", target = "dateattribut", dateformat = "dd.mm.yyyy", constant = " " ) KundeDTO kunde2kundedto(kunde kunde); 34

35 Berechnete Werte im Ziel public interface KundeMapper target="geburtsdatum", expression= "java( new Date(kunde.getGeburtsdatumMillis()) )" ) KundeDTO kunde2kundedto(kunde kunde); 35

36 Methoden per Qualifier auswählen (1) public class AnredeMapper { public String deutsch2englisch(string anrede) { public String englisch2deutsch(string anrede) public interface KundeMapper { KundeDTO kunde2kundedto(kunde kunde); 36

37 Methoden per Qualifier auswählen public class AnredeMapper public String deutsch2englisch(string anrede) public String englisch2deutsch(string anrede) public interface KundeMapper qualifiedby={ AnredeUebersetzer.class,EnglischNachDeutsch.class ) KundeDTO kunde2kundedto(kunde kunde); 37

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

39 Mapping-Konfiguration public interface KundeMapper ) KundeDTO ) void updatedtofromkunde( Kunde KundeDTO dto); 39

40 Umgekehrte public interface KundeMapper ) KundeDTO kunde2kundedto(kunde Kunde kundedto2kunde(kundedto dto); 40

41 Gemeinsam genutzte mappinginheritancestrategy= MappingInheritanceStrategy.AUTO_INHERIT_FROM_CONFIG ) public class MeineKonfiguration ) BasisDTO entity2dto(basisentity entity); Hier wird noch kein Mapping-Code public interface KundeMapper ) KundeDTO kunde2kundedto(kunde kunde); 41

42 Ausblick Eclipse-Plugin Frühes Entwicklungsstadium 42

43 MapStruct Fazit Trotz Beta schon produktiv einsetzbar! Zur Not wird der generierte Code eingecheckt und später von Hand weiter gepflegt. Generierter Code ist einfach und lesbar. Flexible (Custom-)Mappings Einfache Einbindung in div. Komponentenmodelle 43

44 Fragen? Vielen Dank!