Macro란

• 컴파일러에게 코드 블록을 추가(expand)하도록 명령하는 방법 - 기존 코드의 삭제나 변경은 안된다!
• 반복적인 코드 작성을 대신하게 하거나, 컴파일 타임에 확인하고 싶은 부분을 체크해서 에러를 내게 할 수도 있다. \
• swift 5.9에 추가된 기능이기 때문에 Xcode 15.0 이상부터 사용 가능하다.
• 우클릭으로 확장된 코드를 확인할 수 있다.
• 아래는 컴파일타임에 유효한 URL인지 확인하는 매크로예시이다.

// Source code
let swiftLeeBlogURL = #URL("https://www.avanderlee.com")

// Expanded source 
let swiftLeeBlogURL = {
    guard let swiftLeeBlogURL = URL(string: "https://www.avanderlee.com") else {
        /// Throw compiler error
    }
    return swiftLeeBlogURL
}()

종류

• 크게 두가지 종류가 있다.
  • # 로 정의되는 freestanding
  • @ 로 정의되는 attached
• freestanding은 말그대로 독립적으로 이용할 수 있는 매크로다.
  • let x = #stringfy(42) // returns "42" 처럼 표현식처럼 사용하거나
  • #log("some logging") // print("some logging") 로 함수처럼 사용할 수 있다.
• attached는 다른 변수나 타입들이 정의(declare)된 부분에 추가돼서 정의를 확장해준다.
  • 종류가 많은데, 간단하게는 변수에 getter, setter를 추가할 수도 있고, 타입에 protocol conformance를 추가할 수도 있다.

macro를 사용한 라이브러리

• MetaCodable

  • 특정 프로퍼티만 custom coding key를 사용할 수 있음

    // Source code
    @Codable
    struct Landmark {
        @CodablePath("title")
        var name: String
        @CodablePath("founding_date")
        var foundingYear: Int
        var location: Coordinate
        var vantagePoints: [Coordinate]
    }
    
    // Expanded source
    struct Landmark: Codable {
        var name: String
        var foundingYear: Int
        var location: Coordinate
        var vantagePoints: [Coordinate]
        
        enum CodingKeys: String, CodingKey {
            case name = "title"
            case foundingYear = "founding_date"
            case location
            case vantagePoints
        }
    }

  • decoding 실패할 경우(key가 없거나, type이 mismatch)의 default value 지정

    @Codable
    struct CodableData {
        @CodablePath(default: "some")
        let field: String
    }

  • nested coding key value를 사용해서 flatten 가능

    // JSON to decode
    {
      "latitude": 0,
      "longitude": 0,
      "additionalInfo": {
          "elevation": 0
      }
    }
    
    // Source code
    @Codable
    struct Coordinate {
        var latitude: Double
        var longitude: Double
        
        @CodablePath("additionalInfo", "elevation")
        var elevation: Double
    }

• UtilityType
  • 타입스크립트에 있는 유틸리티 타입들을 스위프트에서 사용 가능하다.
  • 특정 프로퍼티만으로 구성된 타입을 만들거나

    @Pick("Picked", properties: "id", "name")
    public struct User {
        let id: UUID
        let name: String
        let age: Int
        let optional: Void?
    }
    
    // Pick is picked properties from User.
    let pickedUser = User.Picked(id: UUID(), name: "bannzai")
    
    // OR
    let user = User(id: UUID(), name: "bannzai", age: 30, optional: ())
    let pickedUser = User.Picked(user: user)

  • enum에서 특정 case를 exclude/extract 하거나

    @Extract("ExtractedOne", extracts: "one")
    public enum Enum {
        case one
        case two(Int)
        case three(String, Int)
        case four(a: String, b: Int)
    }
    
    let testEnum2 = Enum.one
    let extracted = Enum.ExtractedOne(testEnum2)
    
    // The switch statement only `one`.
    switch extracted {
    case .one:
        print("one")
    case nil:
        print("nil")
    }

  • 특정 함수의 parameter(또는 return params)들만으로 구성된 튜플타입을 만들거나

    // Parameters
    @Parameters("FunctionArgs")
    func function(a: Int, b: String, c: @escaping () -> Void, e: () -> Void) -> Int {
        return 1
    }
    
    let args: FunctionArgs = (a: 10, b: "value", c: { print("c") }, e: { print("e") })
    
    // ReturnType
    @ReturnType("FunctionReturnType")
    func function(a: Int, b: String, c: @escaping () -> Void, e: () -> Void) -> Int {
        return 1
    }
    
    let returnType = FunctionReturnType(rawValue: 100)