Introduction
Most Swift developers focus on writing clean, type-safe code—but what if your code could examine itself at runtime? This is the essence of metaprogramming. With Swift's built-in reflection capabilities and the powerful @dynamicMemberLookup attribute, you can build generic inspectors, debuggers, and chainable APIs that adapt to dynamic data. This guide will walk you through the process using Mirror, reflection, and @dynamicMemberLookup, enabling you to write code that inspects and manipulates its own structure.
What You Need
- Xcode 12+ (or a Swift-compatible environment)
- Basic knowledge of Swift syntax (structs, classes, protocols)
- Familiarity with generics and protocols (helpful but not required)
- A sample project or playground to test the examples
Step-by-Step Instructions
Step 1: Understand Reflection with Mirror
Reflection lets your code query the structure of a type at runtime. Swift's primary tool for this is the Mirror struct. A Mirror provides a collection of children—each representing a property or stored value of the reflected instance. To create a mirror, call Mirror(reflecting:) with any value.
let example = (name: "Alice", age: 30)
let mirror = Mirror(reflecting: example)
print(mirror.children.count) // Output: 2
The mirror's children property is a collection of Mirror.Child tuples, each containing an optional label (the property name) and a value (the property's current value). This is the foundation for all runtime introspection in Swift.
Step 2: Use Mirror to Inspect Properties
Once you have a mirror, you can iterate over its children to inspect and even modify (if the type is a class with mutable properties). For instance, to print all property names and values:
struct Person {
var name: String
var age: Int
}
let person = Person(name: "Bob", age: 25)
let personMirror = Mirror(reflecting: person)
for child in personMirror.children {
if let label = child.label {
print("\(label): \(child.value)")
}
}
// Output:
// name: Bob
// age: 25
You can also check the mirror's displayStyle to understand the kind of type (struct, class, enum, etc.). This is useful when building generic tools that need to adapt to different kinds of types.
Step 3: Build a Generic Inspector
Now combine the above into a reusable, generic function that accepts any type and returns a dictionary of property names to values. This is the core of a runtime inspector.
func inspect(_ value: T) -> [String: Any] {
let mirror = Mirror(reflecting: value)
var result = [String: Any]()
for child in mirror.children {
if let label = child.label {
result[label] = child.value
}
}
return result
}
// Usage
print(inspect(person))
// Output: ["name": "Bob", "age": 25]
This inspector works with any struct, class, or enum. You can extend it to handle nested types by creating recursive mirrors, opening the door to full object graph introspection.
Step 4: Implement @dynamicMemberLookup for Chainable APIs
The @dynamicMemberLookup attribute lets you provide dot-syntax access to properties that aren't known at compile time. When applied to a type, you must implement a subscript that takes a string key and returns a value. This is perfect for building clean, chainable APIs over dynamic data (like JSON or dictionaries).
To start, create a struct that wraps a dictionary and provides dynamic member lookup:
@dynamicMemberLookup
struct DynamicJSON {
private var storage: [String: Any]
init(_ data: [String: Any]) {
self.storage = data
}
subscript(dynamicMember member: String) -> Any? {
return storage[member]
}
}
// Usage
let json = DynamicJSON(["user": ["name": "Alice", "age": 30]])
if let userName = json.user?["name"] {
print(userName) // Output: Alice
}
Note that the subscript returns an optional Any?. To enable chaining further, you can return another DynamicJSON when the value is a dictionary. This is where things get interesting.
Step 5: Combine Techniques for Advanced Metaprogramming
Now integrate Mirror with @dynamicMemberLookup to create a type that can both inspect itself and respond to dynamic property access. For example, a ReflectiveObject that allows dot-notation for any property:
@dynamicMemberLookup
class ReflectiveObject {
private let mirror: Mirror
private let subject: Any
init(_ subject: Any) {
self.subject = subject
self.mirror = Mirror(reflecting: subject)
}
subscript(dynamicMember member: String) -> Any? {
for child in mirror.children {
if child.label == member {
return child.value
}
}
return nil
}
}
// Usage
let person = Person(name: "Bob", age: 25)
let reflective = ReflectiveObject(person)
print(reflective.name) // Optional("Bob")
print(reflective.age) // Optional(25)
This gives you a live, dynamic view of any object's properties without knowing them at compile time. You can even extend it to support mutation by adding a setter subscript, provided the underlying object is a class with mutable properties.
Tips for Effective Metaprogramming
- Performance Consideration: Reflection is not free.
Mirrorcreation and iteration are relatively slow compared to direct property access. Use it only where the flexibility justifies the cost—for example in debugging tools, UI bindings, or serialization frameworks. - Debugging: When using
@dynamicMemberLookup, enable compiler warnings about missing members. The attribute can hide spelling errors, so always test thoroughly. - Maintainability: Over-reliance on metaprogramming can make code harder to understand. Document why you use reflection or dynamic lookup, and consider using it only for infrastructure that other developers don't need to modify frequently.
- Safety: Always handle optional values returned by dynamic member subscripts. Use
guardor optional binding to avoid unexpected nil crashes. - Combine with Protocols: For static typing enthusiasts, you can still benefit from metaprogramming by defining protocols that your dynamic types conform to, ensuring a contract while retaining runtime flexibility.
By mastering these techniques, you'll unlock a new dimension of Swift programming—one where your code can adapt and introspect at runtime, making it ideal for tools, libraries, and dynamic environments.