LU03c - Klassen und Tabellen synchronisieren [BZZ

Diese Seite ist nicht editierbar. Sie können den Quelltext sehen, jedoch nicht verändern. Kontaktieren Sie den Administrator, wenn Sie glauben, dass hier ein Fehler vorliegt.
====== LU03c - Klassen und Tabellen synchronisieren ======

==== Ausgangslage ====

In der vorhergehenden Lektion haben Sie die Klasse ''Book'' aufgrund von der Tabelle ''books'' implementiert. Bei einer Änderung müssen Sie dadurch immer sowohl die Tabelle als auch die Klasse anpassen, da diese immer aufeinanderpassen müssen. 

^SQL ''books'' ^Java ''Book'' ^
| {{:de:modul:ffit:3-jahr:java:learningunits:lu03:erd_table_books.svg|}} | {{:de:modul:ffit:3-jahr:java:learningunits:lu03:uml_class_book.svg|}} |

Um unnötige Arbeitsschritte zu vermeiden, können wir die eine Seite aus der anderen generieren:
  * Java-first: Aus den Java-Klassen werden die entsprechenden SQL-Tabellen generiert.
  * SQL-first: Aus den SQL-Tabellen werden die entsprechende Java-Klassen generiert.

==== JPA/Hibernate ====
Wir wählen den Java-first-Ansatz mit JPA/Hibernate.

Die ''build.gradle'' wurde im Commit ''eeed45d'' bereits mit den passenden Abhängigkeiten ergänzt. Die zusätzlich Abhängigkeit zu Hikari dient ausserdem, um Datenbankverbindungen zu cachen.

Ebenfalls existiert eine Konfiguration ''persistance.xml''. Gewisse Einstellungen wie ''jakarta.persistence.jdbc.url'', ''jakarta.persistence.jdbc.user'' oder ''jakarta.persistence.jdbc.password'' werden nicht mit der Konfigurationsdatei commited, sondern können wie bis anhin in ''config.properties'' geschrieben und ersetzen die bisherigen Variabeln.

^ Vorher ^ Nachher ^
| <WRAP>
<code properties>
DB_URL=jdbc:postgresql://localhost:5432/localdb
DB_USER=localuser
DB_PASSWORD=secret
</code>
</WRAP> | <WRAP>
<code properties>
jakarta.persistence.jdbc.url=jdbc:postgresql://localhost:5432/localdb
jakarta.persistence.jdbc.user=localuser
jakarta.persistence.jdbc.password=secret
</code>
</WRAP> |


Im Java-Code sind ausserdem folgende Anpassungen nötig:
  * Die Eigenschaften der Tabelle werden als Annotationen (''@...'') in der Java-Klasse gesetzt. 
  * Ein leerer Standard-Constructor ist nun nötig, damit Hibernate im Hintergrund eine neue Instanz erstellen kann. 
  * ''int'' und andere primitive Datentypen werden durch ihre entsprechenden Klassen (''Integer'', ...) ersetzt.

Dadurch sieht die Klasse ''Book'' neu in etwa so aus. Der Pfad ''ch.bzz.model'' ist auch in ''persistence.xml'' hinterlegt und wird in de Tests vorausgesetzt. Verschieben Sie daher die Klasse entsprechend.

<code java>
package ch.bzz.model;

import jakarta.persistence.*;

@Entity
@Table(name = "books")
public class Book {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Integer id;

    @Column(name = "isbn", nullable = false, length = 20, unique = true)
    private String isbn;

    @Column(name = "title", nullable = false, length = 255)
    private String title;

    @Column(name = "author", nullable = false, length = 255)
    private String author;

    @Column(name = "publication_year")
    private Integer publicationYear;

    public Book(){}

    public Book(Integer id, String isbn, String title, String author, Integer publicationYear) {
        this.id = id;
        this.isbn = isbn;
        this.title = title;
        this.author = author;
        this.publicationYear = publicationYear;
    }
    
    // toString, equals(), hashCode() if needed
    ...
    
    // Getter & Setter
    ...
</code>

Um Objekte von der Datenbank zu lesen kann mittels ''EntityManager'' das entsprechende Abfrage ausgeführt werden. Zum Speichern kann ''persist'' oder ''merge'' (überschreiben falls vorhanden) genutzt werden.
Bei den ''<PROPERTIES>'' werden die Properties von ''config.properties'' mitgegeben.

<code java>
    private final EntityManagerFactory emf = Persistence.createEntityManagerFactory("localPU", <PROPERTIES>);

    public List<Book> getAll(int limit) {
        try (EntityManager em = emf.createEntityManager()) {
            var query = em.createQuery("SELECT b FROM Book b ORDER BY id", Book.class);
            if (limit > 0) {
                query.setMaxResults(limit);
            }
            return query.getResultList();
        }
    }


    public void saveAll(List<Book> books) {
        try (EntityManager em = emf.createEntityManager()) {
            try {
                em.getTransaction().begin();
                books.forEach(em::merge);
                em.getTransaction().commit();
            } catch (RuntimeException e) {
                if (em.getTransaction().isActive()) {
                    em.getTransaction().rollback();
                }
                log.error("Error during saving of books to the database:", e);
            }
        }
    }
</code>

Schreiben Sie Ihren Code so um, dass die ''Book''-Objekte via Hibernate gelesen und geschrieben werden und überprüfen Sie das Resultat mit den bestehenden Tests.

Der Commit ''e556889'' dient dazu, das Ganze in der Pipeline laufen zu lassen. ''schema.sql'' wird nicht mehr benötigt. Hibernate legt bei Bedarf die Tabellen selbst an. Dies vereinfacht das Hinzufügen neuer Entitäten deutlich.