Slim Framework:路由和控制器


Slim Framework: routes and controllers

最初,我的Slim Framework应用程序具有经典结构

(index.php)

<?php
$app = new 'Slim'Slim();
$app->get('/hello/:name', function ($name) {
    echo "Hello, $name";
});
$app->run();

但随着我添加了更多的路线和路线组,我转向了一种基于控制器的方法:

index.php

<?php
$app = new 'Slim'Slim();
$app->get('/hello/:name', 'HelloController::hello');
$app->run();

HelloController.php

<?php
class HelloController {
    public static function hello($name) {
        echo "Hello, $name";
    }
}

这很有效,它有助于组织我的应用程序结构,同时让我为每个控制器方法构建单元测试。

然而,我不确定这是正确的方式。我觉得我在嘲笑Silex的mount方法,这不太好。在每个Controller方法中使用$app上下文需要使用''Slim''Slim::getInstance(),这似乎比像闭包一样使用$app效率低。

所以。。。有没有兼顾效率和秩序的解决方案,或者效率是以路线/关闭噩梦为代价的?

我想我可以和你们分享我所做的。我注意到Slim''Slim中的每个路由方法在某个时候都称为方法mapRoute

(为了清晰起见,我更改了官方源代码的缩进)

Slim.php

 protected function mapRoute($args)
    {
        $pattern = array_shift($args);
        $callable = array_pop($args);
        $route = new 'Slim'Route(
              $pattern, 
              $callable, 
              $this->settings['routes.case_sensitive']
        );
        $this->router->map($route);
        if (count($args) > 0) {
            $route->setMiddleware($args);
        }
        return $route;
    }

反过来,Slim''Route构造函数调用setCallable

Route.php

public function setCallable($callable)
{
    $matches = [];
    $app = $this->app;
    if (
         is_string($callable) && 
         preg_match(
           '!^([^':]+)':([a-zA-Z_'x7f-'xff][a-zA-Z0-9_'x7f-'xff]*)$!', 
           $callable, 
           $matches
         )
       ) {
            $class = $matches[1];
            $method = $matches[2];
            $callable = function () use ($class, $method) {
                static $obj = null;
                if ($obj === null) {
                    $obj = new $class;
                }
                return call_user_func_array([$obj, $method], func_get_args());
            };
        }
        if (!is_callable($callable)) {
            throw new 'InvalidArgumentException('Route callable must be callable');
        }
        $this->callable = $callable;
    }

基本上就是

  • 如果$callable是一个字符串,并且(注意单个冒号)的格式为ClassNamemethod,则它是非静态的,因此Slim将实例化该类,然后调用其上的方法
  • 如果它不可调用,那么抛出一个异常(足够合理)
  • 否则,不管它是什么(ClassName::staticMethod,闭包,函数名),它都将按原样使用

ClassName应该是FQCN,所以它更像'MyProject'Controllers'ClassName

控制器(或任何东西)被实例化的点是注入应用程序实例的好机会。因此,对于初学者,我重写mapRoute,将应用程序实例注入其中:

'Util'MySlim

 protected function mapRoute($args)
    {
        $pattern = array_shift($args);
        $callable = array_pop($args);
        $route = new 'Util'MyRoute(
            $this, // <-- now my routes have a reference to the App
            $pattern, 
            $callable, 
            $this->settings['routes.case_sensitive']
        );
        $this->router->map($route);
        if (count($args) > 0) {
            $route->setMiddleware($args);
        }
        return $route;
    }

所以基本上'Util'MyRoute'Slim'Route,它的构造函数中有一个额外的参数,我将其存储为$this->app

此时,getCallable可以将应用程序注入到每个需要实例化的控制器中

'Util'MyRoute.php

public function setCallable($callable)
{
    $matches = [];
    $app = $this->app;
    if (
       is_string($callable) && 
       preg_match(
          '!^([^':]+)':([a-zA-Z_'x7f-'xff][a-zA-Z0-9_'x7f-'xff]*)$!', 
          $callable, 
          $matches
          )
       ) {
        $class = $matches[1];
        $method = $matches[2];
        $callable = function () use ($app, $class, $method) {
            static $obj = null;
            if ($obj === null) {
                $obj = new $class($app); // <--- now they have the App too!!
            }
            return call_user_func_array([$obj, $method], func_get_args());
        };
    }
    if (!is_callable($callable)) {
        throw new 'InvalidArgumentException('Route callable must be callable');
    }
    $this->callable = $callable;
}

就这样。使用这两个类,我可以将$app注入到我在路由上声明的任何控制器中,只要我使用一个冒号将控制器和方法分开。使用paamayim-nekudotayim将调用静态方法,因此如果我尝试访问其中的$this->app,将抛出错误。

我用blackfire.io和。。。性能增益可以忽略不计。

优点

  • 这让我省去了在每次静态方法调用上调用$app=''Slim''Slim::getInstance()的痛苦,总共调用了大约100行文本
  • 它通过使每个控制器继承一个抽象控制器类为进一步优化开辟了道路,该类又将应用程序方法封装成方便的方法
  • 它让我更好地理解了Slim的请求和响应生命周期

缺点:

  • 性能增益可以忽略不计
  • 您必须将所有路由转换为使用单个冒号而不是paamayin,并将所有控制器方法从静态转换为动态
  • Slim基类的继承可能会在推出v3.0.0时中断

结语:(4年后)

在Slim v3中,他们删除了静态访问器。反过来,如果使用相同的约定FQCN'ClassName:method,则控制器将与应用程序的容器一起实例化。此外,该方法从路由接收请求、响应和$args。这样的DI,很多IoC。我很喜欢它。

回顾我对Slim 2的方法,它打破了最基本的替换原则(Liskov替换)。

class Route extends 'Slim'Route
{
  protected $app;
  public function __construct($app, $pattern, $callable, $caseSensitive = true) {
   ...
   }
}

应该是

class Route extends 'Slim'Route
{
  protected $app;
  public function __construct($pattern, $callable, $caseSensitive = true, $app = null) {
   ...
   }
}

因此,它不会违反合同,并且可以透明地使用。