[swift] Swift Sourcery와 코드 문서의 자동 생성

16 Nov 2023

swift

Swift Sourcery는 Swift 언어를 사용하는 개발자들을 위한 코드 생성 도구입니다. 이 도구를 사용하면 반복적이고 지루한 작업을 자동화하여 시간과 노력을 절약할 수 있습니다.

Sourcery란?

Sourcery는 메타 프로그래밍(Metaprogramming) 기술을 사용하여 코드를 자동 생성하는 도구입니다. 이는 런타임이 아닌 컴파일 타임에 코드를 생성하므로 성능에 영향을 주지 않습니다. Sourcery는 템플릿을 사용하여 코드를 생성하므로 개발자가 직접 작성한 코드와 분리되어 있습니다.

코드 문서의 자동 생성

Sourcery를 사용하면 주석을 통해 문서화된 코드의 메타데이터를 읽을 수 있습니다. 이는 API 문서 자동 생성, 모델 클래스의 Codable 구현 자동 생성 등에 유용합니다.

예를 들어, 다음은 Codable 프로토콜을 구현한 User 클래스입니다.

class User: Codable {
    var name: String
    var age: Int

    enum CodingKeys: String, CodingKey {
        case name
        case age
    }

    init(name: String, age: Int) {
        self.name = name
        self.age = age
    }
}

Sourcery를 사용하면 이 클래스의 Codable 구현을 자동으로 생성할 수 있습니다. 다음은 Sourcery를 사용하여 생성된 코드입니다.

extension User: Codable {
    private enum CodingKeys: String, CodingKey {
        case name
        case age
    }

    convenience init(from decoder: Decoder) throws {
        let container = try decoder.container(keyedBy: CodingKeys.self)
        let name = try container.decode(String.self, forKey: .name)
        let age = try container.decode(Int.self, forKey: .age)
        self.init(name: name, age: age)
    }

    func encode(to encoder: Encoder) throws {
        var container = encoder.container(keyedBy: CodingKeys.self)
        try container.encode(name, forKey: .name)
        try container.encode(age, forKey: .age)
    }
}

이렇게 생성된 코드는 개발자가 직접 작성한 코드와 동일한 동작을 수행하지만, Codable 프로토콜을 구현하는 반복적인 작업을 자동화해줍니다.

결론

Swift Sourcery는 개발자들이 코드 작성 시간을 줄이고 유지 보수성을 향상시킬 수 있는 강력한 도구입니다. 코드 문서 자동 생성은 개발자들이 실수 없이 명확하고 일관된 코드를 작성할 수 있도록 도와줍니다. Sourcery의 다양한 기능을 활용하여 프로젝트의 생산성을 향상시켜보세요.