Automatisk dependency injection i PHP med hjälp av typhintning

Jag har skrivit om dependency injection förut (anonyma funktioner, dependency injection och php oop kurs del 1) och nu är det faktiskt dags igen. Denna gången med en liten twist. I en del ramverk, i tex Laravel, så har man möjlighet att injicera beroenden in i andra objekt enbart genom att typhinta klassnamnet. Jag vet inte säkert om det heter så på svenska, men på engelska heter det type hinting.

Type hinting använder du genom att skriva namnet på klassen du injicerar till ditt objekt. Vanligast är att man gör det i konstruktorn (constructor injection), och då kan det se ut som så här:

function __construct(Klassnamn $klass)

I detta exemplet, så måste objektet som används som argument vara av typen Klassnamn. Om du försöker injicera ett objekt av en annan typ, så kommer php att generera ett fel. Så varför är detta så bra? Jo, för att ditt objekt ska kunna fungera, så är det beroende av denna specifika typen av objekt. Utan type hinting skulle du kunna injicera vilket objekt som helst, och du kommer säkerligen att få massa saker som inte fungerar. På detta viset vet du att ditt objekt inte kan skapas upp utan att det har alla beroenden det behöver. Det är just det som är dependency injection och type hinting i ett nötskal. Kort sagt – Använd er av det när ni programmerar objektorienterat  php! 🙂

Men hursomhelst, så måste ett objekt som behöver injiceras senare fortfarande skapas. Många dependency injection containers som finns på nätet löser detta, men jag skulle vilja visa ett sätt som det kan göras på för att visa hur det hela kan fungera.

Observera/Disclaimer Detta är inte är någon kod jag vill ni ska använda i skarpt läge, men det kan kanske vara intressant att läsa igenom och kanske inspireras av?

Koden till en förenklad Service Container

Låt oss se hur den ser ut:

<?php
class ServiceContainer
{
    /* @var Lagrade objekt */
    private $instances;

    /**
     * Skapa upp servicecontainern och lagra sig själv.
     */
    public function __construct()
    {
        $this->add($this);
    }

    /**
     * Lägg till ett objekt.
     * @param object $instance
     */
    public function add($instance)
    {
        $this->instances[get_class($instance)] = $instance;
    }

    /**
     * Hämta ett objekt.
     * @param string $name Klassnamn.
     * @return object
     */
    public function get($name)
    {
        // Använd reflection för att undersöka klassen.
        $reflector = new \ReflectionClass($name);

        // Objekt av typen finns redan lagrad.
        if (isset($this->instances[$name])) {
            return $this->instances[$name];
        }

        // Skapa en ny instans.
        if ($reflector->getConstructor()) {
            $injections = $this->getInjections($reflector);
            $instance = $reflector->newInstanceArgs($injections);
        } else {
            $instance = $reflector->newInstance();
        }

        // Lagra och returnera objektet.
        $this->add($instance);

        return $instance;
    }

    /**
     * Hämta konstruktorns parametrar.
     * @param ReflectionClass $reflector
     * @return array
     */
    private function getInjections($reflector)
    {
        $parameters = $reflector->getConstructor()->getParameters();
        foreach ($parameters as $parameter) {
            $name = $parameter->getClass()->name;
            $injections[] = $this->get($name);
        }

        return $injections;
    }
}

Låt oss gå uppifrån och ner för att förklara hur det fungerar.

Den enda variabeln (instances) vi behöver är för att lagra objekt som redan finns uppskapade. Objekten är delade, d.v.s. att endast ett objekt av samma typ kan existera i samma container.

Konstruktorn (__construct) är enkel. Det enda den gör är att lägga till sig själv i containern.

Metoden add() är lika enkel den. Där kan du manuellt lägga till ett objekt till containern om du skulle behöva. Nyckeln som lagras internt blir klassnamnet.

Nu börjar det bli intressant. Metoden get() används för att skapa och returnera ett efterfrågat objekt från containern. Om en instans av rätt klass redan finns lagrad, så returneras den direkt. Vi använder oss av Reflections för att undersöka den efterfrågade klassen. Om klassen har en konstruktor, undersöks den och vi kan avgöra om den har några argument eller inte. Om konstruktorn tar argument, så kallar vi på metoden getInjections() för att hämta dessa. En ny instans skapas med hjälp av newInstanceArgs(), eller newInstance(). Slutligen lagras instansen i containern och så returneras den tillbaka.

Metoden getInjections() används slutligen för att skapa upp objekt som behöver injiceras till en konstruktor för att ett objekt ska kunna skapas upp. Metoden loopar igenom alla argument och skapar upp objekt med hjälp av get() och returnerar dem tillbaka i en array som kan användas när det beroende objektet sedan skapas upp.

Ett exempel:

// Exempel:
class Engine {}
class Tires {}
class Car {
    public function __construct(Engine $engine, Tires $tires) {}
}
class Owner {
    public function __construct(Car $car, ServiceContainer $sc) {}
}

$c = new ServiceContainer();
$owner = $c->get('Owner');

var_dump($owner);
var_dump($c);

Först några klasser som vi kan testa att skapa instanser utav. Engine och Tires är enkla klasser som inte har någon konstruktor och således inte har några beroenden heller. Klassen Car däremot är beroende av både Engine och Tires för att fungera. Lägg märke till type hintingen av dessa två klasser i konstruktorn.

Klassen Owner vill ha en Car för att bli tillfredställt och bara för att vi ska se att det fungerar, så slänger vi in även containern som ett beroende. Ett varningens ord här dock – Det är generellt sett inte någon bra idé att skapa ett beroende av en container i en klass. Även om vi har type hintat containern, så vet vi inte om alla containern innehåller alla de objekt koden förväntar sig. Det är bättre att type hinta respektive klass som ett objekt är beroende av i konstruktorn, vilket ju är just det som hela detta inlägget faktiskt går ut på!

Så när vi anropar ServiceContainerns metod get(), så skapas samtliga objekt upp som Owner är beroende av. Genom att dumpa ut $owner och $c så ser vi just detta. Ownerobjektet är skapat och $c, dvs servicecontainern, innehåller alla de objekt som Owner är beroende av:

object(Owner)[5]
object(ServiceContainer)[1]
  private 'instances' => 
    array (size=5)
      'ServiceContainer' => 
        &object(ServiceContainer)[1]
      'Engine' => 
        object(Engine)[9]
      'Tires' => 
        object(Tires)[10]
      'Car' => 
        object(Car)[8]
      'Owner' => 
        object(Owner)[5]

Sammanfattning

Det är inte alla tillfällen som lämpar sig för en sådan här (enkel) lösning. Det finns några stora nackdelar. Till exempel så kan containern bara leverera objekt som har argument med type hintade klasser. Och dessa i sin tur måste också bestå av desamma. Det går inte i denna implementationen att använda sig av argument som tar strängar, arrays eller annat.

Den klarar inte heller av att injicera objekt där man använder interface som typhintning, vilket till viss del motverkar (subtype) polymorfism, vilket egentligen är önskvärt när man programmerar objektorienterat.

Den hanterar endast injektioner till konstruktorn. I vissa situationer så kan injektioner till enskilda metoder också vara praktiskt (s.k. method injection). Om det där tvistar de lärde, men jag föredrar att i största möjliga mån hålla mig till konstruktorn.

Containern lämpar sig helt enkelt bäst till ändamål där man automatiskt behöver skapa beroenden och eventuell input till respektive objekt sker först efter instansieringen. Alternativt beroende av objekt som kan skapas upp mer eller mindre manuellt innan den automatiska instansieringen. Tänk er en controller i MVC som väljs genom URL, eller någon annan routing, och som behöver en eller flera modeller för att kunna göra sitt jobb. I ett automatiserat flöde, så kan vi inte manuellt skapa upp dessa objektberoenden, utan vi måste förlita oss till någon form av objektfabrik, såsom denna service containern.

Hoppas ni förstår kraften med denna typen av funktionalitet och kanske söker er vidare till någon av de mer robusta och testade lösningar som finns där ute. Lösningar som många gånger tar upp de problem som jag nämnt ovan. Sök gärna mer information på er favoritsökmotor. Använd te.x. ”dependency injection container php” som sökord.

Må bäst, tills nästa gång! 🙂

Lämna ett svar

E-postadressen publiceras inte. Obligatoriska fält är märkta *

Denna webbplats använder Akismet för att minska skräppost. Lär dig hur din kommentardata bearbetas.