Clean Code auf Swift: Prinzipien und Praxisbeispiele

Clean Code auf Swift: Prinzipien und Praxisbeispiele

Sauberer Code (Clean Code) ist nicht nur ein modischer Begriff, sondern eine grundlegende Fähigkeit eines professionellen Entwicklers. Im Swift-Ökosystem (iOS/macOS) beeinflusst die Codequalität direkt die Entwicklungsgeschwindigkeit, die Anzahl der Fehler und die Wartbarkeit des Projekts. In diesem Artikel analysieren wir die wichtigsten Clean-Code-Prinzipien in Bezug auf Swift und zeigen deren Umsetzung anhand praktischer Beispiele.

1. Benennung: Sprechen Sie die Sprache der Fachdomäne

Ein guter Name für eine Variable, Funktion oder Klasse ersetzt Kommentare. In Swift, mit seinem reichhaltigen Typsystem und optionalen Werten, ist die korrekte Benennung besonders wichtig.

Schlechtes Beispiel:

func calc(a: [String: Any]) -> Double {\n    var x = 0.0\n    for (_, v) in a {\n        if let n = v as? Double {\n            x += n\n        }\n    }\n    return x\n}

Gutes Beispiel (Clean Code):

func calculateTotalPrice(of products: [Product]) -> Double {\n    return products.reduce(0) { $0 + $1.price }\n}

Benennungsprinzipien in Swift:

\n
• Klarheit vor Kürze: remove(at:) ist besser als rem(at:).
\n
• Verwenden Sie Substantive für Typen: UserViewController, NetworkManager.
\n
• Verben für Funktionen: fetchData(), saveToCache().
\n
• Boolesche Variablen: beginnen Sie mit is, has, should — isEnabled, hasContent.
\n
• Vermeiden Sie Abkürzungen: backgroundColor statt bgColor.
\n

2. Prinzip der einzigen Verantwortung (SRP) in Swift

Jede Klasse, Struktur oder Funktion sollte nur einen einzigen Grund für eine Änderung haben. In der iOS-Entwicklung ist dies besonders relevant für ViewController, die oft zu "göttlichen Objekten" werden.

Verletzung des SRP (typischer ViewController):

class ProfileViewController: UIViewController {\n    @IBOutlet weak var nameLabel: UILabel!\n    @IBOutlet weak var avatarImageView: UIImageView!\n    \n    override func viewDidLoad() {\n        super.viewDidLoad()\n        // Daten laden\n        let url = URL(string: "https://api.example.com/user")!\n        let data = try! Data(contentsOf: url)\n        let json = try! JSONSerialization.jsonObject(with: data) as! [String: Any]\n        nameLabel.text = json["name"] as? String\n        \n        // Avatar laden\n        let imageUrl = URL(string: json["avatar"] as! String)!\n        let imageData = try! Data(contentsOf: imageUrl)\n        avatarImageView.image = UIImage(data: imageData)\n        \n        // Im Cache speichern\n        UserDefaults.standard.set(json, forKey: "cachedUser")\n    }\n}

Refactoring unter Einhaltung des SRP:

// 1. Separater Service für die Netzwerkarbeit\nclass UserNetworkService {\n    func fetchUser(completion: @escaping (Result<User, Error>) -> Void) {\n        // ... Netzwerklogik\n    }\n}\n\n// 2. Separater Cache-Manager\nclass UserCacheManager {\n    func saveUser(_ user: User) {\n        // ... Caching-Logik\n    }\n}\n\n// 3. ViewModel für die Geschäftslogik\nclass ProfileViewModel {\n    private let networkService = UserNetworkService()\n    private let cacheManager = UserCacheManager()\n    \n    func loadProfile(completion: @escaping (User) -> Void) {\n        networkService.fetchUser { [weak self] result in\n            switch result {\n            case .success(let user):\n                self?.cacheManager.saveUser(user)\n                completion(user)\n            case .failure:\n                // Bei Fehler aus dem Cache laden\n                if let cachedUser = self?.cacheManager.lo