Se você já precisou criar diagramas para representar fluxos, arquiteturas ou conceitos e achou ferramentas visuais muito trabalhosas, o PlantUML pode ser a solução. Ele permite que você crie diagramas profissionais de maneira rápida e simples, utilizando apenas texto. Neste artigo, vamos explorar o que é o PlantUML, para que ele serve, como instalar seu servidor no Docker e exemplos práticos de uso.
O PlantUML é uma ferramenta de código aberto que transforma texto em diagramas. Criado para desenvolvedores e arquitetos de software, ele suporta diversos tipos de diagramas, como:
- Diagramas de Classes
- Diagramas de Sequência
- Diagramas de Casos de Uso
- Diagramas de Componentes
- Diagramas de Atividades
- E muito mais.
A grande vantagem do PlantUML é a sua simplicidade: basta escrever o diagrama em texto utilizando uma sintaxe própria e a ferramenta gera automaticamente uma imagem visual. Isso o torna ideal para automatização e documentação de projetos em pipelines DevOps.
Para que serve?
O PlantUML é amplamente utilizado para:
- Documentação de projetos:
- Comunicação em equipe:
- Automação em pipelines CI/CD:
- Educação:
Crie diagramas que acompanham o código de forma simples e rápida.
Expresse ideias complexas com diagramas claros e padronizados.
Gere diagramas como parte de builds automatizados.
Ideal para ensinar conceitos de arquitetura, design patterns e modelagem de sistemas.
Instalando o PlantUML Server com Docker
O PlantUML Server é uma aplicação que permite gerar diagramas remotamente via HTTP. Ele é leve, rápido e ideal para integração com outras ferramentas.
Pré-requisitos
Docker instalado no seu sistema operacional.
Passos de Instalação
Faça o download da imagem oficial do PlantUML Server, conforme segue:
docker pull plantuml/plantuml-server
Inicie o container do PlantUML Server:
docker run -d -p 8080:8080 --name plantuml-docker plantuml/plantuml-server
Digite docker ps para verificar se o PlantUML-Server foi inicializado no container Docker
Acesse no navegador http://localhost:8080 irá aparecer o editor no lado esquerdo com um exemplo de diagram e no lado esquerdo o resultado como imagem, pode escolher PNG, SVG, ASCII, PDF
Exemplo de Uso do PlantUML
Diagrama de Classes
Escreva o seguinte código no editor no lado esquerdo:
@startuml
class Pessoa {
+nome: String
+idade: int
+andar(): void
}
class Funcionario {
+salario: double
+trabalhar(): void
}
Pessoa <|-- Funcionario
@enduml
Resultado
Este código gera um diagrama mostrando a hierarquia entre as classes Pessoa e Funcionario, com Funcionario herdando de Pessoa.
Parar e iniciar o PlantUML-Server no Docker
Considerando que utilizou o nome do container de plantuml-docker, definido no comando anterior definido no argumento --name que foi plantuml-docker
docker stop plantuml-docker
docker start plantuml-docker
Recursos Adicionais
- Extensões IDE:
- Integração com Wikis:
- Suporte a Temas:
O PlantUML possui plugins para IntelliJ, Visual Studio Code, Eclipse e outros.
Use o PlantUML com ferramentas como Confluence ou GitLab para documentar projetos.
Personalize seus diagramas com temas para uma aparência mais profissional.
Considerações finais
O PlantUML é uma ferramenta poderosa para desenvolvedores que buscam eficiência na criação de diagramas. Sua abordagem baseada em texto, integração com ferramentas modernas e a possibilidade de usar um servidor Docker tornam o PlantUML uma solução flexível e produtiva. Comece a usar hoje e revolucione a forma como você cria e mantém diagramas em seus projetos.
Referências
Feito!
