Разделение функциональности

Дата обновления перевода 2023-09-01

Разделение функциональности

Недостатком нашего фреймворка сейчас является то, что нам нужно копировать и вставлять код в front.php каждый раз, когда мы создаём новый сайт. 60 строк кода - это немного, но было бы хорошо, если бы могли обернуть этот код в соответстующий класс. Это дало бы нам лучшую возможность повторного использования и облегчило тестироание, и это только несколько преимуществ.

Если вы внимательнее посмотрите на код, front.php имеет один ввод - Запрос, и один вывод - Ответ. Наш класс фреймворка будет следовать этому простому принципу: логика заключается в создании Ответа, связанного с Запросом.

Давайте создадим наше собственное пространство имён для нашего фреймворка Simplex. Переместите логику обработки запросов в собственный класс Simplex\\Framework:

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
        // example.com/src/Simplex/Framework.php
namespace Simplex;

use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpKernel\Controller\ArgumentResolver;
use Symfony\Component\HttpKernel\Controller\ControllerResolver;
use Symfony\Component\Routing\Exception\ResourceNotFoundException;
use Symfony\Component\Routing\Matcher\UrlMatcher;

class Framework
{
    public function __construct(
        private UrlMatcher $matcher,
        private ControllerResolver $controllerResolver,
        private ArgumentResolver $argumentResolver,
    ) {
    }

    public function handle(Request $request): Response
    {
        $this->matcher->getContext()->fromRequest($request);

        try {
            $request->attributes->add($this->matcher->match($request->getPathInfo()));

            $controller = $this->controllerResolver->getController($request);
            $arguments = $this->argumentResolver->getArguments($request, $controller);

            return call_user_func_array($controller, $arguments);
        } catch (ResourceNotFoundException $exception) {
            return new Response('Not Found', 404);
        } catch (\Exception $exception) {
            return new Response('An error occurred', 500);
        }
    }
}
    

И соответственно обновите example.com/web/front.php:

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
        // example.com/web/front.php

// ...
$request = Request::createFromGlobals();
$routes = include __DIR__.'/../src/app.php';

$context = new Routing\RequestContext();
$matcher = new Routing\Matcher\UrlMatcher($routes, $context);

$controllerResolver = new ControllerResolver();
$argumentResolver = new ArgumentResolver();

$framework = new Simplex\Framework($matcher, $controllerResolver, $argumentResolver);
$response = $framework->handle($request);

$response->send();
    

Чтобы закончить с реогранизацией, давайте переместим всё, кроме определений маршрутов, из example.com/src/app.php в другое пространство имён - Calendar.

Для автозагрузки классов, определённых в пространствах имён Simplex и Calendar, обновите файл composer.json:

        1
2
3
4
5
6
        {
    "...": "...",
    "autoload": {
        "psr-4": { "": "src/" }
    }
}
    

Note

Для обновления автозагрузчика Composer, запустите composer dump-autoload.

Переместите контроллер в Calendar\Controller\LeapYearController:

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
        // example.com/src/Calendar/Controller/LeapYearController.php
namespace Calendar\Controller;

use Calendar\Model\LeapYear;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;

class LeapYearController
{
    public function index(Request $request, int $year): Response
    {
        $leapYear = new LeapYear();
        if ($leapYear->isLeapYear($year)) {
            return new Response('Yep, this is a leap year!');
        }

        return new Response('Nope, this is not a leap year.');
    }
}
    

А также переместите функцию is_leap_year() в её собственный класс:

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
        // example.com/src/Calendar/Model/LeapYear.php
namespace Calendar\Model;

class LeapYear
{
    public function isLeapYear(int $year = null): bool
    {
        if (null === $year) {
            $year = date('Y');
        }

        return 0 == $year % 400 || (0 == $year % 4 && 0 != $year % 100);
    }
}
    

Не забудьте соответственно обновить файл example.com/src/app.php:

        1
2
3
4
        $routes->add('leap_year', new Routing\Route('/is_leap_year/{year}', array(
    'year' => null,
    '_controller' => 'Calendar\Controller\LeapYearController::indexAction',
)));
    

Чтобы подытожить, вот новая разметка файла:

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
        example.com
├── composer.json
├── composer.lock
├── src
│   ├── app.php
│   └── Simplex
│       └── Framework.php
│   └── Calendar
│       └── Controller
│       │   └── LeapYearController.php
│       └── Model
│           └── LeapYear.php
├── vendor
│   └── autoload.php
└── web
    └── front.php
    

Вот и всё! Наше приложение теперь имеет четыре разных слоя и каждый из них имеет чётко определённую цель:

web/front.php: Фронт контроллер; единственный открытый PHP-код, который создаёт интерфейс с клиентом (получает Запрос и отправляет Ответ) и предоставляет шаблонный код для инициализации фреймворка и нашего приложения;
src/Simplex: Повтроно используемый код фреймворка, который абстрагирует обработку входящих Запросов (кстати, он делает ваши контроллеры и шаблоны легкотестируемыми - вы вскоре узнаете больше об этом);
src/Calendar: Наш специфический для приложения код (контроллеры и модель);
src/app.php: Настройка конфигурации/фреймворка приложения.