Skip to content

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

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

Seguiremos a mesma abordagem de antes para implementar a camada [DAO] do TD.

12.1. Suporte

  • Em [1], a pasta [support / chap-12] contém o projeto Eclipse para este 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ções 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]. É isto que precisamos de escrever;
  • [elections.dao.console]: contém uma classe de teste [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 pelo [Spring Data].

12.3. Configuração do Maven


Tarefa: Compilar o ficheiro [pom.xml] do projeto.


12.4. As entidades da camada [JPA]

  
  • [ElectionsConfig] é o modelo de objeto associado a uma linha na tabela [CONF];
  • [VoterList] é o modelo de objeto associado a uma linha na tabela [LISTS];
  • [AbstractEntity] é a classe pai das duas classes anteriores. Ela separa os campos [id, version] comuns a ambas as classes;
  • [ElectionsException] é a classe de exceção do projeto;

12.4.1. A classe [ElectionsException]

  

A classe [ElectionsException] é a exceção não tratada descrita na secção 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;
 
    // 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
...
}

Esta é a classe descrita na secção 11.3.5.2, sem os filtros JSON. Aqui, as tabelas [CONF] e [LISTES] não estão ligadas por uma relação de chave estrangeira. No entanto, é a existência dessa relação com o modo [carregamento diferido] que torna necessários os filtros JSON.

12.4.3. A classe [ElectionsConfig]

  

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


Tarefa: Implementar a classe [ElectionsConfig].


12.4.4. A classe [VoterList]

  

A classe [VoterList] é a entidade JPA associada à tabela [LISTS];


Tarefa: Implementar a classe [VoterList].


12.5. A camada [Spring Data]

  

Tarefa: Escreva as duas interfaces [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 {
 
    // election configuration
    public ElectionsConfig getElectionsConfig();
 
    // candidate lists
    public ListeElectorale[] getListesElectorales();
 
    // updating candidate lists
    public void setListesElectorales(ListeElectorale[] listesElectorales);
}

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


12.7. Configuração do projeto Spring

  

A classe [DaoConfig] configura o projeto Spring.


Tarefa: Escreva a classe [DaoConfig]


12.8. A camada [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 {
 
    // 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();
    }
 
}

A classe [Test01] é um teste 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 {
 
    // 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]);
        }
    }
}

Tarefa: Execute os testes [console] e [JUnit] na sua camada [DAO].


12.9. Gerar o arquivo Maven do projeto

Seguindo o exemplo da Secção 11.3.12, gere o arquivo Maven do projeto.