12. [TD]: تنفيذ طبقة [DAO] في TD باستخدام [Spring Data]

الكلمات المفتاحية: بنية متعددة الطبقات، Spring، حقن التبعية، JPA (Java Persistence API)، Spring Data.

سنتبع نفس النهج السابق لتنفيذ طبقة [DAO] في TD.

12.1. الدعم

في [1]، يحتوي المجلد [support / chap-12] على مشروع Eclipse الخاص بهذا الفصل؛

12.2. مشروع Eclipse

سيكون مشروع Eclipse على النحو التالي:

[elections.dao.config]: يحتوي على فئة تكوين مشروع Spring؛
[elections.dao.entities]: يحتوي على كيانات JPA بالإضافة إلى فئة الاستثناءات الخاصة بالمشروع؛
[elections.dao.repositories]: يحتوي على واجهات [CrudRepository] لجداول [CONF] و[LISTES]؛
[elections.dao.service]: يحتوي على تنفيذ طبقة [DAO]. هذا هو ما نحتاج إلى كتابته؛
[elections.dao.console]: يحتوي على فئة اختبار [console]؛
[pom.xml]: ملف تكوين مشروع Maven؛

يُنفذ هذا المشروع البنية التالية:

لا ترى طبقة [DAO] سوى الطبقة التي تنفذها [Spring Data].

12.3. تكوين Maven

المهمة: إنشاء ملف [pom.xml] الخاص بالمشروع.

12.4. كيانات طبقة [JPA]

[ElectionsConfig] هو نموذج الكائن المرتبط بصف في جدول [CONF]؛
[VoterList] هو نموذج الكائن المرتبط بصف في جدول [LISTS]؛
[AbstractEntity] هي الفئة الأم للفئتين السابقتين. وهي تفصل الحقول [id, version] المشتركة بين الفئتين؛
[ElectionsException] هي فئة الاستثناءات الخاصة بالمشروع؛

12.4.1. فئة [ElectionsException]

فئة [ElectionsException] هي الاستثناء غير المعالج الموصوف في القسم 4.3.

12.4.2. فئة [AbstractEntity]

فئة [AbstractEntity] هي كما يلي:


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
...
}

هذه هي الفئة الموصوفة في القسم 11.3.5.2، بدون مرشحات JSON. هنا، لا ترتبط الجداول [CONF] و[LISTES] بعلاقة مفتاح خارجي. ومع ذلك، فإن وجود مثل هذه العلاقة مع وضع [التحميل المتأخر] هو ما يستلزم مرشحات JSON.

12.4.3. فئة [ElectionsConfig]

فئة [ElectionsConfig] هي كيان JPA المرتبط بالجدول [CONF]؛

المهمة: قم بتنفيذ فئة [ElectionsConfig].

12.4.4. فئة [VoterList]

فئة [VoterList] هي الكيان JPA المرتبط بالجدول [LISTS]؛

المهمة: قم بتنفيذ فئة [VoterList].

12.5. طبقة [Spring Data]

المهمة: اكتب واجهتي [Spring Data] لإدارة الجدولين [CONF] و[LISTES]؛

12.6. طبقة [DAO]

واجهة [IElectionsDao] لطبقة [DAO] هي كما يلي:


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);
}

المهمة: اكتب تنفيذ [ElectionsDaoJpa] لواجهة [IElectionsDao].

12.7. تكوين مشروع Spring

تقوم فئة [DaoConfig] بتكوين مشروع Spring.

المهمة: اكتب فئة [DaoConfig]

12.8. طبقة [console]

الفئة [Main] هي الفئة القابلة للتنفيذ التالية:


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();
    }
 
}

فئة [Test01] هي اختبار 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]);
        }
    }
}

المهمة: قم بتشغيل اختبارات [console] و [JUnit] على طبقة [DAO] الخاصة بك.

12.9. إنشاء أرشيف Maven للمشروع

باتباع المثال الوارد في القسم 11.3.12، قم بإنشاء أرشيف Maven للمشروع.