Skip to content

12. [TD]: Implementacja warstwy [DAO] z TD przy użyciu [Spring Data]

Słowa kluczowe: architektura wielowarstwowa, Spring, wstrzykiwanie zależności, API JPA (Java Persistence API), Spring Data.

Zastosujemy to samo podejście, co poprzednio, aby zaimplementować warstwę [DAO] w ramach TD.

12.1. Support

  • w [1], folder [support / chap-12] zawiera projekt Eclipse z tego rozdziału;

12.2. Projekt Eclipse

Projekt Eclipse będzie wyglądał następująco:

  
  • [elections.dao.config]: zawiera klasę konfiguracyjną projektu Spring;
  • [elections.dao.entities]: zawiera encje JPA oraz klasę wyjątków projektu;
  • [elections.dao.repositories]: zawiera interfejsy [CrudRepository] dla tabel [CONF] i [LISTES];
  • [elections.dao.service]: zawiera implementację warstwy [DAO]. To właśnie tę klasę musimy napisać;
  • [elections.dao.console]: zawiera klasę testową typu [console];
  • [pom.xml]: plik konfiguracyjny projektu Maven;

Projekt ten wykorzystuje następującą architekturę:

Warstwa [DAO] widzi wyłącznie warstwę zaimplementowaną przez [Spring Data].

12.3. Konfiguracja Maven

Zadanie: skompiluj plik [pom.xml] projektu.

12.4. Elementy warstwy [JPA]

  
  • [ElectionsConfig] to model obiektowy powiązany z wierszem tabeli [CONF];
  • [ListeElectorale] to model obiektowy powiązany z wierszem tabeli [LISTES];
  • [AbstactEntity] jest klasą nadrzędną dla obu poprzednich klas. Wyodrębnia ona pola [id, version] wspólne dla obu klas;
  • [ElectionsException] jest klasą wyjątków projektu;

12.4.1. Klasa [ElectionsException]

  

Klasa [ElectionsException] to niekontrolowany wyjątek opisany w paragrafie 4.3.

12.4.2. Klasa [AbstractEntity]

  

Klasa [AbstractEntity] jest następująca:


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;

    // właściwości
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    @Column(name = "ID")
    protected Long id;
    @Version
    @Column(name = "VERSION")
    protected Long version;

    // konstruktory
    public AbstractEntity() {

    }

    public AbstractEntity(Long id, Long version) {
        this.id = id;
        this.version = version;
    }

    // przedefiniowanie [equals] i [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;
    }

    // podpis jSON
    public String toString() {
        ObjectMapper mapper = new ObjectMapper();
        try {
            return mapper.writeValueAsString(this);
        } catch (JsonProcessingException e) {
            e.printStackTrace();
            return null;
        }
    }

    // metody pobierające i ustawiające
...
}

Jest to klasa opisana w paragrafie 11.3.5.2, bez filtrów jSON. W tym przypadku tabele [CONF] i [LISTES] nie są powiązane relacją klucza obcego. Natomiast to właśnie istnienie takiej relacji z trybem [lazy loading] powoduje konieczność zastosowania filtrów jSON.

12.4.3. Klasa [ElectionsConfig]

  

Klasa [ElectionsConfig] to encja JPA powiązana z tabelą [CONF];

Zadanie: utwórz klasę [ElectionsConfig].

12.4.4. Klasa [ListeElectorale]

  

Klasa [ListeElectorale] jest encją JPA powiązaną z tabelą [LISTES];

Zadanie: utwórz klasę [ListeElectorale].

12.5. Warstwa [Spring Data]

  

Zadanie: napisz dwa interfejsy klasy [Spring Data] w celu obsługi dwóch tabel [CONF] i [LISTES];

12.6. Warstwa [DAO]

  

Interfejs [IElectionsDao] warstwy [DAO] ma następujący wygląd:


package dao.service;

import dao.entities.ElectionsConfig;
import dao.entities.ListeElectorale;

public interface IElectionsDao {

    // konfiguracja wyborów
    public ElectionsConfig getElectionsConfig();

    // listy kandydatów
    public ListeElectorale[] getListesElectorales();

    // aktualizacja list kandydatów
    public void setListesElectorales(ListeElectorale[] listesElectorales);
}

Zadanie: napisz implementację [ElectionsDaoJpa] interfejsu [IElectionsDao].

12.7. Konfiguracja projektu Spring

  

Klasa [DaoConfig] konfiguruje projekt Spring.

Zadanie: napisz klasę [DaoConfig]

12.8. Warstwa [console]

  

Klasa [Main] jest następującą klasą wykonywalną:


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 {

    // źródło danych
    private static IElectionsDao dao;

    public static void main(String[] args) {
        // pobieranie kontekstu Spring
        AnnotationConfigApplicationContext ctx = new AnnotationConfigApplicationContext(AppConfig.class);
        // pobieranie źródła danych
        dao = ctx.getBean(IElectionsDao.class);
        // zawartość obu tabel
        ElectionsConfig electionsConfig = dao.getElectionsConfig();
        ListeElectorale[] listes = dao.getListesElectorales();
        // wyświetlanie
        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);
        }
        // zamknięcie kontekstu Spring
        ctx.close();
    }

}

Klasa [Test01] jest testem klasy JUnit:


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 {

    // warstwa [DAO]
    @Autowired
    private IElectionsDao electionsDao;

    @Before
    public void init() {
        // czyścimy tabelę [LISTES]
        // listy startowe
        ListeElectorale[] listes = electionsDao.getListesElectorales();
        // ustawiamy liczbę głosów i mandatów na 0 oraz ustawiamy wartość „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);
        }
        // zapisujemy te dane na stałe za pomocą warstwy [dao]
        electionsDao.setListesElectorales(listes);
    }

    @Test
    public void testElections01() {
        System.out.println("testElections01-------------------------------------");
        // pobieranie konfiguracji wyborów
        ElectionsConfig electionsConfig = electionsDao.getElectionsConfig();
        int nbSiegesAPourvoir = electionsConfig.getNbSiegesAPourvoir();
        double seuilElectoral = electionsConfig.getSeuilElectoral();
        Assert.assertEquals(6, nbSiegesAPourvoir);
        Assert.assertEquals(0.05, seuilElectoral, 1E-6);

        // listy startujące w wyborach
        ListeElectorale[] listes = electionsDao.getListesElectorales();
        // wyświetlanie odczytanych wartości
        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]);
        }

        // przypisywanie głosów i mandatów listom
        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;
        }

        // zapisywanie tych danych w pamięci trwałej za pomocą warstwy [dao]
        electionsDao.setListesElectorales(listes);

        // ponowne odczytanie danych
        ListeElectorale[] listesElectorales2 = electionsDao.getListesElectorales();
        // sprawdza się odczytane dane
        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]);
        }
    }
}

Zadanie do wykonania: przeprowadź testy [console] i [JUnit] na swojej warstwie [DAO].

12.9. Generowanie archiwum Maven projektu

Postępując zgodnie z przykładem z paragrafu 11.3.12, wygeneruj archiwum Maven projektu.

https://stahe.github.io
Ten kurs-samouczek, napisany przez Serge'a Tahé, jest udostępniany publicznie na warunkach licencji Creative Commons Uznanie autorstwa – Zakaz wykorzystania komercyjnego – Na tych samych warunkach 3.0 bez zmian.