README
¶
yaaf-common
Common interfaces to YAAF (Yet Another Application Framework) library
About
This project is part of the complete Go application framework to provide wrapper and utilities for common middleware components required to create micro-services (servers and workers)
BaseConfig
Base utility to provide service configuration via environment variable.
Configuration using environment variables is quite common in container-orchestration frameworks (e.g. Docker, Kubernetes etc) and this utility provides a simple way to define and access application/service specific configuration parameters through accessors.
The basic implementation includes the fundamentals plus a pre-set of common configuration variables for web servers/worker. For each application/service you should write your own configuration utility inherit from this structure and add specific configuration variables.
IDatabase
Interface of object-relational database. It is used by concrete implementations of simple ORM over RDBMS ACID databases (e.g. PostgreSQL, MySQL...) Under the database folder you should find in memory implementation of IDatabase interface, used mainly for testing.
IDatastore
Interface of document database. It is used by concrete implementations of NoSQL Document oriented databases (e.g. Elasticsearch, Couchbase...). Under the database folder you should find in memory implementation of IDatastore interface, used mainly for testing.
IDataCache
Interface of a data structure cache. It is used by concrete implementations of distributed cache (e.g. Redis...). Under the database folder you should find in memory implementation of IDataCache interface, used mainly for testing.
IMessageBus
Interface of a messaging system (publish-subscribe and queueing messaging patterns). It is used by concrete implementations of messaging middleware (e.g. Kafka, Google PubSub, Redis...). Under the messaging folder you should find in memory implementation of IMessageBus interface, used mainly for testing.
Logger
Simple wrapper for zap logger used as system-wide logging framework
Utils
Collection of utility helpers
Adding dependency
$ go get -v -t github.com/go-yaaf/yaaf-common ./...
Publishing module
$ GOPROXY=proxy.golang.org go list -m github.com/go-yaaf/yaaf-common@v1.1.0
Directories
¶
| Path | Synopsis |
|---|---|
|
Package database
|
Package database |
|
Package entity Entity interface and base entity for all persistent model entities
|
Package entity Entity interface and base entity for all persistent model entities |
|
Package logger Logger implementation based on zap log package (https://github.com/uber-go/zap)
|
Package logger Logger implementation based on zap log package (https://github.com/uber-go/zap) |
|
Package utils provides a collection of utility functions, including helpers for making HTTP requests.
|
Package utils provides a collection of utility functions, including helpers for making HTTP requests. |
|
cache
Package cache Cache item implementation Based on https://github.com/ReneKroon/ttlcache
|
Package cache Cache item implementation Based on https://github.com/ReneKroon/ttlcache |
|
cache2
Package cache2 Cache item old implementation Based on https://github.com/ReneKroon/ttlcache
|
Package cache2 Cache item old implementation Based on https://github.com/ReneKroon/ttlcache |
|
collections
Package collections provides a thread-safe implementation of a FIFO (First-In, First-Out) queue data structure.
|
Package collections provides a thread-safe implementation of a FIFO (First-In, First-Out) queue data structure. |