1. Продукти
  2.   Діаграма
  3.   Swift
  4.   SwiftPlantUML
 
  

Відкрита Swift бібліотека для створення діаграми класів UML

Потужна бібліотека Swift з відкритим кодом дозволяє розробникам програмного забезпечення генерувати діаграми UML-класів з вихідного коду Swift. Розробники можуть налаштовувати вихідну діаграму та візуалізувати архітектуру коду.

Що таке SwiftPlantUML?

У швидко змінному світі розробки програмного забезпечення підтримка чіткого розуміння архітектури вашого додатку є критично важливою. У міру того, як проєкти стають складнішими, візуалізація взаємозв’язків між класами, протоколами та іншими компонентами стає необхідною. Розробники програмного забезпечення часто покладаються на діаграми UML (Unified Modeling Language) для візуалізації та документування структури коду. SwiftPlantUML — це бібліотека з відкритим вихідним кодом, яка автоматизує створення діаграм класів UML з коду Swift, роблячи її незамінним інструментом для розробників Swift. Це потужна бібліотека, яка генерує скрипти PlantUML з коду Swift. PlantUML — це текстовий інструмент для створення діаграм UML, включаючи діаграми класів, діаграми послідовностей та інші.

Розроблений Марко Айдінгером, SwiftPlantUML дозволяє розробникам генерувати діаграми UML безпосередньо з коду Swift, спрощуючи документування та візуалізацію структури Swift‑проєктів. SwiftPlantUML надає параметри налаштування, щоб адаптувати створені діаграми UML відповідно до конкретних потреб. Розробники можуть виключати певні класи, коригувати макет або фільтрувати окремі елементи. Він витягує структури класів і їхні взаємозв’язки з коду Swift і автоматично генерує діаграми UML. Підтримуючи широкий спектр типів Swift, налаштовуваний вивід та безшовну інтеграцію з Xcode, SwiftPlantUML є незамінним доповненням до інструментарію будь‑якого розробника Swift.

Початок роботи зі SwiftPlantUML

Рекомендований спосіб встановлення бібліотеки SwiftPlantUML — використання Homebrew. Будь ласка, скористайтеся наступною командою для безпроблемної інсталяції.

Встановіть SwiftPlantUML через Homebrew

brew install swiftplantuml

Встановіть SwiftPlantUML через Mint

$ mint install MarcoEidinger/SwiftPlantUML

Конвертуйте код Swift у діаграми UML

Після встановлення ви можете використовувати SwiftPlantUML для генерації скриптів PlantUML з вашого коду Swift. Замість ручного створення діаграм, бібліотека SwiftPlantUML з відкритим кодом витягує структури класів та їхні взаємозв’язки з коду Swift і автоматично генерує UML‑діаграми без будь‑яких зовнішніх залежностей. Наведений нижче приклад показує, як розробники можуть створити скрипт PlantUML з даного коду, який представляє взаємозв’язки між типами User, Admin та Authenticatable. Вивід можна відобразити у вигляді UML‑діаграми за допомогою редактора PlantUML.

Як згенерувати скрипт PlantUML з даного коду за допомогою 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)

Підтримка налаштовуваного виводу

Бібліотека SwiftPlantUML дозволяє розробникам програмного забезпечення налаштовувати згенеровані скрипти PlantUML відповідно до їхніх потреб. Розробники можуть включати або виключати певні типи, змінювати взаємозв’язки та коригувати розташування діаграми у Swift‑додатках. Наведений нижче приклад показує, як користувачі можуть виключити клас Animal з згенерованої діаграми за допомогою бібліотеки Swift.

Як виключити певний клас зі згенерованої діаграми за допомогою Swift API?

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

Візуалізуйте архітектуру коду та співпрацю

Розуміння взаємозв’язків між класами, протоколами та структурами є важливим для створення масштабованих додатків. Відкрита бібліотека SwiftPlantUML спрощує генерацію UML‑діаграм, які надають чітке візуальне представлення архітектури вашого додатку, полегшуючи виявлення потенційних проблем та оптимізацію дизайну. Візуальні діаграми полегшують спілкування та співпрацю команд. Ділячись UML‑діаграмами, розробники можуть швидко узгоджувати рішення щодо дизайну та виявляти області для покращення.