The English version of quarkus.io is the official project site. Translated sites are community supported on a best-effort basis.
Edit this Page

Usando o cliente MongoDB

O MongoDB é um banco de dados NoSQL bem conhecido e amplamente utilizado.

Neste guia, veremos como você pode fazer com que seus serviços REST usem o banco de dados MongoDB.

Pré-requisitos

Para concluir este guia, você precisa:

  • Cerca de 15 minutos

  • Um IDE

  • JDK 17+ instalado com JAVA_HOME configurado corretamente

  • Apache Maven 3.9.12

  • Opcionalmente, o Quarkus CLI se você quiser usá-lo

  • Opcionalmente, Mandrel ou GraalVM instalado e configurado apropriadamente se você quiser criar um executável nativo (ou Docker se você usar uma compilação de contêiner nativo)

  • MongoDB instalado ou Docker instalado

Arquitetura

O aplicativo criado neste guia é bastante simples: o usuário pode adicionar elementos em uma lista usando um formulário e a lista é atualizada.

Todas as informações entre o navegador e o servidor são formatadas como JSON.

Os elementos são armazenados no MongoDB.

Solução

Recomendamos que siga as instruções nas seções seguintes e crie a aplicação passo a passo. No entanto, você pode ir diretamente para o exemplo completo.

Clone o repositório Git: git clone https://github.com/quarkusio/quarkus-quickstarts.git, ou baixe um arquivo.

A solução está localizada no diretório mongodb-quickstart .

Criar o projeto Maven

Primeiro, precisamos de um novo projeto. Crie um novo projeto com o seguinte comando:

CLI
quarkus create app org.acme:mongodb-quickstart \
    --extension='rest-jackson,mongodb-client' \
    --no-code
cd mongodb-quickstart

Para criar um projeto Gradle, adicione a opção --gradle ou --gradle-kotlin-dsl.

Para obter mais informações sobre como instalar e usar a CLI do Quarkus, consulte o guia Quarkus CLI.

Maven
mvn io.quarkus.platform:quarkus-maven-plugin:3.34.6:create \
    -DprojectGroupId=org.acme \
    -DprojectArtifactId=mongodb-quickstart \
    -Dextensions='rest-jackson,mongodb-client' \
    -DnoCode
cd mongodb-quickstart

Para criar um projeto Gradle, adicione a opção '-DbuildTool=gradle' ou '-DbuildTool=gradle-kotlin-dsl'.

Para usuários do Windows:

  • Se estiver usando cmd, (não use barra invertida '\' e coloque tudo na mesma linha)

  • Se estiver usando o Powershell, envolva os parâmetros '-D' entre aspas duplas, por exemplo, '"-DprojectArtifactId=mongodb-quickstart"'

Esse comando gera uma estrutura Maven importando as extensões Quarkus REST (anteriormente RESTEasy Reactive) Jackson e MongoDB Client. Depois disso, a extensão quarkus-mongodb-client foi adicionada ao seu arquivo de compilação.

Se já tiver o projeto Quarkus configurado, você pode adicionar a extensão mongodb-client ao projeto executando o seguinte comando no diretório base do projeto:

CLI
quarkus extension add mongodb-client
Maven
./mvnw quarkus:add-extension -Dextensions='mongodb-client'
Gradle
./gradlew addExtension --extensions='mongodb-client'

Isso adicionará o seguinte ao seu arquivo pom.xml:

pom.xml
<dependency>
    <groupId>io.quarkus</groupId>
    <artifactId>quarkus-mongodb-client</artifactId>
</dependency>
build.gradle
implementation("io.quarkus:quarkus-mongodb-client")

Criando seu primeiro serviço JSON REST

Neste exemplo, criaremos um aplicativo para gerenciar uma lista de frutas.

Primeiro, vamos criar o bean Fruit da seguinte forma:

package org.acme.mongodb;

import java.util.Objects;

public class Fruit {

    private String name;
    private String description;
    private String id;

    public Fruit() {
    }

    public Fruit(String name, String description) {
        this.name = name;
        this.description = description;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getDescription() {
        return description;
    }

    public void setDescription(String description) {
        this.description = description;
    }

    @Override
    public boolean equals(Object obj) {
        if (!(obj instanceof Fruit)) {
            return false;
        }

        Fruit other = (Fruit) obj;

        return Objects.equals(other.name, this.name);
    }

    @Override
    public int hashCode() {
        return Objects.hash(this.name);
    }

    public void setId(String id) {
        this.id = id;
    }

    public String getId() {
        return id;
    }
}

Nada de especial. Um aspecto importante a ser observado é que a camada de serialização JSON exige um construtor padrão.

Agora, crie um org.acme.mongodb.FruitService que será a camada de negócios do nosso aplicativo e armazene/carregue os frutos do banco de dados do mongoDB.

package org.acme.mongodb;

import com.mongodb.client.MongoClient;
import com.mongodb.client.MongoCollection;
import com.mongodb.client.MongoCursor;
import org.bson.Document;

import jakarta.enterprise.context.ApplicationScoped;
import jakarta.inject.Inject;
import java.util.ArrayList;
import java.util.List;

@ApplicationScoped
public class FruitService {

    @Inject MongoClient mongoClient;

    public List<Fruit> list(){
        List<Fruit> list = new ArrayList<>();
        MongoCursor<Document> cursor = getCollection().find().iterator();

        try {
            while (cursor.hasNext()) {
                Document document = cursor.next();
                Fruit fruit = new Fruit();
                fruit.setName(document.getString("name"));
                fruit.setDescription(document.getString("description"));
                list.add(fruit);
            }
        } finally {
            cursor.close();
        }
        return list;
    }

    public void add(Fruit fruit){
        Document document = new Document()
                .append("name", fruit.getName())
                .append("description", fruit.getDescription());
        getCollection().insertOne(document);
    }

    private MongoCollection getCollection(){
        return mongoClient.getDatabase("fruit").getCollection("fruit");
    }
}

Agora, crie a classe org.acme.mongodb.FruitResource da seguinte forma:

@Path("/fruits")
public class FruitResource {

    @Inject FruitService fruitService;

    @GET
    public List<Fruit> list() {
        return fruitService.list();
    }

    @POST
    public List<Fruit> add(Fruit fruit) {
        fruitService.add(fruit);
        return list();
    }
}

A implementação é bastante simples e você só precisa definir seus endpoints usando as anotações Jakarta REST e usar o FruitService para listar/adicionar novas frutas.

Configuração do banco de dados MongoDB

A principal propriedade a ser configurada é o URL para acessar a instância do MongoDB. Quase todas as configurações podem ser incluídas no URI de conexão, por isso recomendamos que você faça isso. você pode encontrar mais informações na documentação do MongoDB: https://docs.mongodb.com/manual/reference/connection-string/

Um exemplo de configuração deve ser semelhante a este:

# configure the mongoDB client for a replica set of two nodes
quarkus.mongodb.connection-string = mongodb://mongo1:27017,mongo2:27017

Neste exemplo, estamos usando uma única instância em execução no localhost:

# configure the mongoDB client for a single instance on localhost
quarkus.mongodb.connection-string = mongodb://localhost:27017

Resolução de URLs mongo+srv://

Ao usar URLs mongo+srv:// , o driver do MongoDB resolve registros DNS SRV para recuperar a lista de hosts aos quais se conectar. Por padrão, ele se baseia em um cliente DNS implementado usando JNDI.

Por motivos de segurança, o Quarkus restringe o uso do JNDI nos aplicativos para ajudar a mitigar possíveis vulnerabilidades, como o Log4Shell. Para dar suporte a mongo+srv:// , o Quarkus fornece um cliente DNS alternativo.

No entanto, em alguns ambientes, esse cliente DNS alternativo pode não conseguir resolver os registros SRV . Se você encontrar esses problemas, poderá reverter para o cliente DNS padrão do driver do MongoDB definindo as seguintes propriedades:

quarkus.naming.enable-jndi=true
quarkus.class-loading.removed-resources."io.quarkus\:quarkus-mongodb-client"=META-INF/services/com.mongodb.spi.dns.DnsClientProvider

Isso restaura o mecanismo de resolução padrão baseado em JNDI usado pelo driver do MongoDB.

Usar os serviços de desenvolvimento do MongoDB

Vários clientes MongoDB

O MongoDB permite que você configure vários clientes. Usar vários clientes funciona da mesma forma que ter um único cliente.

quarkus.mongodb.connection-string = mongodb://login:pass@mongo1:27017/database

quarkus.mongodb.users.connection-string = mongodb://mongo2:27017/userdb
quarkus.mongodb.inventory.connection-string = mongodb://mongo3:27017/invdb,mongo4:27017/invdb

Observe que há um bit extra na chave (os segmentos users e inventory ). A sintaxe é a seguinte: quarkus.mongodb.[optional name.][mongo connection property] . Se o nome for omitido, ele configurará o cliente padrão.

O uso de vários clientes do MongoDB possibilita o multilocatário para o MongoDB, permitindo a conexão a vários clusters do MongoDB. Se você quiser se conectar a vários bancos de dados dentro do mesmo cluster, não são necessários vários clientes, pois um único cliente é capaz de acessar todos os bancos de dados no mesmo cluster (como uma conexão JDBC é capaz de acessar vários esquemas dentro do mesmo banco de dados).

Injeção de cliente Mongo nomeado

Ao usar vários clientes, cada um MongoClient , você pode selecionar o cliente a ser injetado usando o qualificador io.quarkus.mongodb.MongoClientName . Usando as propriedades acima para configurar três clientes diferentes, você também pode injetar cada um deles da seguinte forma:

@Inject
MongoClient defaultMongoClient;

@Inject
@MongoClientName("users")
MongoClient mongoClient1;

@Inject
@MongoClientName("inventory")
ReactiveMongoClient mongoClient2;

Ativar ou desativar clientes Mongo

Quando um cliente Mongo é configurado no momento da compilação e seu URL é definido em tempo de execução, ele fica ativo por padrão. O Quarkus inicia o cliente Mongo correspondente quando o aplicativo é iniciado.

Para desativar um cliente Mongo em tempo de execução, você pode:

  • Não definir quarkus.mongodb[.optional name].hosts ou quarkus.mongodb[.optional name].connection-string.

  • Definir quarkus.mongodb[.optional name].active como false.

Se um cliente Mongo não estiver ativo:

  • O cliente Mongo não tenta se conectar ao Mongo durante a inicialização do aplicativo.

  • O cliente Mongo não contribui para uma verificação de integridade.

  • Pontos de injeção CDI estáticos envolvendo o cliente Mongo, como @Inject ReactiveMongoClient mongoClient ou @Inject MongoClient mongoClient, fazem com que a inicialização do aplicativo falhe.

  • A recuperação dinâmica do cliente Mongo, como por meio de CDI.getBeanContainer(), Arc.instance() ou um Instance<ReactiveMongoClient> injetado, faz com que uma exceção seja lançada.

  • Outras extensões do Quarkus que consomem o cliente Mongo podem fazer com que a inicialização do aplicativo falhe.

Este recurso é especialmente útil quando o aplicativo deve selecionar dinamicamente um cliente Mongo de um conjunto predefinido em tempo de execução.

Um exemplo de configuração de múltiplos clientes Mongo para seleção em tempo de execução:
quarkus.mongodb.one.active=false
quarkus.mongodb.one.connection-string=mongodb://127.0.0.1:27018
quarkus.mongodb.two.active=false
quarkus.mongodb.two.connection-string=mongodb://127.0.0.1:27019
import io.quarkus.arc.InjectableInstance;

import com.mongodb.client.MongoClient;
import io.quarkus.mongodb.reactive.ReactiveMongoClient;

@ApplicationScoped
public class MyConsumer {
    @Inject
    @MongoClientName("one")
    InjectableInstance<ReactiveMongoClient> one;
    @Inject
    @MongoClientName("two")
    InjectableInstance<MongoClient> two;
    public void doSomething() {
        ReactiveMongoClient mongoClient = one.getActive();
        // ...
    }
}

Definir quarkus.mongodb.one.active=true em tempo de execução torna apenas o cliente Mongo one disponível. Definir quarkus.mongodb.two.active=true em tempo de execução torna apenas o cliente Mongo two disponível.

Um cliente Mongo (padrão ou nomeado) deve ser sempre detectável no momento da compilação para ser considerado para injeção em tempo de execução. Isso pode ser feito injetando o nome do cliente Mongo com @MongoClientName. Se o nome do cliente Mongo puder ser ativo ou inativo, será necessário usar o wrapper InjectableInstance<>, caso contrário, o Quarkus lançará uma exceção no momento da inicialização se o cliente Mongo estiver inativo. Como alternativa, os clientes Mongo também podem ser descobertos via configuração.

Executando um banco de dados MongoDB

Como, por padrão, o MongoClient está configurado para acessar um banco de dados local do MongoDB na porta 27017 (a porta padrão do MongoDB), se você tiver um banco de dados local em execução nessa porta, não há mais nada a fazer antes de poder testá-lo!

Se quiser usar o Docker para executar um banco de dados MongoDB, você pode usar o seguinte comando para iniciar um:

docker run -ti --rm -p 27017:27017 docker.io/library/mongo:7.0

Se você usar o Dev Services , não será necessário iniciar o contêiner manualmente.

Criando um frontend

Agora vamos adicionar uma página da Web simples para interagir com o nosso site FruitResource . O Quarkus fornece automaticamente recursos estáticos localizados no diretório META-INF/resources . No diretório src/main/resources/META-INF/resources , adicione um arquivo fruits.html com o conteúdo desse arquivo fruits.html .

Agora você pode interagir com o serviço REST:

  • iniciar o Quarkus com:

    CLI
    quarkus dev
    Maven
    ./mvnw quarkus:dev
    Gradle
    ./gradlew --console=plain quarkusDev
  • abra um navegador para http://localhost:8080/fruits.html

  • adicionar novas frutas à lista por meio do formulário

Cliente MongoDB reativo

Um cliente MongoDB reativo está incluído no Quarkus. Usá-lo é tão fácil quanto usar o cliente MongoDB clássico. você pode reescrever o exemplo anterior para usá-lo da seguinte forma.

Mutiny

O cliente reativo do MongoDB usa tipos reativos do Mutiny. Se você não estiver familiarizado com o Mutiny, consulte Mutiny - uma biblioteca de programação reativa intuitiva .

package org.acme.mongodb;

import io.quarkus.mongodb.reactive.ReactiveMongoClient;
import io.quarkus.mongodb.reactive.ReactiveMongoCollection;
import io.smallrye.mutiny.Uni;
import org.bson.Document;

import jakarta.enterprise.context.ApplicationScoped;
import jakarta.inject.Inject;
import java.util.List;

@ApplicationScoped
public class ReactiveFruitService {

    @Inject
    ReactiveMongoClient mongoClient;

    public Uni<List<Fruit>> list() {
        return getCollection().find()
                .map(doc -> {
                    Fruit fruit = new Fruit();
                    fruit.setName(doc.getString("name"));
                    fruit.setDescription(doc.getString("description"));
                    return fruit;
                }).collect().asList();
    }

    public Uni<Void> add(Fruit fruit) {
        Document document = new Document()
                .append("name", fruit.getName())
                .append("description", fruit.getDescription());
        return getCollection().insertOne(document)
                .onItem().ignore().andContinueWithNull();
    }

    private ReactiveMongoCollection<Document> getCollection() {
        return mongoClient.getDatabase("fruit").getCollection("fruit");
    }
}
package org.acme.mongodb;

import io.smallrye.mutiny.Uni;

import java.util.List;

import jakarta.inject.Inject;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.Produces;
import jakarta.ws.rs.Consumes;
import jakarta.ws.rs.GET;
import jakarta.ws.rs.POST;
import jakarta.ws.rs.core.MediaType;

@Path("/reactive_fruits")
@Produces(MediaType.APPLICATION_JSON)
@Consumes(MediaType.APPLICATION_JSON)
public class ReactiveFruitResource {

    @Inject
    ReactiveFruitService fruitService;

    @GET
    public Uni<List<Fruit>> list() {
        return fruitService.list();
    }

    @POST
    public Uni<List<Fruit>> add(Fruit fruit) {
        return fruitService.add(fruit)
                .onItem().ignore().andSwitchTo(this::list);
    }
}

Simplificando o uso do cliente MongoDB usando o codec BSON

Ao usar um Bson Codec , o cliente MongoDB cuidará da transformação do seu objeto de domínio de/para um MongoDB Document automaticamente.

Primeiro, você precisa criar um Bson Codec que dirá ao Bson como transformar sua entidade de/para um MongoDB Document . Aqui usamos um CollectibleCodec porque nosso objeto pode ser recuperado do banco de dados (ele tem um identificador MongoDB); caso contrário, teríamos usado um Codec . Mais informações na documentação do codec: https://www.mongodb.com/docs/drivers/java/sync/current/fundamentals/data-formats/codecs/.

package org.acme.mongodb.codec;

import com.mongodb.MongoClientSettings;
import org.acme.mongodb.Fruit;
import org.bson.Document;
import org.bson.BsonWriter;
import org.bson.BsonValue;
import org.bson.BsonReader;
import org.bson.BsonString;
import org.bson.codecs.Codec;
import org.bson.codecs.CollectibleCodec;
import org.bson.codecs.DecoderContext;
import org.bson.codecs.EncoderContext;

import java.util.UUID;

public class FruitCodec implements CollectibleCodec<Fruit> {

    private final Codec<Document> documentCodec;

    public FruitCodec() {
        this.documentCodec = MongoClientSettings.getDefaultCodecRegistry().get(Document.class);
    }

    @Override
    public void encode(BsonWriter writer, Fruit fruit, EncoderContext encoderContext) {
        Document doc = new Document();
        doc.put("name", fruit.getName());
        doc.put("description", fruit.getDescription());
        documentCodec.encode(writer, doc, encoderContext);
    }

    @Override
    public Class<Fruit> getEncoderClass() {
        return Fruit.class;
    }

    @Override
    public Fruit generateIdIfAbsentFromDocument(Fruit document) {
        if (!documentHasId(document)) {
            document.setId(UUID.randomUUID().toString());
        }
        return document;
    }

    @Override
    public boolean documentHasId(Fruit document) {
        return document.getId() != null;
    }

    @Override
    public BsonValue getDocumentId(Fruit document) {
        return new BsonString(document.getId());
    }

    @Override
    public Fruit decode(BsonReader reader, DecoderContext decoderContext) {
        Document document = documentCodec.decode(reader, decoderContext);
        Fruit fruit = new Fruit();
        if (document.getString("id") != null) {
            fruit.setId(document.getString("id"));
        }
        fruit.setName(document.getString("name"));
        fruit.setDescription(document.getString("description"));
        return fruit;
    }
}

Em seguida, você precisa criar um CodecProvider para vincular esse Codec à classe Fruit .

package org.acme.mongodb.codec;

import org.acme.mongodb.Fruit;
import org.bson.codecs.Codec;
import org.bson.codecs.configuration.CodecProvider;
import org.bson.codecs.configuration.CodecRegistry;

public class FruitCodecProvider implements CodecProvider {
    @Override
    public <T> Codec<T> get(Class<T> clazz, CodecRegistry registry) {
        if (clazz.equals(Fruit.class)) {
            return (Codec<T>) new FruitCodec();
        }
        return null;
    }

}

A Quarkus se encarrega de registrar o CodecProvider para você como um feijão CDI do escopo do @Singleton .

Por fim, ao obter o MongoCollection do banco de dados, você pode usar diretamente a classe Fruit em vez da Document . O codec mapeará automaticamente o Document para/de sua classe Fruit .

Aqui está um exemplo de uso de um MongoCollection com o FruitCodec .

package org.acme.mongodb;

import com.mongodb.client.MongoClient;
import com.mongodb.client.MongoCollection;
import com.mongodb.client.MongoCursor;

import jakarta.enterprise.context.ApplicationScoped;
import jakarta.inject.Inject;
import java.util.ArrayList;
import java.util.List;

@ApplicationScoped
public class CodecFruitService {

    @Inject MongoClient mongoClient;

    public List<Fruit> list(){
        List<Fruit> list = new ArrayList<>();
        MongoCursor<Fruit> cursor = getCollection().find().iterator();

        try {
            while (cursor.hasNext()) {
                list.add(cursor.next());
            }
        } finally {
            cursor.close();
        }
        return list;
    }

    public void add(Fruit fruit){
        getCollection().insertOne(fruit);
    }

    private MongoCollection<Fruit> getCollection(){
        return mongoClient.getDatabase("fruit").getCollection("fruit", Fruit.class);
    }
}

O codec POJO

O codec POJO fornece um conjunto de anotações que permitem a personalização da forma como um POJO é mapeado para uma coleção do MongoDB, e esse codec é inicializado automaticamente pelo Quarkus. Esse codec também oferece suporte a registros Java para que você possa usá-los para seus POJOs ou para um atributo de seus POJOs.

Uma dessas anotações é a anotação @BsonDiscriminator , que permite armazenar vários tipos Java em uma única coleção do MongoDB adicionando um campo discriminador dentro do documento. Isso pode ser útil ao trabalhar com tipos abstratos ou interfaces.

O Quarkus registrará automaticamente todas as classes anotadas com @BsonDiscriminator com o codec POJO.

O codec POJO tem suporte genérico aprimorado por meio de PropertyCodecProvider , o Quarkus registrará automaticamente qualquer PropertyCodecProvider com o codec POJO (essas classes são automaticamente transformadas em beans CDI do escopo @Singleton ). Ao criar executáveis nativos e usar tipos genéricos, talvez seja necessário registrar os argumentos do tipo para reflexão.

Simplificando o MongoDB com o Panache

A extensão MongoDB com Panache facilita o uso do MongoDB, fornecendo entidades (e repositórios) no estilo de registro ativo, como no Hibernate ORM com Panache , e se concentra em tornar as entidades triviais e divertidas de escrever no Quarkus.

Migração de esquemas com o Liquibase

A extensão Liquibase MongoDB facilita a inicialização de um banco de dados MongoDB, incluindo índices e dados iniciais. Ela implementa os mesmos recursos de migração de esquema que o Liquibase oferece para bancos de dados SQL.

Verificação da integridade da conexão

Se você estiver usando a extensão quarkus-smallrye-health , o quarkus-mongodb-client adicionará automaticamente uma verificação de integridade de prontidão para validar a conexão com o cluster.

Assim, quando você acessar o endpoint /q/health/ready do seu aplicativo, terá informações sobre o status de validação da conexão.

Esse comportamento pode ser desativado definindo a propriedade quarkus.mongodb.health.enabled como false em seu application.properties .

Métricas

Se você estiver usando o quarkus-micrometer, o quarkus-mongodb-client pode fornecer métricas sobre os pools de conexão. Este comportamento deve ser ativado primeiro definindo a propriedade quarkus.mongodb.metrics.enabled como true no seu arquivo application.properties.

Assim, ao acessar o endpoint /q/metrics do seu aplicativo, você terá informações sobre o status do pool de conexão.

Rastreamento

Para usar o rastreamento com o MongoDB, você precisa adicionar a extensão quarkus-opentelemetry ao seu projeto.

Mesmo com toda a infraestrutura de rastreamento instalada, o rastreamento do mongodb não está ativado por padrão e você precisa ativá-lo definindo essa propriedade:

# enable tracing
quarkus.mongodb.tracing.enabled=true

Ajudantes de teste

O Dev Services for MongoDB é a melhor opção para iniciar um banco de dados MongoDB para seus testes de unidade.

Mas se não puder usá-lo, você pode iniciar um banco de dados MongoDB usando um dos dois QuarkusTestResourceLifecycleManager que o Quarkus fornece. Eles dependem do MongoDB incorporado ao Flapdoodle .

  • io.quarkus.test.mongodb.MongoTestResource iniciará uma única instância na porta 27017.

  • io.quarkus.test.mongodb.MongoReplicaSetTestResource iniciará um conjunto de réplicas com duas instâncias, uma na porta 27017 e a outra na porta 27018.

Para usá-los, você precisa adicionar a dependência io.quarkus:quarkus-test-mongodb ao seu pom.xml.

Para obter mais informações sobre o uso do site QuarkusTestResourceLifecycleManager , leia o recurso de teste do Quarkus .

Para definir a porta desejada que o MongoDB escutará quando for iniciado, o código a seguir deve ser usado:

@QuarkusTestResource(value = MongoTestResource.class, initArgs = @ResourceArg(name = MongoTestResource.PORT, value = "27017"))

Para definir a versão desejada do MongoDB que será iniciada, o código a seguir deve ser usado:

@QuarkusTestResource(value = MongoTestResource.class, initArgs = @ResourceArg(name = MongoTestResource.VERSION, value = "V5_0"))

O valor da cadeia de caracteres usado pode ser qualquer um dos enums de.flapdoodle.embed.mongo.distribution.Version ou de.flapdoodle.embed.mongo.distribution.Version.Main . Se nenhuma versão for especificada, Version.Main.V4_0 será usado por padrão.

O cliente antigo

Por padrão, não incluímos o cliente MongoDB legado. Ele contém a API Java do MongoDB (DB, DBCollection,…​), agora aposentada, e o site com.mongodb.MongoClient , que agora foi substituído pelo site com.mongodb.client.MongoClient .

Se quiser usar a API legada, Você precisará adicionar a seguinte dependência ao seu arquivo de compilação:

pom.xml
<dependency>
    <groupId>org.mongodb</groupId>
    <artifactId>mongodb-driver-legacy</artifactId>
</dependency>
build.gradle
implementation("org.mongodb:mongodb-driver-legacy")

Configuração do TLS

Se quiser usar a criptografia SSL/TLS, você precisa adicionar essa propriedade em seu site application.properties :

quarkus.mongodb.tls=true

Também é possível configurar o cliente para usar uma configuração tls do registro TLS, o que ativará o tls:

quarkus.tls.mongo.trust-store.pem.certs=certa.pem,certb.pem
quarkus.mongodb.tls-configuration-name=mongo

Você pode configurar o cliente para confiar em servidores com certificados com nomes de host inválidos:

quarkus.tls.mongo.hostname-verification-algorithm=NONE
quarkus.mongodb.tls-configuration-name=mongo

Criação de um executável nativo

Você pode usar o cliente MongoDB em um executável nativo.

Você pode criar um executável nativo com o comando usual:

CLI
quarkus build --native
Maven
./mvnw install -Dnative
Gradle
./gradlew build -Dquarkus.native.enabled=true

Para executá-lo, basta acessar ./target/mongodb-quickstart-1.0.0-SNAPSHOT-runner .

Em seguida, você pode direcionar seu navegador para http://localhost:8080/fruits.html e usar seu aplicativo.

Atualmente, o Quarkus não suporta Client-Side Field Level Encryption no modo nativo.

Se você encontrar o seguinte erro ao executar seu aplicativo no modo nativo:
Failed to encode 'MyObject'. Encoding 'myVariable' errored with: Can’t find a codec for class org.acme.MyVariable.
Isso significa que a classe org.acme.MyVariable não é conhecida pela GraalVM. A solução é adicionar a anotação @RegisterForReflection à sua classe MyVariable. Mais detalhes sobre a anotação @RegisterForReflection podem ser encontrados na página de dicas de aplicativos nativos.

Personalizar a configuração do cliente Mongo de forma programática

Se precisar personalizar a configuração do cliente Mongo de forma programática, você precisará implementar a interface io.quarkus.mongodb.runtime.MongoClientCustomizer e expô-la como um bean com escopo de aplicativo CDI:

@ApplicationScoped
public class MyCustomizer implements MongoClientCustomizer {

    @Override
    public MongoClientSettings.Builder customize(MongoClientSettings.Builder builder) {
        return builder.applicationName("my-app");
    }
}

O bean pode personalizar um cliente específico usando o qualificador @MongoClientName para indicar o nome do cliente. Quando não há qualificador, ele personaliza o cliente padrão. No máximo um personalizador pode ser usado por cliente. Se forem detectados vários personalizadores direcionados ao mesmo cliente, será lançada uma exceção no momento da compilação.

Esse recurso pode ser usado para configurar a criptografia de nível de campo no lado do cliente (CSFLE). Siga as instruções do site da Mongo para configurar o CSFLE:

@ApplicationScoped
public class MyCustomizer implements MongoClientCustomizer {
    @Override
    public MongoClientSettings.Builder customize(MongoClientSettings.Builder builder) {
        Map<String, Map<String, Object>> kmsProviders = getKmsProviders();
        String dek = getDataEncryptionKey();
        Map<String, BsonDocument> schema = getSchema(dek);

        Map<String, Object> extraOptions = new HashMap<>();
        extraOptions.put("cryptSharedLibPath", "<path to crypt shared library>");

        return builder.autoEncryptionSettings(AutoEncryptionSettings.builder()
                .keyVaultNamespace(KEY_VAULT_NAMESPACE)
                .kmsProviders(kmsProviders)
                .schemaMap(schemaMap)
                .extraOptions(extraOptions)
                .build());
    }
}
A criptografia em nível de campo do lado do cliente e os recursos que dependem do Mongo Crypt em geral não são compatíveis com o modo nativo.

Referência de configuração

Propriedade de Configuração Fixa no Momento da Compilação - Todas as outras propriedades de configuração podem ser sobrepostas em tempo de execução.

Configuration property

Tipo

Padrão

Whether a health check is published in case the smallrye-health extension is present.

Environment variable: QUARKUS_MONGODB_HEALTH_ENABLED

Show more

boolean

true

Whether metrics are published in case a metrics extension is present.

Environment variable: QUARKUS_MONGODB_METRICS_ENABLED

Show more

boolean

false

If set to true, the default clients will always be created even if there are no injection points that use them

Environment variable: QUARKUS_MONGODB_FORCE_DEFAULT_CLIENTS

Show more

boolean

false

Whether tracing spans of driver commands are sent in case the quarkus-opentelemetry extension is present.

Environment variable: QUARKUS_MONGODB_TRACING_ENABLED

Show more

boolean

false

This property configures the DNS server. If the server is not set, it tries to read the first nameserver from /etc /resolv.conf (if the file exists), otherwise fallback to the default.

Environment variable: QUARKUS_MONGODB_DNS_SERVER_HOST

Show more

string

This property configures the DNS server port.

Environment variable: QUARKUS_MONGODB_DNS_SERVER_PORT

Show more

int

If native.dns.use-vertx-dns-resolver is set to true, this property configures the DNS lookup timeout duration.

Environment variable: QUARKUS_MONGODB_DNS_LOOKUP_TIMEOUT

Show more

Duration 

5S

This property enables the logging ot the DNS lookup. It can be useful to understand why the lookup fails.

Environment variable: QUARKUS_MONGODB_DNS_LOG_ACTIVITY

Show more

boolean

false

quarkus.mongodb."mongo-client-name".active

Whether this Mongo Client should be active at runtime.

Environment variable: QUARKUS_MONGODB_ACTIVE

Show more

boolean

true

quarkus.mongodb."mongo-client-name".connection-string

Configures the connection string. The format is: mongodb://[username:password@]host1[:port1][,host2[:port2],…​[,hostN[:portN]]][/[database.collection][?options]]

mongodb:// is a required prefix to identify that this is a string in the standard connection format.

username:password@ are optional. If given, the driver will attempt to log in to a database after connecting to a database server. For some authentication mechanisms, only the username is specified and the password is not, in which case the ":" after the username is left off as well.

host1 is the only required part of the connection string. It identifies a server address to connect to.

:portX is optional and defaults to :27017 if not provided.

/database is the name of the database to log in to and thus is only relevant if the username:password@ syntax is used. If not specified the admin database will be used by default.

?options are connection options. Note that if database is absent there is still a / required between the last host and the ? introducing the options. Options are name=value pairs and the pairs are separated by "&".

An alternative format, using the mongodb+srv protocol, is:

mongodb+srv://[username:password@]host[/[database][?options]]
  • mongodb+srv:// is a required prefix for this format.

  • username:password@ are optional. If given, the driver will attempt to login to a database after connecting to a database server. For some authentication mechanisms, only the username is specified and the password is not, in which case the ":" after the username is left off as well

  • host is the only required part of the URI. It identifies a single host name for which SRV records are looked up from a Domain Name Server after prefixing the host name with "_mongodb._tcp". The host/port for each SRV record becomes the seed list used to connect, as if each one were provided as host/port pair in a URI using the normal mongodb protocol.

  • /database is the name of the database to login to and thus is only relevant if the username:password@ syntax is used. If not specified the "admin" database will be used by default.

  • ?options are connection options. Note that if database is absent there is still a / required between the last host and the ? introducing the options. Options are name=value pairs and the pairs are separated by "&". Additionally with the mongodb+srv protocol, TXT records are looked up from a Domain Name Server for the given host, and the text value of each one is prepended to any options on the URI itself. Because the last specified value for any option wins, that means that options provided on the URI will override any that are provided via TXT records.

Environment variable: QUARKUS_MONGODB_CONNECTION_STRING

Show more

string

quarkus.mongodb."mongo-client-name".hosts

Configures the MongoDB server addresses (one if single mode). The addresses are passed as host:port.

Environment variable: QUARKUS_MONGODB_HOSTS

Show more

list of string

127.0.0.1:27017

quarkus.mongodb."mongo-client-name".database

Configure the database name.

Environment variable: QUARKUS_MONGODB_DATABASE

Show more

string

quarkus.mongodb."mongo-client-name".application-name

Configures the application name.

Environment variable: QUARKUS_MONGODB_APPLICATION_NAME

Show more

string

quarkus.mongodb."mongo-client-name".max-pool-size

Configures the maximum number of connections in the connection pool.

Environment variable: QUARKUS_MONGODB_MAX_POOL_SIZE

Show more

int

quarkus.mongodb."mongo-client-name".min-pool-size

Configures the minimum number of connections in the connection pool.

Environment variable: QUARKUS_MONGODB_MIN_POOL_SIZE

Show more

int

quarkus.mongodb."mongo-client-name".max-connection-idle-time

Maximum idle time of a pooled connection. A connection that exceeds this limit will be closed.

Environment variable: QUARKUS_MONGODB_MAX_CONNECTION_IDLE_TIME

Show more

Duration 

quarkus.mongodb."mongo-client-name".max-connection-life-time

Maximum lifetime of a pooled connection. A connection that exceeds this limit will be closed.

Environment variable: QUARKUS_MONGODB_MAX_CONNECTION_LIFE_TIME

Show more

Duration 

quarkus.mongodb."mongo-client-name".maintenance-frequency

Configures the time period between runs of the maintenance job.

Environment variable: QUARKUS_MONGODB_MAINTENANCE_FREQUENCY

Show more

Duration 

quarkus.mongodb."mongo-client-name".maintenance-initial-delay

Configures period of time to wait before running the first maintenance job on the connection pool.

Environment variable: QUARKUS_MONGODB_MAINTENANCE_INITIAL_DELAY

Show more

Duration 

quarkus.mongodb."mongo-client-name".connect-timeout

How long a connection can take to be opened before timing out.

Environment variable: QUARKUS_MONGODB_CONNECT_TIMEOUT

Show more

Duration 

quarkus.mongodb."mongo-client-name".read-timeout

How long a socket read can take before timing out.

Environment variable: QUARKUS_MONGODB_READ_TIMEOUT

Show more

Duration 

quarkus.mongodb."mongo-client-name".tls

Whether to connect using TLS.

Environment variable: QUARKUS_MONGODB_TLS

Show more

boolean

false

quarkus.mongodb."mongo-client-name".tls-configuration-name

The name of the TLS configuration to use.

If a name is configured, it uses the configuration from quarkus.tls.<name>.* If a name is configured, but no TLS configuration is found with that name then an error will be thrown.

The default TLS configuration is not used by default.

Environment variable: QUARKUS_MONGODB_TLS_CONFIGURATION_NAME

Show more

string

quarkus.mongodb."mongo-client-name".replica-set-name

Implies that the hosts given are a seed list, and the driver will attempt to find all members of the set.

Environment variable: QUARKUS_MONGODB_REPLICA_SET_NAME

Show more

string

quarkus.mongodb."mongo-client-name".server-selection-timeout

How long the driver will wait for server selection to succeed before throwing an exception.

Environment variable: QUARKUS_MONGODB_SERVER_SELECTION_TIMEOUT

Show more

Duration 

quarkus.mongodb."mongo-client-name".local-threshold

When choosing among multiple MongoDB servers to send a request, the driver will only send that request to a server whose ping time is less than or equal to the server with the fastest ping time plus the local threshold.

Environment variable: QUARKUS_MONGODB_LOCAL_THRESHOLD

Show more

Duration 

quarkus.mongodb."mongo-client-name".heartbeat-frequency

The frequency that the driver will attempt to determine the current state of each server in the cluster.

Environment variable: QUARKUS_MONGODB_HEARTBEAT_FREQUENCY

Show more

Duration 

quarkus.mongodb."mongo-client-name".read-concern

Configures the read concern. Supported values are: local|majority|linearizable|snapshot|available

Environment variable: QUARKUS_MONGODB_READ_CONCERN

Show more

string

quarkus.mongodb."mongo-client-name".read-preference

Configures the read preference. Supported values are: primary|primaryPreferred|secondary|secondaryPreferred|nearest

Environment variable: QUARKUS_MONGODB_READ_PREFERENCE

Show more

string

quarkus.mongodb."mongo-client-name".health.database

The database used during the readiness health checks

Environment variable: QUARKUS_MONGODB_HEALTH_DATABASE

Show more

string

admin

quarkus.mongodb."mongo-client-name".uuid-representation

Configures the UUID representation to use when encoding instances of java.util.UUID and when decoding BSON binary values with subtype of 3.

Environment variable: QUARKUS_MONGODB_UUID_REPRESENTATION

Show more

unspecified, standard, c-sharp-legacy, java-legacy, python-legacy

quarkus.mongodb."mongo-client-name".reactive-transport

Configures the reactive transport.

Environment variable: QUARKUS_MONGODB_REACTIVE_TRANSPORT

Show more

nettyUses a Netty-based transport re-using the existing Netty event loops., mongoWith a reactive driver it uses an async transport backed by a driver-managed thread pool.

nettyUses a Netty-based transport re-using the existing Netty event loops.

This property is deprecated: This resolver is always used.

The default DNS resolver used to handle mongo+srv:// urls cannot be used in a native executable. This option enables a fallback to use Vert.x to resolve the server names instead of JNDI. IMPORTANT: The resolution may be different in JVM mode using the default (JNDI-based) DNS resolver, and in native mode. This feature is experimental.

Environment variable: QUARKUS_MONGODB_NATIVE_DNS_USE_VERTX_DNS_RESOLVER

Show more

boolean

false

quarkus.mongodb."mongo-client-name".tls-insecure

This property is deprecated since 3.21: in favor of configuration at the tls registry level. See tls-configuration-name() and quarkus tls registry hostname verification configuration quarkus.tls.hostname-verification-algorithm=NONE.

If connecting with TLS, this option enables insecure TLS connections.

Environment variable: QUARKUS_MONGODB_TLS_INSECURE

Show more

boolean

false

Dev Services

Tipo

Padrão

If DevServices has been explicitly enabled or disabled. DevServices is generally enabled by default, unless there is an existing configuration present.

When DevServices is enabled Quarkus will attempt to automatically configure and start a database when running in Dev or Test mode.

Environment variable: QUARKUS_MONGODB_DEVSERVICES_ENABLED

Show more

boolean

The container image name to use, for container based DevServices providers.

Environment variable: QUARKUS_MONGODB_DEVSERVICES_IMAGE_NAME

Show more

string

docker.io/library/mongo:7.0

Optional fixed port the dev service will listen to.

If not defined, the port will be chosen randomly.

Environment variable: QUARKUS_MONGODB_DEVSERVICES_PORT

Show more

int

Generic properties that are added to the connection URL.

Environment variable: QUARKUS_MONGODB_DEVSERVICES_PROPERTIES__PROPERTY_KEY_

Show more

Map<String,String>

Environment variables that are passed to the container.

Environment variable: QUARKUS_MONGODB_DEVSERVICES_CONTAINER_ENV__ENVIRONMENT_VARIABLE_NAME_

Show more

Map<String,String>

Indicates if the MongoDB server managed by Quarkus Dev Services is shared. When shared, Quarkus looks for running containers using label-based service discovery. If a matching container is found, it is used, and so a second one is not started. Otherwise, Dev Services for MongoDB starts a new container.

The discovery uses the quarkus-dev-service-mongodb label. The value is configured using the service-name property.

Container sharing is only used in dev mode.

Environment variable: QUARKUS_MONGODB_DEVSERVICES_SHARED

Show more

boolean

true

The value of the quarkus-dev-service-mongodb label attached to the started container. This property is used when shared is set to true. In this case, before starting a container, Dev Services for MongoDB looks for a container with the quarkus-dev-service-mongodb label set to the configured value. If found, it will use this container instead of starting a new one. Otherwise it starts a new container with the quarkus-dev-service-mongodb label set to the specified value.

Environment variable: QUARKUS_MONGODB_DEVSERVICES_SERVICE_NAME

Show more

string

mongodb

Write concern

Tipo

Padrão

quarkus.mongodb."mongo-client-name".write-concern.safe

Configures the safety. If set to true: the driver ensures that all writes are acknowledged by the MongoDB server, or else throws an exception. (see also w and wtimeoutMS). If set fo - false: the driver does not ensure that all writes are acknowledged by the MongoDB server.

Environment variable: QUARKUS_MONGODB_WRITE_CONCERN_SAFE

Show more

boolean

true

quarkus.mongodb."mongo-client-name".write-concern.journal

Configures the journal writing aspect. If set to true: the driver waits for the server to group commit to the journal file on disk. If set to false: the driver does not wait for the server to group commit to the journal file on disk.

Environment variable: QUARKUS_MONGODB_WRITE_CONCERN_JOURNAL

Show more

boolean

true

quarkus.mongodb."mongo-client-name".write-concern.w

When set, the driver adds w: wValue to all write commands. It requires safe to be true. The value is typically a number, but can also be the majority string.

Environment variable: QUARKUS_MONGODB_WRITE_CONCERN_W

Show more

string

quarkus.mongodb."mongo-client-name".write-concern.retry-writes

If set to true, the driver will retry supported write operations if they fail due to a network error.

Environment variable: QUARKUS_MONGODB_WRITE_CONCERN_RETRY_WRITES

Show more

boolean

false

quarkus.mongodb."mongo-client-name".write-concern.w-timeout

When set, the driver adds wtimeout : ms to all write commands. It requires safe to be true.

Environment variable: QUARKUS_MONGODB_WRITE_CONCERN_W_TIMEOUT

Show more

Duration 

Credentials and authentication mechanism

Tipo

Padrão

quarkus.mongodb."mongo-client-name".credentials.username

Configures the username.

Environment variable: QUARKUS_MONGODB_CREDENTIALS_USERNAME

Show more

string

quarkus.mongodb."mongo-client-name".credentials.password

Configures the password.

Environment variable: QUARKUS_MONGODB_CREDENTIALS_PASSWORD

Show more

string

quarkus.mongodb."mongo-client-name".credentials.auth-mechanism

Configures the authentication mechanism to use if a credential was supplied. The default is unspecified, in which case the client will pick the most secure mechanism available based on the sever version. For the GSSAPI and MONGODB-X509 mechanisms, no password is accepted, only the username. Supported values: null or GSSAPI|PLAIN|MONGODB-X509|SCRAM_SHA_1|SCRAM_SHA_256|MONGODB_AWS

Environment variable: QUARKUS_MONGODB_CREDENTIALS_AUTH_MECHANISM

Show more

string

quarkus.mongodb."mongo-client-name".credentials.auth-source

Configures the source of the authentication credentials. This is typically the database where the credentials have been created. The value defaults to the database specified in the path portion of the connection string or in the 'database' configuration property. If the database is specified in neither place, the default value is admin. This option is only respected when using the MONGO-CR mechanism (the default).

Environment variable: QUARKUS_MONGODB_CREDENTIALS_AUTH_SOURCE

Show more

string

quarkus.mongodb."mongo-client-name".credentials.auth-mechanism-properties."property-key"

Allows passing authentication mechanism properties.

Environment variable: QUARKUS_MONGODB_CREDENTIALS_AUTH_MECHANISM_PROPERTIES__PROPERTY_KEY_

Show more

Map<String,String>

quarkus.mongodb."mongo-client-name".credentials.credentials-provider

The credentials provider name

Environment variable: QUARKUS_MONGODB_CREDENTIALS_CREDENTIALS_PROVIDER

Show more

string

quarkus.mongodb."mongo-client-name".credentials.credentials-provider-name

The credentials provider bean name.

This is a bean name (as in @Named) of a bean that implements CredentialsProvider. It is used to select the credentials provider bean when multiple exist. This is unnecessary when there is only one credentials provider available.

For Vault, the credentials provider bean name is vault-credentials-provider.

Environment variable: QUARKUS_MONGODB_CREDENTIALS_CREDENTIALS_PROVIDER_NAME

Show more

string

About the Duration format

To write duration values, use the standard java.time.Duration format. See the Duration#parse() Java API documentation for more information.

Você também pode usar um formato simplificado, começando com um número:

  • Se o valor for apenas um número, ele representará o tempo em segundos.

  • Se o valor for um número seguido de 'ms', ele representa o tempo em milissegundos.

Em outros casos, o formato simplificado é traduzido para o formato 'java.time.Duration' para análise:

  • Se o valor for um número seguido de 'h', 'm' ou 's', ele é prefixado com 'PT'.

  • Se o valor for um número seguido de 'd', ele é prefixado com 'P'.

Related content