Mapstruct Java-Beispiel: Zuordnen mehrerer Felder zu einer Eigenschaft und Zuordnen einer Eigenschaft zu mehreren Eigenschaften.

Spring Framework Spring Boot

Spring Boot ist ein beliebtes Java-Framework. Spring Boot bietet einem Entwicklungsteam viel Konsistenz. Teams, die eine Spring-basierte Anwendung erstellen, werden feststellen, dass Dinge wie Konfigurationsdateien, Java Beans und eine gemeinsame Bibliothek von Tools von einem Spring Boot-Projekt zum anderen konsistent verfügbar sind.

Darüber hinaus können beim Erstellen von Spring-Microservices-Projekten zwei Dienste eine ähnliche Struktur, Codebasis, Integrationstests usw. gemeinsam nutzen, was die Wartungskosten senkt.

Codegeneratoren tragen dazu bei, die Entwicklungs- und Wartungskosten zu senken. Einer der von uns verwendeten Codegeneratoren ist Mapscruct.

Mapstruct Spring Boot

Mapstrruct ist eine einfache Möglichkeit, öffentlich zugängliche Ansichten in Datenansichten zu konvertieren.

Wenn Sie nicht wissen, was Mapstruct oder Objektmapping ist, lesen Sie bitte: /training/spring-boot/mapstruct/für einen allgemeinen Überblick.

In diesem Artikel stellen wir ein einfaches Tutorial bereit, in dem die Zuordnung von mehreren Quelleigenschaften zu einer einzigen Zieleigenschaft erläutert wird.

Wir verwenden Mapstruct häufig in unseren Spring- und Spring-Boot-Anwendungen. Mapstruct ist ein großartiges Tool zum Zuordnen von Objekten von dem, was von einer Webanwendung oder mobilen Anwendung an die Spring-Boot-Microservices-API gesendet wird, zu dem, was in der Datenbank gespeichert ist. Weitere Informationen finden Sie unter

Kartenstrukturund Mapping von Pojos hier: (http://www.ibcscorp.com/training/mapstruct)

Mapstruct bildet primitive Objekte bereits vorab perfekt ab. Das spart jede Menge Arbeit

Mapstruct bildet primitive Objekte standardmäßig perfekt ab. Das erspart viel Arbeit.

Manchmal möchten wir jedoch eine bestimmte Zuordnung manuell implementieren, damit wir beim Transformieren von einem Objekt in ein anderes die Geschäftslogik definieren können. Um diese Transformationen durchzuführen, können wir benutzerdefinierte Methoden direkt in unserer Mapper-Schnittstelle implementieren, indem wir eine Standardmethode definieren.

MapStruct unterstützt standardmäßig nicht das Zuordnen mehrerer Quelleigenschaften zu einer einzigen Zieleigenschaft. Wir können jedoch auf folgende Weise mehrere Eigenschaften einer Eigenschaft zuordnen.

Verwenden von Qualifizierern

Um dies zu erreichen, müssen wir eine Methode zur Konvertierung definieren. Dann müssen wir MapStruct über die Methode informieren. Schließlich ruft MapStruct die Methode auf, um die Konvertierung von der Quelle zum Ziel durchzuführen.

Bevor wir das Zuordnen mehrerer Quelleigenschaften zu einer einzigen Zieleigenschaft mit mapstruct erklären, definieren wir einige Ansichten. Eine Personen- und eine Entitätsklasse, wobei die Personenklasse als Objekt mit mehreren Quellelementen und die Entitätsklasse als Objekt mit einem einzigen Zielelement betrachtet wird. Unten sehen Sie das Bild, das mehrere Quellelemente einer Person zeigt, die einem einzigen Zielelement einer Entität zugeordnet werden sollen.

Beachten Sie, dass es sich nicht um eine Beziehungsdarstellung handelt. Es soll lediglich die Zuordnung zweier Felder zu einem Feld zeigen.

Schreiben von POJOs für die Person-Klasse

Lassen Sie uns die Personenklasse mithilfe von Mapstruct unserer Datenbankentität DTO-Klasse zuordnen. ER-Diagram

Hier ist unser Datenmodell eine Entität

öffentliche Klasse

Juristische Person

{

int

Entitäts-ID

; Privat ZeichenfolgenentitätName;

Zeichenfolge

Kontakt; }In diesem Fall ist eine Entität eine Person oder Organisation. Sie kann beispielsweise durch eine Person oder ein Unternehmen dargestellt werden, muss aber zur Speicherung einer Entität zugeordnet werden. Hier sind unsere Ansichten Einer zum Schreiben der Daten und einer zum Lesen der Daten PersonW.java

öffentliche KlassePersonW{ Privat Zeichenfolge zuerstName; Privat Schnur zuletzt

Name

; Privat ZeichenfolgeKontakt; } PersonR.java

öffentliche KlassePersonR{

Privat
Zeichenfolge zuerst

Name
;

Privat

Schnur zuletzt

Name

;

Privat

ZeichenfolgeKontakt; } EntityW.java öffentliche Klasse

EntitätW

{ Privat Zeichenfolge vollName; Privat ZeichenfolgeKontakt; }

EntityR.java öffentliche KlasseEntityR{ private intpersonId; Privat

Zeichenfolge voll

Name; Privat ZeichenfolgeKontakt; }Unser Problem besteht darin, dass wir den Vor- und Nachnamen in einen vollständigen Namen umwandeln müssen. Es gibt drei Möglichkeiten, einen benutzerdefinierten Mapper mit MapStruct zu verwenden.

Wir können die benutzerdefinierte Methode entweder aufrufen, indem wir sie in die Eigenschaft qualifiedByName der Annotation @Mapping eingeben, Verwenden von Java-Ausdrücken innerhalb unserer Mapping-Konstruktion oder wir können eine Mapping-Annotation erstellen

Mapstruct zuordnen: Benutzerdefinierte Methoden
1. Auswahl der Mapping-Methoden mithilfe von Qualifikatoren

Mapstruct-Qualifizierer ermöglichen die Übergabe des von der Mapper-Methode referenzierten Objekts, das die mehreren Felder enthält, die Sie als Quellfelder benötigen, an eine „qualifiedByName“-Methode, indem Sie mit einem Punkt auf die Quelle verweisen, wie nachstehend:

@Mapper öffentlichSchnittstellePersonEntityMapper{ @Mapping(Ziel

=

"vollständiger Name",Quelle=".",qualifiziertNachName="vollständigen Namen abrufen") EntitätWvonPersonWnachEntityW(PersonWPersonW);

@Namens("vollständigen Namen abrufen") StandardZeichenfolge getFullName(PersonWPerson){ ZeichenfolgeName =

""

; Wenn(person.getFirstName()!=null){ Name=Person.getFirstName(); } Wenn(person.getLastName()!=null){

Name=Name
+
" "+person.getLastName();

}

zurückkehrenName;

}

} 2. Verwenden von Java-Ausdrücken beim Mapping Die Verwendung eines Java-Ausdrucks ist eine einfache und schnelle Möglichkeit, eine Zuordnung bereitzustellen. Dies eignet sich gut für einmalige Fälle. Wenn Sie den Ausdruck wiederholen, verwenden Sie stattdessen eine Anmerkung. In Ihrer Zuordnung ist auch die Zuordnung mehrerer Felder zu einem Feld möglich, wie unten dargestellt. @Abbildung(Ziel=

"vollständiger Name"

,Ausdruck="java(person.getFirstName()+ \" \" + person.getLastName())") EntitätWkonvertierenVonPersonW(PersonWPerson); 3. Benutzerdefinierter Mapper mit einer Anmerkung Eine Annotation ist für trockenes (nicht wiederholendes) Codieren nützlich. Denn wir können die Annotation bei Bedarf immer wieder verwenden.

Um einen benutzerdefinierten Mapper mit einer Annotation zu verwenden, müssen wir anstelle der Annotation @Named eine Annotation definieren. Dann müssen wir MapStruct über die neu erstellte Annotation informieren, indem wir den Parameter qualifiedByName der Annotation @Mapping angeben.

Sehen wir uns an, wie wir die Annotation definieren: @Qualifikation@Ziel(Elementtyp.METHODE)@Retention(RetentionPolicy.KLASSE)öffentlich@SchnittstelleVollständigerNameVonPersonZuEnityMapper{ }

FullNameFromPersonToEnityMapper-Annotation zu unserer getFullName-Methode: @VollständigerNameVonPersonZuEnityMapper

öffentlichstatisch
ZeichenfolgegetFullName

(
PersonW

Person

){

Zeichenfolge
Name =

""

; Wenn(person.getFirstName()!=null){ Name=Person.getFirstName(); }

Wenn(person.getLastName()!=null){ Name=Name+" "+person.getLastName(); }

zurückkehrenName; } Jetzt definieren wir die Mapper-Schnittstellenmethode mit der Annotation @Mapping. Innerhalb der Mapping-Annotation teilen wir MapStruct den Quelltyp, den Zieltyp und die zu verwendende Annotationsklasse mit: @Mapper öffentlichSchnittstellePersonEntityMapper

{

@Mapping(Ziel="vollständiger Name",Quelle=".",qualifiziertVon=„VollständigerNameVonPersonZuEnityMapper.class“)

EntitätW

vonPersonWnachEntityW(PersonWPersonW); @VollständigerNameVonPersonZuEnityMapper

öffentlich
statischZeichenfolge getFullName(PersonW

Person)
{

ZeichenfolgeName =

""

Wenn
Name=Person.getFirstName();
}

Wenn

(person.getLastName()!=null){

Name=Name

+

" "

+person.getLastName();
        }
zurückkehren
Name;     } } Mapstruct-Standardzuordnung für einzelne Felder zu mehreren Feldern innerhalb eines Zielobjekts. Alle drei Methoden können verwendet werden, um von einer einzelnen Quelle auf mehrere Ziele abzubilden. Hier ist ein Beispiel, bei dem eine Mapstruct-Standardzuordnung verwendet wird, um von einem einzelnen Quellfeld auf mehrere Felder abzubilden. Hier ist unser Mapstruct-Beispiel:
Standard
PersonRconvertTOReadPersonCustom(Entitätjuristische Person){         zurückkehrenPersonR                 .Erbauer()                 .personId(entity.getEntityId())                 .Vorname(entity.getFullName().Teilzeichenfolge(0,entity.getFullName().indexOf(" ")))

.Nachname(entity.getFullName().Substring(entity.getFullName().indexOf(" ")+1))                 .bauen();

}
EntityRepository, wo wir den EntityPerson-Mapper wie unten gezeigt verwenden werden:

@Komponente öffentlichKlasseEntityRepository{

    PrivatPersonEntityMapperpersonEntityMapper;     öffentlichstatischListeEntitätsliste =neuArrayList<>();     öffentlich
EntityRepository(PersonEntityMapper
personEntityMapper){         Das.personEntityMapper=personEntityMapper;     }

    öffentlichJuristische PersonspeichernEntity(EntityWEinheitW){
Juristische Person
juristische Person=Entity.builder().entityId(entityList.size())
.fullName(entityW.getFullName())
                .Kontakt(entityW.getContact())
.bauen();

        entityList.add(entity);         zurückkehrenjuristische Person;

}     öffentlichJuristische PersonspeichernPerson(PersonWpersonW){        /EntitätWEntitätW=
personEntityMapper.vonpersonWzuEntityW(PersonW.builder()
                .Vorname(personW.getFirstName())
.lastName(personW.getLastName())
                .Kontakt(PersonW.getContact()).build());/         EntitätWEntitätW
=
personEntityMapper.convertFromPersonW(PersonW.builder()                 .Vorname(personW.getFirstName())

.lastName(personW.getLastName())
.contact(personW.getContact()).build());

Juristische Person

juristische Person

=

Entity.builder().entityId(entityList.size())
.fullName(entityW.getFullName())

.Kontakt(entityW.getContact())

.bauen();
entityList.add(entity);

zurückkehrenjuristische Person; } öffentlichJuristische Personfinden(intEntity-ID){ zurückkehrenEntityList.get(entityId); }

öffentlichPersonRfindByEntityId(intEntity-ID){ zurückkehren

personEntityMapper.convertTOReadPersonCustom(entityList.get(entityId));

}

}

Abschließend testen wir unseren benutzerdefinierten Mapper:

@Prüfen

öffentlichLeerebenutzerdefinierterMappingTest(){ PersonWpersonW1=PersonW.builder() .Vorname("Jim") .Nachname("Corbet") .Kontakt(„jim@test.com“

).bauen();

Juristische Person

juristische Person

=

entityRepository.savePerson(personW1);

PersonRPerson=entityRepository.findByEntityId(entity.getEntityId()); Assertions.assertEquals(

"Jim

Corbet",entity.getFullName()); Assertions.assertEquals("Jim",person.getFirstName()); Assertions.assertEquals("Corbet",person.getLastName()); Abschluss Wir haben mehrere Strategien zum Zuordnen mehrerer Quellen zu einem einzigen Ziel und von einem einzigen Feld zu mehreren Feldern mit Mapstruct vorgestellt. Diese benutzerdefinierten Zuordnungsstrategien mit Mapstruct helfen uns sehr, die Entwicklung zu beschleunigen und unseren Code klar und fehlerfrei zu machen. Probieren Sie Mapstruct in Ihrem nächsten Spring-Microservices-Projekt aus. Wenn Sie ein Java-Spring-Microservices-Team, irgendeine Art von Anwendungsentwicklung oder Beratung suchen, probieren Sie iBCScorp aus.

Sprechen Sie mit unserem Team

Wenn Sie mehr über die Spring-Entwicklung erfahren möchten, können Sie sich auch für unsere Mailingliste anmelden, um von Zeit zu Zeit neue Artikel oder kostenlose Online-Webinare zu erhalten. {{Für Spring Boot-Schulung anmelden}} Forschung Mapstruct https://mapstruct.org/ Maximieren der Effizienz und Klarheit von Java-Code mit MapStruct: Ein umfassender Leitfaden https://madukajayawardana.medium.com/maximizing-java-code-efficiency-and-clarity-with-mapstruct-a-comprehensive-guide-be3a498c6d74