README

Attribute-based service discovery for Nette DI Container.

Simplify your application configuration by automatically discovering and registering services based on:

Class type (parent class)
PHP 8 attributes

Installation

composer require mildabre/service-discovery

Bootstrap Hook

Add this hook to your Nette Bootstrap.php:

use Mildabre\ServiceDiscovery\DI\ServiceDiscoveryExtension;

public function bootWebApplication(): Container
{
    $this->initializeEnvironment();
    ServiceDiscoveryExtension::boot($this->rootDir.'/temp');    # add just before $configurator->createContainer()
    return $this->configurator->createContainer();
}

Configuration

extensions:
    discovery: Mildabre\ServiceDiscovery\DI\ServiceDiscoveryExtension

Service Discovery by Class Type

Define discovery rules in your service.neon:

discovery:
    in:
        - %appDir%/Controls
        - %appDir%/Model
    
    type:
        - App\Controls\Abstract\AbstractControl
        - App\Model\Abstract\AbstractModel

All classes in %appDir%/Controls and %appDir%/Model matching these criteria will be automatically registered. Discovery by implementing interfaces is by design not possible.

Service Discovery by Attribute

use Mildabre\ServiceDiscovery\Attributes\Service;

#[Service]
class TokenManager
{}

Event Listener Discovery by Attribute

Require mildabre/event-dispatcher. package.

use Mildabre\ServiceDiscovery\Attributes\EventListener;

#[EventListener]
class UserRegisteredListener
{
    public function handle(UserRegisteredEvent $event): void      #  handle event
    {}
}

Services with this attribute are automatically tagged with event.listener tag and added by mildabre/event-dispatcher to EventDispatcher.

Exclude Service from Discovery

use Mildabre\ServiceDiscovery\Attributes\Excluded;
use App\Model\Abstract\AbstractModel;

#[Excluded]                                     # overrides discovery by-type
class ShiftControl extends AbstractControl 
{
    public function __construct(
        private readonly AbstractModel $model,
    )
    {}
}

Class excluded from auto-registration can still be instantiated manually via constructor, without relying on setter injection.

Important: Manually-registered services in services.neon are not affected by the attribute!

Lazy Services

Native PHP 8.4 lazy services are supported and can be enabled per discovery configuration:

discovery:
    lazy: true          # requires PHP 8.4+

When disabled, lazy initialization is not used and PHP 8.1+ is sufficient:

discovery:
    lazy: false         # PHP 8.1+

Individual services registered via #[Service] attribute can override the global lazy setting:

#[Service(lazy: false)]
class TokenManager
{}

Enable Inject mode by Class Type

discovery:
    in:
        - %appDir%/Controls
        - %appDir%/Model
        
    enableInject:
        - App\Controls\Abstract\AbstractControl
        - App\Model\Abstract\AbstractModel

Enable Inject mode by implementing interfaces is by design not possible.

Migration from Search Section

Before:

search:
    application:
        in: %appDir%
        implements: App\Core\Interfaces\AsService
    
    controls:
        in: '%appDir%/Controls'
        extends: App\Controls\Abstract\AbstractControl

decorator:
    App\Core\Interfaces\Injectable:
        inject: true

use App\Core\DI\AsService;
use App\Core\DI\Injectable;

class TokenService implements AsService
{}

class AbstractControl extends Control implements Injectable
{}

After:

discovery:
    in:
        - %appDir%
        
    type:
        - App\Controls\Abstract\AbstractControl
        
    enableInject:
        - App\Controls\Abstract\AbstractControl

use Mildabre\ServiceDiscovery\Attributes\Service;

#[Service]
class TokenService
{}

Go Event-Driven

Service Discovery is a natural foundation for event-driven architecture. Pair it with mildabre/event-dispatcher - simple EventDispatcher that brings modern architecture possibilities.

automatic listener discovery
zero manual wiring
clean separation of concerns

A worthy plugin for modern Nette-based applications.

mildabre/event-dispatcher

Requirements

PHP 8.1 or higher
Nette DI 3.1+
Nette Schema 1.2+
Nette RobotLoader 4.0+

License

MIT License. See LICENSE file.

mildabre / service-discovery

Maintainers

Package info

Statistics

Security