Spring und Spring Boot - Aufgaben

Aufträge

Voraussetzungen

Im Lab zu Modul #J8 (JDBC) hast du ein persistentes Notenverwaltungssystem umgesetzt. Zu diesem Zweck hast du eine MariaDB-Instanz mit folgenden Tabellen aufgesetzt:

• SCHOOL_SUBJECT
• GRADE
• SCHOOL_SUBJECT_GRADE

Mehr Details dazu findest du im obenerwähnten Lab. Diese Datenbank und das dazu gehörende Datenbankmodel wirst du für unsere Spring-Aufgabe benötigen.
Bei Bedarf kannst du das Model erweitern.

Auftrag

Die Aufgaben in diesem Lab führen dich Schritt für Schritt durch die Umsetzung einer Webanwendung mit Spring Boot, welche einem Notenverwaltungssystem entspricht. Die folgenden Abschnitte listen die groben Funktionalen (was soll die Anwendung können) und die nicht-funktionalen (zusätzliche Anforderungen z.B. an die Qualität der Anwendung) Anforderungen an die Anwendung auf. Genauere Details zu den Anforderungen und den Akzeptanzkriterien werden in den entsprechenden Kapiteln aufgeführt.

Funktionale Anforderungen

• Die Anwendung unterstützt zwei unterschiedliche Profile: “student” und “admin”
• Wenn die Anwendung mit dem Profil “student” gestartet wird, stehen die folgenden Funktionalitäten zur Verfügung:
  • Alle Fächer und all deren Noten auflisten (ein Fach kann mehreren Noten beinhalten)
  • Alle Fächer und deren Durchschnittsnote auflisten
  • Für ein bestimmtes Fach:
    • Alle Noten und die Durchschnittsnote des Fachs auflisten
    • Eine neue Note hinzufügen
    • Eine bestehende Note ändern
    • Eine bestehende Note löschen
• Wenn die Anwendung mit dem Profil “admin” gestartet wird, stehen zusätzlich auch folgende Funktionalitäten zur Verfügung:
  • Alle Fächer auflisten
  • Neue Fächer hinzufügen
  • Bestehende Fächer bearbeiten
  • Bestehende Fächer löschen
• Die Anwendung bietet die Möglichkeit abzufragen, welches Profil gestartet ist.

Nicht funktionale Anforderungen (NFAs)

• Der Code (das Design) der Anwendung ist sinnvoll in entsprechenden Packages aufgesplittet.
• Eine Klasse hat eine einzige Aufgabe (Single Responsibility Principle).
• Direkter Zugriff auf der internen Struktur einer Klasse ist verboten (Encapsulation / Information Hiding).
• Jede Klasse ist getestet.

Schritt 1: Maven-Projekt erstellen / pom.xml

In diesem ersten Schritt wirst du eine Spring Boot Anwendung erstellen und ausführen. Hier stehen dir zwei Möglichkeiten für die Umsetzung zur Verfügung:

• Die Projektstruktur manuell anzulegen (#Hard-Core-Variante)
• Die Projektstruktur mit Spring-Initializr anlegen (#Easy-Going-Variante)

Beide Möglichkeiten werden in dieser Aufgabe aufgeführt.

Voraussetzungen (was du brauchst)

• Java 20 oder neuer ist installiert.
• Maven 3.5 oder neuer ist installiert.
• IntelliJ ist installiert und konfiguriert.
• Ein Bitbucket Repository steht bereit, um den Code des Projektes zu verwalten und ist auf der lokalen Maschine geklont worden.

Variante I: Projekt manuell anlegen

Erstelle ein Maven-Projekt in IntelliJ

Öffne IntelliJ und erstelle ein neues Maven-Projekt (File → New → Project): Ersetze GroupId, ArtifactId, Name und Location durch passende Werte.

Passe dein pom.xml File an

Füge den “Parent” und folgende Dependencies und Maven-Plugins in deine pom.xml Datei hinzu:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

  <!-- Parent kommt normalerweise nach der modelVersion -->
  <parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>3.1.5</version>
    <relativePath/> <!-- lookup parent from repository -->
  </parent>

  <!-- Dependencies kommen normalerweise nach den Properties -->
  <dependencies>
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-test</artifactId>
      <scope>test</scope>
    </dependency>
  </dependencies>

  <!-- Build kommen normalerweise nach den Dependencies -->
  <build>
    <plugins>
      <plugin>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-maven-plugin</artifactId>
      </plugin>
    </plugins>
  </build>

Lade alle Dependencies erneut (Maven-View -> Reload all maven projects).

Ersetze die Main Klasse mit einer SpringBootApplikation Klasse

Wenn du beim Erstellen des Projektes “add sample code” angekreuzt hast, beinhaltet dein Projekt nun eine Main-Klasse in deinem Source-Folder (im richtigen Package selbstverständlich). Diese Main Klasse werden wir nun in einer SpringBootApplication-Klasse umwandeln:

• Benenne die Main Klasse um, so dass sie <name-deines-artefaktes>Application heisst (z.B. wenn dein Artefakt “demo” heisst, wird die Klasse nun “DemoApplication” heissen).
• Füge die Annotation @SpringBootApplication auf der Klassenebene hinzu
• Passe deine main Methode an, so dass sie wie folgt aussieht (Ersetzte DemoApplication mit deinem Application-Klassennamen):

1
2
3

    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }

Gratuliere! Du hast nun dein Projekt angelegt, und zwar Hard-Core. Bravo! Fahre nun mit dem Schritt “Führe deine Anwendung aus” fort.

Variante II: Projekt mit Spring-Initializr anlegen

Öffne die Seite: https://start.spring.io/ und ersetzte die Angaben zu Group, Artifact (der Name wird sich automatisch ändern) und Description durch passende Werte. Achte das bei Project “Maven” ausgewählt ist und nicht Gradle. Füge die Abhängigkeit für “Spring Web” hinzu und drücke den “GENERATE” Knopf.

Entpacke das heruntergeladene Zip-File in deinem Repository-Verzeichnis und öffne die Anwendung als Maven-Projekt in IntelliJ: File → New → Project from existing sources → Zum Root-Folder des Projektes navigieren und pom.xml auswählen.

Führe deine Anwendung aus

Öffne deine Application-Klasse (normalerweise heist sie Application). Wenn du Spring-Initializr benutzt hast, wurde diese Klasse für dich automatisch erstellt. Starte deine Anwendung mit der Default-Run-Konfiguration. Zu diesem Zweck kannst du die Application-Klasse öffnen und die Main-Methode ausführen.

Akzeptanzkriterien Schritt 1

Du bist mit diesem Schritt fertig erst, wenn folgende Aussagen stimmen:

• Dein Projekt weist eine richtige Maven Projektstruktur aus:
  
• Das Projekt ist in IntelliJ richtig konfiguriert (JDK, Maven, Source-Verzeichnisse, Resource-Verzeichnisse usw.)
• Du verstehst, wozu wir die Dependencies im pom.xml File brauchen
• Eine “SpringBootApplication”-Klasse ist vorhanden, ist richtig annotiert und beinhaltet eine “main” Methode, welche die Applikation ausführt.
• Spring Boot Applikation startet fehlerfrei
• In der Run-Konsole ist eine ähnliche Ausgabe zu sehen:
• Dein Projekt ist im vorbereiteten Bitbucket-Repository vorhanden

Schritt 2: Rest Schnittstellen definieren und umsetzen

In diesem Schritt geht es darum die Schnittstellen (die API) zur Anwendung zu definieren. Über diese Schnittstellen können die Benutzer:innen die gewünschten Aktionen ausführen

System-Design erstellen und Code Struktur anlegen

Damit, du den Code gemäss den nicht-funktionalen Anforderungen (NFA) aufbauen kannst, überlege dir zuerst, wie du deine Anwendung zerlegen möchtest.
Dazu kannst du die Schritte der Methodik “functional decomposition” anwenden (mehr Information zur Methode findest du in diesem Artikel).
Bei der Zerlegung des Systems beachte auch Prinzipien wie Kohäsion (starke Kohäsion ist gewünscht) und Kopplung (lose Kopplung sollte das Ziel sein).

Aufgabe
Sobald du die Zerlegung deiner Anwendung gemacht hast, kannst du die passende Java-Packages erstellen, welche diese Zerlegung dann abbildet. Dein Code fügst du später an den richtigen Stellen hinzu.

REST-Schnittstelle definieren

Die Struktur für deine Anwendung steht. Nun definierst du die Schnittstellen, womit die Benutzer:innen mit der Anwendung interagieren werden. Die nötige Funktionalität entnimmst du aus den funktionalen Anforderungen.

Beispiel: Anforderung - ein neues Schulfach hinzufügen
Die entsprechende Schnittstelle könnte entsprechend so aussehen:

Dort wo ein Request-Body und/oder ein Response-Body benötigt wird, wird mit JSON-Objekten gearbeitet. Diese JSON-Objekte werden wir im nächsten Abschnitt verwenden, um die Resource-Representation Klassen zu erzeugen.

Aufgabe
Erweitere die obige Tabelle mit den restlichen Funktionen gemäss den funktionalen Anforderungen. Buche sobald du fertig bist ein Review mit einem Coach, damit spätere Fehler vermieden werden.

Wichtig Endpunkt für Profil: Vergiss nicht das du noch einen Endpunkt erstellen musst, um herauszufinden, mit welchem Profil die Anwendung gestartet wurde.

Resource-Representation Klassen erstellen

Unsere Schnittstellendefinition verwendet JSON-Objekte bei bestimmten Requests und Responses. Diese JSON-Objekte stellen sog. “Resource” dar. Im Beispiel “Neues Schulfach hinzufügen” stellt das JSON-Objekt ein Schulfach dar.

In diesem Abschnitt wirst du für alle JSON-Objekte entsprechende Java-Klassen erstellen. Das sind sogenannte Resource-Representation Klassen, auch Modelle genannt.
In unserer Anwendung werden wir die Resource-Representation Klassen als sog. DTOs (Data Transfer Objects) umsetzen. Diese Klassen wirst du später in deinen Controllern verwenden.

Beispiel: Schulfach Resource-Representation
Das folgende JSON-Objekt stellt ein Schulfach dar:

1
2
3
4

{
  "id": 1,
  "name": "Deutsch"
}

Daraus können wir unsere DTO-Klasse erstellen (vorerst nur mit Feldern und noch keine weitere Funktionalität):

1
2
3
4

public class SchulfachDto {
    private final Long id;
    private final String name;
}

Aufgabe
Erstelle für jedes JSON-Objekt aus dem vorherigen Abschnitt eine DTO-Klasse. Denke daran, die Klassen in die richtigen Packages zu setzen.

Controller erstellen

In Spring werden HTTP Requests an REST-Services von Controllern behandelt. Das ist eine Java-Klasse, welche mit @RestController annotiert wird. Controller sind also die Umsetzung unserer Schnittstellendefinition. Da wir noch keine persistierten Daten haben, wirst du vorerst Mockdaten aus den Schnittstellenmethoden liefern müssen.

Beispiel: Controller für die Schulfachverwaltung

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

@RestController
@RequestMapping("/api/admin")
public class SchulfachAdminController {

  @PostMapping("/schulfaecher")
  public SchulfachDto createNewSchulfach(@RequestBody SchulfachDto newSchulfach) {
    // TODO: Das sind Mockdaten und sollten zu einem späteren Zeitpunkt mit "echtem" Code ersetzt werden
    return new SchulfachDto(3, "Physik");
  }

  // hier können weitere Methoden der Schnittstelle umgesetzt werden
}

Aufgabe
Erstelle Controller und Methoden (mit Mockdaten), um die Umsetzung deiner Schnittstellen abzuschliessen.

Akzeptanzkriterien Schritt 2

• Ein grobes System-Design ist vorhanden (z.B. mit der Hilfe des Functional-Decomposition-Diagramm).
• Die Codestruktur entspricht dem Design.
• Die REST Schnittstellen sind für jede relevante Funktion (gemäss funktionalen Anforderungen) dokumentiert und mit Controllern umgesetzt.
• Jede API-Methode, welche einen Wert liefert, schreibt diesen Wert direkt in den Response-Body (RestController)
• Die API-Methoden sind “RESTful” (siehe HTTP Methods in RESTful Web Services)
• Die API-Methoden, welche einen Wert liefern, liefern zurzeit Mockdaten zurück (alle Aufrufe einer Methode liefern immer die gleiche Mockdaten zurück)
• Mit Insomnia oder mit dem HTTP-Browser kann auf jede API-Methode zugegriffen werden
• Für jede API-Methode wurden passende Unit-Tests geschrieben und erfolgreich ausgeführt

Schritt 3: Services anlegen

Service-Klassen erstellen

In diesem Schritt wird ein komplett neuer Layer angelegt, welcher die Business-Logik der Applikation enthalten wird. Er ist zuständig für Aufgaben wie Exception-Handling und Validierung. Dieser Layer wird Service-Layer genannt. Service-Klassen werden grundsätzlich mit der Annotation @Service annotiert. Diese Annotation ist eine von drei möglichen Spezialisierungen eines Spring Components.

Die möglichen Annotationen für einen Spring Component sind die folgenden:

• @Component
• @Controller
• @Service
• @Repository

Im folgenden Beispiel wird nun eine Service-Klasse angelegt, welche den vom Controller empfangenen Request-Body als Parameter entgegennimmt und diesen dann später weiter verarbeiten wird. Im Moment begnügen wir uns damit die Mock-Daten aus dem Controller hierher zu verschieben.

Beispiel: Service für die Schulfachverwaltung

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

@Service
public class SchulfachAdminService {

  public SchulfachDto createNewSchulfach(SchulfachDto newSchulfach) {
    // TODO: Dies sind die Mock-Daten aus dem Controller, sie werden später durch richtige Daten ersetzt
    return new SchulfachDto(3, "Physik");
  }

  // hier können weitere Methoden des Services umgesetzt werden
}

Aufgabe
Erstelle die nötigen Service-Klassen mit entsprechenden Methoden und verschiebe die Mock-Daten aus den Controllern in die Service-Methoden. Versuche die Methoden, welche das gleiche fachliche Thema behandeln im gleichen Service unterzubringen. Denke daran, die Service-Klassen in das richtige Package zu setzen.

Service-Klassen und Controller verbinden

Nun ist es an der Zeit, die erstellten Controller- und Service-Klassen miteinander zu verbinden. Dazu nutzen wir die Dependency Injection. Controller- und Service-Klassen werden durch ihre Annotationen als Spring-Components erkannt und durch den Spring Container instanziiert. Die Injection eines Service in einen Controller kann beispielsweise durch eine Constructor-Injection erfolgen. Durch diese Art von Implementation holt sich der Controller den Service aus dem Container selbst. Die Methoden der Controller leiten nun ihre Anfragen an die entsprechenden Service-Klassen weiter.

Beispiel: Constructor-Injection

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17

@RestController
@RequestMapping("/api/admin")
public class SchulfachAdminController {

  private final SchulfachAdminService schulfachAdminService;

  public SchulfachAdminController(SchulfachAdminService schulfachAdminService) {
      this.schulfachAdminService = schulfachAdminService;
  }

  @PostMapping("/schulfaecher")
  public SchulfachDto createNewSchulfach(@RequestBody SchulfachDto newSchulfach) {
    return this.schulfachAdminService.createNewSchulfach(newSchulfach);
  }
  
  // ...
}

Aufgabe
Verbinde die erstellten Controller-Klassen mit den entsprechenden Services. Leite sämtliche Anfragen aus den Controllern an die Service-Methoden weiter. Die ursprünglich erstellten Test sollten immer noch erfolgreich ausführbar sein.

Akzeptanzkriterien Schritt 3

• Die Mock-Daten wurden in Methoden auf dem Service-Layer ausgelagert
• Die Service-Klassen sind nach Thema aufgebaut
• Sämtliche Anfragen der Controller (Requests) wurden an die Service-Klassen und deren Methoden weitergeleitet
• Die Controller- und Service-Klassen sind mittels Constructor-Injection miteinander verbunden
• Sämtliche Unit-Tests für die Controller funktionieren nach wie vor
• Für alle Service-Methoden wurden entsprechende neue Unit-Tests geschrieben

Schritt 4: Datenbank-Verbindung herstellen

Repository-Klassen erstellen

In diesem Schritt wird erneut ein komplett neuer Layer angelegt, welcher die Verbindung der Applikation zu einer Datenbank aufbauen wird. Dieser Layer wird Persistenz-Layer genannt. Repository-Klassen werden grundsätzlich mit der Annotation @Repository annotiert.

Die Verbindung zu einer Datenbank kann auf verschiedene Arten realisiert werden. In diesem Kapitel werden wir JPA oder JDBCTemplate eingehen.

1
2
3
4
5
6
7
8
9

@Entity
@Table(name = "SCHOOL_SUBJECT")
public class Schulfach {
    
  @Id
  @Column(name = "description")
  private String bezeichnung;

}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18

@Entity
@Table(name = "SCHOOL_SUBJECT")
public class Schulfach {

  @OneToMany(mappedBy = "schulfach")
  private Set<SchulfachNote> noten;

}

@Entity
@Table(name = "SCHOOL_SUBJECT_GRADE")
public class SchulfachNote {

  @ManyToOne
  @JoinColumn(name = "FK_SCHOOL_SUBJECT_ID", nullable = false)
  private Schulfach schulfach;

}

1
2
3
4

@Repository
public interface SchulfachAdminRepository extends JpaRepository<Schulfach, String> {

}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

@Entity
@Table(name = "SCHOOL_SUBJECT")
public class Schulfach {

  @ManyToMany
  @JoinTable(
          name = "SCHOOL_SUBJECT_GRADE",
          joinColumns = @JoinColumn(name = "FK_SCHOOL_SUBJECT_ID"),
          inverseJoinColumns = @JoinColumn(name = "FK_GRADE_ID")
  )
  private List<Note> noten;

}

@Entity
@Table(name = "GRADE")
public class Note {

  @ManyToMany
  @JoinTable(
          name = "SCHOOL_SUBJECT_GRADE",
          joinColumns = @JoinColumn(name = "FK_GRADE_ID"),
          inverseJoinColumns = @JoinColumn(name = "FK_SCHOOL_SUBJECT_ID")
  )
  private List<SchoolSubject> subjects;

}

1
2
3
4
5
6

@Repository
public interface GradeRepository extends JpaRepository<Grade, Integer> {

    List<Grade> findGradesBySubjectsSubject(String subject);

}

1
2
3
4
5
6
7
8
9

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-jdbc</artifactId>
</dependency>
<dependency>
    <groupId>org.mariadb.jdbc</groupId>
    <artifactId>mariadb-java-client</artifactId>
<version>3.1.0</version>
</dependency>

1
2
3
4
5
6

@Getter
@Setter
public class Grade {
    private Long gradeId;
    private Double gradeValue;
}

1
2
3
4
5
6

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.18.30</version>
    <scope>provided</scope>
</dependency>

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15

@Repository
public class StudentRepository {
    private final JdbcTemplate jdbcTemplate;

    public StudentRepositoryImpl(JdbcTemplate jdbcTemplate) {
        this.jdbcTemplate = jdbcTemplate;
    }

    public List<SchoolSubject> getAllSubjectsAndGrades() {
        return null;
    }
    
    // ...
}

Repository-Klassen und Service-Klassen verbinden

Die Verbindung zwischen Repository- und Service-Klassen in einer Softwareanwendung ist entscheidend für eine saubere Struktur und effiziente Datenverwaltung. Repository-Klassen handhaben den Datenzugriff, während Service-Klassen die Geschäftslogik umsetzen. Service-Klassen nutzen die Methoden der Repository-Klassen, um auf Daten zuzugreifen oder diese zu manipulieren. Diese Trennung ermöglicht eine klare Aufgabenverteilung, verbessert die Wartbarkeit und erleichtert die Integration von Datenzugriff und Geschäftslogik.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15

@Service
public class StudentService {

    private final StudentRepository studentRepository;

    public StudentService(StudentRepository studentRepository) {
        this.studentRepository = studentRepository;
    }

    public List<SchoolSubjectGradeDto> getAllSubjectsAndGrades() {
        return studentRepository.getAllSubjectsAndGrades();
    }

    // ...
}

Aufgabe Füge die benötigte Dependency in dein Projekt ein und erstelle die nötigen Entity-Klassen. Zudem erstelle die benötigten Services und Repositories in der korrekten packages Struktur.

Akzeptanzkriterien Schritt 4

• Dependency wurde im pom.xml hinzugefügt.
• Alle nötigen Entities wurden erstellt.
• Alle benötigten Services wurden erstellt und in einen Ordner für alle Services abgelegt.
• Alle benötigten Repositories wurden erstellt und in einen Ordner für alle Repositories abgelegt.

Schritt 5: Konfiguration anlegen

In der Konfigurationsdatei können Einstellungen für die Datenbankverbindung, Log-Ebene, Profile, Spring-Profile, Webserver-Port, Sicherheitskonfigurationen und viele andere Aspekte der Anwendung angegeben werden.

Die zwei häufigsten Arten eine Konfigurationsdatei anzulegen sind in application.yml oder die application.properties. Der Unterschied der beiden besteht darin das die application.yml-Datei, in YAML-Syntax geschrieben ist, und die application.properties-Datei eine einfache Key-Value-Paar-Syntax verwendet.

application.properties:

1
2
3
4

spring.datasource.url=jdbc:mariadb://localhost:3306/[your_database]
spring.datasource.username=[your_username]
spring.datasource.password=[your_password]
spring.datasource.driver-class-name=org.mariadb.jdbc.Driver

application.yml:

1
2
3
4
5
6

spring:
  datasource:
    url: jdbc:mariadb://localhost:3306/[your_database]
    username: [your_username]
    password: [your_password]
    driver-class-name: org.mariadb.jdbc.Driver

Aufgabe
Erstelle deine Konfigurationsdatei entsprechend deiner Datenbank.

Akzeptanzkriterien Schritt 5

• Die Spring Boot Applikation startet mit der Datenbank.

Schritt 6: Profile anlegen

In diesem Schritt erstellst du die gewünschten Spring Boot Profile: “student” und “admin”. Diese Profile werden benutzt, um die verfügbare Funktionalität einzuschränken bzw. zu erweitern. Welche Funktionalität mit welchem Profil zur Verfügung stehen darf, entnimmst du aus den funktionalen Anforderungen.

Mit der @Profile Annotation, kannst du bestimmte Beans für das gegebene Profil aktivieren bzw. deaktivieren.

Aufgabe
Aktiviere bzw. deaktiviere die Schnittstellen-Funktionalität entsprechend dem aktiven Profil

Akzeptanzkriterien Schritt 6

• Wenn die Anwendung mit dem Profil “student” gestartet wird, darf die Admin-Funktionalität nicht zur Verfügung stehen. Direkter Zugriff auf Admin-URLs liefert den HTTP Status-Code: 404 (Not Found)
• Wenn die Anwendung mit dem Profil “admin” gestartet wird, steht die gesamte Funktionalität zur Verfügung.
• Wenn die Anwendung mit dem Default-Profil gestartet wird, muss sie sich genauso verhalten, wie mit dem “student” Profil.

Schritt 7 Business-Logik- und Persistenz-Layer anpassen

Repository- und Service-Implementierungen

In Spring Boot ist die Verwendung von Repository- und Service-Implementierungen eine bewährte Methode, um eine saubere Trennung von Geschäftslogik, Datenzugriff und Präsentation sicherzustellen. Diese Trennung hilft, den Code übersichtlich, wartbar und testbar zu machen.

• Repository-Interface: Definiert die Methoden für den Datenzugriff.

• Repository-Implementierung (RepositoryImpl): Implementiert die Methoden des Repository-Interfaces und führt die tatsächlichen Datenbankoperationen aus.

• Service-Interface: Definiert die Methoden für die Geschäftslogik.

• Service-Implementierung (ServiceImpl): Implementiert die Methoden des Service-Interfaces und ruft bei Bedarf das Repository auf, um auf Daten zuzugreifen.

1
2
3
4
5

public interface StudentRepository {
    List<SchoolSubject> getAllSubjectsAndGrades();
    
    // ...
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15

@Repository
public class StudentRepositoryImpl implements StudentRepository { 
    private final JdbcTemplate jdbcTemplate;

    public StudentRepositoryImpl(JdbcTemplate jdbcTemplate) {
        this.jdbcTemplate = jdbcTemplate;
    }
    
    @Override
    public List<SchoolSubject> getAllSubjectsAndGrades() {
        return null;
    }
    
    // ...
}

Aufgabe
Passe deine Services und Repositories entsprechend der Implementierungs-Methode an.

Akzeptanzkriterien Schritt 7

• Alle Services sind mit der Implementierungs-Methode ausgestattet.
• Alle Repositories sind mit der Implementierungs-Methode ausgestattet

1

INSERT INTO SCHOOL_SUBJECT (subject_name) VALUES (?)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22

@Repository
public class StudentRepositoryImpl implements StudentRepository { 
    private final JdbcTemplate jdbcTemplate;

    public StudentRepositoryImpl(JdbcTemplate jdbcTemplate) {
        this.jdbcTemplate = jdbcTemplate;
    }
    
    // ...

  @Override
  public void addSubject(SchoolSubjectDto schoolSubjectDto) {
      String sql = "INSERT INTO SCHOOL_SUBJECT (subject_name) VALUES (?)";
      PreparedStatementSetter preparedStatementSetter = preparedStatement -> {
          preparedStatement.setString(1, schoolSubjectDto.getSubjectName());
      };

      jdbcTemplate.update(sql, preparedStatementSetter);
  }
    
    // ...
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

public static SchoolSubject mapDtoToEntity(SchoolSubjectDto dto) {
    if (dto == null) {
        return null;
    }

    SchoolSubject entity = new SchoolSubject();
    entity.setSubjectId(dto.getSubjectId());
    entity.setSubjectName(dto.getSubjectName());
    return entity;
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

 @Service
public class AdminService {

    private final AdminRepository adminRepository;

    public AdminService(AdminRepository adminRepository) {
        this.adminRepository = adminRepository;
    }

    public void addSubject(SchoolSubjectDto schoolSubjectDto) {
        adminRepository.addSubject(mapDtoToEntity(schoolSubjectDto));
    }
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16

import org.springframework.jdbc.core.RowMapper;

import java.sql.ResultSet;
import java.sql.SQLException;

public class SchoolSubjectDtoRowMapper implements RowMapper<SchoolSubjectDto> {


  @Override
  public SchoolSubjectDto mapRow(ResultSet resultSet, int rowNum) throws SQLException {
    Long subjectId = resultSet.getLong("subject_id");
    String subjectName = resultSet.getString("subject_name");

    return new SchoolSubjectDto(subjectId, subjectName);
  }
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22

@Repository
public class StudentRepositoryImpl implements StudentRepository {
    private final NamedParameterJdbcTemplate namedParameterJdbcTemplate;

    private final CommonDeclarableProperties declarableProperties;

    public StudentRepositoryImpl(NamedParameterJdbcTemplate namedParameterJdbcTemplate, CommonDeclarableProperties declarableProperties) {
        this.namedParameterJdbcTemplate = namedParameterJdbcTemplate;
        this.declarableProperties = declarableProperties;
    }
    
    // ...

    @Override
    public List<SchoolSubjectDto> getAllSubjects() {
        String sql = "SELECT * FROM SCHOOL_SUBJECT";
        return namedParameterJdbcTemplate.query(sql, new SchoolSubjectDtoRowMapper());
    }
    
    // ...

}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17

public class SchoolSubjectDtoResultSetExtractor implements ResultSetExtractor<List<SchoolSubjectDto>> { 
    
    @Override
    public List<SchoolSubjectDto> extractData(ResultSet resultSet) throws SQLException {
    List<SchoolSubjectDto> schoolSubjectDtos = new ArrayList<>();

    while (resultSet.next()) {
      Long gradeId = resultSet.getLong("subject_id");
      String subjectName = resultSet.getString("subject_name");

      SchoolSubjectDto schoolSubjectDto = new SchoolSubjectDto(gradeId, subjectName);
      schoolSubjectDtos.add(schoolSubjectDto);
    }

    return schoolSubjectDtos;
  }
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22

@Repository
public class AdminRepositoryImpl implements AdminRepository {

    private final NamedParameterJdbcTemplate namedParameterJdbcTemplate;

    private final JdbcTemplate jdbcTemplate;

    public AdminRepositoryImpl(NamedParameterJdbcTemplate namedParameterJdbcTemplate, JdbcTemplate jdbcTemplate) {
        this.namedParameterJdbcTemplate = namedParameterJdbcTemplate;
        this.jdbcTemplate = jdbcTemplate;
    }
    
    // ...

    @Override
    public List<SchoolSubjectDto> getAllSubjects() {
        String sql = "SELECT * FROM SCHOOL_SUBJECT";
        return namedParameterJdbcTemplate.query(sql, new SchoolSubjectDtoResultSetExtractor());
    }

    // ...
}

Schritt 9: API testen

Sobald deine Schnittstelle umgesetzt wird bzw. bereits ab dem zweiten Schritt in diesem Auftrag, kann die Schnittstelle von HTTP-Clients angesprochen und getestet werden. In diesem Schritt wirst du deine Schnittstelle mit dem IntelliJ HTTP-Client testen.

Eine Alternative zum IntelliJ HTTP-Client bietet Swagger an. Swagger ist ein Open-Source-Framework, das in erster Linie dazu dient, APIs zu entwerfen, zu dokumentieren und zu testen. Es ermöglicht eine einfache und strukturierte Beschreibung von Webdiensten, um deren Funktionalitäten, Parameter und Endpunkte zu verstehen.

Mit Spring Boot 3 kann man neu nur noch einen Dependency hinzufügen damit der Swagger läuft. Diese sieht folgerndermassen aus:

1
2
3
4
5

<dependency>
  <groupId>org.springdoc</groupId>
  <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
  <version>2.2.0</version>
</dependency>

Für unsere Test-Zwecke reicht der IntelliJ HTTP-Client völlig aus.

Testen mit IntelliJ HTTP Client

Wenn du eine RestController-Klasse in IntelliJ offen hast, wird an einigen Stellen ein Symbol dargestellt wie hier mit Rot unterstrichen:

Wenn man den Pfeil neben dem Symbol drückt, kann man die Option “Generate Request in HTTP Client” auswählen:

Somit wird der HTTP-Client Editor geöffnet, mit dem entsprechenden HTTP-Method und Pfad:

Mit einem Klick auf dem grünen Pfeil, wird die HTTP Request ausgeführt. Wenn du ein Beispiel brauchst, um zu wissen, wie du Requests erstellst (z.B. solche mit einem Request-Body) kannst du auf dem Examples Pfeil (oben rechts) klicken und die entsprechende Beispiel-Datei öffnen.

Weitere Dokumentation zum IntelliJ HTTP-Client findest du auf dieser IntelliJ IDEA Seite

Aufgabe
Erstelle eine HTTP-Request Datei, welche alle Methoden in deiner Schnittstelle ausführt.

Akzeptanzkriterien Schritt 9

• Eine HTTP-Request Datei liegt vor, welche alle öffentlichen Schnittstellen-Methoden ausführen kann.
• Bei Methoden, welche Parameter oder einen Request-Body brauchen, sind diese in den Requests auch so konfiguriert.
• Jede Methode, welche ausgeführt wird, liefert die erwarteten Ergebnisse (ggf. auch Anpassungen der Daten in der darunterliegenden Datenbank).

Integrationstests mit H2 umsetzen

Integrationstests mit H2 in einem Spring-Boot-Projekt umzusetzen ist eine bewährte Methode, um die Interaktion zwischen verschiedenen Komponenten einer Anwendung zu testen, ohne auf eine reale Datenbank angewiesen zu sein. In diesem Kontext dient H2, eine In-Memory-Datenbank, als Ersatz für die eigentliche Datenbank und erlaubt es, Tests zu schreiben, welche die Anwendungslogik unter simulierten Bedingungen überprüft.

Struktur

Es wird folgende Ordnerstruktur empfohlen, damit das gesamte Testing wie gewollt funktioniert:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18

src/
|-- main/
|   |-- java/
|   |   |-- com/
|   |       |-- example/
|   |           |-- myapp/
|   |               |-- YourProductionCode.java
|-- test/
|   |-- java/
|   |   |-- com/
|   |       |-- example/
|   |           |-- myapp/
|   |               |-- integration/
|   |                   |-- YourIntegrationTests.java
|   |-- resources/
|       |-- application-test.properties
|       |-- schema.sql
|       |-- data.sql

Dependencies

Damit man H2 verwenden kann, muss man auch hier noch einen Dependency im pom.xml hinzufügen. Diese ist folgende:

1
2
3
4
5

<dependency>
  <groupId>com.h2database</groupId>
  <artifactId>h2</artifactId>
  <scope>test</scope>
</dependency>

Konfiguration anlegen

In der Testkonfiguration (z. B. application-test.properties), konfiguriert man H2 als Datenbank für die Integrationstests. Es wird die Verbindungs-URL, der Treiber und die Anmeldeinformationen für H2 festgelegt. Diese Datenbank wird in den Tests automatisch erstellt und verwaltet.

application-test.properties:

1
2
3
4
5
6

spring.datasource.url=jdbc:h2:mem:testdb
spring.datasource.driverClassName=org.h2.Driver
spring.datasource.username=sa
spring.datasource.password=password
spring.datasource.platform=h2
spring.jpa.hibernate.ddl-auto=update

application-test.yml:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

spring: 
  datasource: 
    url: jdbc:h2:mem:testdb
    username: sa
    password: password
    platform: h2
    driver-class-name: org.h2.Driver
jpa: 
  hibernate:
    ddl-auto: update

SQL Files

Nun werden SQL-Skripte benötigt, die das Datenbankschema und Testdaten definieren. Diese Skripte werden während der Testausführung automatisch geladen.

Schema File

1
2
3
4

CREATE TABLE SCHOOL_SUBJECT (
    subject_id INT AUTO_INCREMENT PRIMARY KEY,
    subject_name VARCHAR(255) NOT NULL
);

Data File

1
2
3
4

INSERT INTO SCHOOL_SUBJECT (subject_name) VALUES ('Mathematics');
INSERT INTO SCHOOL_SUBJECT (subject_name) VALUES ('History');
INSERT INTO SCHOOL_SUBJECT (subject_name) VALUES ('Science');
INSERT INTO SCHOOL_SUBJECT (subject_name) VALUES ('English');

Integration Test

Integrationstests sind wichtig, um sicherzustellen, dass verschiedene Komponenten einer Anwendung (z. B. Klassen, Module, Services, REST-Endpunkte) ordnungsgemäss miteinander interagieren und Daten korrekt austauschen. Sie helfen dabei, potenzielle Fehler und Inkompatibilitäten zwischen den Komponenten frühzeitig zu erkennen und zu beheben.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

@SpringBootTest
@AutoConfigureMockMvc
@ActiveProfiles("admin")
@ExtendWith(SpringExtension.class)
public class AdminControllerIntegrationTest {

    @Autowired
    private MockMvc mockMvc;
    
    @MockBean
    private AdminService adminService;
    
    @Test
    public void testGetAllSubjects() throws Exception {
      List<SchoolSubjectDto> subjects = new ArrayList<>();
      subjects.add(new SchoolSubjectDto(1, "Mathematics"));
      subjects.add(new SchoolSubjectDto(2, "History"));
    
      when(adminService.getAllSubjects()).thenReturn(subjects);
    
      mockMvc.perform(get("/api/admin/subjects")
                      .contentType(MediaType.APPLICATION_JSON))
              .andExpect(status().isOk())
              .andExpect(content().contentType(MediaType.APPLICATION_JSON))
              .andExpect(jsonPath("$[0].subjectId").value(1))
              .andExpect(jsonPath("$[0].subjectName").value("Mathematics"))
              .andExpect(jsonPath("$[1].subjectId").value(2))
              .andExpect(jsonPath("$[1].subjectName").value("History"));
    }

    // ...
}

Unittests

Schreibe zu den Integrationtests auch noch Unittest. Diese solltest du aus J4 Testing bereits kennen.

Zurück zur Spring und Spring Boot Theorie.