gontainer

Gontainer

Dependency injection service container for Golang projects.

Features

• 🚀 Eager or lazy services instantiation with automatic dependencies resolution and optional dependencies support.
• 🛠 Automatic injection of dependencies for service factories, avoiding manual fetch through container API.
• 🔄 Automatic reverse-to-instantiation order for service termination to ensure proper resource release and shutdown.
• 📣 Built-in events broker service for inter-service container-wide communications and loose coupling between services.
• 🤖 Clean and tested implementation based on reflection and generics. No external dependencies.

Examples

• Console command example – demonstrates how to build a simple console command. It shows how to use Resolver and Invoker services to organize the application entry point in a run-and-exit style.

  12:51:32 Creating new service container
  12:51:32 Hello from the Hello Service Bob
  12:51:32 Hello from the Hello Service Bob
  12:51:32 Closing service container by defer
  12:51:32 Service container closed
  

• Daemon service example – demonstrates how to maintain background services. It shows how to organize a daemon entry point and wait for graceful shutdown by subscribing to OS termination signals.

  12:48:22 Creating service container instance
  12:48:22 Starting service container
  12:48:22 Starting listening on: http://127.0.0.1:8080
  12:48:22 Starting serving HTTP requests
  12:48:22 Awaiting service container done
  ------ Application was started and now accepts HTTP requests -------------
  ------ CTRL+C was pressed or a TERM signal was sent to the process -------
  12:48:28 Service container done chan closed
  12:48:28 Closing service container by defer
  12:48:28 Service container closed
  

• Complete webapp example – demonstrates how to organize web application with multiple services. It provides basic config service, handles logging, setups HTTP server and initiates two endpoints.

  15:19:48 INFO msg="Starting service container" service=logger
  15:19:48 INFO msg="Configuring app endpoints" service=app
  15:19:48 INFO msg="Configuring health endpoints" service=app
  15:19:48 INFO msg="Starting HTTP server" service=http address=127.0.0.1:8080
  15:19:48 INFO msg="Service container started" service=logger
  ------ Application was started and now accepts HTTP requests -------------
  15:19:54 INFO msg="Serving home page" service=app remote-addr=127.0.0.1:62640
  15:20:01 INFO msg="Serving health check" service=app remote-addr=127.0.0.1:62640
  ------ CTRL+C was pressed or a TERM signal was sent to the process -------
  15:20:04 INFO msg="Closing service container" service=logger
  15:20:04 INFO msg="Closing HTTP server" service=http
  15:20:04 INFO msg="Service container closed" service=logger
  

• Transient service example – demonstrates how to return a function that can be called multiple times to produce transient services.

  11:19:22 Creating new service container
  11:19:22 Starting service container
  11:19:22 New value: 42
  11:19:22 New value: 42
  11:19:22 New value: 42
  11:19:22 Closing service container by defer
  11:19:22 Service container closed
  

• Service function example – demonstrates how to define a service function that could be used to organize the application entry point.

  12:47:21 Creating new service container
  12:47:21 Starting service container
  12:47:21 Closing service container by defer
  12:47:21 Starting service function with 42
  12:47:21 Exiting from service function
  12:47:21 Service container closed
  

Quick Start

1. Define an example service.

   // MyService performs some crucial tasks.
   type MyService struct{}
   
   // SayHello outputs a friendly greeting.
   func (s *MyService) SayHello(name string) {
       log.Println("Hello,", name)
   }
   

2. Define a service factory.

   func NewMyService() *MyService {
      return new(MyService)
   }
   

3. Register service factories in the container.

   container, err := gontainer.New(
      // Define MyService factory in the container.
      gontainer.NewFactory(NewMyService),
   
      // Here we can define additional services depending on `*MyService`.
      // All dependencies are declared using factory function args.
      gontainer.NewFactory(func(service *MyService) {
         service.SayHello("Username")
      }),
   )
   if err != nil {
      log.Fatalf("Failed to init service container: %s", err)
   }
   

4. Start the container and launch all factories.

   if err := container.Start(); err != nil {
      log.Fatalf("Failed to start service container: %s", err)
   }
   

5. Alternatively to eager start with a Start() call it is possible to use Resolver or Invoker service. They will instantiate only the explicitly requested services and their transitive dependencies.

   var myService *MyService
   if err := container.Resolver().Resolve(&MyService); err != nil {
       log.Fatalf("Failed to resolve dependency: %s", err)
   }
   myService.DoSomething()
   

   or

   if err := container.Invoker().Invoke(func(myService *MyService) {
       myService.DoSomething()
   }); err != nil {
       log.Fatalf("Failed to invoke a function: %s", err)
   }
   

   Resolver and Invoker could also serve as an entry point to the application, especially when it's a simple console tool that runs a task and exits. The console command example demonstrates this approach.

Key Concepts

Service Factories

The Service Factory is a key component of the service container, serving as a mechanism for creating service instances. A service factory is essentially a function that accepts other services as arguments and returns one or more service instances, optionally along with an error. Using service factory signature, the service container will resolve and spawn all dependency services using reflection and fail, if there are unresolvable dependencies.

// MyServiceFactory is an example of a service factory.
func MyServiceFactory( /* service dependencies */) *MyService {
   // Initialize service instance.
   return new(MyService)
}

// MyServiceFactory depends on two services.
func MyServiceFactory(svc1 MyService1, svc2 MyService2) MyService {...}

// MyServiceFactory provides two services.
func MyServiceFactory() (MyService1, MyService2) {...}

// MyServiceFactory provides two services and return an error.
func MyServiceFactory() (MyService1, MyService2, error) {...}

// MyServiceFactory returns only an error.
func MyServiceFactory() error {...}

// MyServiceFactory provides nothing.
func MyServiceFactory() {...}

The factory function's role is to perform any necessary initializations and return a fully-configured service instance to the container.

There are several predefined by container service types that may be used as a dependencies in the factory arguments.

1. The context.Context service provides the per-service context, inherited from the background context. This context is cancelled right before the service's Close() call and intended to be used with service functions.
2. The gontainer.Events service provides the events broker. It can be used to send and receive events inside service container between services or outside from the client code. Thread safe.
3. The gontainer.Resolver service provides a service to resolve dependencies dynamically. Thread safe.
4. The gontainer.Invoker service provides a service to invoke functions dynamically. Thread safe.

Transient Service Factories

In the service container all factories are singletons by design: they are called exactly once (with the container.Start()) or zero-or-once (without start but via resolver.Resolve() or invoker.Invoke() calls) times. But sometimes it is necessary to create new service instance calling the factory multiple times, for example, to create a new service for each HTTP request. To achieve this, the service factory can return a function (this function will be still in the single instance) that produces a new service instance each time it is called and other factories could depend on this function by its type.

container, err := gontainer.New(
    // Return new function from the factory.
	// It will produce new values each time.
    gontainer.NewFactory(func() func() int {
        return func() int { 
			return 42
		}
    }),

    // Depend on the function returned from the first factory.
	// It will be called three times, producing three new values.
    gontainer.NewFactory(func(funcFromFactory1 func() int) {
        fmt.Println(funcFromFactory1())
        fmt.Println(funcFromFactory1())
        fmt.Println(funcFromFactory1())
    }),
)

Optional Dependency Declaration

The gontainer.Optional[T] type allows to depend on a type that may or may not be present. For example, when developing a factory that uses a telemetry service, this type can be used if the service is registered in the container. If the telemetry service is not registered, this is not considered an error, and telemetry initialization can be skipped in the factory.

// MyServiceFactory optionally depends on the service.
func MyServiceFactory(optService1 gontainer.Optional[MyService1]) {
    // Get will not produce any error if the MyService1 is not registered
    // in the container: it will return zero value for the service type.
    service := optSvc1.Get()
}

Multiple Dependencies Declaration

The gontainer.Multiple[T] type allows retrieval of all services that match the type T. This feature is intended to be used when providing concrete service types from multiple factories (e.g., struct pointers like *passwordauth.Provider, *tokenauth.Provider) and depending on them as services Multiple[IProvider]. In this case, the length of the services slice could be in the range [0, N].

If a concrete non-interface type is specified in T, the slice can have at most one element. The container restricts the registration of the same non-interface type more than once.

// MyServiceFactory depends on all services implementing the interface.
func MyServiceFactory(servicesSlice gontainer.Multiple[MyInterface]) {
    for _, service := range servicesSlice {
        service.DoSomething()
    }
}

Services

A service is a functional component of the application, created and managed by a Service Factory. The lifetime of a service is tied to the lifetime of the entire container.

A service may optionally implement a Close() error or just Close() method, which is called when the container is shutting down. The Close call is synchronous: remaining services will not be closed until this method returns.

// MyService defines example service.
type MyService struct {}

// SayHello is service domain method example. 
func (s *MyService) SayHello(name string) {
    fmt.Println("Hello,", name)
}

// Close is an optional method called from container's Close(). 
func (s *MyService) Close() error {
   // Synchronous cleanup logic here.
   return nil
}

Service Functions

The Service Function is a function with a signature func() error or func() returned from the factory. This function is executed in the background when the container starts, and it is awaited during the container close. The error value function returns is treated as if it were returned by a conventional Close() method of a service. The container close will wait until this function returns, ensuring that all background tasks are completed.

The function serves two primary roles:

• It defines the code to execute in background when the container starts with the Start() method.
• It returns an error, which is treated as if it were returned by a conventional Close() method.

// MyServiceFactory is an example of a service function usage.
// Context here is the factory-level context. It starts when the
// factory is invoked (on container start or on service resolve)
// and is cancelled when the factory is closing.
func MyServiceFactory(ctx context.Context) func() error {
    return func() error {
        // Await its order in container close.
        <-ctx.Done()
      
        // Return nil from the `service.Close()`.
        return nil
    }
}

Events Broker

The Events Broker is an additional part of the service container architecture. It facilitates communication between services without them having to be directly aware of each other. The Events Broker works on a publisher-subscriber model, enabling services to publish events to, and subscribe to events from, a centralized broker.

This mechanism allows services to remain decoupled while still being able to interact through a centralized medium. In particular, the gontainer.Events service provides an interface to the events broker and can be injected as a dependency in any service factory.

Triggering Events

To trigger an event, use the Trigger() method. Create an event using NewEvent() and pass the necessary arguments:

events.Trigger(gontainer.NewEvent("Event1", event, arguments, here))

Subscribing to Events

To subscribe to an event, use the Subscribe() method. Two types of handler functions are supported:

• A function that accepts a variable number of any-typed arguments:

  events.Subscribe("Event1", func(args ...any) {
      // Handle the event with args slice.
  })
  

• A function that accepts concrete argument types:

  ev.Subscribe("Event1", func(x string, y int, z bool) {
      // Handle the event with specific args.
  })
  

  • The number of arguments in the event and the handler can differ because handlers are designed to be flexible and can process varying numbers and types of arguments, allowing for greater versatility in handling different event scenarios.
  • The types of arguments in the event and the handler must be assignable. Otherwise, an error will be returned from a Trigger() call.

Every handler function could return an error which will be joined and returned from Trigger() call.

Container Interface

// Container defines service container interface.
type Container interface {
    // Start initializes every service in the container.
    Start() error

    // Close closes service container with all services.
    // Blocks invocation until the container is closed.
    Close() error

    // Done is closing after closing of all services.
    Done() <-chan struct{}

    // Factories returns all defined factories.
    Factories() []*Factory

    // Services returns all spawned services.
    Services() []any

    // Events returns events broker instance.
    Events() Events

    // Resolver returns service resolver instance.
    // If container is not started, only requested services
    // will be spawned on `resolver.Resolve(...)` call.
    Resolver() Resolver

    // Invoker returns function invoker instance.
    // If container is not started, only requested services
    // will be spawned to invoke the func.
    Invoker() Invoker
}

Container Events

The service container emits several events during its lifecycle:

Container Errors

The service container may return the following errors, which can be checked using errors.Is: