1. Produtos
  2.   Diagrama
  3.   Swift
  4.   SwiftPlantUML
 
  

Biblioteca Swift de Código Aberto para Criar Diagrama de Classes UML

Uma poderosa biblioteca Swift de código aberto permite que desenvolvedores de software gerem diagramas de classes UML a partir do código-fonte Swift. Os desenvolvedores podem personalizar o diagrama de saída e visualizar a arquitetura do código.

O que é SwiftPlantUML?

No mundo acelerado do desenvolvimento de software, manter uma compreensão clara da arquitetura do seu aplicativo é fundamental. À medida que os projetos se tornam mais complexos, visualizar as relações entre classes, protocolos e outros componentes torna‑se essencial. Os desenvolvedores de software frequentemente dependem de diagramas UML (Unified Modeling Language) para visualizar e documentar a estrutura do código. SwiftPlantUML é uma biblioteca de código aberto que automatiza a geração de diagramas de classes UML a partir do código Swift, tornando‑se uma ferramenta essencial para desenvolvedores Swift. É uma biblioteca poderosa que gera scripts PlantUML a partir do código Swift. PlantUML é uma ferramenta baseada em texto para criar diagramas UML, incluindo diagramas de classes, diagramas de sequência e muito mais.

Desenvolvido por Marco Eidinger, o SwiftPlantUML permite que desenvolvedores gerem diagramas UML diretamente a partir do código Swift, facilitando a documentação e visualização da estrutura de projetos Swift. O SwiftPlantUML oferece opções de personalização para adaptar os diagramas UML gerados às necessidades específicas. Os desenvolvedores podem excluir determinadas classes, ajustar o layout ou filtrar elementos específicos. Ele extrai estruturas de classes e relacionamentos do código Swift e gera diagramas UML automaticamente. Com suporte a uma ampla variedade de tipos Swift, saída personalizável e integração perfeita com o Xcode, o SwiftPlantUML é uma adição inestimável ao conjunto de ferramentas de qualquer desenvolvedor Swift.

Previous Next

Começando com SwiftPlantUML

A forma recomendada de usar a biblioteca SwiftPlantUML é através do Homebrew. Por favor, use o comando a seguir para uma instalação tranquila.

Instalar SwiftPlantUML via Homebrew

brew install swiftplantuml

Instalar SwiftPlantUML via Mint

$ mint install MarcoEidinger/SwiftPlantUML

Converter código Swift em diagramas UML

Depois de instalado, você pode usar o SwiftPlantUML para gerar scripts PlantUML a partir do seu código Swift. Em vez de criar diagramas manualmente, a biblioteca de código aberto SwiftPlantUML extrai estruturas de classes e relacionamentos do código Swift e gera diagramas UML automaticamente, sem dependências externas. O exemplo a seguir mostra como os desenvolvedores podem gerar um script PlantUML a partir do código fornecido que representa os relacionamentos entre os tipos User, Admin e Authenticatable. A saída pode ser renderizada em um diagrama UML usando um editor PlantUML.

Como gerar script PlantUML a partir do código fornecido via API Swift?

import SwiftPlantUML

class User {
    var name: String
    var email: String

    init(name: String, email: String) {
        self.name = name
        self.email = email
    }
}

class Admin: User {
    func managePermissions() {
        print("Managing permissions...")
    }
}

protocol Authenticatable {
    func login()
    func logout()
}

extension Admin: Authenticatable {
    func login() {
        print("Admin logged in")
    }

    func logout() {
        print("Admin logged out")
    }
}

let generator = PlantUMLGenerator()
let plantUMLScript = generator.generate(from: User.self)
print(plantUMLScript)

Suporte a saída personalizável

A biblioteca SwiftPlantUML permite que os desenvolvedores de software personalizem os scripts PlantUML gerados para atender às suas necessidades. Os desenvolvedores podem incluir ou excluir tipos específicos, modificar relacionamentos e ajustar o layout do diagrama dentro de aplicações Swift. O exemplo a seguir mostra como os usuários podem excluir a classe Animal do diagrama gerado usando a biblioteca Swift.

Como excluir uma classe específica do diagrama gerado usando a API Swift?

let options = PlantUMLOptions(exclude: ["Animal"])
let generator = PlantUMLGenerator(options: options)
let plantUMLScript = generator.generate(from: MySwiftClass.self)
Visualize Code Architecture

Visualizar arquitetura de código e colaboração

Entender os relacionamentos entre classes, protocolos e structs é crucial para construir aplicativos escaláveis. A biblioteca de código aberto SwiftPlantUML facilita a geração de diagramas UML que fornecem uma representação visual clara da arquitetura do seu aplicativo, tornando mais fácil identificar possíveis problemas e otimizar o design. Diagramas visuais facilitam a comunicação e colaboração das equipes. Ao compartilhar diagramas UML, os desenvolvedores podem alinhar rapidamente as decisões de design e identificar áreas de melhoria.

 Português