Introdução

Os diagramas de classes PlantUML descrevem a estrutura estática de um sistema: suas classes, atributos, operações e relacionamentos. Você escreve uma especificação em texto e a renderiza como um diagrama, tornando a fonte fácil de editar e manter sob controle de versão.
1. Um diagrama mínimo
Um diagrama de classes começa com@startuml e termina com@enduml:

@startuml
class User
class Order
User --> Order : places
@enduml
O PlantUML pode inferir classes a partir de declarações de relacionamento, mas declará-las explicitamente torna diagramas maiores mais fáceis de visualizar e manter.
2. Classes, atributos e métodos
Coloque atributos e operações entre chaves. Dois pontos separam o nome de um membro de seu tipo; parênteses marcam uma operação.

@startuml
class User {
-id: int
-email: String
+login(password: String): boolean
+logout(): void
}
@enduml
Os marcadores de visibilidade são:
-
+público -
-privado -
#protegido -
~package-private
Você também pode escrever o tipo antes do nome do membro — por exemplo, +String email ou +void logout(). O PlantUML suporta tanto a notação de membros semelhante a código, familiar, quanto esses marcadores de visibilidade.
Membros estáticos e abstratos
Use {static} ou {classifier} para membros estáticos e {abstract} para membros abstratos:

@startuml
abstract class PaymentMethod {
{abstract} +authorize(amount: Decimal): boolean
{static} +supportedCurrencies: String[]
}
class CardPayment {
+authorize(amount: Decimal): boolean
}
PaymentMethod <|-- CardPayment
@enduml
Uma classe abstrata também pode ser declarada com classe abstrata.
3. Relacionamentos
O formato da seta indica o tipo de relacionamento. A direção da linha é escolhida pela ordem dos nomes; use rótulos para esclarecer seu significado.
| Relacionamento | Notação PlantUML | Significado típico |
|---|---|---|
| Herança / generalização | `Pai < | — Filho` |
| Realização de interface | `Interface < | .. Classe` |
| Composição | Todo *-- Parte |
O ciclo de vida da parte é de propriedade do todo |
| Agregação | Todo o-- Parte |
O todo agrupa ou referencia partes que podem existir independentemente |
| Associação direcionada | A --> B |
A tem um relacionamento navegável com B |
| Dependência | A ..> B |
A usa ou depende de B |
Estas são as notações padrão de relacionamento do PlantUML.

@startuml
interface Repository
class SqlRepository
class OrderService
class Order
class OrderLine
Repository <|.. SqlRepository
OrderService ..> Repository : usa
Order *-- "1..*" OrderLine : contém
@enduml
Escolha com cuidado: Composição e agregação expressam semânticas de ciclo de vida diferentes. Use composição apenas quando a parte for significativamente possuída pelo todo; use uma associação simples quando nenhuma interpretação de propriedade se adequar.
4. Multiplicidade, nomes de papéis e rótulos
A multiplicidade especifica quantos objetos podem participar em cada extremidade de uma associação. As formas comuns incluem "1", "0..1", "*", e "1..*".

@startuml
class Cliente
class Pedido
Cliente "1" --> "0..*" Pedido : faz
@enduml
Aqui, cada Pedido está associado a um Cliente, enquanto um Cliente pode fazer zero ou mais pedidos. Leia as multiplicidades da extremidade oposta: o número próximo a “Pedido descreve quantos pedidos podem ser associados a um cliente.
Para maior precisão, adicione nomes de papéis ou restrições:

@startuml
class Team
class Player
Team "1" o-- "0..*" Player : membros
nota na ligação
Um jogador pode transferir-se entre equipas.
end note
@enduml
5. Interfaces, enumerações, estereótipos e pacotes
O PlantUML suporta declarações como interface, enumeração, classe abstrata, e estereótipos escritos entre << e >>.

@startuml
package "Pedido" {
interface GatewayPagamento {
+cobrar(valor: Decimal): ResultadoPagamento
}
enum StatusPedido {
NOVO
PAGO
CANCELADO
}
class Pedido <<Entidade>> {
+id: UUID
+status: StatusPedido
}
class ServiçoCheckout <<Serviço>> {
+checkout(pedido: Pedido): ResultadoPagamento
}
ServiçoCheckout ..> GatewayPagamento : chama
Pedido --> StatusPedido
}
@enduml
Pacotes agrupam tipos relacionados visualmente. Use estereótipos como “<<Entity>> ou “<<Service>> quando eles adicionam contexto útil; evite adicionar rótulos que apenas repetem o que o nome da classe já diz.
6. Notas, aliases e layout
Notas podem explicar decisões de design ou esclarecer uma restrição sem sobrecarregar os nomes das classes. Aliases ajudam quando um nome exibido contém espaços ou pontuação.

@startuml
class "External Payment API" as PaymentApi
class CheckoutService
CheckoutService ..> PaymentApi : submits payment
note right of CheckoutService
Retries transient failures.
Does not retry declined payments.
end note
left to right direction
@enduml
direção da esquerda para a direita altera a direção geral do layout; o padrão é de cima para baixo. Você também pode usar direções de relacionamento como “-left-> ou “-up-|> para orientar o posicionamento local.
7. Um exemplo mais completo
Este exemplo combina visibilidade, tipos, métodos, enums, multiplicidades, composição e dependência:

@startuml
direção da esquerda para a direita
package "Sales" {
class Customer {
-id: UUID
+name: String
+placeOrder(): Order
}
class Order {
-id: UUID
-status: OrderStatus
+addLine(product: Product, quantity: int): void
+total(): Decimal
}
class OrderLine {
-quantity: int
+lineTotal(): Decimal
}
class Product {
+sku: String
+price: Decimal
}
enum OrderStatus {
NEW
PAID
CANCELLED
}
interface PaymentGateway {
+charge(amount: Decimal): PaymentResult
}
class CheckoutService {
+checkout(order: Order): PaymentResult
}
Customer "1" --> "0..*" Order : places
Order *-- "1..*" OrderLine : contains
OrderLine "*" --> "1" Product : refers to
Order --> OrderStatus
CheckoutService ..> PaymentGateway : uses
}
@enduml
8. Ferramentas: Visual Paradigm VPasCode
O VPasCode é um editor de texto para diagramas baseado em navegador da Visual Paradigm. Ele suporta diagramas de classes PlantUML e oferece um editor de código com visualização ao vivo, permitindo que você escreva ou cole PlantUML e inspecione o resultado renderizado conforme trabalha.

Um fluxo de trabalho típico:
-
Abra o VPasCode e selecione o editor PlantUML ou um exemplo PlantUML.
-
Substitua o texto inicial pelo seu diagrama, incluindo
@startumle@enduml. -
Verifique a visualização ao vivo; se a renderização falhar, inspecione o erro de sintaxe destacado e sua linha.
-
Refine o diagrama e, em seguida, exporte ou compartilhe conforme necessário. O VPasCode descreve as opções de exportação para SVG, PNG e PDF.
O VPasCode também oferece uma interface de seleção de temas para PlantUML, incluindo os temas Visual Paradigm e Rose. Para resultados consistentes em uma equipe, mantenha a fonte PlantUML junto com sua documentação ou código, em vez de depender apenas de uma imagem exportada.
9. Armadilhas comuns e boas práticas

-
Não confunda uma associação com uma dependência.Uma dependência geralmente significa “usa”; uma associação frequentemente representa um relacionamento estrutural mais persistente.
-
Evite o uso excessivo de composição.Ela faz uma afirmação mais forte sobre o ciclo de vida do que uma simples conexão.
-
Rotacione as multiplicidades da extremidade oposta.O número ao lado de uma classe indica quantas instâncias dessa classe podem estar relacionadas a uma instância na outra extremidade.
-
Mantenha os diagramas focados.Divida um modelo muito grande em pacotes ou diagramas separados para preocupações distintas.
-
Mostre os detalhes que atendem ao público.Uma visão conceitual pode precisar apenas de nomes de classes e relacionamentos; um diagrama de nível de design pode precisar de tipos, visibilidade e operações.
-
Trate a fonte como o artefato mantido.Revise as alterações no texto, renderize após as edições e regenere as exportações quando a fonte mudar.
Referência rápida

@startuml
class A {
+publicField: String
-privateField: int
#protectedMethod(): void
~packageMember(): boolean
}
interface I
abstract class Base
enum State { READY; DONE }
Base <|-- A
I <|.. A
A *-- B : composition
A o-- C : aggregation
A --> D : association
A ..> I : dependency
@enduml
O PlantUML suporta recursos adicionais de diagramas de classes — incluindo agrupamento de membros, notas, cores e mais — quando um diagrama precisa de refinamento adicional.










