[Swift] defer를 어떻게 써야 잘 썼다고 소문이 날까

공부를 하다보면 꼭 한 번씩 마주치게 되는 defer... 하지만 평소에 거의 쓸 일이 없었어서 개념에 대한 이해도 부족 & 그래서 진짜로 어떻게 쓰는건데 ?!?! 하는 궁금증으로 다시 defer에 대해 알아보기로 했습니다 🤔

defer란?

defer {
    <#statements#>
}

다음과 같은 형태를 띄고 있는 defer 구문 안에는 현재 코드 블록을 나가기 전에 꼭 실행해야되는 코드를 작성하여 코드가 블록을 어떻게 빠져나가든 꼭 마무리해야되는 작업을 할 수 있게 도와줄 수 있습니다.

 

코드 블록을 빠져나가게 되는 경우는 1) return 2) 에러 throw 3) 코드 블록의 끝을 만났을 때 이렇게 있다고 생각하는데 defer는 코드 블록을 빠져나가는 조건, 이유에 상관없이 늘 실행됩니다. 

defer의 주 사용 목적

주로 리소스 정리 및 오류 처리에 유용하게 사용됩니다.

 

대표적인 예시로는 NSLock(Dead Lock을 해결할 수 있는 방법들 중 하나)을 사용할 때가 있습니다.

서로 다른 스레드에서 하나의 리소스에 접근하여 변경하는 것을 막기 위해 사용할 때 lock을 걸고 사용이 끝나면 unlock을 호출해야합니다.

이때 unlock 메서드를 defer 구문에 작성해줘서 코드 블록을 빠져나갈 때 항상 unlock 메서드가 꼭 호출돼서 데드락 현상이 발생하는 것을 예방할 수 있습니다!

 

보다 간단한 예시를 통해 이해해볼게요! 함수 내에서 파일을 열어 사용하는 상황이 있다고 가정해봅시다. 파일을 사용하던 중 오류가 발생해서 코드 블록을 빠져나가야할 때 파일을 정상적으로 닫아 메모리에서 해제해줘야합니다. 이런 내용을 defer에 구현하면 유용하게 사용할 수 있습니다!

defer를 사용하지 않은 경우와 사용하는 경우를 코드로 한 번 볼게요!

func writeData() {
	let file = openFile()

	if ... {
		closeFile(file)
		return
	}
	
	if ... {
		closeFile(file)
		return
	}
}

만약 defer를 사용하지 않는다면 ….. 중복 코드가 계속 발생하게 됩니다. return 혹은 throw 전에는 반드시 closeFile 메서드를 실행해야 하기 때문이죠. 그리고 유지 관리도 어렵구 코드가 길어지면 closeFile을 까먹을지도 … 더헉.

func writeData() {
	let file = openFile()
	
	defer {
		closeFile(file)
	}
	
	if ... { return }
	
	if ... { return }
}

하지만 이렇게 defer에 closeFile 메서드를 한 번 작성해주기만 하면 해당 writeData 코드 블록을 벗어날때마다 defer가 실행된다는 것을 한 눈에 확인하기도 쉽고 코드도 훨씬 간편해지죠!

특징

• 현재 코드 범위를 벗어나기 전까지 실행을 미루다가 프로그램 흐름이 코드 범위를 벗어나기 직전에 실행됩니다.
• 한 코드 범위에 여러 defer가 작성돼있으면 맨 마지막에 작성된 구문부터 역순으로 진행됩니다.

아래의 예시를 통해서 defer의 특징에 대해 조금 더 알아봅시당 !

for i in 0...2 {
	defer {
		print("A", terminator: " ")
	}
	print(i, terminator: " ")
	
    // if문도 하나의 코드 블록이겠죠?
	if i % 2 == 0 {
		defer {
			print("", terminator: "\\n")
		}
		
		print("It's even", terminator: " ")
	}
}
// 0 It's even
// A 1 A 2 It's even
// A

먼저 for문이라는 가장 큰 하나의 코드 블록이 있고 i가 0인 상황부터 시작됩니다.

시작하자마자 defer문을 만나면 해당 클로저를 스택에 하나씩 쌓는다고 생각해볼게요!

지금 defer 스택에는 print("A", terminator: " ")가 하나 쌓였습니다!

 

다음 프린트 문에 따라 "0"이 프린트 되고 if문을 만나게 됩니다. 

0 % 2 == 0 이기 때문에 if문 안을 들여다보면 defer가 또 있죠! 하지만 이때 for문과 if문은 별개의 코드 블록이기 때문에 이전에 쌓아둔 defer 스택과는 다른 새로운 스택에 print("", terminator: "\\n")을 쌓아줍니다.

그리고 "It's even"이 프린트되고 if문 코드블록을 빠져나가게 됩니다. 

코드 블록을 빠져나가면 defer문이 실행된다고 했으니 이때 새로운 if문 defer 스택에서 pop을 해줘서 가장 최근에 쌓인 print("", terminator: "\\n")가 실행되겠죠!

말로만 설명을 하려니 뭔가 좀 어렵고 복잡해보이는데... 🫠 그렇지 않다는거 !!

 

여기까지 오면 for문 코드블록도 한 번 빠져나가게 되겠죠? 그럼 처음에 쌓았던 defer 스택에서 pop을 해준 뒤 print("A", terminator: " ")를 실행해주게 됩니다!

그러면 현재는 여기까지 프린트가 된 상태입니다.

0 It's even
A

이런 식으로 두번 더 for문을 돌면 코드 하단의 결과를 확인할 수 있습니다.

 

처음에 defer가 역순으로 실행된다는게 뭔가 했는데  defer를 스택에 쌓아놨다가 하나씩 pop해서 실행시키는 느낌으로 이해를 하니 조금 더 감이 잘 오는 것 같더라구요! 참고하십쇼 👍

 

또 다른 defer의 특징들로는

• defer를 읽기 전에 함수가 종료되면 defer문은 실행되지 않는다.
• defer 코드 내부에는 break, return처럼 구분을 빠져나갈 수 있는 코드나 오류를 던지는 코드를 작성하면 안된다.
  애초에 두 개의 값을 리턴할 수 없을 뿐더러 이미 코드 블럭에서 빠져나와서 실행됐기 때문에 거기서 또 flow를 빠져나오려고 하는 것 자체가 말이 안되는 ? 상황이라고 저는 이해를 했습니다...🤔

• 코드 블록 내부에 또 한 단계 하위의 블록을 만들고자 할 때 do 구문을 catch 없이 단독으로도 사용할 수 있습니다.
  do block 종료 시 그 내부의 defer 구문이 실행되니 잘 사용하면 복잡한 flow 짤 때 사용해볼 수도 있을 것 같네요!

func someFunction() {
	print("1")
	
	defer {
		print("2")
	}
	
	do {
		defer {
			print("3")
		}
		
		print("4")
	}
	
	defer {
		print("5")
	}
	
	print("6")
}

someFunction()

// 1
// 4
// 3
// 6
// 5
// 2

• 중첩되는 경우 바깥 → 안 순서대로 실행됩니다.
  defer도 결국 하나의 코드 블럭이기 때문에 그 defer문을 벗어나야 내부 defer문이 실행되는 원리인듯?🤔

func deferExample3() {
	defer {
		print("example1")
		defer {
			print("example2")
		}
		print("example3")
	}
}

// example 1
// example 3
// example 2

근데 요렇게 코드 작성해서 돌리니까 scope의 끝에 있는 defer는 바로 실행되버리니까 첫번째 defer → do로 변경해라! 라는 경고문이 뜹니다 호오

print(”example3”)를 삭제하면 중첩돼있는 defer에도 똑같은 경고문이 뜨는 것을 볼 수 있습니다.

defer 뒤에 다른 내용이 없다 ? 그러면 어차피 defer가 가장 마지막에 실행되기 때문에 defer를 사용하는 의미가 없어서 do로 변경하라고 하는 것 같네요!

 

또 공식 문서를 읽다가 한 문장을 발견했는데 잘 와닿지 않아서 GPT한테 물어봤습니다 ㅎ😗

범위의 마지막 defer 구문을 먼저 실행한다는 것은 다른 defer 구문에 의해 정리될 리소스를 참조할 수 있다는 의미입니다.

 

이 문장에 대해 지피티에게 예시와 함께 설명해달라고 요청했을 때 받을 수 있었던 내용입니다.

func processFile(filename: String) {
    let file = openFile(filename)
    defer {
        closeFile(file)
    }

    let data = readFile(file)
    defer {
        releaseData(data)
    }

    // 파일 데이터 처리
}

1. closeFile(file): 파일을 닫는 작업. 함수의 마지막 부분에 실행되어야 합니다.
2. releaseData(data): 파일로부터 읽은 데이터를 해제하는 작업. 데이터 처리가 완료된 후 실행되어야 합니다.

이 순서는 파일을 닫은 후에 데이터를 해제하려고 시도하는 것을 방지합니다. 파일이 닫혔다면, 그 파일로부터 읽은 데이터에 접근하는 것이 더 이상 유효하지 않을 수 있기 때문입니다.

 

위 코드에서는 fileName으로 file을 열고, 거기서부터 데이터를 읽어오고 있습니다. 이때 코드 블럭을 빠져나가기 전, 1) 데이터 해제 2) 파일 닫기 이 두 가지 작업이 반드시 실행돼야합니다. 이때 두 작업은 서로에게 영향을 끼칠 수 있다고 판단이 됩니다. 

파일이 먼저 닫히면 그 데이터에 접근을 할 수 없을 수도 있기 때문이죠! 정확한 예시는 아닐 수 있지만 이와 같이 먼저 실행될 releaseData defer문은 마지막으로 실행될 defer문이 정리하고자 하는 file 변수로부터 받아온 데이터를 참조하고 있는걸 확인할 수 있습니다.

조금 헷갈릴만한 예시

func deferExample() -> String {
		var nickname = "콜리"
		
		// 함수 호출 후 return까지 끝난 다음에 호출됨
		// 스코프 끝, 함수 리소스 정리
		defer {
			nickname = "카레"
			print("defer")
			print(nickname)
		}
		
		return nickname
}

print(deferExample())

// defer
// 카레
// 콜리

내 예상은 콜리 defer 카레였는데 … defer까지 끝나야 메서드가 정말 끝나는거라서 return → defer → print문 실행 이렇게 되는 것 같다 일단 defer문 내부에서 값을 변경하더라도 return 값에는 영향을 끼치지 않는걸로.. .!
노우….. defer는 코드블록을 벗어나기 직전!!에 실행되기 때문에 defer 내용 실행 후..? 어..? return이 되는줄알았는데…? 만약 그렇게 되면 defer 카레 카레가 나와야하는데 그건 안 그렇네…왜 그렇지 🤔 ➡️ String이 일단 값 타입이기 때문에… 참조 타입이면 내가 말한대로 나올것같다! return과 코드 블록 벗어나기 직전은 타이밍이 다른가보다…밑의 글을 읽어보자…

이러한 의식의 흐름을 따라..따라 가다가..아래의 글을 만나서 defer의 실제 작동에 대해 더 알아보았습니다..🫠

아래의 글은 defer 작동 원리 및 순서에 대해 참고 정도로만 봐주세요!

How “defer” operator in Swift actually works

이 글을 번역한 이 글을 참고했습니다 🙇‍♀️

defer를 호출하고 새로운 값을 적용하기 전에 원래 값을 저장한다!

defer를 호출하는 것은 임시 변수에 기존 값을 넣어두고 기존 값에 변형을 일으키고 임시 변수를 리턴하는 것과 같은 로직이다.

따라서 아래의 두 함수는 내부 동작이 거의 동작하다고 한다!

var a = "Hello"

func b() -> String {
    defer { a.append(" world") }
    return a
}

var a = "Hello"

func c() -> String {
    let d = a
    a.append(" world")
    return d
}

 

 

옵셔널 값을 언래핑하는 과정은 조금 더 복잡하다 …

var a: String? = nil

func b() -> String {
    a = "Hello world"
    defer { a = nil }
    return a!
}

print(b()) // Hello world

 

여기서는 return a!에서 강제 언래핑하는 과정에서 a에 값이 있는 경우 defer를 중간에 실행하고 있다..! 싱기..

---

생각보다 간단한 줄 알았는데 생각보다 복잡했던 defer에 대해 알아보았습니다 ~ 🙋‍♀️