使用 Symfony 的组件创建自己的 PHP 框架（第七部分：封装框架代码）

英文原文地址：https://symfony.com/doc/current/create_framework/separation_of_concerns.html

目前我们的框架还有一个不足之处：当我们要创建新的网站的时候，我们都需要将 front.php 的代码复制一份。虽然 40 行代码并不是很多，但是如果我们能将这些代码写成一个合适的类，将会更给力一些，比如更好的复用性以及更好的可测试性。

更进一步研究你会发现，front.php包含一个输入，即一个请求 Request，以及一个输出，即一个相应 Response。我们的框架将遵循一个简单的原则：生成与请求对应的响应。

我们可以为框架设置一个自己的命名空间：Simplex

将处理请求的逻辑代码移动到我们的框架类中：

<?php

// example.com/src/Simplex/Framework.php

namespace Simplex;

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

class Framework
{
    protected $matcher;
    protected $resolver;

    public function __construct(UrlMatcher $matcher, ControllerResolver $resolver)
    {
        $this->matcher = $matcher;
        $this->resolver = $resolver;
    }

    public function handle(Request $request)
    {
        try {
            $request->attributes->add($this->matcher->match($request->getPathInfo()));

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

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

相应的我们也需要更新一下 front.php 的代码：

<?php

// example.com/web/front.php

// ...

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

$context = new Routing\RequestContext();
$context->fromRequest($request);
$matcher = new Routing\Matcher\UrlMatcher($routes, $context);
$resolver = new HttpKernel\Controller\ControllerResolver();

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

$response->send();

让我们把除了路由定义的代码挪到另外一个命名空间 Calendar 下，以完成我们对重构代码的继续封装：

为了让在 Simplex 以及 Calendar 这两个命名空间下的代码文件能够自动加载，我们需要更新一下 composer.json 文件：

{
    "...": "...",
    "autoload": {
        "psr-4": { "": "src/" }
    }
}

为了让自动加载生效，需要运行

php composer.phar dump-autoload

将控制器代码挪到Calendar\Controller\LeapYearController：

<?php

// example.com/src/Calendar/Controller/LeapYearController.php

namespace Calendar\Controller;

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

class LeapYearController
{
    public function indexAction(Request $request, $year)
    {
        $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() 方法挪到它应该存在的类中：

<?php

// example.com/src/Calendar/Model/LeapYear.php

namespace Calendar\Model;

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

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

别忘了example.com/src/app.php也需要在相应的地方做下更新：

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

最终，我们得到一个新的目录结构：

example.com/
    composer.json
    src/
        app.php
        Simplex/
            Framework.php
        Calendar/
            Controller/
                LeapYearController.php
            Model/
                LeapYear.php
    vendor/
        autoload.php
    web/
        front.php

没错！我们的应用程序目前有4个不同的部分，而且每一个部分都有自己特有的责任：

• web/front.php：前段控制器，这是唯一一处没有被封装的php代码文件，并且唯一与客户端交互的接口（它接受请求并发送响应），并且提供了初始化框架的代码模版（boil-plate，译者注：这个单词很有意思，来源于印刷工业，指的是不能拆卸的一整块印刷母板，你可以想成是活字印刷发明之前用来印书的东西）
• src/Simplex：可供复用的框架代码，作为处理请求的抽象化接口（另外，他使你的控制器/模板文件更容易测试，更多信息请看下一章）
• src/Calendar：我们程序的特定代码（译者注：指一个程序的具体实现）
• src/app.php：程序配置/框架自定义

返回阅读第六部分 | 继续阅读第八部分

使用 Symfony 的组件创建自己的 PHP 框架（第七部分：封装框架代码） by Chris Yue is licensed under a Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License.

如果觉得文章还不错，就请扫码鼓励一下作者吧
天使打赏人