Devprime | Documentação – Implementações nativas do RabbitMQ

Settings: Adiciona uma exchange no RabbitMQ

Mon, 01 Jan 0001 00:00:00 +0000

Parâmetros

alias (string): Parâmetro opcional com o nome do Stream Alias conforme definido na configuração do Stream Adapter. O valor padrão é “Stream1”.
exchangeName (string): Nome da exchange. Este é o identificador único da exchange no RabbitMQ.
exchangeType (ExchangeType): Tipo da exchange, que pode ser um dos seguintes:
- Direct: Roteia mensagens para filas que possuem uma chave de roteamento exata.
- Fanout: Roteia mensagens para todas as filas ligadas à exchange.
- Topic: Roteia mensagens para filas com base em padrões de chave de roteamento.
- Headers: Roteia mensagens com base em cabeçalhos de mensagem.
customProperties (CustomExchangeProperties, opcional): Propriedades adicionais para configurar a exchange. A classe CustomExchangeProperties permite especificar:
- Durable (bool): Define se a exchange deve ser durável. O padrão é true.
- AutoDelete (bool): Define se a exchange deve ser excluída automaticamente quando não houver filas ligadas. O padrão é false.
- Arguments (IDictionary<string, object>): Argumentos adicionais para configuração específica da exchange. Pode ser null se não houver argumentos adicionais.

Retorno

bool: Retorna true se a exchange for criada com sucesso; caso contrário, retorna false.

Aqui estão exemplos de como usar o método AddExchangeRabbitMQ com e sem propriedades personalizadas:

1. Criação de uma exchange do tipo Direct sem propriedades personalizadas:

// Criação de uma exchange do tipo Direct
var exchangeName = "myExchangeName";
var success = Dp.Stream.AddExchangeRabbitMQ(exchangeName,ExchangeType.Direct,null);
if (success)
{
    Console.WriteLine("Exchange criada com sucesso.");
}
else
{
    Console.WriteLine("Falha ao criar a exchange.");
}

2. Criação de uma exchange do tipo Topic com propriedades personalizadas:

var exchangeName = "myExchangeName";
var properties = new CustomExchangeProperties
    {
        Durable = true, // Explicitly durable
        AutoDelete = false, // Do not auto-delete
        Arguments = new Dictionary<string, object>
        {
            { "x-message-ttl", 60000 }, // Message time-to-live in milliseconds
            { "x-max-length", 1000 }    // Maximum number of messages in the queue
        }
    };
var success = Dp.Stream.AddExchangeRabbitMQ(exchangeName, ExchangeType.Direct, properties);

Considerações

Certifique-se de que o exchangeName seja único dentro do RabbitMQ para evitar conflitos.
Escolha o exchangeType adequado com base na sua estratégia de roteamento de mensagens.
Utilize CustomExchangeProperties para configurar comportamentos avançados, como durabilidade, exclusão automática e argumentos específicos.
As implementações nativas do RabbitMQ são específicas para essa plataforma e atendem a casos de uso particulares. Caso você migre para outra plataforma de streaming, será necessário ajustar seu código para usar os métodos padrão da Devprime ou os métodos específicos da nova plataforma.

Settings: Adiciona uma fila no RabbitMQ

Mon, 01 Jan 0001 00:00:00 +0000

Parâmetros

alias (string, opcional): Parâmetro opcional com o nome do Stream Alias conforme definido na configuração do Stream Adapter. O valor padrão é “Stream1”.
queueName (string): Nome da fila. Este é o identificador único da fila no RabbitMQ.
customProperties (CustomQueueProperties, opcional): Propriedades personalizadas para a fila, como configurações de TTL (Time-to-Live), persistência e outras características específicas da fila.

Retorno

bool: Retorna true se a fila for criada com sucesso; caso contrário, retorna false.

Aqui está um exemplo de como usar o método AddQueueRabbitMQ na sua aplicação:

Criando uma fila sem utilizar as propridades

O parâmetro CustomQueueProperties é opcional e utilizado apenas para customização

// The CustomQueueProperties parameter is optional and used only for customization
var queueName = "myQueueName";
bool success = Dp.Stream.AddQueueRabbitMQ(queueName, null);
if (success)
    {
    Console.WriteLine("Fila criada com sucesso.");
    }
    else
    {
    Console.WriteLine("Falha ao criar a fila.");
    }

Criando uma fila com as propridades e argumento nulo

var customProperties = new CustomQueueProperties
{
    Durable = true,
    Exclusive = false,
    AutoDelete = false,
    Arguments = null
};
Dp.Stream.AddQueueRabbitMQ("queue-with-properties", customProperties);

Criando uma fila com as propridades e argumento configurando TTL

// This parameter is optional and used only for customization
// Creation of a queue with custom properties
var customProperties = new CustomQueueProperties
{
    Durable = true,
    Exclusive = false,
    AutoDelete = false,
    Arguments = new Dictionary<string, object>
    {
        { "x-message-ttl", 600000 } // TTL
    }
};
Dp.Stream.AddQueueRabbitMQ("queue-with-properties", customProperties);

Considerações

Certifique-se de que o queueName seja único dentro do RabbitMQ para evitar conflitos.
Utilize as propriedades personalizadas para configurar a fila de acordo com as necessidades específicas da sua aplicação.
As implementações nativas do RabbitMQ são específicas para essa plataforma e atendem a casos de uso particulares. Caso você migre para outra plataforma de streaming, será necessário ajustar seu código para usar os métodos padrão da Devprime ou os métodos específicos da nova plataforma.

Settings: Adiciona vinculo entre uma exchange e fila no RabbitMQ

Mon, 01 Jan 0001 00:00:00 +0000

Parâmetros

alias (string, opcional): Parâmetro opcional com o nome do Stream Alias conforme definido na configuração do Stream Adapter. O valor padrão é “Stream1”.
exchangeName (string): Nome da exchange à qual a fila será vinculada.
exchangeType (ExchangeType): Tipo da exchange. Pode ser:
- Direct: Roteia mensagens para filas com uma chave de roteamento exata.
- Fanout: Roteia mensagens para todas as filas ligadas à exchange.
- Topic: Roteia mensagens para filas com base em padrões de chave de roteamento.
- Headers: Roteia mensagens com base em cabeçalhos de mensagem.
queueName (string): Nome da fila que será vinculada à exchange.
routingKey (string): Chave de roteamento usada para direcionar mensagens da exchange para a fila.
arguments (IDictionary<string, object>, opcional): Argumentos adicionais para a ligação, como filtros ou parâmetros de configuração específicos.

Retorno

bool: Retorna true se a ligação entre a exchange e a fila for criada com successo; caso contrário, retorna false.

Aqui está um exemplo de como usar o método AddBindingExchangeQueueRabbitMQ na sua aplicação:

1. Efetuando um Bind de Exchange Direct sem utilizar argument

var exchangeName = "myExchangeName";
var queueName= "myQueueName";
var routingKey = "myQueueName";
bool success = Dp.Stream.AddBindingExchangeQueueRabbitMQ(exchangeName,
ExchangeType.Direct, queueName, routingKey, null);
    if (success)
    {
        Console.WriteLine("Bind realizado com successo.");
    }
    else
    {
        Console.WriteLine("Falha ao criar Bind.");
    }

2. Efetuando um Bind de Exchange Fanout

var exchangeName = "myExchangeName";
var queueName = "myQueueName";
var routingKey = ""; // Not using in fanout
bool success = Dp.Stream.AddBindingExchangeQueueRabbitMQ(exchangeName,
ExchangeType.Fanout, queueName, routingKey, null);

3. Efetuando um Bind de Exchange Topic

var exchangeName = "myExchangeName";
var queueName = "myQueueName";
var routingKey = "topic.routing.key"; // Important parameter in Exchange Topic
bool success = Dp.Stream.AddBindingExchangeQueueRabbitMQ(exchangeName,
ExchangeType.Topic, queueName, routingKey, null);

4. Efetuando um Bind de Exchange Headers utilizando argumentos

var exchangeName = "myExchangeName";
var queueName = "myQueueName";
var routingKey = string.Empty; // Not using in Headers
var arguments = new Dictionary<string, object>
    {
        { "headerKey1", "headerValue1" },
        { "headerKey2", "headerValue2" }
    };
bool success = Dp.Stream.AddBindingExchangeQueueRabbitMQ(exchangeName,
ExchangeType.Headers, queueName, routingKey, arguments);

Considerações

Certifique-se de que o exchangeName e o queueName estejam corretamente configurados e existam no RabbitMQ.
Ajuste a routingKey e os arguments conforme necessário para sua estratégia de roteamento de mensagens.
As implementações nativas do RabbitMQ são específicas para essa plataforma e atendem a casos de uso particulares. Caso você migre para outra plataforma de streaming, será necessário ajustar seu código para usar os métodos padrão da Devprime ou os métodos específicos da nova plataforma.

Settings: Inscreve-se em uma fila no RabbitMQ

Mon, 01 Jan 0001 00:00:00 +0000

Parâmetros

alias (string, opcional): Parâmetro opcional com o nome do Stream Alias conforme definido na configuração do Stream Adapter. O valor padrão é “Stream1”.
exchangeName (string): Nome da exchange da qual a fila vai receber mensagens.
exchangeType (ExchangeType): Tipo da exchange. Pode ser:
- Direct: Roteia mensagens para filas com uma chave de roteamento exata.
- Fanout: Roteia mensagens para todas as filas ligadas à exchange.
- Topic: Roteia mensagens para filas com base em padrões de chave de roteamento.
- Headers: Roteia mensagens com base em cabeçalhos de mensagem.
queueName (string): Nome da fila que será assinada para receber mensagens da exchange.

Retorno

List<(bool Ready, string Queue)>: Retorna uma lista de tuplas onde cada tupla contém:
- Ready (bool): Indica se a assinatura foi criada com sucesso.
- Queue (string): Nome da fila que foi assinada.

Aqui está um exemplo de como usar o método AddSubscribeRabbitMQ na sua aplicação:

Adicionando a subscrição em uma Queue

var exchangeName = "myExchangeName";
var queueName = "myQueueName";
var success = Dp.Stream.AddSubscribeRabbitMQ(exchangeName, ExchangeType.Direct, queueName);
  if (success)
  {
      Console.WriteLine("Assinatura criada com sucesso.");
  }
  else
  {
      Console.WriteLine("Falha ao criar a assinatura.");
  }

Considerações

Certifique-se de que a exchangeName e a queueName estejam corretamente configurados e existam no RabbitMQ.
O tipo de exchange (exchangeType) deve corresponder à estratégia de roteamento que você deseja implementar.
As implementações nativas do RabbitMQ são específicas para essa plataforma e atendem a casos de uso particulares. Caso você migre para outra plataforma de streaming, será necessário ajustar seu código para usar os métodos padrão da Devprime ou os métodos específicos da nova plataforma.

Settings: Remove uma fila do RabbitMQ

Mon, 01 Jan 0001 00:00:00 +0000

Parâmetros

alias (string, opcional): Parâmetro opcional com o nome do Stream Alias conforme definido na configuração do Stream Adapter. O valor padrão é “Stream1”.
queueName (string): Nome da fila que será removida. Este é o identificador único da fila no RabbitMQ.

Retorno

bool: Retorna true se a fila for removida com sucesso; caso contrário, retorna false.

Aqui está um exemplo de como usar o método RemoveQueueRabbitMQ na sua aplicação:

Removendo uma Queue

// Removing a queue
var queueName = "myQueueName";
bool success = Dp.Stream.RemoveQueueRabbitMQ(queueName);
    if (success)
    {
        Console.WriteLine("Queue removed successfully.");
    }
    else
    {
        Console.WriteLine("Failed to remove the queue.");
    }

Considerações

Certifique-se de que o queueName esteja corretamente configurado e exista no RabbitMQ antes de tentar removê-lo.
Após a remoção, todas as mensagens na fila serão perdidas e não poderão ser recuperadas.
As implementações nativas do RabbitMQ são específicas para essa plataforma e atendem a casos de uso particulares. Caso você migre para outra plataforma de streaming, será necessário ajustar seu código para usar os métodos padrão da Devprime ou os métodos específicos da nova plataforma.

Settings: Remove uma exchange do RabbitMQ

Mon, 01 Jan 0001 00:00:00 +0000

Parâmetros

alias (string, opcional): Parâmetro opcional com o nome do Stream Alias conforme definido na configuração do Stream Adapter. O valor padrão é “Stream1”.
exchangeName (string): Nome da exchange que será removida. Este é o identificador único da exchange no RabbitMQ.

Retorno

bool: Retorna true se a exchange for removida com sucesso; caso contrário, retorna false.

Aqui está um exemplo de como usar o método RemoveExchangeRabbitMQ na sua aplicação:

Removendo uma Exchange

// Removing an exchange
var exchangeName = "myExchangeName";
bool success = Dp.Stream.RemoveExchangeRabbitMQ(exchangeName);
    if (success)
    {
        Console.WriteLine("Exchange removed successfully.");
    }
    else
    {
        Console.WriteLine("Failed to remove the exchange.");
    }

Considerações

Certifique-se de que a exchangeName esteja corretamente configurada e exista no RabbitMQ antes de tentar removê-la.
Após a remoção, todas as filas vinculadas à exchange serão afetadas e não receberão mais mensagens da exchange removida.
As implementações nativas do RabbitMQ são específicas para essa plataforma e atendem a casos de uso particulares. Caso você migre para outra plataforma de streaming, será necessário ajustar seu código para usar os métodos padrão da Devprime ou os métodos específicos da nova plataforma.

Settings: Cancela uma assinatura em uma fila

Mon, 01 Jan 0001 00:00:00 +0000

Parâmetros

alias (string, opcional): Parâmetro opcional com o nome do Stream Alias conforme definido na configuração do Stream Adapter. O valor padrão é “Stream1”.
queueName (string): Nome da fila cuja assinatura será removida. Este é o identificador único da fila no RabbitMQ.

Retorno

bool: Retorna true se a assinatura for removida com sucesso; caso contrário, retorna false.

Aqui está um exemplo de como usar o método RemoveSubscribeRabbitMQ na sua aplicação:

Removendo a assinatura de uma fila

// Cancelling a queue subscription
var queueName = "myQueueName";
bool success = Dp.Stream.RemoveSubscribeRabbitMQ(queueName);
    if (success)
    {
        Console.WriteLine("Subscription removed successfully.");
    }
    else
    {
        Console.WriteLine("Failed to remove the subscription.");
    }

Considerações

Certifique-se de que a queueName esteja corretamente configurada e exista no RabbitMQ antes de tentar remover a assinatura.
Após o cancelamento da assinatura, a fila não receberá mais mensagens da exchange da qual estava assinada.
As implementações nativas do RabbitMQ são específicas para essa plataforma e atendem a casos de uso particulares. Caso você migre para outra plataforma de streaming, será necessário ajustar seu código para usar os métodos padrão da Devprime ou os métodos específicos da nova plataforma.

Settings: Publicar uma mensagem em uma exchange ou fila no RabbitMQ

Mon, 01 Jan 0001 00:00:00 +0000

Parâmetros

alias (string, opcional): Parâmetro opcional com o nome do Stream Alias conforme definido na configuração do Stream Adapter. O valor padrão é “Stream1”.
exchangeName (string): Nome da exchange para a qual a mensagem será publicada.
exchangeType (ExchangeType?, opcional): Tipo da exchange. Pode ser:
- Direct: Roteia mensagens para filas com uma chave de roteamento exata.
- Fanout: Roteia mensagens para todas as filas ligadas à exchange.
- Topic: Roteia mensagens para filas com base em padrões de chave de roteamento.
- Headers: Roteia mensagens com base em cabeçalhos de mensagem.
Se não for especificado, o padrão será usado conforme a configuração da exchange.
routingKey (string): Chave de roteamento usada para direcionar mensagens da exchange para as filas associadas.
eventMessage (BasicEvent): Mensagem do evento que será publicada na exchange.
customProperties (CustomMessageProperties, opcional): Propriedades personalizadas para a mensagem, como TTL (Time-to-Live), persistência e outras características específicas.

Retorno

void: Este método não retorna um valor. Ele executa a publicação da mensagem na exchange especificada.

Aqui está um exemplos de como usar o método PublishRabbitMQ na sua aplicação:

1. Publicação direta na fila sem utilizar a Exchange
Nesse cenário não é necessário informar uma exchange

var routingKey = "myQqueueName";
var eventName = "OrderCreated";
var eventData = new
    {
        Message = "Demonstration"
    };
Dp.Stream.PublishRabbitMQ(null, null, routingKey, eventName, eventData, null);

2. Publicação usando Exchange Direct sem CustomMessageProperties
Para configurar esse cenário, é necessário associar a Exchange “myExchangeName” do tipo Direct à fila “myQueueName”.

var exchangeName = "myExchangeName";
var routingKey = "myQueueName";
var eventName = "OrderCreated";
var eventData = new
{
    Message = "Demonstration"
};

Dp.Stream.PublishRabbitMQ(exchangeName, ExchangeType.Direct,
    routingKey, eventName, eventData, null);

3. Publicação usando Exchange Direct usando TTL

Para configurar esse cenário, é necessário associar a Exchange “myExchangeName” do tipo Direct à fila “myQueueName”. Utilizamos CustomMessageProperties para definir os parâmetros de persistência e o tempo de expiração (TTL). O evento publicado terá um tempo determinado para expirar.

var exchangeName = "myExchangeName";
var routingKey = "myQueueName";
var eventName = "OrderCreated";
var eventData = new
{
    Message = "Demonstration"
};

var basicProperties = new CustomMessageProperties();
basicProperties.Persistent = true;
basicProperties.Expiration = 50000000; // TTL in milliseconds

Dp.Stream.PublishRabbitMQ(exchangeName, ExchangeType.Direct,
         routingKey, eventName, eventData, basicProperties);

4. Publicação usando Exchange Fanout com duas filas como destino

Para configurar esse cenário, é necessário associar a Exchange “myExchangeName” do tipo Fanout às filas “myQueueName1” e “myQueueName2”. Neste caso, não é necessário especificar o nome da fila no Publish. A Exchange distribuirá o evento automaticamente para ambas as filas.

var exchangeName = "myExchangeName";
var routingKey = ""; // This parameter is not used in Fanout
var eventName = "PaymentApproved";
var eventData = new
{
    Message = "Demonstration"
};

Dp.Stream.PublishRabbitMQ(exchangeName, ExchangeType.Fanout,
 routingKey, eventName, eventData, null);

5. Publicação usando Exchange Topic com duas filas como destino

Para configurar esse cenário, é necessário associar a Exchange “myExchangeName” do tipo Topic a duas filas:

Bind para a fila “myQueueName1” com a Routing Key: "quick.ecommerce.#"
Bind para a fila “myQueueName2” com a Routing Key: "#.logs"

Neste exemplo, faremos três publicações, variando a routingKey. A exchange irá distribuir as mensagens de forma que uma delas será entregue em ambas as filas, enquanto as outras serão entregues em apenas uma das filas.

var exchangeName = "myExchangeName";
var routingKey1 = "quick.ecommerce.logs"; // Destination: myQueue1 and myQueue2
var routingKey2 = "quick.ecommerce.approved"; // Destination: myQueue1
var routingKey3 = "quick.financial.logs"; // Destination: myQueue2
var eventName = "EcommerceEvents";
var eventData = new
{
    Message = "Demonstration"
};

// Publishing with routingKey 1 for distribution to myQueue1 and myQueue2
Dp.Stream.PublishRabbitMQ(exchangeName, ExchangeType.Topic,
 routingKey1, eventName, eventData, null);

// Publishing with routingKey 2 for distribution to myQueue1
Dp.Stream.PublishRabbitMQ(exchangeName, ExchangeType.Topic,
 routingKey2, eventName, eventData, null);

// Publishing with routingKey 3 for distribution to myQueue2
Dp.Stream.PublishRabbitMQ(exchangeName, ExchangeType.Topic,
 routingKey3, eventName, eventData, null);

6. Publicação usando Exchange Headers com duas filas como destino
Para configurar esse cenário, é necessário associar a Exchange “myExchangeName” do tipo Headers a duas filas. O primeiro bind será para a fila “myQueueName1” utilizando os seguintes argumentos de chave/valor:

Arguments 1: { "format", "pdf" }
Arguments 2: { "type", "report" }
Arguments 3: { "x-match", "all" }

O segundo bind também será para a fila “myQueueName2”, com os seguintes argumentos:

Arguments 1: { "format", "zip" }
Arguments 2: { "x-match", "any" }

É importante observar que a Exchange do tipo Headers não utiliza a configuração de Routing Key durante o bind.

Neste exemplo, realizaremos três publicações, variando os parâmetros de Arguments. A exchange será responsável por distribuir as mensagens, e, ao final, um dos eventos será direcionado para “myQueueName1” e os outros dois para “myQueueName2”.

var exchangeName = "myExchangeName";
var routingKey = ""; // This parameter is not used in the Headers Exchange
var eventName = "ComplianceApprove";
var eventData = new
{
    Message = "Demonstration"
};

// Publishing with Headers for distribution to myQueueName1
var properties1 = new CustomMessageProperties();
properties1.Arguments = new Dictionary<string, object> 
{ 
    { "format", "pdf" }, 
    { "type", "report" } 
};
Dp.Stream.PublishRabbitMQ(exchangeName, ExchangeType.Headers,
 routingKey, eventName, eventData, properties1);

// Publishing with Headers for distribution to myQueueName2
var properties2 = new CustomMessageProperties();
properties2.Arguments = new Dictionary<string, object> 
{ 
    { "format", "zip" } 
};
Dp.Stream.PublishRabbitMQ(exchangeName, ExchangeType.Headers,
 routingKey, eventName, eventData, properties2);

// Publishing with Headers for distribution to myQueueName2
var properties3 = new CustomMessageProperties();
properties3.Arguments = new Dictionary<string, object> 
{ 
    { "format", "zip" }, 
    { "type", "image" } 
};
Dp.Stream.PublishRabbitMQ(exchangeName, ExchangeType.Headers,
 routingKey, eventName, eventData, properties3);

Considerações

Certifique-se de que o exchangeName esteja corretamente configurado e exista no RabbitMQ antes de tentar publicar a mensagem.
Ajuste o exchangeType e as customProperties conforme necessário para sua estratégia de publicação e roteamento de mensagens.
As implementações nativas do RabbitMQ são específicas para essa plataforma e atendem a casos de uso particulares. Caso você migre para outra plataforma de streaming, será necessário ajustar seu código para usar os métodos padrão da Devprime ou os métodos específicos da nova plataforma.