Golang context 이해하기

Go, Context

Context란?

Package context defines the Context type, which carries deadlines, cancellation signals, and other request-scoped values across API boundaries and between processes.

위는 공식 문서에 나와있는 표현으로, 이에 따르면 context는 API와 프로세스 경계에서 기한, 취소 신호, 요청 범위의 값들을 전달한다. 우리가 어떤 API를 호출하거나, 새로운 goroutine을 생성하여 작업을 수행할 때 context를 통해서 호출이 완료되어야 하는 기한을 명시할 수도 있고, 요청했던 작업을 취소할 수도 있으며, 특정 값을 전달할 수도 있다.

Context 인터페이스

Context는 인터페이스이고, 다음과 같은 네 가지 메서드로 구성되어 있다.

type Context interface {
    Deadline() (deadline time.Time, ok bool)
    Done() <-chan struct{}
    Err() error
    Value(key interface{}) interface{}
}

각 메서드는 다음과 같은 기능을 한다.

메서드 기능
Deadline() 해당 컨텍스트에서 수행되는 작업이 취소되어야 하는 시각(time.Time)을 반환한다. 기한이 없는 경우에는 ok==false를 반환한다.
Done() 해당 컨텍스트가 취소될 때 닫히는 채널을 반환한다. 취소되지 않는 컨텍스트의 경우에는 nil이 반환된다.
Err() Done() 채널이 아직 닫히지 않았으면, nil을 반환하고, 닫히지 않았다면 왜 닫혔는지를 설명하는 error가 반환된다. 에러 메시지는 "Canceled if the context was canceled" 또는 "DeadlineExceeded if the context's deadline passed." 둘 중에 하나이다.
Value() 해당 컨텍스트에서 키와 연관된 값을 반환한다. 연관된 값이 없는 경우 nil을 반환한다.

Context 구현

context 패키지는 Context 인터페이스 뿐 아니라, 다음과 같은 Context 구현 메서드들을 제공한다.

context.Background()

빈 Context를 반환한다. 이 함수로 생성된 Context 객체는 기한도, 값도 없고 취소되지도 않는다. 이 메서드는 탑레벨의 Context를 생성하는데 사용된다. 뒤에 가서 보게 되겠지만 context.TODO()를 제외한 다른 Context 생성 함수들은 부모 Context에 파생되어 생성된다. context.Background()는 부모가 없는, 즉 루트 Context를 생성하기 때문에 탑레벨 Context라고 하는 것이다.

Background() --- WithValue() --- WithCancel
              |
              `- WithTimeout()

context.TODO()

context.Background()와 동일하게 기한, 값이 없고 취소되지 않는 빈 Context를 반환한다. 소스 코드를 들어가서 보면 실제로 context.Background()와 동일하게 emptyContext 객체를 반환하는 것을 볼 수 있다. 따라서 context.Background()를 써야할 곳에 context.TODO()를 써도 동일하게 동작할 것이다. 하지만 이름에서 알 수 있듯 이 함수는 Context를 쓰긴 해야 하지만 어떻게 써야할지 확실치 않은 곳에 써야한다.

context.WithValue(Context, key, val interface{}) (ctx Context)

부모 Context에서 파생되어, {key, val} 쌍을 저장하는 자식 Context를 반환한다. 저장된 값은 Value(key interface{}) 메서드로 읽어올 수 있다.

ctx := context.WithValue(context.Background(), "foo", "bar")
fmt.Println(ctx.Value("foo")) // "bar"

쓰임새는 맵과 비슷하지만, 값을 읽어오는 과정은 맵과는 다르다. Value(key interface{}) 메서드는 현재 Context에 찾는 key에 해당하는 값이 없으면 부모 Context를 하나씩 거슬러 올라가면서 값을 찾는다. 끝내 값을 찾지 못하면 nil이 반환되고, 값을 찾으면 해당 값이 반환된다.

// ctx1{1:a} --- ctx2{2:b}
//            |
//            `- ctx3{3:c}
ctx1 := context.WithValue(context.Background(), 1, "a")
ctx2 := context.WithValue(ctx1, 2, "b")
ctx3 := context.WithValue(ctx1, 3, "c")
fmt.Println(ctx2.Value(1)) // "a"
fmt.Println(ctx2.Value(2)) // "b"
fmt.Println(ctx3.Value(1)) // "a"
fmt.Println(ctx3.Value(2)) // <nil>
fmt.Println(ctx3.Value(3)) // "c"

위 예제에서 ctx1은 ctx2, ctx3의 부모이기 때문에 ctx2, ctx3 모두 1에 연관된 값 "a"를 가져올 수 있다. 하지만 ctx3에서부터 거슬러 올라갈 때는 2 키에 해당하는 값이 없기 때문에 nil이 반환된다.

context.WithCancel(Context) (Context, CancelFunc)

부모 Context에서 파생된 취소 가능한 Context 객체와 취소 함수를 반환한다. 취소가 가능한 Context이기 때문에 Done() 함수는 nil 이 아닌 채널을 반환한다. 이 Done 채널은 취소 함수가 호출되거나 부모 Context의 Done 채널이 닫히면 닫힌다. 연관된 자원을 해제하기 위해서, 작업을 해제하는 즉시 CancelFunc를 호출해야한다. 공식 문서의 이 예제는 취소 함수를 호출하여 goroutine 누수를 막는 것을 보여준다.

context.WithDeadline(context.Context, time.Time) (Context, CancelFunc)

부모 Context에서 파생된 취소 가능하며, 지정된 시간에 자동으로 취소되는 Context 객체를 반환한다. WithCancel()과 마찬가지로 취소 함수도 함께 반환된다. 기한이 지나면 자동으로 취소되기는 하지만, 자원을 빠르게 해제하기 위해서 작업 종료 후에 취소 함수를 호출해야 한다.

context.WithTimeout(context.Context, time.Duration) (Context, CancelFunc)

WithDeadline()과 동일하지만 기한(e.g. 2021-10-03 00:00:00 을 받는 것이 아닌 기한까지 남은 시간(e.g. 5 minutes)을 받는다.

References

https://pkg.go.dev/context

Go, Context