12. [TD]: Implementierung der [DAO]-Schicht des TD unter Verwendung von [Spring Data]

Stichworte: mehrschichtige Architektur, Spring, Dependency Injection, JPA (Java Persistence API), Spring Data.

Wir werden denselben Ansatz wie zuvor verfolgen, um die [DAO]-Schicht des TD zu implementieren.

12.1. Support

In [1] enthält der Ordner [support / chap-12] das Eclipse-Projekt für dieses Kapitel;

12.2. Das Eclipse-Projekt

Das Eclipse-Projekt sieht wie folgt aus:

[elections.dao.config]: enthält die Spring-Projektkonfigurationsklasse;
[elections.dao.entities]: enthält die JPA-Entitäten sowie die Ausnahmeklasse des Projekts;
[elections.dao.repositories]: enthält die [CrudRepository]-Schnittstellen für die Tabellen [CONF] und [LISTES];
[elections.dao.service]: enthält die Implementierung der [DAO]-Schicht. Dies ist der Teil, den wir schreiben müssen;
[elections.dao.console]: enthält eine [console]-Testklasse;
[pom.xml]: die Maven-Projektkonfigurationsdatei;

Dieses Projekt implementiert die folgende Architektur:

Die [DAO]-Schicht sieht nur die von [Spring Data] implementierte Schicht.

12.3. Maven-Konfiguration

Aufgabe: Erstellen Sie die [pom.xml]-Datei des Projekts.

12.4. Die Entitäten der [JPA]-Schicht

[ElectionsConfig] ist das Objektmodell, das einer Zeile in der Tabelle [CONF] zugeordnet ist;
[VoterList] ist das Objektmodell, das einer Zeile in der Tabelle [LISTS] zugeordnet ist;
[AbstractEntity] ist die übergeordnete Klasse der beiden vorangehenden Klassen. Sie fasst die beiden Klassen gemeinsamen Felder [id, version] zusammen;
[ElectionsException] ist die Ausnahmeklasse des Projekts;

12.4.1. Die Klasse [ElectionsException]

Die Klasse [ElectionsException] ist die in Abschnitt 4.3 beschriebene unbehandelte Ausnahme.

12.4.2. Die Klasse [AbstractEntity]

Die Klasse [AbstractEntity] sieht wie folgt aus:


package elections.dao.entities;
 
import java.io.Serializable;
 
import javax.persistence.Column;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.MappedSuperclass;
import javax.persistence.Version;
 
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
 
@MappedSuperclass
public abstract class AbstractEntity implements Serializable{
    private static final long serialVersionUID = 1L;
 
    // properties
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    @Column(name = "ID")
    protected Long id;
    @Version
    @Column(name = "VERSION")
    protected Long version;
 
    // manufacturers
    public AbstractEntity() {
 
    }
 
    public AbstractEntity(Long id, Long version) {
        this.id = id;
        this.version = version;
    }
 
    // redefine [equals] and [hashcode]
    @Override
    public int hashCode() {
        return (id != null ? id.hashCode() : 0);
    }
 
    @Override
    public boolean equals(Object entity) {
        if (!(entity instanceof AbstractEntity)) {
            return false;
        }
        String class1 = this.getClass().getName();
        String class2 = entity.getClass().getName();
        if (!class2.equals(class1)) {
            return false;
        }
        AbstractEntity other = (AbstractEntity) entity;
        return id != null && this.id == other.id;
    }
 
    // signature jSON
    public String toString() {
        ObjectMapper mapper = new ObjectMapper();
        try {
            return mapper.writeValueAsString(this);
        } catch (JsonProcessingException e) {
            e.printStackTrace();
            return null;
        }
    }
 
    // getters and setters
...
}

Dies ist die in Abschnitt 11.3.5.2 beschriebene Klasse, ohne die JSON-Filter. Hier sind die Tabellen [CONF] und [LISTES] nicht durch eine Fremdschlüsselbeziehung verknüpft. Es ist jedoch das Vorhandensein einer solchen Beziehung im [Lazy-Loading]-Modus, das JSON-Filter erforderlich macht.

12.4.3. Die Klasse [ElectionsConfig]

Die Klasse [ElectionsConfig] ist die JPA-Entität, die der Tabelle [CONF] zugeordnet ist;

Aufgabe: Implementieren Sie die Klasse [ElectionsConfig].

12.4.4. Die Klasse [VoterList]

Die Klasse [VoterList] ist die JPA-Entität, die der Tabelle [LISTS] zugeordnet ist;

Aufgabe: Implementieren Sie die Klasse [VoterList].

12.5. Die [Spring Data]-Schicht

Aufgabe: Schreiben Sie die beiden [Spring Data]-Schnittstellen zur Verwaltung der beiden Tabellen [CONF] und [LISTES];

12.6. Die [DAO]-Schicht

Die [IElectionsDao]-Schnittstelle der [DAO]-Schicht sieht wie folgt aus:


package dao.service;
 
import dao.entities.ElectionsConfig;
import dao.entities.ListeElectorale;
 
public interface IElectionsDao {
 
    // election configuration
    public ElectionsConfig getElectionsConfig();
 
    // candidate lists
    public ListeElectorale[] getListesElectorales();
 
    // updating candidate lists
    public void setListesElectorales(ListeElectorale[] listesElectorales);
}

Aufgabe: Schreiben Sie die [ElectionsDaoJpa]-Implementierung der [IElectionsDao]-Schnittstelle.

12.7. Spring-Projektkonfiguration

Die Klasse [DaoConfig] konfiguriert das Spring-Projekt.

Aufgabe: Schreiben Sie die Klasse [DaoConfig]

12.8. Die [console]-Schicht

Die Klasse [Main] ist die folgende ausführbare Klasse:


package dao.console;
 
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
 
import dao.config.AppConfig;
import dao.entities.ElectionsConfig;
import dao.entities.ListeElectorale;
import dao.service.IElectionsDao;
 
public class Main {
 
    // data source
    private static IElectionsDao dao;
 
    public static void main(String[] args) {
        // spring context retrieval
        AnnotationConfigApplicationContext ctx = new AnnotationConfigApplicationContext(AppConfig.class);
        // data source recovery
        dao = ctx.getBean(IElectionsDao.class);
        // contents of both tables
        ElectionsConfig electionsConfig = dao.getElectionsConfig();
        ListeElectorale[] listes = dao.getListesElectorales();
        // display
        System.out.println(String.format("Nombre de sièges à pourvoir : %d", electionsConfig.getNbSiegesAPourvoir()));
        System.out.println(String.format("Seuil électoral : %5.2f", electionsConfig.getSeuilElectoral()));
        System.out.println("Listes candidates----------------");
        for (ListeElectorale liste : listes) {
            System.out.println(liste);
        }
        // closing Spring context
        ctx.close();
    }
 
}

Die Klasse [Test01] ist ein JUnit-Test:


package dao.tests;
 
import org.junit.Assert;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.SpringApplicationConfiguration;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
 
import dao.config.AppConfig;
import dao.entities.ElectionsConfig;
import dao.entities.ListeElectorale;
import dao.service.IElectionsDao;
 
@SpringApplicationConfiguration(classes = AppConfig.class)
@RunWith(SpringJUnit4ClassRunner.class)
public class Test01 {
 
    // layer [DAO]
    @Autowired
    private IElectionsDao electionsDao;
 
    @Before
    public void init() {
        // the table is cleaned [LISTES]
        // competing lists
        ListeElectorale[] listes = electionsDao.getListesElectorales();
        // set votes and seats to 0 and eliminate false
        int voix = 0;
        int sièges = 0;
        boolean elimine = false;
        for (ListeElectorale liste : listes) {
            liste.setVoix(voix);
            liste.setSieges(sièges);
            liste.setElimine(elimine);
        }
        // we make this data persistent using the [dao] layer
        electionsDao.setListesElectorales(listes);
    }
 
    @Test
    public void testElections01() {
        System.out.println("testElections01-------------------------------------");
        // election configuration recovery
        ElectionsConfig electionsConfig = electionsDao.getElectionsConfig();
        int nbSiegesAPourvoir = electionsConfig.getNbSiegesAPourvoir();
        double seuilElectoral = electionsConfig.getSeuilElectoral();
        Assert.assertEquals(6, nbSiegesAPourvoir);
        Assert.assertEquals(0.05, seuilElectoral, 1E-6);
 
        // competing lists
        ListeElectorale[] listes = electionsDao.getListesElectorales();
        // display read values
        System.out.println("Nombre de sièges à pourvoir : " + nbSiegesAPourvoir);
        System.out.println("Seuil électoral : " + seuilElectoral);
        System.out.println("Listes en compétition ---------------------");
        for (int i = 0; i < listes.length; i++) {
            System.out.println(listes[i]);
        }
 
        // votes and seats are allocated to lists
        int voix = 0;
        int sièges = 0;
        boolean elimine = false;
        for (ListeElectorale liste : listes) {
            liste.setVoix(voix);
            liste.setSieges(sièges);
            liste.setElimine(elimine);
            voix += 10;
            sièges += 1;
            elimine = !elimine;
        }
 
        // we make this data persistent using the [dao] layer
        electionsDao.setListesElectorales(listes);
 
        // data re-reading
        ListeElectorale[] listesElectorales2 = electionsDao.getListesElectorales();
        // check data read
        Assert.assertEquals(7, listesElectorales2.length);
        voix = 0;
        sièges = 0;
        elimine = false;
        for (ListeElectorale liste : listes) {
            Assert.assertEquals(voix, liste.getVoix());
            Assert.assertEquals(sièges, liste.getSieges());
            Assert.assertEquals(elimine, liste.isElimine());
            voix += 10;
            sièges += 1;
            elimine = !elimine;
        }
        System.out.println("Listes en compétition ---------------------");
        for (int i = 0; i < listes.length; i++) {
            System.out.println(listes[i]);
        }
    }
}

Aufgabe: Führen Sie die [Konsolen-] und [JUnit]-Tests auf Ihrer [DAO]-Schicht aus.

12.9. Erstellen des Maven-Archivs des Projekts

Erstellen Sie gemäß dem Beispiel in Abschnitt 11.3.12 das Maven-Archiv des Projekts.