ไลบรารี Swift แบบโอเพนซอร์สสำหรับสร้างแผนภาพคลาส UML

เริ่มต้นใช้งาน SwiftPlantUML

วิธีที่แนะนำสำหรับไลบรารี SwiftPlantUML คือการใช้ Homebrew โปรดใช้คำสั่งต่อไปนี้เพื่อการติดตั้งที่ราบรื่น

brew install swiftplantuml

$ mint install MarcoEidinger/SwiftPlantUML

แปลงโค้ด Swift เป็นแผนภาพ UML

เมื่อติดตั้งแล้ว คุณสามารถใช้ SwiftPlantUML เพื่อสร้างสคริปต์ PlantUML จากโค้ด Swift ของคุณได้ แทนการสร้างไดอะแกรมด้วยตนเอง ไลบรารีโอเพ่นซอร์ส SwiftPlantUML จะสกัดโครงสร้างคลาสและความสัมพันธ์จากโค้ด Swift และสร้างไดอะแกรม UML โดยอัตโนมัติโดยไม่ต้องพึ่งพาไลบรารีภายนอก ตัวอย่างต่อไปนี้แสดงว่าผู้พัฒนาสามารถสร้างสคริปต์ PlantUML จากโค้ดที่ให้ซึ่งแสดงความสัมพันธ์ระหว่างประเภท User, Admin และ Authenticatable ได้อย่างไร ผลลัพธ์สามารถเรนเดอร์เป็นไดอะแกรม UML ได้โดยใช้โปรแกรมแก้ไข PlantUML.

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 นักพัฒนาสามารถปรับแนวทางการออกแบบได้อย่างรวดเร็วและระบุพื้นที่ที่ต้องปรับปรุง