Weak references to break cycles in Swift

Introduction

Sometimes two objects keep each other alive by holding strong references. This causes a memory problem called a cycle. Weak references help stop this by not keeping the other object alive.

When two objects refer to each other and you want to avoid memory leaks.

When you have a parent-child relationship and the child should not keep the parent alive.

When you want to allow one object to disappear even if another still points to it.

When managing delegate patterns where the delegate should not be strongly held.

When breaking cycles in closures that capture self.

Syntax

Swift

class SomeClass {
    weak var otherObject: OtherClass?
}

Use the weak keyword before the variable to make it a weak reference.

Weak references must be optional because the referenced object can disappear (become nil).

Examples

The Person class has a weak reference to Apartment to avoid a cycle.

Swift

class Person {
    var name: String
    weak var apartment: Apartment?
    init(name: String) {
        self.name = name
    }
}

The Apartment class has a strong reference to Person.

Swift

class Apartment {
    let unit: String
    var tenant: Person?
    init(unit: String) {
        self.unit = unit
    }
}

Here, john and unit4A refer to each other, but john.apartment is weak, so no cycle occurs.

Swift

let john = Person(name: "John")
let unit4A = Apartment(unit: "4A")
john.apartment = unit4A
unit4A.tenant = john

Sample Program

This program creates a Person and an Apartment that refer to each other. The Person holds a weak reference to the Apartment. When both variables are set to nil, both objects are properly cleaned up because there is no strong cycle.

Swift

class Person {
    let name: String
    weak var apartment: Apartment?
    init(name: String) {
        self.name = name
        print("Person \(name) is created")
    }
    deinit {
        print("Person \(name) is being deinitialized")
    }
}

class Apartment {
    let unit: String
    var tenant: Person?
    init(unit: String) {
        self.unit = unit
        print("Apartment \(unit) is created")
    }
    deinit {
        print("Apartment \(unit) is being deinitialized")
    }
}

var john: Person? = Person(name: "John")
var unit4A: Apartment? = Apartment(unit: "4A")
john!.apartment = unit4A
unit4A!.tenant = john

john = nil
unit4A = nil

Important Notes

Weak references do not increase the reference count of the object.

If the referenced object is deallocated, the weak reference automatically becomes nil.

Use unowned references only when you are sure the referenced object will never be nil during the lifetime of the reference.

Summary

Weak references help avoid memory cycles by not keeping objects alive.

They must be optional because the object they point to can disappear.

Use weak references in relationships where one object should not own the other strongly.

Practice

1. What is the main purpose of using weak references in Swift?

easy

A. To increase the performance of the program by caching values

B. To prevent strong reference cycles and allow objects to be deallocated

C. To make variables constant and unchangeable

D. To create multiple copies of an object automatically

Solution

1. Step 1: Understand what strong reference cycles are

   Strong reference cycles happen when two objects hold strong references to each other, preventing deallocation.

2. Step 2: Role of weak references

   Weak references do not increase the reference count, so they help break these cycles and allow memory to be freed.

3. Final Answer:

   To prevent strong reference cycles and allow objects to be deallocated -> Option B

4. Quick Check:

   Weak references prevent cycles = C [OK]

Hint: Weak references avoid memory cycles by not owning objects [OK]

Common Mistakes:

• Thinking weak makes variables constant
• Confusing weak with performance optimization
• Assuming weak creates copies

2. Which of the following is the correct syntax to declare a weak reference to an instance of class Person in Swift?

easy

A. weak var friend: Person?

B. weak let friend: Person?

C. weak var friend: Person

D. var weak friend: Person?

Solution

1. Step 1: Understand weak reference syntax

   Weak references must be declared with weak var and must be optional because the referenced object can be nil.

2. Step 2: Check each option

   weak var friend: Person? uses weak var friend: Person?, which is correct syntax.

3. Final Answer:

   weak var friend: Person? -> Option A

4. Quick Check:

   Weak references use 'weak var' and optional type = A [OK]

Hint: Weak references are always optional vars [OK]

Common Mistakes:

• Using 'let' with weak
• Not making the type optional
• Placing 'weak' after 'var'

3. Consider the following Swift code snippet:

class Owner {
    var pet: Pet?
}

class Pet {
    weak var owner: Owner?
}

let owner = Owner()
let pet = Pet()
owner.pet = pet
pet.owner = owner

print(owner.pet!.owner! === owner)

What is the output of this code?

medium

A. nil

B. false

C. true

D. Compilation error

Solution

1. Step 1: Understand the references

   The Owner has a strong reference to Pet, and Pet has a weak reference back to Owner.

2. Step 2: Evaluate the print statement

   The expression owner.pet!.owner! === owner checks if the pet's owner is the same instance as owner. Since pet.owner weakly references owner, this is true.

3. Final Answer:

   true -> Option C

4. Quick Check:

   Weak reference points back correctly = true [OK]

Hint: Weak references still point to original object if alive [OK]

Common Mistakes:

• Thinking weak reference becomes nil immediately
• Confusing identity check with equality
• Expecting compilation error due to weak

4. Given the following code, why does it cause a strong reference cycle?

class A {
    var b: B?
}

class B {
    var a: A?
}

let a = A()
let b = B()
a.b = b
b.a = a

How can you fix this cycle?

medium

A. Change a in class B to a weak reference

B. Change b in class A to a weak reference

C. Make both references strong

D. Use unowned for both references

Solution

1. Step 1: Identify the cycle

   Class A holds a strong reference to B, and B holds a strong reference back to A, causing a cycle.

2. Step 2: Break the cycle with weak reference

   Changing the reference from B to A to weak var a: A? breaks the cycle because B no longer strongly owns A.

3. Final Answer:

   Change a in class B to a weak reference -> Option A

4. Quick Check:

   Break cycle by making one side weak = D [OK]

Hint: Make one side weak to break cycles [OK]

Common Mistakes:

• Making both references weak (loses ownership)
• Making the wrong reference weak
• Using unowned incorrectly causing crashes

5. You have two classes, Teacher and Student, where each Teacher has many Students and each Student has one Teacher. How should you declare the references to avoid strong reference cycles?

hard

A. Teacher holds weak references to Students; Student holds a strong reference to Teacher

B. Both hold weak references

C. Both hold strong references

D. Teacher holds strong references to Students; Student holds a weak reference to Teacher

Solution

1. Step 1: Analyze ownership

   A Teacher owns many Students, so it should hold strong references to them.

2. Step 2: Avoid cycle by weak reference

   Each Student should hold a weak reference back to its Teacher to avoid a strong cycle.

3. Final Answer:

   Teacher holds strong references to Students; Student holds a weak reference to Teacher -> Option D

4. Quick Check:

   Owner strong, back weak = B [OK]

Hint: Owner holds strong, back reference is weak [OK]

Common Mistakes:

• Making owner reference weak
• Making both references strong causing cycles
• Making both references weak losing ownership