Skip to content

Latest commit

 

History

History
118 lines (97 loc) · 7.47 KB

README_pt.md

File metadata and controls

118 lines (97 loc) · 7.47 KB
Raw

iPub Messaging

Sistema de mensagens thread-safe, assíncrono e simplista para comunicação entre classes/camadas no delphi criado pela equipe do iPub.

O problema

O Delphi tem um sistema de mensagens próprio (System.Messaging.pas) que funciona bem mas é totalmente síncrono e thread-unsafe. Em sistemas multithread temos sempre a necessidade de comunicar com outras classes, algumas vezes de forma síncrona, outras assíncronas, outras sincronizando com o mainthread (no caso da UI), e fazer isso sem um sistema de mensagens próprio (comunicando direto) torna o código grande e complexo, passível de muitos bugs.

A solução

Um sistema de mensagens ideal seria um sistema thread-safe que permitisse que uma classe se inscreva e depois cancele sua inscrição para escutar uma determinada mensagem ao longo do tempo, sendo que esta classe recebedora da mensagem quem irá informar como o seu método será executado ao receber a mensagem: no mesmo thread (posting), no main thread (main), em outro thread (async) e em um thread que não seja o main (background). Essa é a base do nosso sistema de mensagens, o uso é similar à outro sistema existente, o Delphi Event Bus (DEB).

Vantagens em relação ao similar (DEB)

  • Performance: mais rápido em todas as operações (subscribe, unsubscribe, post), além de ter a inicialização 10x mais rápida
  • Eficiência: consome metade da memória
  • Código menor: menor binário gerado e compilação mais rápida

Veja a comparação em um ambiente com 1000 objetos:

Subscribe Post Unsubscribe
iPub 1.6368 ms 0.1215 ms 1.7666 ms
DEB 9.8832 ms 2.0293 ms 4.0022 ms

Uso

Mensagem interface

ILogOutMessage = interface
  ['{CA101646-B801-433D-B31A-ADF7F31AC59E}']
  // here you can put any data
end;

Escutando uma mensagem

Primeiro você deve inscrever sua classe para escutar mensagens, então todos os métodos públicos que tiverem o atributo [Subscribe] serão inscritos.

TForm1 = class(TForm)
  procedure FormCreate(Sender: TObject);
  procedure FormDestroy(Sender: TObject);
private
  { Private declarations }
public
  { Public declarations }
  [Subscribe(TipMessagingThread.Main)]
  procedure OnLogout(const AMessage: ILogOutMessage);
end;

...

procedure TForm1.FormCreate(Sender: TObject);
begin
  GMessaging.Subscribe(Self);
end;

procedure TForm1.FormDestroy(Sender: TObject);
begin
  GMessaging.Unsubscribe(Self);
end;

procedure TForm1.OnLogout(const AMessage: ILogOutMessage);
begin
  Showmessage('Log out!');
end;

Você também poderá declarar o método no protected, mas para isso você precisará adicionar a diretiva {$RTTI EXPLICIT METHODS([vcProtected, vcPublic, vcPublished])} antes da classe.

Enviando uma mensagem

var
  LMessage: ILogOutMessage
begin
  LMessage := TLogOutMessage.Create;
  GMessaging.Post(LMessage);

Outros tipos de mensagem

Nos exemplos anteriores mostramos uma mensagem interface, mas existem ao todo 3 formas de mensagens:

Identidade Parâmetro
nome (explícito) string
guid da interface do parametro (implícito) interface
guid da interface do parametro (implícito) + nome (explícito) interface

Para receber uma mensagem com nome, basta declarar o nome no atributo do método

  [Subscribe('Name', TipMessagingThread.Main)]

Para enviar uma mensagem identficada por um nome, basta informá-la no próprio Post:

  GMessaging.Post('Name', LMessage);

Nota: O nome explícito é case-insensitive.

Tipo de invocação (thread)

No atributo [Subscribe], você pode determinar como o método que está recebendo a mensagem será executado:

Tipo Descrição
TipMessagingThread.Posting Este é o padrão, o método inscrito será invocado no mesmo thread em que a mensagem foi postada
TipMessagingThread.Main O método inscrito será invocado no main thread
TipMessagingThread.Async O método inscrito será invocado de forma assíncrona, isto é, em um thread anônimo, não sendo o mesmo em que a mensagem foi postada
TipMessagingThread.Background Se a mensagem for postada do main thread, o método inscrito será invocado de forma assíncrona em um thread anônimo, não sendo o mesmo em que a mensagem foi postada. Mas se a mensagem foi postada em um thread que não seja o main thread, o método inscrito será invocado no mesmo thread em que a mensagem foi postada

Inscrever manualmente um método em tempo de execução

Embora o uso do atributo [Subscribe] para inscrever um método seja muito prático, ele acaba sendo limitado pois você tem que definir o nome da mensagem antes da compilação, em design time, e algumas vezes é realmente útil definir o nome das mensagens em tempo de execução. Um exemplo, uma mensagem de um produto que foi alterado 'product_105346_changed', esse nome dessa mensagem eu só consigo definir em tempo de execução, por isso adicionamos a opção de inscrever/desinscrever um método para escutar uma mensagem manualmente:

  GMessaging.SubscribeMethod<string>('product_105346_changed', Self.OnProductChanged, TipMessagingThread.Posting);
  GMessaging.UnsubscribeMethod<string>('product_105346_changed', Self.OnProductChanged);

Estes dois métodos manuais são independente dos métodos Subscribe/Unsubscribe. Você pode mesclar uma mesma classe com métodos inscritos automaticamente usando o atributo [Subscribe] e chamando o Subscribe/Unsubscribe, e ao mesmo tempo nesta classe ter métodos que você adicionou manualmente usando o SubscribeMethod/UnsubscribeMethod.

Outro benefício de inscrever métodos manualmente é o fato de não restringir a apenas métodos públicos (embora este problema possa ser resolvido usando a diretiva RTTI EXPLICIT METHODS).

Considerações

A ideia do sistema é apenas repassar mensagens, avisos, contendo ou não informações, então tenha em mente que não é aconselhável colocar grandes códigos ou códigos com paradas (waitfor) dentro dos métodos inscritos para escutar mensagens, pois isso afetaria diretamente a performance do sistema, mesmo nos modos assíncronos.

Uma outra consideração é apenas um lembrete da forma correta de se usar TTask do delphi. Nunca use o TTask para executar métodos com paradas (eventos, semáforos, ...), ele não foi feito para isso, o objetivo dele é de executar tarefas contínuas e mais simples, se sua tarefa for mais complexa o correto é usar um TThread. Estamos alertando sobre isso, pois o nosso sistema usa o TTask do delphi para aumentar a performance principalmente em ambientes mais complexo além de economizar recursos, e se você usar o TTask de forma incorreta em seus códigos poderá fazer com que sua aplicação trave ao enviar uma mensagem.

Licença

O iPub Messaging é licenciado pelo MIT e o arquivo de licença está incluído nesta pasta.