Documentation
¶
Overview ¶
Package interfaces provides generic configuration interfaces that can be used across different applications.
Package interfaces defines the core configuration interfaces used throughout the application.
This package contains the fundamental interfaces that establish the contract for configuration access across the application. By defining these interfaces separately from their implementations, the package promotes loose coupling and enables dependency inversion.
The interfaces defined here are:
- AppConfig: For accessing application-specific configuration
- DatabaseConfig: For accessing database-specific configuration
- Config: A composite interface that provides access to both AppConfig and DatabaseConfig
These interfaces are designed to be implementation-agnostic, allowing different configuration sources (files, environment variables, remote services, etc.) to provide the same consistent access patterns.
Example usage:
// Using the Config interface
func InitializeApp(cfg interfaces.Config) {
appName := cfg.GetApp().GetName()
appVersion := cfg.GetApp().GetVersion()
dbConnStr := cfg.GetDatabase().GetConnectionString()
fmt.Printf("Initializing %s v%s\n", appName, appVersion)
fmt.Printf("Connecting to database: %s\n", dbConnStr)
}
The interfaces in this package are typically implemented by adapter types in the parent config package, but can be implemented by any type that satisfies the required methods.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AppConfig ¶
type AppConfig interface {
// GetVersion returns the application version
GetVersion() string
// GetName returns the application name
GetName() string
// GetEnvironment returns the application environment (e.g., "development", "production")
GetEnvironment() string
}
AppConfig is a generic interface for application configuration
type Config ¶
type Config interface {
// GetApp returns the application configuration
GetApp() AppConfig
// GetDatabase returns the database configuration
GetDatabase() DatabaseConfig
}
Config is a generic interface for application configuration
type DatabaseConfig ¶
type DatabaseConfig interface {
// GetType returns the database type (e.g., "mongodb", "postgres", "sqlite")
GetType() string
// GetConnectionString returns the database connection string
GetConnectionString() string
// GetDatabaseName returns the database name
GetDatabaseName() string
// GetCollectionName returns the collection/table name for a given entity type
GetCollectionName(entityType string) string
}
DatabaseConfig is a generic interface for database configuration
Source Files