Projetos de coleção única no MongoDB com dados Spring (Parte 2)

Na Parte 1 desta série de duas partes, discutimos padrões de design de coleção única no MongoDB e como eles podem ser usados para evitar a necessidade de junções computacionalmente caras entre coleções. Nesta segunda parte da série, forneceremos exemplos de como o padrão de coleção única pode ser utilizado em aplicações Java usando o Spring Data MongoDB e, em particular, como documentos que representam classes diferentes, mas residem na mesma coleção, podem ser acessados.

Acessando dados de coleção única polimórficos usando o Spring Data MongoDB

Embora as interfaces idiomáticas nativas oficiais do MongoDB estejam disponíveis para 12 diferentes linguagens de programação, com interfaces fornecidas pela comunidade disponíveis para muitas outras, muitos de nossos clientes já têm investimentos e conhecimentos significativos no desenvolvimento de aplicativos Java usando Spring Data. Uma pergunta comum que nos fazem é como acessar documentos polimórficos de coleção única usando o Spring Data MongoDB?

Nas próximas etapas, mostrarei como o modelo de template do Spring Data pode ser usado para mapear documentos de relatórios de posição de companhias aéreas, aeronaves e ADSB em uma única coleção chamada aerodata, para POJOs correspondentes em um aplicativo Spring.

Os exemplos de código a seguir foram criados usando o Netbeans IDE, mas qualquer IDE compatível com Java IDE, incluindo o Eclipse e o IntelliJ IDEA, pode ser usado.

Para começar, visite o site Spring Initializr e crie um novo projeto Spring Boot, adicionando Spring Data MongoDB como uma dependência. No meu exemplo estou usando Gradle, mas você pode usar Maven, se preferir.

Gere seu projeto modelo, descompacte-o e abra-o em seu IDE:

Adicione um pacote ao seu projeto para armazenar o POJO, a classe de repositório e as definições de interface. (No meu projeto, criei um pacote chamado (com.mongodb.devrel.gcr.aerodata). Para nossa demonstração, adicionaremos quatro POJOs — AeroData, Airline, Aircraft e ADSBRecord — para representar nossos dados, com quatro repositórios correspondentes definições da interface. AeroData será uma classe de base abstrata a partir da qual os outros POJOs se estenderão:

Trecho de código

package com.mongodb.devrel.gcr.aerodata;

import java.util.Date;
import org.springframework.data.annotation.TypeAlias;
import org.springframework.data.mongodb.core.mapping.Document;

@Document(collection = "aeroData")
@TypeAlias("ADSBRecord")
public class ADSBRecord extends AeroData {

public Integer altitude; 
    public Integer heading;
    public Integer speed;
    public Integer verticalSpeed;
    public Date timestamp;
    public GeoPoint geoPoint;

public ADSBRecord(String id, Integer altitude, Integer heading, Integer speed, Integer verticalSpeed, Date timestamp, GeoPoint geoPoint) {
        this.id = id;
        this.altitude = altitude;
        this.heading = heading;
        this.speed = speed;
        this.verticalSpeed = verticalSpeed;
        this.timestamp = timestamp;
        this.geoPoint = geoPoint;
    }

@Override
    public String toString() {
        return String.format(
            "ADSB[id=%s, altitude='%d', heading='%d', speed='%d', verticalSpeed='%d' timestamp='%tc', latitude='%f', longitude='%f']",
            id, altitude, heading, speed, verticalSpeed, timestamp, geoPoint == null ? null : geoPoint.coordinates[1], geoPoint == null ? null : geoPoint.coordinates[0]);
    }
}

Trecho de código

Também adicionaremos uma classe GeoPoint para manter as informações de localização nos objetos ADSBRecord:

Trecho de código

Observe as anotações usadas nas quatro classes POJO principais. Usamos a anotação "@Document" para especificar a coleção do MongoDB na qual os dados de cada classe devem ser salvos. Em cada caso, especificamos a coleção "aeroData". Nas classes Airline, Airship e ADSBRecord, também usamos a anotação "@TypeAlias". O Spring Data adicionará automaticamente um campo "_class" a cada um de nossos documentos contendo o nome da classe Java do objeto de origem. A anotação TypeAlias nos permite substituir o valor salvo nesse campo e pode ser útil no início do desenvolvimento de um projeto se houver suspeita de que o tipo de classe possa mudar. Finalmente, na classes abstrata AeroData, usamos a anotação "@id" para especificar o campo que o Spring Data usará no campo MongoDB _id de nossos documentos.

Vamos atualizar nosso projeto para adicionar e recuperar alguns dados. Comece adicionando seu URI de conexão do MongoDB a application.properties. (Se necessário, crie um MongoDB Atlas cluster gratuito cadastrando-se em cloud.mongodb.com.)

Trecho de código

Observe que ter credenciais de usuário não criptografadas em um arquivo de propriedades obviamente não é a melhor prática do ponto de vista da segurança e essa abordagem deve ser usada apenas para fins de teste e instrução. Para obter mais detalhes sobre as opções de conexão segura ao MongoDB, incluindo o uso de armazenamentos de chaves e mecanismos de identidade na nuvem, consulte a documentação do MongoDB.

Com os detalhes da conexão prontos, podemos agora atualizar a classe de entrada do aplicativo principal. Como não estamos usando uma exibição ou um controlador, configuraremos o aplicativo como um CommandLineRunner para exibir a saída na linha de comando:

Trecho de código

package com.mongodb.devrel.gcr.aerodata;

import java.util.Date;
import java.util.Optional;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.CommandLineRunner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class AerodataApplication implements CommandLineRunner {

@Autowired
    private AirlineRepository airlineRepo;
    
    @Autowired
    private AircraftRepository aircraftRepo;
    
    @Autowired
    private ADSBRecordRepository adsbRepo;

public static void main(String[] args) {
        SpringApplication.run(AerodataApplication.class, args);
    }

@Override
    public void run(String... args) throws Exception {

// save an airline
        airlineRepo.save(new Airline("DAL", "Delta Air Lines", "United States", "US", "DELTA", "delta.com"));
        
        // add some aircraft aircraft
        aircraftRepo.save(new Aircraft("DAL_a93d7c", "N695CA", "Bombardier Inc", "CL-600-2D24"));
        aircraftRepo.save(new Aircraft("DAL_ab8379", "N8409N", "Bombardier Inc", "CL-600-2B19"));
        aircraftRepo.save(new Aircraft("DAL_a36f7e", "N8409N", "Airbus Industrie", "A319-114"));
        
        //Add some ADSB position reports
        Double[] coords1 = {55.991776, -4.776722};
        GeoPoint geoPoint = new GeoPoint(coords1);
        adsbRepo.save(new ADSBRecord("DAL_a36f7e_1", 38825, 319, 428, 1024, new Date(1656980617041l), geoPoint));
        Double[] coords2 = {55.994843, -4.781466};
        geoPoint = new GeoPoint(coords2);
        adsbRepo.save(new ADSBRecord("DAL_a36f7e_2", 38875, 319, 429, 1024, new Date(1656980618041l), geoPoint));
        Double[] coords3 = {55.99606, -4.783344};
        geoPoint = new GeoPoint(coords3);
        adsbRepo.save(new ADSBRecord("DAL_a36f7e_3", 38892, 319, 428, 1024, new Date(1656980619041l), geoPoint));

// fetch all airlines
        System.out.println("Airlines found with findAll():");
        System.out.println("-------------------------------");
        for (Airline airline : airlineRepo.findAll()) {
            System.out.println(airline);
        }
        // fetch a specific airline by ICAO ID
        System.out.println("Airline found with findById():");
        System.out.println("-------------------------------");
        Optional<Airline> airlineResponse = airlineRepo.findById("DAL");
        System.out.println(airlineResponse.get());
        
        System.out.println();

// fetch all aircraft
        System.out.println("Aircraft found with findAll():");
        System.out.println("-------------------------------");
        for (Aircraft aircraft : aircraftRepo.findAll()) {
            System.out.println(aircraft);
        }
        // fetch a specific aircraft by ICAO ID
        System.out.println("Aircraft found with findById():");
        System.out.println("-------------------------------");
        Optional<Aircraft> aircraftResponse = aircraftRepo.findById("DAL_a36f7e");
        System.out.println(aircraftResponse.get());
        
        System.out.println();
        
        // fetch all adsb records
        System.out.println("ADSB records found with findAll():");
        System.out.println("-------------------------------");
        for (ADSBRecord adsb : adsbRepo.findAll()) {
            System.out.println(adsb);
        }
        // fetch a specific ADSB Record by ID
        System.out.println("ADSB Record found with findById():");
        System.out.println("-------------------------------");
        Optional<ADSBRecord> adsbResponse = adsbRepo.findById("DAL_a36f7e_1");
        System.out.println(adsbResponse.get());
        System.out.println();
        
    }

}

O Spring Boot cuida de muitos detalhes em segundo plano para nós, incluindo o estabelecimento de uma conexão com o MongoDB e a ligação automática de nossas classes de repositório. Ao executar o aplicativo, estamos:

Usando o método save nos repositórios Airline, Aircraft e ADSBRecord, respectivamente, para adicionar uma companhia aérea, três aeronaves e três documentos de relatório de posição ADSB à nossa coleção.
Usando os métodos findAll e findById nos repositórios Airline, Aircraft e ADSBRecord, respectivamente, para recuperar, por sua vez, todos os documentos de companhias aéreas, um documento de companhia aérea específico, todos os documentos de aeronave, um documento específico de qualquer aeronave, todos os documentos de relatório de posição ADSB e um ADSB específico documento de relatório de posição.

Se tudo estiver configurado corretamente, veremos a seguinte saída na linha de comando:

Trecho de código

Airlines found with findAll():
-------------------------------
Airline[id=DAL, name='Delta Air Lines', country='United States (US)', callsign='DELTA', website='delta.com']
Airline[id=DAL_a93d7c, name='null', country='null (null)', callsign='null', website='null']
Airline[id=DAL_ab8379, name='null', country='null (null)', callsign='null', website='null']
Airline[id=DAL_a36f7e, name='null', country='null (null)', callsign='null', website='null']
Airline[id=DAL_a36f7e_1, name='null', country='null (null)', callsign='null', website='null']
Airline[id=DAL_a36f7e_2, name='null', country='null (null)', callsign='null', website='null']
Airline[id=DAL_a36f7e_3, name='null', country='null (null)', callsign='null', website='null']
Airline found with findById():
-------------------------------
Airline[id=DAL, name='Delta Air Lines', country='United States (US)', callsign='DELTA', website='delta.com']

Aircraft found with findAll():
-------------------------------
Aircraft[id=DAL, tailNumber='null', manufacturer='null', model='null']
Aircraft[id=DAL_a93d7c, tailNumber='N695CA', manufacturer='Bombardier Inc', model='CL-600-2D24']
Aircraft[id=DAL_ab8379, tailNumber='N8409N', manufacturer='Bombardier Inc', model='CL-600-2B19']
Aircraft[id=DAL_a36f7e, tailNumber='N8409N', manufacturer='Airbus Industrie', model='A319-114']
Aircraft[id=DAL_a36f7e_1, tailNumber='null', manufacturer='null', model='null']
Aircraft[id=DAL_a36f7e_2, tailNumber='null', manufacturer='null', model='null']
Aircraft[id=DAL_a36f7e_3, tailNumber='null', manufacturer='null', model='null']
Aircraft found with findById():
-------------------------------
Aircraft[id=DAL_a36f7e, tailNumber='N8409N', manufacturer='Airbus Industrie', model='A319-114']

ADSB records found with findAll():
-------------------------------
ADSB[id=DAL, altitude='null', heading='null', speed='null', verticalSpeed='null' timestamp='null', latitude='null', longitude='null']
ADSB[id=DAL_a93d7c, altitude='null', heading='null', speed='null', verticalSpeed='null' timestamp='null', latitude='null', longitude='null']
ADSB[id=DAL_ab8379, altitude='null', heading='null', speed='null', verticalSpeed='null' timestamp='null', latitude='null', longitude='null']
ADSB[id=DAL_a36f7e, altitude='null', heading='null', speed='null', verticalSpeed='null' timestamp='null', latitude='null', longitude='null']
ADSB[id=DAL_a36f7e_1, altitude='38825', heading='319', speed='428', verticalSpeed='1024' timestamp='Tue Jul 05 01:23:37 BST 2022', latitude='55.991776', longitude='-4.776722']
ADSB[id=DAL_a36f7e_2, altitude='38875', heading='319', speed='429', verticalSpeed='1024' timestamp='Tue Jul 05 01:23:38 BST 2022', latitude='55.994843', longitude='-4.781466']
ADSB[id=DAL_a36f7e_3, altitude='38892', heading='319', speed='428', verticalSpeed='1024' timestamp='Tue Jul 05 01:23:39 BST 2022', latitude='55.996060', longitude='-4.783344']
ADSB Record found with findById():
-------------------------------
ADSB[id=DAL_a36f7e_1, altitude='38825', heading='319', speed='428', verticalSpeed='1024' timestamp='Tue Jul 05 01:23:37 BST 2022', latitude='-4.776722', longitude='55.991776']

Como você pode ver, nossos dados foram adicionados com sucesso à coleção do MongoDB e podemos recuperar os dados. No entanto, há um problema. Os métodos findAll de cada um dos objetos de repositório estão retornando um resultado para cada documento em nossa coleção, não apenas os documentos do tipo de classe associado a cada repositório. Como resultado, sete documentos são retornados para cada tipo de registro – companhia aérea, aeronave e ADSB – quando esperaríamos ver apenas uma companhia aérea, três aeronaves e três relatórios de posição do ADSB. Observe que esse problema é comum em todos os métodos de repositório "All" — findAll, deleteAll e notifyAll. Uma chamada para o método deleteAll no repositório da companhia aérea resultaria na exclusão de todos os documentos da coleção, não apenas dos documentos da companhia aérea.

Para resolver isso, temos duas opções: podemos substituir os métodos padrão findAll (e deleteAll/notifyAll) do repositório Spring Boot para incluir métodos na classe associada a cada classe de repositório de chamada, ou podemos estender as definições da interface do repositório para incluir métodos para especificamente recuperar somente documentos da classe correspondente. Em nosso exercício, nos concentraremos na abordagem posterior atualizando as definições de interface do repositório:

Trecho de código

Em cada interface, adicionamos duas novas definições de função: uma para retornar todos os documentos do tipo relevante e outra para permitir que os documentos sejam devolvidos ao pesquisar pelo endereço ICAO. Usando a anotação @Query, podemos formatar as queries conforme necessário.

Com nossas definições de função em vigor, agora podemos atualizar a classe de aplicativo principal:

Trecho de código

package com.mongodb.devrel.gcr.aerodata;

import java.util.Date;
import java.util.Optional;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.CommandLineRunner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class AerodataApplication implements CommandLineRunner {

@Autowired
    private AirlineRepository airlineRepo;
    
    @Autowired
    private AircraftRepository aircraftRepo;
    
    @Autowired
    private ADSBRecordRepository adsbRepo;

public static void main(String[] args) {
        SpringApplication.run(AerodataApplication.class, args);
    }

@Override
    public void run(String... args) throws Exception {

//Delete any records from a previous run;
        airlineRepo.deleteAll();

// save an airline
        airlineRepo.save(new Airline("DAL", "Delta Air Lines", "United States", "US", "DELTA", "delta.com"));
        
        // add some aircraft aircraft
        aircraftRepo.save(new Aircraft("DAL_a93d7c", "N695CA", "Bombardier Inc", "CL-600-2D24"));
        aircraftRepo.save(new Aircraft("DAL_ab8379", "N8409N", "Bombardier Inc", "CL-600-2B19"));
        aircraftRepo.save(new Aircraft("DAL_a36f7e", "N8409N", "Airbus Industrie", "A319-114"));
        
        //Add some ADSB position reports
        Double[] coords1 = {-4.776722, 55.991776};
        GeoPoint geoPoint = new GeoPoint(coords1);
        adsbRepo.save(new ADSBRecord("DAL_a36f7e_1", 38825, 319, 428, 1024, new Date(1656980617041l), geoPoint));
        Double[] coords2 = {-4.781466, 55.994843};
        geoPoint = new GeoPoint(coords2);
        adsbRepo.save(new ADSBRecord("DAL_a36f7e_2", 38875, 319, 429, 1024, new Date(1656980618041l), geoPoint));
        Double[] coords3 = {-4.783344, 55.99606};
        geoPoint = new GeoPoint(coords3);
        adsbRepo.save(new ADSBRecord("DAL_a36f7e_3", 38892, 319, 428, 1024, new Date(1656980619041l), geoPoint));

// fetch all airlines
        System.out.println("Airlines found with findAllAirlines():");
        System.out.println("-------------------------------");
        for (Airline airline : airlineRepo.findAllAirlines()) {
            System.out.println(airline);
        }
        System.out.println();
        // fetch a specific airline by ICAO ID
        System.out.println("Airlines found with findAirlineByIcaoAddr(\"DAL\"):");
        System.out.println("-------------------------------");
        Optional<Airline> airlineResponse = airlineRepo.findAirlineByIcaoAddr("DAL");
        System.out.println(airlineResponse.get());
        
        System.out.println();

// fetch all aircraft
        System.out.println("Aircraft found with findAllAircraft():");
        System.out.println("-------------------------------");
        for (Aircraft aircraft : aircraftRepo.findAllAircraft()) {
            System.out.println(aircraft);
        }
        System.out.println();
        // fetch Aircraft Documents specific to airline "DAL"
        System.out.println("Aircraft found with findAircraftDataByIcaoAddr(\"DAL\"):");
        System.out.println("-------------------------------");
        for (Aircraft aircraft : aircraftRepo.findAircraftDataByIcaoAddr("DAL")) {
            System.out.println(aircraft);
        }
        
        System.out.println();
        
        // fetch Aircraft Documents specific to aircraft "a36f7e"
        System.out.println("Aircraft found with findAircraftDataByIcaoAddr(\"DAL_a36f7e\"):");
        System.out.println("-------------------------------");
        for (Aircraft aircraft : aircraftRepo.findAircraftDataByIcaoAddr("DAL_a36f7e")) {
            System.out.println(aircraft);
        }
        
        System.out.println();
        
        // fetch all adsb records
        System.out.println("ADSB records found with findAllADSBRecords():");
        System.out.println("-------------------------------");
        for (ADSBRecord adsb : adsbRepo.findAllADSBRecords()) {
            System.out.println(adsb);
        }
        System.out.println();
        // fetch ADSB Documents specific to airline "DAL"
        System.out.println("ADSB Documents found with findADSBDataByIcaoAddr(\"DAL\"):");
        System.out.println("-------------------------------");
        for (ADSBRecord adsb : adsbRepo.findADSBDataByIcaoAddr("DAL")) {
            System.out.println(adsb);
        }
        
        System.out.println();
        
        // fetch ADSB Documents specific to aircraft "a36f7e"
        System.out.println("ADSB Documents found with findADSBDataByIcaoAddr(\"DAL_a36f7e\"):");
        System.out.println("-------------------------------");
        for (ADSBRecord adsb : adsbRepo.findADSBDataByIcaoAddr("DAL_a36f7e")) {
            System.out.println(adsb);
        }
    }
}

Observe que, além das chamadas de pesquisa revisadas, também adicionamos uma chamada para DeleteAll no repositório da companhia aérea para remover dados adicionados por execuções anteriores do aplicativo.

Com as atualizações em vigor, quando executarmos o aplicativo, devemos ver o resultado esperado:

Trecho de código

Airlines found with findAllAirlines():
-------------------------------
Airline[id=DAL, name='Delta Air Lines', country='United States (US)', callsign='DELTA', website='delta.com']

Airlines found with findAirlineByIcaoAddr("DAL"):
-------------------------------
Airline[id=DAL, name='Delta Air Lines', country='United States (US)', callsign='DELTA', website='delta.com']

Aircraft found with findAllAircraft():
-------------------------------
Aircraft[id=DAL_a93d7c, tailNumber='N695CA', manufacturer='Bombardier Inc', model='CL-600-2D24']
Aircraft[id=DAL_ab8379, tailNumber='N8409N', manufacturer='Bombardier Inc', model='CL-600-2B19']
Aircraft[id=DAL_a36f7e, tailNumber='N8409N', manufacturer='Airbus Industrie', model='A319-114']

Aircraft found with findAircraftDataByIcaoAddr("DAL"):
-------------------------------
Aircraft[id=DAL_a36f7e, tailNumber='N8409N', manufacturer='Airbus Industrie', model='A319-114']
Aircraft[id=DAL_a93d7c, tailNumber='N695CA', manufacturer='Bombardier Inc', model='CL-600-2D24']
Aircraft[id=DAL_ab8379, tailNumber='N8409N', manufacturer='Bombardier Inc', model='CL-600-2B19']

Aircraft found with findAircraftDataByIcaoAddr("DAL_a36f7e"):
-------------------------------
Aircraft[id=DAL_a36f7e, tailNumber='N8409N', manufacturer='Airbus Industrie', model='A319-114']

ADSB records found with findAllADSBRecords():
-------------------------------
ADSB[id=DAL_a36f7e_1, altitude='38825', heading='319', speed='428', verticalSpeed='1024' timestamp='Tue Jul 05 01:23:37 BST 2022', latitude='55.991776', longitude='-4.776722']
ADSB[id=DAL_a36f7e_2, altitude='38875', heading='319', speed='429', verticalSpeed='1024' timestamp='Tue Jul 05 01:23:38 BST 2022', latitude='55.994843', longitude='-4.781466']
ADSB[id=DAL_a36f7e_3, altitude='38892', heading='319', speed='428', verticalSpeed='1024' timestamp='Tue Jul 05 01:23:39 BST 2022', latitude='55.996060', longitude='-4.783344']

ADSB Documents found with findADSBDataByIcaoAddr("DAL"):
-------------------------------
ADSB[id=DAL_a36f7e_1, altitude='38825', heading='319', speed='428', verticalSpeed='1024' timestamp='Tue Jul 05 01:23:37 BST 2022', latitude='55.991776', longitude='-4.776722']
ADSB[id=DAL_a36f7e_2, altitude='38875', heading='319', speed='429', verticalSpeed='1024' timestamp='Tue Jul 05 01:23:38 BST 2022', latitude='55.994843', longitude='-4.781466']
ADSB[id=DAL_a36f7e_3, altitude='38892', heading='319', speed='428', verticalSpeed='1024' timestamp='Tue Jul 05 01:23:39 BST 2022', latitude='55.996060', longitude='-4.783344']

ADSB Documents found with findADSBDataByIcaoAddr("DAL_a36f7e"):
-------------------------------
ADSB[id=DAL_a36f7e_1, altitude='38825', heading='319', speed='428', verticalSpeed='1024' timestamp='Tue Jul 05 01:23:37 BST 2022', latitude='55.991776', longitude='-4.776722']
ADSB[id=DAL_a36f7e_2, altitude='38875', heading='319', speed='429', verticalSpeed='1024' timestamp='Tue Jul 05 01:23:38 BST 2022', latitude='55.994843', longitude='-4.781466']
ADSB[id=DAL_a36f7e_3, altitude='38892', heading='319', speed='428', verticalSpeed='1024' timestamp='Tue Jul 05 01:23:39 BST 2022', latitude='55.996060', longitude='-4.783344']

Nesta publicação de duas partes, vimos como os projetos polimórficos de coleção única no MongoDB podem fornecer toda a flexibilidade de queries dos projetos relacionais normalizados e, ao mesmo tempo, evitar antipadrões, como arrays ilimitados e junções desnecessárias. Isso torna as coleções resultantes altamente eficientes do ponto de vista de pesquisar e passíveis de dimensionamento horizontal. Também mostramos como podemos trabalhar com esses projetos usando o Spring Data MongoDB.

O exemplo de código-fonte usado nesta série está disponível no Github.

Java

Projetos de coleção única no MongoDB com dados Spring (Parte 2)

Acessando dados de coleção única polimórficos usando o Spring Data MongoDB

Relacionado

Introdução ao Minecraft e ao MongoDB

Como a Queryable Encryption pode manter o James Bond seguro

Expansão do setor de jogos com Gaspard Petit, da Square Enix

Como migrar do Realm Java SDK para o Realm Kotlin SDK

Sumário