Diagramas UML com PlantUML

Uma ferramenta muito útil para geração de diagramas UML, principalmente o disgrama de sequência, é a PlantUML. Construída na linguagem java facilita a construção de documentos simples e rápidos assim como elaborações mais sofisticadas.

A aplicação pode ser baixada no site https://plantuml.com. Neste artigo apresento o diagrama de sequência como exemplo de utilização, pois está entre aqueles de maior uso no dia-a-dia de desenvolvimento e sustentação.

Execução da Aplicação

Após baixar o arquivo JAR da aplicação basta executar o comando:

java -jar plantuml.jar &

Será inicializada uma janela como apresentada abaixo:

PlantUML_01.png

Figura 1 - Apresentação do PlantUML

Conteúdo

Em qualquer editor de texto crie um arquivo com extensão PUML. Adicione o conteúdo abaixo:

@startuml

participant Game
participant "Splash Screen" as Splash
participant Animation

Game -> Splash ++ : Load Content
  Splash -> Animation ++ : Load
  Splash <-- Animation --
Game <-- Splash --

@enduml

Na aplicação selecione o diretório de trabalho onde está localizado o arquivo com o conteúdo acima. Selecione o botão "Change Directory". Será apresentada uma lista de arquivos disponíveis para visualização, conforme a figura abaixo:

PlantUML_02.png

Figura 2 - Após configuração do diretório de trabalho

Dê um duplo clique no item "teste.puml" e será aberto o diagrama:

PlantUML_03.png

Figura 3 - Diagrama

Dicas

Quando o diagrama ficar muito grande haverá limitação no espaço para desenho cortando partes da estrutura visual, isso porque o tamanho padrão limite é de 4096 px de tamanho e largura.

Para ampliar o espaço do diagrama inicialize a aplicação com a variável de ambiente PLANTUML_LIMIT_SIZE.

java -DPLANTUML_LIMIT_SIZE=16384 -jar plantuml.jar &

Observe que o aumento do tamanho da página acarretará maior uso de memória, sendo em alguns casos necessário ampliá-la no Java:

java -Xmx1024m -DPLANTUML_LIMIT_SIZE=16384 -jar plantuml.jar &

Comandos adicionais na geração de diagramas podem ser estudados em https://plantuml.com/sequence-diagram.

Download

Apenas para manter um local alternativo para download:

plantuml  document