← Zurück zum Blog

Spring Data JPA: Abfrageergebnis direkt in ein DTO schreiben

Übersetzter Artikel. Original lesen

Einleitung

Eine weniger bekannte Funktion von Spring Data JPA ist die Möglichkeit, Abfrageergebnisse direkt in ein DTO zu schreiben, statt sie in einer höheren Schicht durch einen Mapper umzuwandeln. Ob dieser Ansatz zur eigenen Architektur passt, muss natürlich individuell entschieden werden.

Was ist Spring Data?

Spring Data ist eine Abstraktionsschicht zwischen der Art, wie Daten abgefragt werden, und den verschiedenen zugrunde liegenden Datenquellen. Die Schreibweise der Abfragen bleibt gleich; Spring Data übersetzt sie in die passende Abfragesprache für JPA, MongoDB, Couchbase, Neo4j und weitere Systeme.

Besonders ist, dass die Definition von Interface-Methoden genügt. Repositories oder Data Access Objects müssen nicht selbst implementiert werden.

Beispiel einer einfachen Interface-Methode in Spring Data JPA

Dieses JpaRepository zeigt die grundlegende Funktionsweise von Spring Data:

package de.smarterco.example.repositories;

import de.smarterco.example.entities.User;
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.stereotype.Repository;

import java.util.List;

@Repository
public interface UserRepository extends JpaRepository<User, Long> {

    List<User> findAll();
}

Die wichtigsten Bestandteile:

  • @Repository – Markiert die Klasse als Repository, damit sie vom Dependency-Injection-Framework erkannt wird.
  • JpaRepository – Ergänzt UserRepository um Basisfunktionen für JPA-Datenquellen.
  • <User, Long> – User ist die abgefragte Entity, Long der Typ ihrer ID.
  • List<User> findAll() – Ruft alle Benutzer ab und liefert sie als Liste. Query-Methoden beginnen in Spring Data mit find, gefolgt von Einschränkungen und Parametern.

Die Annotation @Query verwenden

Dasselbe Ergebnis ist mit @Query möglich. Damit lassen sich eigene Abfragen in JPQL, der Java Persistence Query Language, formulieren.

package de.smarterco.example.repositories;

import de.smarterco.example.entities.User;
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.data.jpa.repository.Query;
import org.springframework.stereotype.Repository;

import java.util.List;

@Repository
public interface UserRepository extends JpaRepository<User, Long> {

    @Query("SELECT u FROM User AS u")
    List<User> findAll();
}

Ergebnisse direkt in ein DTO abfragen

Dieser Abschnitt zeigt, wie Abfrageergebnisse direkt in ein DTO geschrieben werden, ohne sie außerhalb des Repository in einer zweiten Schicht zu mappen.

Zuerst wird ein DTO benötigt, hier UserNameDTO.

Der Konstruktor muss alle benötigten Felder als Parameter akzeptieren.

package de.smarterco.example.dto;

public class UserNameDTO {

    private Long id;
    private String name;

    public UserNameDTO(Long id, String name) {
        this.id = id;
        this.name = name;
    }

    public Long getId() {
        return id;
    }

    public String getName() {
        return name;
    }
}

Mit einer JPQL-Abfrage im JpaRepository werden die Daten direkt im DTO gespeichert:

package de.smarterco.example.repositories;

import de.smarterco.example.dto.UserNameDTO;
import de.smarterco.example.entities.User;
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.data.jpa.repository.Query;
import org.springframework.data.repository.query.Param;
import org.springframework.stereotype.Repository;

import java.util.List;

@Repository
public interface UserRepository extends JpaRepository<User, Long> {

    @Query("SELECT u FROM User AS u")
    List<User> findAll();

    @Query("SELECT new de.smarterco.example.dto.UserNameDTO(u.id, u.name) FROM User u WHERE u.name = :name")
    List<UserNameDTO> retrieveUsernameAsDTO(@Param("name") String name);
}
  • List<UserNameDTO> retrieveUsernameAsDTO(...) – Liefert die Ergebnisse als Liste von UserNameDTO statt User.
  • @Param("name") String name – Kennzeichnet den übergebenen Parameter und bindet ihn an :name in der Abfrage.
  • new de.smarterco.example.dto.UserNameDTO(u.id, u.name) – Hier geschieht die eigentliche Arbeit: JPQL erzeugt über den vollständigen Klassennamen und den parametrisierten Konstruktor ein neues UserNameDTO. Die benötigten User-Felder u.id und u.name werden direkt zugeordnet.