cache

README

Кэш.

Компонент для кэширования данных, с возможностью подключения к разным кэширующим системам. Реализует интерфейс cache.CacheInterface[[]byte], который доступен в контейнере объектов.

Список доступных драйверов:

• Gocache;
• Memcached;
• Redis.

Объект конфигурации.

type Config struct {
	Driver     string
	Expiration time.Duration
}

Описание полей:

Поле	Описание	Значение по умолчанию	Доступные значения
Driver	Имя драйвера кэширующей системы, который следует использовать, этот параметр может быть передан одним из 3-х методов: - флаг командной строки --cache.driver - переменная окружения CACHE_DRIVER - значение в конфиг файле cache.driver	app	- app - Gocache; - memcached - Memcached; - redis - Redis.
Expiration	Время хранения записи по умолчанию, этот параметр может быть передан одним из 3-х методов: - флаг командной строки --cache.expiration - переменная окружения CACHE_EXPIRATION - значение в конфиг файле cache.expiration	5 минут

Documentation

Index

• Constants
• Variables
• func New[T any](config *Config, appConfig *app.Config, informer logger.Informer, ...) (cache.CacheInterface[T], error)
• func NewWithConfigurator[T any](config *Config, configurator configurator.Configurator, appConfig *app.Config, ...) (cache.CacheInterface[T], error)
• type Config
  • func Configuration(config *Config, configurator configurator.Configurator) *Config
  • func NewConfig() *Config
• type ReConfiguration
  • func NewReConfiguration(informer logger.Informer, appConfig *app.Config, container container.Container, ...) (*ReConfiguration[[]byte], error)
  • func NewReConfigurationWithConfigurator(informer logger.Informer, appConfig *app.Config, container container.Container, ...) (*ReConfiguration[[]byte], error)
  • func (reConfiguration *ReConfiguration[T]) Cache() cache.CacheInterface[T]
  • func (reConfiguration *ReConfiguration[T]) Clear(ctx context.Context) error
  • func (reConfiguration *ReConfiguration[T]) Delete(ctx context.Context, key any) error
  • func (reConfiguration *ReConfiguration[T]) Get(ctx context.Context, key any) (T, error)
  • func (reConfiguration *ReConfiguration[T]) GetType() string
  • func (reConfiguration *ReConfiguration[T]) Invalidate(ctx context.Context, options ...store.InvalidateOption) error
  • func (reConfiguration *ReConfiguration[T]) ReConfiguration(c configurator.Configurator) error
  • func (reConfiguration *ReConfiguration[T]) Set(ctx context.Context, key any, object T, options ...store.Option) error

Constants

const (
	DriverFieldName     = "cache.driver"
	ExpirationFieldName = "cache.expiration"

	GoCacheDriver   = "app"
	RedisDriver     = "redis"
	MemcachedDriver = "memcached"

	DriverDefault     = GoCacheDriver
	ExpirationDefault = 5 * time.Minute
)

Variables

var Component = &app.Component{
	Dependencies: app.Components{
		logger.Component,
		configurator.Component,
		reConfiguration.Component,
		gocache.Component,
		memcached.Component,
		redis.Component,
		info.Component,
	},
	Constructor: func(container container.Container) error {
		return container.Provides(
			NewConfig,
			NewReConfigurationWithConfigurator,
			func(reConfiguration *ReConfiguration[[]byte]) cache.CacheInterface[[]byte] { return reConfiguration },
		)
	},
	BindFlags: func(flagSet *pflag.FlagSet, container container.Container) error {
		return container.Invoke(func(config *Config) {
			flagSet.StringVar(&config.Driver, DriverFieldName, DriverDefault, fmt.Sprintf(
				"cache driver. Available drivers: "+
					"%s - stores data in application memory; "+
					"%s - stores data in redis; "+
					"%s - stores data in memcached.",
				GoCacheDriver,
				RedisDriver,
				MemcachedDriver,
			))
			flagSet.DurationVar(&config.Expiration, ExpirationFieldName, ExpirationDefault, "default data retention time")

		})
	},
	Run: func(c container.Container) error {
		cache, err := container.Get[*ReConfiguration[[]byte]](c)
		if err != nil {
			return err
		}

		reConfiguration, err := container.Get[configurator.ReConfiguration](c)
		if err != nil {
			return err
		}

		informer, err := container.Get[logger.Informer](c)
		if err != nil {
			return err
		}

		reConfiguration.Registration(cache)
		informer.Info("cache: registration in the reConfigurator")

		info, err := container.Get[info.Info](c)
		if err != nil {
			return err
		}

		config, err := container.Get[*Config](c)
		if err != nil {
			return err
		}

		info.Registration("cache", config)

		return nil
	},
}

Functions

func New

func New[T any](config *Config, appConfig *app.Config, informer logger.Informer, container container.Container) (cache.CacheInterface[T], error)

func NewWithConfigurator

func NewWithConfigurator[T any](
	config *Config,
	configurator configurator.Configurator,
	appConfig *app.Config,
	informer logger.Informer,
	container container.Container,
) (cache.CacheInterface[T], error)

Types

type Config

type Config struct {
	Driver     string
	Expiration time.Duration
}

func Configuration

func Configuration(config *Config, configurator configurator.Configurator) *Config

func NewConfig

func NewConfig() *Config

type ReConfiguration

type ReConfiguration[T any] struct {
	// contains filtered or unexported fields
}

func NewReConfiguration

func NewReConfiguration(informer logger.Informer, appConfig *app.Config, container container.Container, config *Config) (*ReConfiguration[[]byte], error)

func NewReConfigurationWithConfigurator

func NewReConfigurationWithConfigurator(informer logger.Informer, appConfig *app.Config, container container.Container, config *Config, configurator configurator.Configurator) (*ReConfiguration[[]byte], error)

func (*ReConfiguration[T]) Cache

func (reConfiguration *ReConfiguration[T]) Cache() cache.CacheInterface[T]

func (*ReConfiguration[T]) Clear

func (reConfiguration *ReConfiguration[T]) Clear(ctx context.Context) error

func (*ReConfiguration[T]) Delete

func (reConfiguration *ReConfiguration[T]) Delete(ctx context.Context, key any) error

func (*ReConfiguration[T]) Get

func (reConfiguration *ReConfiguration[T]) Get(ctx context.Context, key any) (T, error)

func (*ReConfiguration[T]) GetType

func (reConfiguration *ReConfiguration[T]) GetType() string

func (*ReConfiguration[T]) Invalidate

func (reConfiguration *ReConfiguration[T]) Invalidate(ctx context.Context, options ...store.InvalidateOption) error

func (*ReConfiguration[T]) ReConfiguration

func (reConfiguration *ReConfiguration[T]) ReConfiguration(c configurator.Configurator) error

func (*ReConfiguration[T]) Set

func (reConfiguration *ReConfiguration[T]) Set(ctx context.Context, key any, object T, options ...store.Option) error