کتابخانه منبع باز Swift برای ایجاد نمودار کلاس UML

آغاز کار با SwiftPlantUML

روش پیشنهادی برای کتابخانه SwiftPlantUML استفاده از Homebrew است. لطفاً برای نصب روان، دستور زیر را اجرا کنید.

brew install swiftplantuml

$ mint install MarcoEidinger/SwiftPlantUML

تبدیل کد سوئیفت به نمودارهای UML

پس از نصب، می‌توانید از SwiftPlantUML برای تولید اسکریپت‌های PlantUML از کد Swift خود استفاده کنید. به‌جای ایجاد دستی نمودارها، کتابخانه منبع باز SwiftPlantUML ساختارهای کلاس و روابط را از کد Swift استخراج کرده و به‌صورت خودکار نمودارهای UML را بدون هیچ وابستگی خارجی تولید می‌کند. مثال زیر نشان می‌دهد که چگونه توسعه‌دهندگان می‌توانند یک اسکریپت PlantUML را از کد داده‌شده که روابط بین انواع User، Admin و Authenticatable را نشان می‌دهد، تولید کنند. خروجی می‌تواند با استفاده از یک ویرایشگر PlantUML به نمودار UML تبدیل شود.

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 حذف کنند.

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

به تصویر کشیدن معماری کد و همکاری

درک روابط بین کلاس‌ها، پروتکل‌ها و ساختارها برای ساخت برنامه‌های مقیاس‌پذیر بسیار مهم است. کتابخانه منبع باز SwiftPlantUML به سادگی امکان تولید نمودارهای UML را فراهم می‌کند که نمایشی واضح از معماری برنامه شما ارائه می‌دهند و شناسایی مشکلات احتمالی و بهینه‌سازی طراحی را آسان‌تر می‌سازند. نمودارهای بصری ارتباط و همکاری تیم‌ها را تسهیل می‌کنند. با به اشتراک‌گذاری نمودارهای UML، توسعه‌دهندگان می‌توانند به سرعت در تصمیمات طراحی هم‌راستا شوند و نقاط قابل بهبود را شناسایی کنند.