12. [TD]: Implementação da camada [DAO] do TD com [Spring Data]

Palavras-chave: arquitetura multicamadas, Spring, injeção de dependências, API JPA (Java Persistence API), Spring Data.

Vamos seguir o mesmo procedimento que anteriormente para implementar a camada [DAO] do TD.

12.1. Support

em [1]; a pasta [support / chap-12] contém o projeto Eclipse deste capítulo;

12.2. O projeto Eclipse

O projeto Eclipse será o seguinte:

[elections.dao.config]: contém a classe de configuração do projeto Spring;
[elections.dao.entities]: contém as entidades JPA, bem como a classe de exceção do projeto;
[elections.dao.repositories]: contém as interfaces [CrudRepository] para as tabelas [CONF] e [LISTES];
[elections.dao.service]: contém a implementação da camada [DAO]. É esta que temos de escrever;
[elections.dao.console]: contém uma classe de teste do tipo [console];
[pom.xml]: o ficheiro de configuração do projeto Maven;

Este projeto implementa a seguinte arquitetura:

A camada [DAO] apenas vê a camada implementada por [Spring Data].

12.3. Configuração do Maven

Tarefa a realizar: compile o ficheiro [pom.xml] do projeto.

12.4. As entidades da camada [JPA]

[ElectionsConfig] é o modelo de objeto associado a uma linha da tabela [CONF];
[ListeElectorale] é o modelo de objeto associado a uma linha da tabela [LISTES];
[AbstactEntity] é a classe pai das duas classes anteriores. Esta classe agrupa os campos [id, version] comuns às duas classes;
[ElectionsException] é a classe de exceção do projeto;

12.4.1. A classe [ElectionsException]

A classe [ElectionsException] é a exceção não controlada descrita no parágrafo 4.3.

12.4.2. A classe [AbstractEntity]

A classe [AbstractEntity] é a seguinte:


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;

    // propriedades
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    @Column(name = "ID")
    protected Long id;
    @Version
    @Column(name = "VERSION")
    protected Long version;

    // construtores
    public AbstractEntity() {

    }

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

    // redefinição de [equals] e [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;
    }

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

    // getters e setters
...
}

Esta é a classe descrita no parágrafo 11.3.5.2, sem os filtros jSON. De facto, neste caso, as tabelas [CONF] e [LISTES] não estão ligadas por uma relação de chave estrangeira. Ora, é precisamente a existência dessa relação com o modo [lazy loading] que determina a necessidade dos filtros jSON.

12.4.3. A classe [ElectionsConfig]

A classe [ElectionsConfig] é a entidade JPA associada à tabela [CONF];

Tarefa a realizar: crie a classe [ElectionsConfig].

12.4.4. A classe [ListeElectorale]

A classe [ListeElectorale] é a entidade JPA associada à tabela [LISTES];

Tarefa a realizar: crie a classe [ListeElectorale].

12.5. A camada [Spring Data]

Tarefa a realizar: escreva as duas interfaces de [Spring Data] para gerir as duas tabelas [CONF] e [LISTES];

12.6. A camada [DAO]

A interface [IElectionsDao] da camada [DAO] é a seguinte:


package dao.service;

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

public interface IElectionsDao {

    // configuração da eleição
    public ElectionsConfig getElectionsConfig();

    // listas de candidatos
    public ListeElectorale[] getListesElectorales();

    // atualização das listas de candidatos
    public void setListesElectorales(ListeElectorale[] listesElectorales);
}

Tarefa a realizar: escreva a implementação [ElectionsDaoJpa] da interface [IElectionsDao].

12.7. Configuração do projeto Spring

A classe [DaoConfig] configura o projeto Spring.

Tarefa a realizar: escreva a classe [DaoConfig]

12.8. A fralda [console]

A classe [Main] é a seguinte classe executável:


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 {

    // fonte de dados
    private static IElectionsDao dao;

    public static void main(String[] args) {
        // recuperação do contexto Spring
        AnnotationConfigApplicationContext ctx = new AnnotationConfigApplicationContext(AppConfig.class);
        // recuperação da fonte de dados
        dao = ctx.getBean(IElectionsDao.class);
        // conteúdo das duas tabelas
        ElectionsConfig electionsConfig = dao.getElectionsConfig();
        ListeElectorale[] listes = dao.getListesElectorales();
        // exibição
        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);
        }
        // encerramento do contexto Spring
        ctx.close();
    }

}

A classe [Test01] é um teste da 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 {

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

    @Before
    public void init() {
        // limpa-se a tabela [LISTES]
        // listas em concorrência
        ListeElectorale[] listes = electionsDao.getListesElectorales();
        // zera-se o número de votos e de lugares e define-se como «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);
        }
        // tornamos estes dados persistentes através da camada [dao]
        electionsDao.setListesElectorales(listes);
    }

    @Test
    public void testElections01() {
        System.out.println("testElections01-------------------------------------");
        // recuperação da configuração das eleições
        ElectionsConfig electionsConfig = electionsDao.getElectionsConfig();
        int nbSiegesAPourvoir = electionsConfig.getNbSiegesAPourvoir();
        double seuilElectoral = electionsConfig.getSeuilElectoral();
        Assert.assertEquals(6, nbSiegesAPourvoir);
        Assert.assertEquals(0.05, seuilElectoral, 1E-6);

        // listas concorrentes
        ListeElectorale[] listes = electionsDao.getListesElectorales();
        // exibição dos valores lidos
        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]);
        }

        // atribuição de votos e lugares às listas
        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;
        }

        // permanência destes dados através da camada [dao]
        electionsDao.setListesElectorales(listes);

        // releitura dos dados
        ListeElectorale[] listesElectorales2 = electionsDao.getListesElectorales();
        // verifica-se os dados lidos
        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]);
        }
    }
}

Tarefa a realizar: execute os testes [console] e [JUnit] na sua camada [DAO].

12.9. Geração do arquivo Maven do projeto

Seguindo o exemplo do parágrafo 11.3.12, gere o arquivo Maven do projeto.