Skip to content

Latest commit

 

History

History
146 lines (136 loc) · 7.55 KB

File metadata and controls

146 lines (136 loc) · 7.55 KB

Понятие контекста (context) в Go

Что такое контекст вообще? Это совокупность обстоятельств, которые окружают субъект в определённый момент времени. Например, X не отстаёт от моды, или Y отслеживает финансовые рынки. Если говорить о коде, то мы можем задать набор параметров для функций, и передавать туда конкретные значения текущего состояния программы. Но, когда у нас несколько разных функций, которым нужно передать тот же самый набор параметров, то напрашивается обобщение - контекст выполнения программы. Принцип KISS & DRY. В Go очень часто применяется контекст для ослеживания сигнала на завершение программы. А так же для передачи каких-либо других параметров состояния по иерархии вызова функций. Например, очередь в кассу обрабатывается до крайнего покупателя, который дальше сообщает "попросили за мной не занимать".

Зачем контекст

  • Получение дедлайна - Deadline
  • Синхронизация при помощи каналов - Done
  • Получение причины завершения - Err
  • Хранение произвольных данных - Value

Интерфейс

// A Context carries a deadline, a cancellation signal, and other values across
// API boundaries.
//
// Context's methods may be called by multiple goroutines simultaneously.
type Context interface {
	// Deadline возвращает время, когда работа, выполняемая на основе этого контекста, должна быть отменена. Deadline возвращает ok==false, когда не установлено время ожидания. Последовательные вызовы Deadline возвращают одинаковые результаты.

	// Deadline returns the time when work done on behalf of this context
	// should be canceled. Deadline returns ok==false when no deadline is
	// set. Successive calls to Deadline return the same results.
	Deadline() (deadline time.Time, ok bool)

	// Done возвращает канал, который закрывается, когда необходимо отменить работу,
	// выполненную на основе этого контекста. Done может вернуть nil, если этот
	// контекст никогда не может быть отменен. Последующие вызовы Done возвращают
	// то же значение. Закрытие канала Done может произойти асинхронно, после
	// вызова функции отмены.
	//
	// WithCancel организует закрытие канала Done при вызове функции отмены;
	// WithDeadline организует закрытие канала Done при истечении срока
	// действия; WithTimeout организует закрытие канала Done при истечении
	// таймера.
	//
	// Done предоставляется для использования в операторах select:
	//
	//   // Stream генерирует значения с помощью DoSomething и отправляет их в
	//   // out, пока DoSomething не вернет ошибку или ctx.Done не будет закрыт.
	//   func Stream(ctx context.Context, out chan<- Value) error {
	//   	for {
	//   		v, err := DoSomething(ctx)
	//   		if err != nil {
	//   			return err
	//   		}
	//   		select {
	//   		case <-ctx.Done():
	//   			return ctx.Err()
	//   		case out <- v:
	//   		}
	//   	}
	//   }
	//
	// Смотрите https://blog.golang.org/pipelines для дополнительных примеров того,
	// как использовать канал Done для отмены.

	// Done returns a channel that's closed when work done on behalf of this
	// context should be canceled. Done may return nil if this context can
	// never be canceled. Successive calls to Done return the same value.
	// The close of the Done channel may happen asynchronously,
	// after the cancel function returns.
	//
	// WithCancel arranges for Done to be closed when cancel is called;
	// WithDeadline arranges for Done to be closed when the deadline
	// expires; WithTimeout arranges for Done to be closed when the timeout
	// elapses.
	//
	// Done is provided for use in select statements:
	//
	//  // Stream generates values with DoSomething and sends them to out
	//  // until DoSomething returns an error or ctx.Done is closed.
	//  func Stream(ctx context.Context, out chan<- Value) error {
	//  	for {
	//  		v, err := DoSomething(ctx)
	//  		if err != nil {
	//  			return err
	//  		}
	//  		select {
	//  		case <-ctx.Done():
	//  			return ctx.Err()
	//  		case out <- v:
	//  		}
	//  	}
	//  }
	//
	// See https://blog.golang.org/pipelines for more examples of how to use
	// a Done channel for cancellation.
	Done() <-chan struct{}

	// If Done is not yet closed, Err returns nil.
	// If Done is closed, Err returns a non-nil error explaining why:
	// Canceled if the context was canceled
	// or DeadlineExceeded if the context's deadline passed.
	// After Err returns a non-nil error, successive calls to Err return the same error.
	Err() error

	// Value returns the value associated with this context for key, or nil
	// if no value is associated with key. Successive calls to Value with
	// the same key returns the same result.
	//
	// Use context values only for request-scoped data that transits
	// processes and API boundaries, not for passing optional parameters to
	// functions.
	//
	// A key identifies a specific value in a Context. Functions that wish
	// to store values in Context typically allocate a key in a global
	// variable then use that key as the argument to context.WithValue and
	// Context.Value. A key can be any type that supports equality;
	// packages should define keys as an unexported type to avoid
	// collisions.
	//
	// Packages that define a Context key should provide type-safe accessors
	// for the values stored using that key:
	//
	// 	// Package user defines a User type that's stored in Contexts.
	// 	package user
	//
	// 	import "context"
	//
	// 	// User is the type of value stored in the Contexts.
	// 	type User struct {...}
	//
	// 	// key is an unexported type for keys defined in this package.
	// 	// This prevents collisions with keys defined in other packages.
	// 	type key int
	//
	// 	// userKey is the key for user.User values in Contexts. It is
	// 	// unexported; clients use user.NewContext and user.FromContext
	// 	// instead of using this key directly.
	// 	var userKey key
	//
	// 	// NewContext returns a new Context that carries value u.
	// 	func NewContext(ctx context.Context, u *User) context.Context {
	// 		return context.WithValue(ctx, userKey, u)
	// 	}
	//
	// 	// FromContext returns the User value stored in ctx, if any.
	// 	func FromContext(ctx context.Context) (*User, bool) {
	// 		u, ok := ctx.Value(userKey).(*User)
	// 		return u, ok
	// 	}
	Value(key any) any
}