Łańcuch zobowiązań w języku PHP
Łańcuch zobowiązań to behawioralny wzorzec projektowy pozwalający przekazywać żądanie wzdłuż łańcucha potencjalnych obiektów obsługujących aż zostanie obsłużone.
W łańcuchu zobowiązań wiele obiektów może obsłużyć żądanie bez konieczności sprzęgania klas wysyłających je z konkretnymi klasami odbierającymi. Łańcuch można układać dynamicznie w trakcie działania programu z dowolnych obiektów obsługujących, wyposażonych w standardowy interfejs obsługi żądań.
Złożoność:
Popularność:
Przykłady użycia: Wzorzec Łańcuch zobowiązań nie jest zbyt powszechny w PHP ponieważ zakłada obecność łańcuchów obiektów. Jednym z najsłynniejszych przykładów użycia tego wzorca w PHP jest [Oprogramowanie pośredniczące żądań HTTP] opisane w PSR-15.
Identyfikacja: Wzorzec można rozpoznać na podstawie obecności behawioralnych metod jednej grupy obiektów pośrednio wywołujących analogiczne metody w innych obiektach za pośrednictwem wspólnego interfejsu.
Przykład koncepcyjny
Poniższy przykład ilustruje strukturę wzorca Łańcuch zobowiązań ze szczególnym naciskiem na następujące kwestie:
- Z jakich składa się klas?
- Jakie role pełnią te klasy?
- W jaki sposób elementy wzorca są ze sobą powiązane?
Poznawszy strukturę wzorca będzie ci łatwiej zrozumieć następujący przykład, oparty na prawdziwym przypadku użycia PHP.
index.php: Przykład koncepcyjny
<?php namespace RefactoringGuru\ChainOfResponsibility\Conceptual; /** * The Handler interface declares a method for building the chain of handlers. * It also declares a method for executing a request. */ interface Handler { public function setNext(Handler $handler): Handler; public function handle(string $request): ?string; } /** * The default chaining behavior can be implemented inside a base handler class. */ abstract class AbstractHandler implements Handler { /** * @var Handler */ private $nextHandler; public function setNext(Handler $handler): Handler { $this->nextHandler = $handler; // Returning a handler from here will let us link handlers in a // convenient way like this: // $monkey->setNext($squirrel)->setNext($dog); return $handler; } public function handle(string $request): ?string { if ($this->nextHandler) { return $this->nextHandler->handle($request); } return null; } } /** * All Concrete Handlers either handle a request or pass it to the next handler * in the chain. */ class MonkeyHandler extends AbstractHandler { public function handle(string $request): ?string { if ($request === "Banana") { return "Monkey: I'll eat the " . $request . ".\n"; } else { return parent::handle($request); } } } class SquirrelHandler extends AbstractHandler { public function handle(string $request): ?string { if ($request === "Nut") { return "Squirrel: I'll eat the " . $request . ".\n"; } else { return parent::handle($request); } } } class DogHandler extends AbstractHandler { public function handle(string $request): ?string { if ($request === "MeatBall") { return "Dog: I'll eat the " . $request . ".\n"; } else { return parent::handle($request); } } } /** * The client code is usually suited to work with a single handler. In most * cases, it is not even aware that the handler is part of a chain. */ function clientCode(Handler $handler) { foreach (["Nut", "Banana", "Cup of coffee"] as $food) { echo "Client: Who wants a " . $food . "?\n"; $result = $handler->handle($food); if ($result) { echo " " . $result; } else { echo " " . $food . " was left untouched.\n"; } } } /** * The other part of the client code constructs the actual chain. */ $monkey = new MonkeyHandler(); $squirrel = new SquirrelHandler(); $dog = new DogHandler(); $monkey->setNext($squirrel)->setNext($dog); /** * The client should be able to send a request to any handler, not just the * first one in the chain. */ echo "Chain: Monkey > Squirrel > Dog\n\n"; clientCode($monkey); echo "\n"; echo "Subchain: Squirrel > Dog\n\n"; clientCode($squirrel); Output.txt: Wynik działania
Chain: Monkey > Squirrel > Dog Client: Who wants a Nut? Squirrel: I'll eat the Nut. Client: Who wants a Banana? Monkey: I'll eat the Banana. Client: Who wants a Cup of coffee? Cup of coffee was left untouched. Subchain: Squirrel > Dog Client: Who wants a Nut? Squirrel: I'll eat the Nut. Client: Who wants a Banana? Banana was left untouched. Client: Who wants a Cup of coffee? Cup of coffee was left untouched. Przykład z prawdziwego życia
Najbardziej znanym przykładem użycia wzorca Łańcuch zobowiązań w świecie PHP jest oprogramowanie pośredniczące HTTP. Implementuje się je w najpopularniejszych frameworkach PHP, a nawet jest ustandaryzowane w ramach PSR-15.
Działa ono w następujący sposób: żądanie HTTP musi przejść przez stos obiektów pośredniczących aby mogło być obsłużone przez aplikację. Każdy z obiektów-pośredników może albo odmówić dalszego przetwarzania żądania, albo przekazać je kolejnemu obiektowi. Gdy żądanie pomyślnie pokona całą drogę — przejmuje je główny obiekt przetwarzający aplikacji.
Być może widzisz już, że to podejście jest nieco przeciwstawne do pierwotnego celu wzorca. I w rzeczy samej — w typowej implementacji żądanie jest przekazywane wzdłuż łańcucha jeśli bieżący obiekt NIE MOŻE go obsłużyć; w tym zaś przypadku oprogramowanie pośredniczące przekazuje żądanie dalej gdy “sądzi” że aplikacja MOŻE się nim zająć. Niemniej jednak, ponieważ obiekty-składniki oprogramowania pośredniczącego są połączone w łańcuch, cała koncepcja jest nadal zgodna z ideą wzorca Łańcuch zobowiązań.
index.php: Przykład z prawdziwego życia
<?php namespace RefactoringGuru\ChainOfResponsibility\RealWorld; /** * The classic CoR pattern declares a single role for objects that make up a * chain, which is a Handler. In our example, let's differentiate between * middleware and a final application's handler, which is executed when a * request gets through all the middleware objects. * * The base Middleware class declares an interface for linking middleware * objects into a chain. */ abstract class Middleware { /** * @var Middleware */ private $next; /** * This method can be used to build a chain of middleware objects. */ public function linkWith(Middleware $next): Middleware { $this->next = $next; return $next; } /** * Subclasses must override this method to provide their own checks. A * subclass can fall back to the parent implementation if it can't process a * request. */ public function check(string $email, string $password): bool { if (!$this->next) { return true; } return $this->next->check($email, $password); } } /** * This Concrete Middleware checks whether a user with given credentials exists. */ class UserExistsMiddleware extends Middleware { private $server; public function __construct(Server $server) { $this->server = $server; } public function check(string $email, string $password): bool { if (!$this->server->hasEmail($email)) { echo "UserExistsMiddleware: This email is not registered!\n"; return false; } if (!$this->server->isValidPassword($email, $password)) { echo "UserExistsMiddleware: Wrong password!\n"; return false; } return parent::check($email, $password); } } /** * This Concrete Middleware checks whether a user associated with the request * has sufficient permissions. */ class RoleCheckMiddleware extends Middleware { public function check(string $email, string $password): bool { if ($email === "admin@example.com") { echo "RoleCheckMiddleware: Hello, admin!\n"; return true; } echo "RoleCheckMiddleware: Hello, user!\n"; return parent::check($email, $password); } } /** * This Concrete Middleware checks whether there are too many failed login * requests. */ class ThrottlingMiddleware extends Middleware { private $requestPerMinute; private $request; private $currentTime; public function __construct(int $requestPerMinute) { $this->requestPerMinute = $requestPerMinute; $this->currentTime = time(); } /** * Please, note that the parent::check call can be inserted both at the * beginning of this method and at the end. * * This gives much more flexibility than a simple loop over all middleware * objects. For instance, a middleware can change the order of checks by * running its check after all the others. */ public function check(string $email, string $password): bool { if (time() > $this->currentTime + 60) { $this->request = 0; $this->currentTime = time(); } $this->request++; if ($this->request > $this->requestPerMinute) { echo "ThrottlingMiddleware: Request limit exceeded!\n"; die(); } return parent::check($email, $password); } } /** * This is an application's class that acts as a real handler. The Server class * uses the CoR pattern to execute a set of various authentication middleware * before launching some business logic associated with a request. */ class Server { private $users = []; /** * @var Middleware */ private $middleware; /** * The client can configure the server with a chain of middleware objects. */ public function setMiddleware(Middleware $middleware): void { $this->middleware = $middleware; } /** * The server gets the email and password from the client and sends the * authorization request to the middleware. */ public function logIn(string $email, string $password): bool { if ($this->middleware->check($email, $password)) { echo "Server: Authorization has been successful!\n"; // Do something useful for authorized users. return true; } return false; } public function register(string $email, string $password): void { $this->users[$email] = $password; } public function hasEmail(string $email): bool { return isset($this->users[$email]); } public function isValidPassword(string $email, string $password): bool { return $this->users[$email] === $password; } } /** * The client code. */ $server = new Server(); $server->register("admin@example.com", "admin_pass"); $server->register("user@example.com", "user_pass"); // All middleware are chained. The client can build various configurations of // chains depending on its needs. $middleware = new ThrottlingMiddleware(2); $middleware ->linkWith(new UserExistsMiddleware($server)) ->linkWith(new RoleCheckMiddleware()); // The server gets a chain from the client code. $server->setMiddleware($middleware); // ... do { echo "\nEnter your email:\n"; $email = readline(); echo "Enter your password:\n"; $password = readline(); $success = $server->logIn($email, $password); } while (!$success); Output.txt: Wynik działania
Enter your email: asd Enter your password: 123 UserExistsMiddleware: This email is not registered! Enter your email: admin@example.com Enter your password: wrong UserExistsMiddleware: Wrong password! Enter your email: admin@example.com Enter your password: letmein ThrottlingMiddleware: Request limit exceeded! Enter your email: admin@example.com Enter your password: admin_pass RoleCheckMiddleware: Hello, admin! Server: Authorization has been successful!