php - HMVC路由中的歧义

Question

我有一个路由机制，通过依赖文件系统结构来发送请求：

function Route($root) {
  $root = realpath($root) . '/';
  $segments = array_filter(explode('/',
    substr($_SERVER['PHP_SELF'], strlen($_SERVER['SCRIPT_NAME']))
  ), 'strlen');

  if ((count($segments) == 0) || (is_dir($root) === false)) {
    return true; // serve index
  }

  $controller = null;
  $segments = array_values($segments);

  while ((is_null($segment = array_shift($segments)) !== true)
    && (is_dir($root . $controller . $segment . '/'))) {
      $controller .= $segment . '/';
  }

  if ((is_file($controller = $root . $controller . $segment . '.php')) {
    $class = basename($controller . '.php');
    $method = array_shift($segments) ?: $_SERVER['REQUEST_METHOD'];

    require($controller);

    if (method_exists($class = new $class(), $method)) {
      return call_user_func_array(array($class, $method), $segments);
    }
  }

  throw new Exception('/' . implode('/', self::Segment()), 404); // serve 404
}

基本上，它尝试将尽可能多的url段映射到目录，将下面的段匹配到实际的控制器（ .php同名文件）。如果提供了更多的段，第一个段将定义要调用的操作（返回到http方法），其余的段将作为操作参数。
问题是（取决于文件系统结构）存在一些模糊性。考虑一下：

- /controllers
  - /admin
    - /company
      - /edit.php   (has get() & post() methods)
    - /company.php  (has get($id = null) method)

现在的模棱两可-当我访问 domain.tld/admin/company/edit/时， edit.php控制器提供请求（它应该提供），但是通过 domain.tld/admin/company/或 GET访问 domain.tld/admin/company/get/会直接抛出404错误，因为 company段被映射到相应的目录，即使剩余的段在文件系统中没有映射。我怎样才能解决这个问题？最好不要在磁盘上花费太多精力。
已经有很多类似的问题，所以关于这个问题，我看了一些，但我找不到一个单一的答案，提供了可靠和有效的解决方案。

Answer 1

对于像这样关键的东西，用phpunit这样的测试框架编写测试非常重要。
按此处所述安装（您需要PEAR）：
https://github.com/sebastianbergmann/phpunit/
我还使用虚拟文件系统，这样您的测试文件夹就不会变得凌乱：https://github.com/mikey179/vfsStream/wiki/Install
我只是把route函数放到了一个名为Route.php的文件中。在同一个目录中，我现在创建了一个test.php文件，其中包含以下内容：

<?php

require_once 'Route.php';

class RouteTest extends PHPUnit_Framework_TestCase {
}

要检查它是否全部工作，请打开命令行并执行以下操作：

$ cd path/to/directory
$ phpunit test.php
PHPUnit 3.7.13 by Sebastian Bergmann.

F

Time: 0 seconds, Memory: 1.50Mb

There was 1 failure:

1) Warning
No tests found in class "RouteTest".


FAILURES!
Tests: 1, Assertions: 0, Failures: 1.

如果这显示phpunit已正确安装，并且您已经准备好编写测试。
为了使路由功能更好地测试，减少与服务器和文件系统的耦合，我对其进行了一些修改：

// new parameter $request instead of relying on server variables
function Route($root, $request_uri, $request_method) {
  // vfsStream doesn't support realpath(). This will do.
  $root .= '/';
  // replaced server variable with $request_uri
  $segments = array_filter(explode('/', $request_uri), 'strlen');

  if ((count($segments) == 0) || (is_dir($root) === false)) {
    return true; // serve index
  }

  $controller = null;
  $all_segments = array_values($segments);
  $segments = $all_segments;

  while ((is_null($segment = array_shift($segments)) !== true)
    && (is_dir($root . $controller . $segment . '/'))) {
      $controller .= $segment . '/';
  }

  if (is_file($controller = $root . $controller . $segment . '.php')) {
    $class = basename($controller . '.php');
    // replaced server variable with $request_method
    $method = array_shift($segments) ?: $request_method;

    require($controller);

    if (method_exists($class = new $class(), $method)) {
      return call_user_func_array(array($class, $method), $segments);
    }
  }
  // $all_segments variable instead of a call to self::
  throw new Exception('/' . implode('/', $all_segments), 404); // serve 404
}

如果请求索引路由，则允许添加测试以检查函数是否返回true：

public function testIndexRoute() {
    $this->assertTrue(Route('.', '', 'get'));
    $this->assertTrue(Route('.', '/', 'get'));
}

因为您的测试类扩展了 PHPUnit_Framework_TestCase，您现在可以使用类似 $this->assertTrue的方法
检查某一语句的计算结果是否为真。让我们再次运行它：

$ phpunit test.php
PHPUnit 3.7.13 by Sebastian Bergmann.

.

Time: 0 seconds, Memory: 1.75Mb

OK (1 test, 2 assertions)

这次考试通过了！让我们测试 array_filter是否正确删除空段：

public function testEmptySegments() {
    $this->assertTrue(Route('.', '//', 'get'));
    $this->assertTrue(Route('.', '//////////', 'get'));
}

如果路由的 $root目录不存在，还可以测试是否请求索引路由。

public function testInexistentRoot() {
    $this->assertTrue(Route('./inexistent', '/', 'get'));
    $this->assertTrue(Route('./does-not-exist', '/some/random/route', 'get'));
}

为了测试更多的东西，我们现在需要包含类和方法的文件。因此，在运行每个测试之前，让我们使用虚拟文件系统设置包含文件的目录结构。

require_once 'Route.php';
require_once 'vfsStream/vfsStream.php';

class RouteTest extends PHPUnit_Framework_TestCase {

    public function setUp() {
        // intiialize stuff before each test
    }

    public function tearDown() {
        // clean up ...
    }

phpunit对这种事情有一些特殊的方法。 setUp方法在此测试类中的每个测试方法之前执行。以及执行测试方法后的 tearDown方法。
现在我使用vfsstream创建一个目录结构。（如果你想找一个教程来做这个： https://github.com/mikey179/vfsStream/wiki是一个很好的资源）

    public function setUp() {
        $edit_php = <<<EDIT_PHP
<?php
class edit {
    public function get() {
        return __METHOD__ . "()";
    }
    public function post() {
        return __METHOD__ . "()";
    }
}
EDIT_PHP;

        $company_php = <<<COMPANY_PHP
<?php
class company {
    public function get(\$id = null) {
        return __METHOD__ . "(\$id)";
    }
}
COMPANY_PHP;

        $this->root = vfsStream::setup('controllers', null, Array(
            'admin' => Array(
                'company' => Array(
                    'edit.php' => $edit_php
                ),
                'company.php' => $company_php
            )
        ));
    }

    public function tearDown() {
        unset($this->root);
    }

vfsStream::setup()现在创建一个具有给定文件结构和给定文件内容的虚拟目录。
如您所见，我让我的控制器返回方法的名称和参数作为字符串。
现在，我们可以向测试套件中添加更多的测试：

public function testSimpleDirectMethodAccess() {
    $this->assertEquals("edit::get()", Route(vfsStream::url('controllers'), '/controllers/admin/company/edit/get', 'get'));
}

但这次测试失败了：

$ phpunit test.php
PHPUnit 3.7.13 by Sebastian Bergmann.

...
Fatal error: Class 'edit.php.php' not found in C:\xampp\htdocs\r\Route.php on line 27

所以 $class变量有问题。如果我们现在使用调试器（或一些 echos）检查route函数中的以下行。

$class = basename($controller . '.php');

我们可以看到 $controller变量保存了正确的文件名，但是为什么会附加一个 .php？
这似乎是打字错误。我想应该是：

$class = basename($controller, '.php');

因为这会删除.php扩展名。我们得到了正确的类名 edit。
现在让我们测试一下，如果我们请求一个目录结构中不存在的随机路径，是否会引发异常。

/**
 * @expectedException Exception
 * @expectedMessage /random-route-to-the/void
 */
public function testForInexistentRoute() {
    Route(vfsStream::url('controllers'), '/random-route-to-the/void', 'get');
}

phpunit会自动读取这些注释，并检查在执行此方法时是否引发 Exception类型的异常，以及异常消息是否 /random-route-to-the/void
这个缝好了。让我们检查 $request_method参数是否正常工作。

public function testMethodAccessByHTTPMethod() {
    $this->assertEquals("edit::get()", Route(vfsStream::url('controllers'), '/admin/company/edit', 'get'));
    $this->assertEquals("edit::post()", Route(vfsStream::url('controllers'), '/admin/company/edit', 'post'));
}

如果执行此测试，则会遇到其他问题：

$ phpunit test.php
PHPUnit 3.7.13 by Sebastian Bergmann.

....
Fatal error: Cannot redeclare class edit in vfs://controllers/admin/company/edit.php on line 2

看起来我们对同一个文件多次使用 include/ require。

require($controller);

我们把它改成

require_once($controller);

现在让我们面对您的问题，编写一个测试来检查目录 company和文件 company.php是否相互干扰。

$this->assertEquals("company::get()", Route(vfsStream::url('controllers'), '/admin/company', 'get'));
$this->assertEquals("company::get()", Route(vfsStream::url('controllers'), '/admin/company/get', 'get'));

这里我们得到404例外，正如你在问题中所说：

$ phpunit test.php
PHPUnit 3.7.13 by Sebastian Bergmann.

.....E.

Time: 0 seconds, Memory: 2.00Mb

There was 1 error:

1) RouteTest::testControllerWithSubControllers
Exception: /admin/company

C:\xampp\htdocs\r\Route.php:32
C:\xampp\htdocs\r\test.php:69

FAILURES!
Tests: 7, Assertions: 10, Errors: 1.

这里的问题是，我们不知道何时进入子目录，何时使用.php文件中的控制器。
所以我们需要具体说明你到底想发生什么。我假设如下，因为这是有道理的。
仅当控制器不包含所请求的方法时才输入子目录。
如果控制器和子目录都不包含请求的方法，则抛出404
所以，不要像这里那样搜索目录：

while ((is_null($segment = array_shift($segments)) !== true)
  && (is_dir($root . $controller . $segment . '/'))) {
    $controller .= $segment . '/';
}

我们需要搜索文件。如果我们找到一个不包含请求的方法的文件，那么我们就搜索一个目录。

function Route($root, $request_uri, $request_method) {
  $segments = array_filter(explode('/', $request_uri), 'strlen');

  if ((count($segments) == 0) || (is_dir($root) === false)) {
    return true; // serve index
  }

  $all_segments = array_values($segments);
  $segments = $all_segments;

  $directory = $root . '/';
  do {
    $segment = array_shift($segments);
    if(is_file($controller = $directory . $segment . ".php")) {
      $class = basename($controller, '.php');
      $method = isset($segments[0]) ? $segments[0] : $request_method;

      require_once($controller);
      if (method_exists($class = new $class(), $method)) {
        return call_user_func_array(array($class, $method), array_slice($segments, 1));
      }
    }
    $directory .= $segment . '/';
  } while(is_dir($directory));

  throw new Exception('/' . implode('/', $all_segments), 404); // serve 404
}

这个方法现在可以正常工作了。
我们现在可以添加更多的测试用例，但我不想再扩展了。
如您所见，运行一组自动测试以确保
你的一些功能发挥作用。这对调试也很有帮助，因为
你会知道错误到底发生在哪里。我只是想给你一个开始
如何做tdd和如何使用phpunit，这样您就可以自己调试代码了。
“给一个人一条鱼，你就喂他一天。教一个人钓鱼，你就可以养活他一辈子。”
当然，在编写代码之前应该先编写测试。
这里还有一些有趣的链接：
phpunit手册： http://www.phpunit.de/manual/current/en/
梨官方网站： http://pear.php.net/
测试驱动开发（TDD）： http://en.wikipedia.org/wiki/Test-driven_development