1. Produkter
  2.   Diagram
  3.   Swift
  4.   SwiftPlantUML
 
  

Öppet Swift-bibliotek för att skapa UML-klassdiagram

Ett kraftfullt open source Swift-bibliotek låter mjukvaruutvecklare generera UML-klassdiagram från Swift-källkod. Utvecklare kan anpassa diagrammet och visualisera kodarkitekturen.

Vad är SwiftPlantUML?

I den snabbrörliga världen av mjukvaruutveckling är det kritiskt att upprätthålla en klar förståelse för din apps arkitektur. När projekten blir mer komplexa blir visualisering av relationer mellan klasser, protokoll och andra komponenter avgörande. Mjukvaruutvecklare förlitar sig ofta på UML‑diagram (Unified Modeling Language) för att visualisera och dokumentera sin kodstruktur. SwiftPlantUML är ett open‑source‑bibliotek som automatiserar genereringen av UML‑klassdiagram från Swift‑kod, vilket gör det till ett viktigt verktyg för Swift‑utvecklare. Det är ett kraftfullt bibliotek som genererar PlantUML‑skript från Swift‑kod. PlantUML är ett textbaserat verktyg för att skapa UML‑diagram, inklusive klassdiagram, sekvensdiagram och mer.

Utvecklad av Marco Eidinger, gör SwiftPlantUML det möjligt för utvecklare att generera UML-diagram direkt från Swift-kod, vilket underlättar dokumentation och visualisering av strukturen i Swift-projekt. SwiftPlantUML erbjuder anpassningsalternativ för att skräddarsy de genererade UML-diagrammen efter specifika behov. Utvecklare kan utesluta vissa klasser, justera layouten eller filtrera specifika element. Den extraherar klassstrukturer och relationer från Swift-kod och genererar UML-diagram automatiskt. Med stöd för ett brett spektrum av Swift-typer, anpassningsbar output och sömlös integration med Xcode är SwiftPlantUML ett ovärderligt tillskott till varje Swift-utvecklares verktygssats.

Previous Next

Kom igång med SwiftPlantUML

Det rekommenderade sättet att använda SwiftPlantUML-biblioteket är via Homebrew. Använd följande kommando för en smidig installation.

Installera SwiftPlantUML via Homebrew

brew install swiftplantuml

Installera SwiftPlantUML via Mint

$ mint install MarcoEidinger/SwiftPlantUML

Konvertera Swift-kod till UML-diagram

När den är installerad kan du använda SwiftPlantUML för att generera PlantUML‑skript från din Swift‑kod. Istället för att manuellt skapa diagram extraherar det öppna källkods‑biblioteket SwiftPlantUML klassstrukturer och relationer från Swift‑koden och genererar UML‑diagram automatiskt utan några externa beroenden. Följande exempel visar hur utvecklare kan generera ett PlantUML‑skript från den givna koden som representerar relationerna mellan typerna User, Admin och Authenticatable. Utdata kan renderas till ett UML‑diagram med en PlantUML‑redigerare.

Hur genererar man PlantUML‑skript från den givna koden via Swift API?

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)

Stöd för anpassningsbar utdata

SwiftPlantUML‑biblioteket låter mjukvaruutvecklare anpassa de genererade PlantUML‑skripten efter sina behov. Utvecklare kan inkludera eller exkludera specifika typer, ändra relationer och justera diagrammets layout i Swift‑applikationer. Följande exempel visar hur användare kan exkludera Animal‑klassen från det genererade diagrammet med Swift‑biblioteket.

Hur utesluter man en viss klass från det genererade diagrammet med Swift API?

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

Visualisera kodarkitektur & samarbete

Att förstå relationerna mellan klasser, protokoll och strukturer är avgörande för att bygga skalbara appar. Det öppna källkodsbiblioteket SwiftPlantUML gör det enkelt att generera UML-diagram som ger en tydlig visuell representation av din apps arkitektur, vilket underlättar att identifiera potentiella problem och optimera designen. Visuella diagram underlättar för team att kommunicera och samarbeta. Genom att dela UML-diagram kan utvecklare snabbt enas om designbeslut och identifiera förbättringsområden.

 Svenska