jetz1nn/simple-router

简单、快速且易于集成的PHP路由器，适用于几乎任何项目。深受Laravel路由器的启发。

维护者

详细信息

github.com/jetz1nn/simple-php-router

源代码

安装: 6

依赖者: 0

建议者: 0

安全: 0

星标: 0

关注者: 0

分支: 119

5.0.0.2 2022-05-21 20:05 UTC

Requires

Requires (Dev)

MIT b4e053078ccdd2a14d72a5647f39b536bb303f13

  • Simon Sessingø <simon.sessingoe.woop@gmail.com>

frameworkrouteroutingphprouterlaravelpeceesimple-php-routerrequest-handlerurl-handlinginput-handlerrouting-engine

This package is not auto-updated.

Last update: 2024-09-23 05:45:49 UTC

README

简单、快速且功能强大的PHP路由器，易于集成，适用于任何项目。深受Laravel处理路由方式的影响，既注重简洁性，又注重可扩展性。

使用simple-router，您可以快速创建新项目，无需依赖框架。

只需几行代码即可开始使用

SimpleRouter::get('/', function() {
    return 'Hello world';
});

支持项目

如果您喜欢simple-router并希望看到项目的持续开发和维护，请考虑通过购买我一杯咖啡来支持我。支持者将在本文档的致谢部分列出。

您可以点击这里捐赠任意金额。

目录

入门指南

通过运行此命令添加simple-router项目的最新版本。

composer require pecee/simple-router

注意事项

本项目的目标是创建一个路由器，其与Laravel文档的兼容性达到大约100%，同时尽可能保持简单，易于集成和修改，不牺牲速度或复杂度。轻量级是首要任务。

我们包括了一个简单的路由器演示项目，可以在这里找到。这个项目应该能让你对如何设置和使用simple-php-router项目有一个基本的了解。

请注意，演示项目仅涵盖如何在没有现有框架的项目中集成simple-php-router。如果您在项目中使用框架，实现可能会有所不同。

您可以在这里找到演示项目： https://github.com/skipperbent/simple-router-demo

我们不涉及的内容

  • 如何设置满足您需求解决方案。这是一个基本的演示，帮助您开始。
  • MVC的理解；包括控制器、中间件或异常处理器。
  • 如何集成到第三方框架中。

我们涉及的内容

  • 如何快速启动——从头开始。
  • 如何使异常处理器、中间件和控制器正常工作。
  • 如何设置您的web服务器。

要求

  • PHP 7.1或更高版本（版本3.x及以下支持PHP 5.5+）
  • 启用PHP JSON扩展。

特性

  • 基本路由（GET、POST、PUT、PATCH、UPDATE、DELETE）支持自定义多个动词。
  • 参数的正则表达式约束。
  • 命名路由。
  • 生成路由的URL。
  • 路由分组。
  • 中间件（在渲染路由之前拦截的类）。
  • 命名空间。
  • 路由前缀。
  • CSRF保护。
  • 可选参数
  • 子域路由。
  • 自定义启动管理器以将URL重写为“更友好”的URL。
  • 输入管理器；轻松管理GET、POST和FILE值。
  • 基于IP的限制。
  • 易于扩展。

安装

  1. 在终端导航到您的项目文件夹，并运行以下命令
composer require pecee/simple-router

配置Nginx

如果您使用Nginx，请确保已启用url-rewriting。

您可以通过添加以下配置为Nginx配置文件启用url-rewriting，用于演示项目。

location / {
    try_files $uri $uri/ /index.php?$query_string;
}

配置Apache

对于Apache，不需要特殊要求。我们在public文件夹中包含了.htaccess文件。如果您发现重写不起作用，请检查是否在Apache配置中启用了mod_rewrite模块（htaccess支持）。

.htaccess示例

以下是一个simple-php-router使用的正在工作的.htaccess文件的示例。

只需在您的项目public目录中创建一个新的.htaccess文件，并将以下内容粘贴到新创建的文件中。这将重定向所有请求到您的index.php文件（见配置部分以下）。

RewriteEngine on
RewriteCond %{SCRIPT_FILENAME} !-f
RewriteCond %{SCRIPT_FILENAME} !-d
RewriteCond %{SCRIPT_FILENAME} !-l
RewriteRule ^(.*)$ index.php/$1

配置IIS

在IIS中，您必须在public文件夹中的web.config文件中添加一些行或创建一个新的文件。如果重写不起作用，请检查您的IIS版本是否包含url rewrite模块，或者从Microsoft网站下载并安装它们。

web.config示例

以下是一个simple-php-router使用的正在工作的web.config文件的示例。

只需在您的项目public目录中创建一个新的web.config文件，并将以下内容粘贴到新创建的文件中。这将重定向所有请求到您的index.php文件（见配置部分以下）。如果web.config文件已经存在，请在<system.webServer>分支内部添加<rewrite>部分。

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <system.webServer>
	<rewrite>
	  <rules>
		<!-- Remove slash '/' from the en of the url -->
		<rule name="RewriteRequestsToPublic">
		  <match url="^(.*)$" />
		  <conditions logicalGrouping="MatchAll" trackAllCaptures="false">
		  </conditions>
		  <action type="Rewrite" url="/{R:0}" />
		</rule>

		<!-- When requested file or folder don't exists, will request again through index.php -->
		<rule name="Imported Rule 1" stopProcessing="true">
		  <match url="^(.*)$" ignoreCase="true" />
		  <conditions logicalGrouping="MatchAll">
			<add input="{REQUEST_FILENAME}" matchType="IsDirectory" negate="true" />
			<add input="{REQUEST_FILENAME}" matchType="IsFile" negate="true" />
		  </conditions>
		  <action type="Rewrite" url="/index.php/{R:1}" appendQueryString="true" />
		</rule>
	  </rules>
	</rewrite>
    </system.webServer>
</configuration>

故障排除

如果你的项目中没有favicon.ico文件，你可能会遇到NotFoundHttpException（404 - 未找到）错误。

要将favicon.ico添加到IIS忽略列表，请在<conditions>组中添加以下行

<add input="{REQUEST_FILENAME}" negate="true" pattern="favicon.ico" ignoreCase="true" />

你也可以为一些扩展名的文件设置一个例外

<add input="{REQUEST_FILENAME}" pattern="\.ico|\.png|\.css|\.jpg" negate="true" ignoreCase="true" />

如果你正在使用$_SERVER['ORIG_PATH_INFO']，你将得到返回值中包含的\index.php\。

示例

/index.php/test/mypage.php

配置

创建一个新文件，命名为routes.php，并将其放置在您的库文件夹中。这将是一个定义您项目所有路由的文件。

警告：永远不要将您的routes.php放置在公共文件夹中！

在您的index.php中引入您新创建的routes.php，并调用SimpleRouter::start()方法。这将触发并执行实际的请求路由。

这不是必需的，但您可以设置SimpleRouter::setDefaultNamespace('\Demo\Controllers');，以便将命名空间前缀添加到所有路由。这将简化一些事情，因为您不需要在每个路由上指定控制器的命名空间。

下面是一个基本index.php文件的示例

<?php
use Pecee\SimpleRouter\SimpleRouter;

/* Load external routes file */
require_once 'routes.php';

/**
 * The default namespace for route-callbacks, so we don't have to specify it each time.
 * Can be overwritten by using the namespace config option on your routes.
 */

SimpleRouter::setDefaultNamespace('\Demo\Controllers');

// Start the routing
SimpleRouter::start();

辅助函数

我们建议您将这些辅助函数添加到您的项目中。这将使您更轻松地访问路由器的功能。

要实现以下函数，只需将代码复制到新文件中，并在初始化路由器之前引入该文件，或者复制我们在此库中包含的helpers.php。

use Pecee\SimpleRouter\SimpleRouter as Router;
use Pecee\Http\Url;
use Pecee\Http\Response;
use Pecee\Http\Request;

/**
 * Get url for a route by using either name/alias, class or method name.
 *
 * The name parameter supports the following values:
 * - Route name
 * - Controller/resource name (with or without method)
 * - Controller class name
 *
 * When searching for controller/resource by name, you can use this syntax "route.name@method".
 * You can also use the same syntax when searching for a specific controller-class "MyController@home".
 * If no arguments is specified, it will return the url for the current loaded route.
 *
 * @param string|null $name
 * @param string|array|null $parameters
 * @param array|null $getParams
 * @return \Pecee\Http\Url
 * @throws \InvalidArgumentException
 */
function url(?string $name = null, $parameters = null, ?array $getParams = null): Url
{
    return Router::getUrl($name, $parameters, $getParams);
}

/**
 * @return \Pecee\Http\Response
 */
function response(): Response
{
    return Router::response();
}

/**
 * @return \Pecee\Http\Request
 */
function request(): Request
{
    return Router::request();
}

/**
 * Get input class
 * @param string|null $index Parameter index name
 * @param string|mixed|null $defaultValue Default return value
 * @param array ...$methods Default methods
 * @return \Pecee\Http\Input\InputHandler|array|string|null
 */
function input($index = null, $defaultValue = null, ...$methods)
{
    if ($index !== null) {
        return request()->getInputHandler()->value($index, $defaultValue, ...$methods);
    }

    return request()->getInputHandler();
}

/**
 * @param string $url
 * @param int|null $code
 */
function redirect(string $url, ?int $code = null): void
{
    if ($code !== null) {
        response()->httpCode($code);
    }

    response()->redirect($url);
}

/**
 * Get current csrf-token
 * @return string|null
 */
function csrf_token(): ?string
{
    $baseVerifier = Router::router()->getCsrfVerifier();
    if ($baseVerifier !== null) {
        return $baseVerifier->getTokenProvider()->getToken();
    }

    return null;
}

路由

请记住，您在index.php中引入的routes.php文件，这是您放置所有自定义路由规则的地方。

基本路由

以下是一个非常基本的设置路由的示例。第一个参数是路由应匹配的URL - 下一个参数是一个Closure或回调函数，一旦匹配到路由就会触发。

SimpleRouter::get('/', function() {
    return 'Hello world';
});

类提示

您可以使用类提示来加载类和方法，如下所示

SimpleRouter::get('/', [MyClass::class, 'myMethod']);

可用方法

在这里，您可以看到所有可用的路由列表

SimpleRouter::get($url, $callback, $settings);
SimpleRouter::post($url, $callback, $settings);
SimpleRouter::put($url, $callback, $settings);
SimpleRouter::patch($url, $callback, $settings);
SimpleRouter::delete($url, $callback, $settings);
SimpleRouter::options($url, $callback, $settings);

多个HTTP动词

有时您可能需要创建一个接受多个HTTP动词的路由。如果您需要匹配所有HTTP动词，可以使用any方法。

SimpleRouter::match(['get', 'post'], '/', function() {
    // ...
});

SimpleRouter::any('foo', function() {
    // ...
});

我们已经创建了一个简单的匹配GET和POST的方法，这是最常用的。

SimpleRouter::form('foo', function() {
    // ...
});

路由参数

必需参数

您可能已经好奇如何从URL中解析参数了。例如，您可能希望从URL中捕获用户的ID。您可以通过定义路由参数来实现这一点。

SimpleRouter::get('/user/{id}', function ($userId) {
    return 'User with id: ' . $userId;
});

您可以定义与路由需求相匹配的任何数量的路由参数

SimpleRouter::get('/posts/{post}/comments/{comment}', function ($postId, $commentId) {
    // ...
});

注意：路由参数总是用{}括号括起来，并且应该由字母字符组成。路由参数只能包含某些字符，如A-Z、a-z、0-9、-和_。如果您的路由包含其他字符，请参阅自定义参数匹配正则表达式。

可选参数

偶尔您可能需要指定一个路由参数，但使其存在是可选的。您可以通过在参数名称后放置一个?标记来这样做。请确保为路由的相应变量提供一个默认值

SimpleRouter::get('/user/{name?}', function ($name = null) {
    return $name;
});

SimpleRouter::get('/user/{name?}', function ($name = 'Simon') {
    return $name;
});

正则表达式约束

您可以使用路由实例上的where方法来限制路由参数的格式。where方法接受参数名称和一个定义参数应如何限制的正则表达式。

SimpleRouter::get('/user/{name}', function ($name) {
    
    // ... do stuff
    
})->where([ 'name' => '[A-Za-z]+' ]);

SimpleRouter::get('/user/{id}', function ($id) {
    
    // ... do stuff
    
})->where([ 'id' => '[0-9]+' ]);

SimpleRouter::get('/user/{id}/{name}', function ($id, $name) {
    
    // ... do stuff
    
})->where(['id' => '[0-9]+', 'name' => '[a-z]+']);

正则表达式路由匹配

如果您愿意，可以定义整个路由的正则表达式匹配。

如果，例如，您正在创建一个加载来自ajax的URL的模型框，这很有用。

以下示例使用以下正则表达式：/ajax/([\w]+)/?([0-9]+)?/?，它基本上只是匹配/ajax/并期望下一个参数是一个字符串 - 下一个是一个数字（但可选）。

匹配：/ajax/abc/、/ajax/abc/123/

不匹配： /ajax/

正则表达式指定的匹配组将被作为参数传递

SimpleRouter::all('/ajax/abc/123', function($param1, $param2) {
	// param1 = abc
	// param2 = 123
})->setMatch('/\/ajax\/([\w]+)\/?([0-9]+)?\/?/is');

自定义正则表达式匹配参数

默认情况下，simple-php-router 使用 [\w\-]+ 正则表达式。它可以匹配 A-Z、a-z、0-9、- 和 _ 字符。这个决定是为了速度和可靠性，因为这个匹配将匹配字母、数字和互联网上使用的大多数符号。

然而，有时添加一个自定义正则表达式以匹配更高级的字符（如外国字母 æ ø å 等）是必要的。

您可以通过网站 Regex101.com 测试您的自定义正则表达式。

您可以为路由上的所有参数添加一个全局正则表达式，而不是为所有参数添加自定义正则表达式。

注意：如果您想让正则表达式在多个路由间可用，我们建议使用以下示例中演示的组全局参数。

示例

此示例将确保所有参数在解析时都使用 [\w\-\æ\ø\å]+（a-z、A-Z、-、_、0-9、æ、ø、å）正则表达式。

SimpleRouter::get('/path/{parameter}', 'VideoController@home', ['defaultParameterRegex' => '[\w\-\æ\ø\å]+']);

如果需要多个路由在解析参数时使用您的自定义正则表达式，您也可以将此设置应用于组。

SimpleRouter::group(['defaultParameterRegex' => '[\w\-\æ\ø\å]+'], function() {

    SimpleRouter::get('/path/{parameter}', 'VideoController@home');

});

命名路由

命名路由允许方便地生成特定路由的 URL 或重定向。您可以通过将名称方法链接到路由定义上来为路由指定名称。

SimpleRouter::get('/user/profile', function () {
    // Your code here
})->name('profile');

您还可以为控制器-操作指定名称。

SimpleRouter::get('/user/profile', 'UserController@profile')->name('profile');

生成命名路由的URL

一旦您为给定的路由分配了名称，您就可以在生成 URL 或重定向时使用该路由的名称，通过全局 url 辅助函数（请参阅辅助函数部分）。

// Generating URLs...
$url = url('profile');

如果命名路由定义了参数，您可以将参数作为 url 函数的第二个参数传递。给定的参数将自动插入到 URL 的正确位置。

SimpleRouter::get('/user/{id}/profile', function ($id) {
    //
})->name('profile');

$url = url('profile', ['id' => 1]);

有关 URL 的更多信息，请参阅 Urls 部分。

路由分组

路由组允许您在不为每个单独的路由定义这些属性的情况下，在大量路由间共享路由属性，如中间件或命名空间。共享属性作为数组格式指定为 SimpleRouter::group 方法的第一个参数。

中间件

要为组内的所有路由分配中间件，您可以在组属性数组中使用中间件键。中间件按数组中列出的顺序执行。

SimpleRouter::group(['middleware' => \Demo\Middleware\Auth::class], function () {
    SimpleRouter::get('/', function ()    {
        // Uses Auth Middleware
    });

    SimpleRouter::get('/user/profile', function () {
        // Uses Auth Middleware
    });
});

命名空间

路由组的另一个常见用例是使用组数组中的 namespace 参数将相同的 PHP 命名空间分配给一组控制器。

注意

组命名空间仅添加到具有相对回调的路由中。例如，如果您的路由具有绝对回调 \Demo\Controller\DefaultController@home，则不会添加路由的命名空间。要修复此问题，您可以通过删除回调开头中的 \ 来使回调相对。

SimpleRouter::group(['namespace' => 'Admin'], function () {
    // Controllers Within The "App\Http\Controllers\Admin" Namespace
});

您还可以添加参数到路由的前缀。

在添加任何路由所需的参数之后，您的先前路由中的参数将注入到您的路由中，从最旧的开始，直到最新的。

SimpleRouter::group(['prefix' => '/lang/{lang}'], function ($language) {
    
    SimpleRouter::get('/about', function($language) {
    	
    	// Will match /lang/da/about
    	
    });
    
});

子域名路由

路由组还可以用于处理子域路由。子域可以像路由 URL 一样分配路由参数，允许您捕获子域的一部分用于您的路由或控制器。您可以使用组属性数组中的 domain 键指定子域。

SimpleRouter::group(['domain' => '{account}.myapp.com'], function () {
    SimpleRouter::get('/user/{id}', function ($account, $id) {
        //
    });
});

路由前缀

您可以使用 prefix 组属性为组中的每个路由添加给定的 URL 前缀。例如，您可能希望将组内的所有路由 URL 前缀为 admin。

SimpleRouter::group(['prefix' => '/admin'], function () {
    SimpleRouter::get('/users', function ()    {
        // Matches The "/admin/users" URL
    });
});

您也可以在您的组中使用参数。

SimpleRouter::group(['prefix' => '/lang/{language}'], function ($language) {
    SimpleRouter::get('/users', function ($language)    {
        // Matches The "/lang/da/users" URL
    });
});

部分分组

部分路由组与普通组具有相同的优势，但只有在URL匹配后才会渲染，而普通组则始终渲染以获取其子路由。因此，部分组更像是传统路由与组优势的混合。

这在只想在满足特定条件或逻辑时添加特殊路由的情况下非常有用。

注意：谨慎使用部分组，因为添加其中的路由只有在部分组的URL匹配并渲染后才会渲染和可用。这可能导致在部分组匹配并渲染之前，url()找不到添加的路由的URL。

示例

SimpleRouter::partialGroup('/plugin/{name}', function ($plugin) {

    // Add routes from plugin

});

表单方法欺骗

HTML表单不支持PUT、PATCH或DELETE操作。因此，当定义从HTML表单调用的PUT、PATCH或DELETE路由时，您需要在表单中添加一个隐藏的_method字段。发送给_method字段的值将被用作HTTP请求方法。

<input type="hidden" name="_method" value="PUT" />

访问当前路由

您可以使用以下方法访问当前加载的路由的信息

SimpleRouter::request()->getLoadedRoute();
request()->getLoadedRoute();

其他示例

您可以在下面的routes.php示例文件中找到更多示例

<?php
use Pecee\SimpleRouter\SimpleRouter;

/* Adding custom csrfVerifier here */
SimpleRouter::csrfVerifier(new \Demo\Middlewares\CsrfVerifier());

SimpleRouter::group(['middleware' => \Demo\Middlewares\Site::class, 'exceptionHandler' => \Demo\Handlers\CustomExceptionHandler::class], function() {


    SimpleRouter::get('/answers/{id}', 'ControllerAnswers@show', ['where' => ['id' => '[0-9]+']]);

	/**
     * Class hinting is supported too
     */
     
     SimpleRouter::get('/answers/{id}', [ControllerAnswers::class, 'show'], ['where' => ['id' => '[0-9]+']]);

    /**
     * Restful resource (see IRestController interface for available methods)
     */

    SimpleRouter::resource('/rest', ControllerResource::class);


    /**
     * Load the entire controller (where url matches method names - getIndex(), postIndex(), putIndex()).
     * The url paths will determine which method to render.
     *
     * For example:
     *
     * GET  /animals         => getIndex()
     * GET  /animals/view    => getView()
     * POST /animals/save    => postSave()
     *
     * etc.
     */

    SimpleRouter::controller('/animals', ControllerAnimals::class);

});

SimpleRouter::get('/page/404', 'ControllerPage@notFound', ['as' => 'page.notfound']);

CSRF保护

向POST、PUT或DELETE路由发送的任何表单都应该包含CSRF令牌。我们强烈建议您在您的网站上启用CSRF验证以最大化安全性。

您可以使用BaseCsrfVerifier来在所有请求上启用CSRF验证。如果您需要禁用特定URL的验证，请参阅下面的“自定义CSRF验证器”部分。

默认情况下，simple-php-router将使用CookieTokenProvider类。此提供程序将在客户端机器上的cookie中存储安全令牌。如果您想将令牌存储在其他位置，请参阅下面的“创建自定义令牌提供程序”部分。

添加CSRF验证器

当您创建您的CSRF验证器后，您需要告诉simple-php-router它应该使用它。您可以在您的routes.php文件中添加以下行来完成此操作

SimpleRouter::csrfVerifier(new \Demo\Middlewares\CsrfVerifier());

获取CSRF令牌

当向启用了CSRF验证的任何URL发送请求时，您需要发送CSRF令牌，否则请求将被拒绝。

您可以通过调用辅助方法来获取CSRF令牌

csrf_token();

您还可以直接获取令牌

return SimpleRouter::router()->getCsrfVerifier()->getTokenProvider()->getToken();

输入字段的默认名称/键是csrf_token，它在BaseCsrfVerifier类中的POST_KEY常量中定义。您可以通过在您自己的CSRF验证器类中覆盖常量来更改键。

示例

下面的示例将使用隐藏字段"csrf_token"向当前URL发送POST请求。

<form method="post" action="<?= url(); ?>">
    <input type="hidden" name="csrf_token" value="<?= csrf_token(); ?>">
    <!-- other input elements here -->
</form>

自定义CSRF验证器

创建一个新的类，并扩展simple-php-router库默认提供的BaseCsrfVerifier中间件类。

向要排除/白名单的CSRF验证的路由添加具有URL数组属性的except。使用*在URL末尾将匹配整个URL。

下面是一个CSRF验证器类的示例

namespace Demo\Middlewares;

use Pecee\Http\Middleware\BaseCsrfVerifier;

class CsrfVerifier extends BaseCsrfVerifier
{
	/**
	 * CSRF validation will be ignored on the following urls.
	 */
	protected $except = ['/api/*'];
}

自定义令牌提供程序

默认情况下，BaseCsrfVerifier将使用CookieTokenProvider在客户端机器上的cookie中存储令牌。

如果您需要将令牌存储在其他位置，您可以创建自己的类并实现ITokenProvider类。

class SessionTokenProvider implements ITokenProvider
{

    /**
     * Refresh existing token
     */
    public function refresh(): void
    {
        // Implement your own functionality here...
    }

    /**
     * Validate valid CSRF token
     *
     * @param string $token
     * @return bool
     */
    public function validate($token): bool
    {
        // Implement your own functionality here...
    }
    
    /**
     * Get token token
     *
     * @param string|null $defaultValue
     * @return string|null
     */
    public function getToken(?string $defaultValue = null): ?string 
    {
        // Implement your own functionality here...
    }

}

接下来，您需要在您的路由文件中将您的自定义ITokenProvider实现设置在您的BaseCsrfVerifier类中

$verifier = new \Demo\Middlewares\CsrfVerifier();
$verifier->setTokenProvider(new SessionTokenProvider());

SimpleRouter::csrfVerifier($verifier);

中间件

中间件是在渲染路由之前加载的类。中间件可用于验证用户是否已登录 - 或为当前请求/路由设置特定参数。中间件必须实现IMiddleware接口。

示例

namespace Demo\Middlewares;

use Pecee\Http\Middleware\IMiddleware;
use Pecee\Http\Request;

class CustomMiddleware implements IMiddleware {

    public function handle(Request $request): void 
    {
    
        // Authenticate user, will be available using request()->user
        $request->user = User::authenticate();

        // If authentication failed, redirect request to user-login page.
        if($request->user === null) {
            $request->setRewriteUrl(url('user.login'));
        }

    }
}

异常处理程序

异常处理器是处理所有异常的类。异常处理器必须实现IExceptionHandler接口。

处理404、403和其他错误

如果您只想捕获404（页面未找到）等异常，您可以使用SimpleRouter::error($callback)静态辅助方法。

这将在所有路由发生错误时触发一个回调方法。

以下基本示例简单地重定向页面到 /not-found，如果发生 NotFoundHttpException（404）错误。应将此代码放在包含您路由的文件中。

SimpleRouter::get('/not-found', 'PageController@notFound');
SimpleRouter::get('/forbidden', 'PageController@notFound');

SimpleRouter::error(function(Request $request, \Exception $exception) {

    switch($exception->getCode()) {
        // Page not found
        case 404:
            response()->redirect('/not-found');
        // Forbidden
        case 403:
            response()->redirect('/forbidden');
    }
    
});

上述示例将重定向所有带有 HTTP 代码 404（页面未找到）的错误到 /not-found，将 403（禁止）错误重定向到 /forbidden。

如果您不希望重定向，但想在当前 URL 上渲染错误页面，可以告诉路由器执行一个重写回调，如下所示

$request->setRewriteCallback('ErrorController@notFound');

使用自定义异常处理程序

这是一个异常处理器实现的基本示例（请参阅 "轻松覆盖即将加载的路由" 了解如何更改回调的示例）。

namespace Demo\Handlers;

use Pecee\Http\Request;
use Pecee\SimpleRouter\Handlers\IExceptionHandler;
use Pecee\SimpleRouter\Exceptions\NotFoundHttpException;

class CustomExceptionHandler implements IExceptionHandler
{
	public function handleError(Request $request, \Exception $error): void
	{

		/* You can use the exception handler to format errors depending on the request and type. */

		if ($request->getUrl()->contains('/api')) {

			response()->json([
				'error' => $error->getMessage(),
				'code'  => $error->getCode(),
			]);

		}

		/* The router will throw the NotFoundHttpException on 404 */
		if($error instanceof NotFoundHttpException) {

			// Render custom 404-page
			$request->setRewriteCallback('Demo\Controllers\PageController@notFound');
			return;
			
		}

		throw $error;

	}

}

您可以使用 exceptionHandler 设置属性将您自定义的异常处理器类添加到组中。exceptionHandler 可以是类名或类名数组。

SimpleRouter::group(['exceptionHandler' => \Demo\Handlers\CustomExceptionHandler::class], function() {

    // Your routes here

});

防止合并父异常处理程序

默认情况下，路由器将合并异常处理器与父组提供的任何处理器，并按从新到旧的顺序执行。

如果您希望您的组异常处理器独立执行，可以添加 mergeExceptionHandlers 属性并将其设置为 false。

SimpleRouter::group(['prefix' => '/', 'exceptionHandler' => \Demo\Handlers\FirstExceptionHandler::class, 'mergeExceptionHandlers' => false], function() {

	SimpleRouter::group(['prefix' => '/admin', 'exceptionHandler' => \Demo\Handlers\SecondExceptionHandler::class], function() {
	
		// Both SecondExceptionHandler and FirstExceptionHandler will trigger (in that order).
	
	});
	
	SimpleRouter::group(['prefix' => '/user', 'exceptionHandler' => \Demo\Handlers\SecondExceptionHandler::class, 'mergeExceptionHandlers' => false], function() {
	
		// Only SecondExceptionHandler will trigger.
	
	});

});

URL

默认情况下，所有控制器和资源路由都将使用它们的简化版 URL 作为名称。

您可以使用 url() 简短助手函数轻松检索路由的 URL 或操作当前 URL。

url() 将返回一个 Url 对象，当渲染时将返回一个 string，因此可以在模板等地方安全使用，但包含 Url 类中的所有有用助手方法，如 contains、indexOf 等。请参阅下面的 有用的 URL 小技巧。

获取当前URL

获取和/或操作当前 URL 从未如此简单。

以下示例显示了如何获取当前 URL

# output: /current-url
url();

按名称获取（单个路由）

SimpleRouter::get('/product-view/{id}', 'ProductsController@show', ['as' => 'product']);

# output: /product-view/22/?category=shoes
url('product', ['id' => 22], ['category' => 'shoes']);

# output: /product-view/?category=shoes
url('product', null, ['category' => 'shoes']);

按名称获取（控制器路由）

SimpleRouter::controller('/images', ImagesController::class, ['as' => 'picture']);

# output: /images/view/?category=shows
url('picture@getView', null, ['category' => 'shoes']);

# output: /images/view/?category=shows
url('picture', 'getView', ['category' => 'shoes']);

# output: /images/view/
url('picture', 'view');

按类获取

SimpleRouter::get('/product-view/{id}', 'ProductsController@show', ['as' => 'product']);
SimpleRouter::controller('/images', 'ImagesController');

# output: /product-view/22/?category=shoes
url('ProductsController@show', ['id' => 22], ['category' => 'shoes']);

# output: /images/image/?id=22
url('ImagesController@getImage', null, ['id' => 22]);

为控制器/资源路由上的方法使用自定义名称

SimpleRouter::controller('gadgets', GadgetsController::class, ['names' => ['getIphoneInfo' => 'iphone']]);

url('gadgets.iphone');

# output
# /gadgets/iphoneinfo/

获取REST/资源控制器URL

SimpleRouter::resource('/phones', PhonesController::class);

# output: /phones/
url('phones');

# output: /phones/
url('phones.index');

# output: /phones/create/
url('phones.create');

# output: /phones/edit/
url('phones.edit');

操作URL

您可以通过添加您的 get 参数参数轻松操作查询字符串。

# output: /current-url?q=cars

url(null, null, ['q' => 'cars']);

您可以通过将值设置为 null 来删除查询字符串参数。

以下示例将删除任何名为 q 的查询字符串参数，但保留所有其他查询字符串参数

$url = url()->removeParam('q');

有关更多信息，请参阅文档中的 有用的 URL 小技巧 部分。

有用的URL技巧

调用 url 总是返回一个 Url 对象。渲染后，它将返回一个相对 url 的 string，因此可以在模板等地方安全使用。

但是，这允许我们使用 Url 对象的有用方法，如 indexOf 和 contains，或检索 URL 的特定部分，如路径、查询字符串参数、主机等。您还可以像删除或添加参数、更改主机等一样操作 URL。

在以下示例中，我们检查当前 URL 是否包含 /api 部分。

if(url()->contains('/api')) {
    // ... do stuff
}

如前所述，您还可以使用 Url 对象来显示 URL 的特定部分或控制您想要的部分。

# Grab the query-string parameter id from the current-url.
$id = url()->getParam('id');

# Get the absolute url for the current url.
$absoluteUrl = url()->getAbsoluteUrl();

有关更多方法，请参阅 Pecee\Http\Url 类。

输入和参数

simple-router 提供了库和助手，使得管理和管理输入参数（如 $_POST、$_GET 和 $_FILE）变得简单。

使用Input类来管理参数

您可以使用 InputHandler 类轻松访问和管理请求中的参数。InputHandler 类提供扩展功能，例如直接在对象上复制/移动上传的文件，获取文件扩展名、MIME 类型等。

获取单个参数值

input($index, $defaultValue, ...$methods);

要快速从参数中获取值，您可以使用 input 助手函数。

这将自动修剪值并确保它不是空的。如果是空的，则返回 $defaultValue。

注意：此函数返回一个 string，除非参数分组在一起，在这种情况下，它将返回值的 array。

示例

此示例匹配POST和GET请求方法，如果名称为空，则返回默认值“Guest”。

$name = input('name', 'Guest', 'post', 'get');

获取参数对象

处理文件上传时，检索原始参数对象可能很有用。

在多个或特定请求方法中搜索具有默认值的对象

以下示例如果找到参数，将返回一个InputItem对象，或者返回$defaultValue。如果参数分组，它将返回一个InputItem对象的数组。

$object = input()->find($index, $defaultValue = null, ...$methods);

获取特定的$_GET参数作为InputItem对象

以下示例如果找到参数，将返回一个InputItem对象，或者返回$defaultValue。如果参数分组，它将返回一个InputItem对象的数组。

$object = input()->get($index, $defaultValue = null);

获取特定的$_POST参数作为InputItem对象

以下示例如果找到参数，将返回一个InputItem对象，或者返回$defaultValue。如果参数分组，它将返回一个InputItem对象的数组。

$object = input()->post($index, $defaultValue = null);

获取特定的$_FILE参数作为InputFile对象

以下示例如果找到参数，将返回一个InputFile对象，或者返回$defaultValue。如果参数分组，它将返回一个InputFile对象的数组。

$object = input()->file($index, $defaultValue = null);

管理文件

/**
 * Loop through a collection of files uploaded from a form on the page like this
 * <input type="file" name="images[]" />
 */

/* @var $image \Pecee\Http\Input\InputFile */
foreach(input()->file('images', []) as $image)
{
    if($image->getMime() === 'image/jpeg') 
    {
        $destinationFilname = sprintf('%s.%s', uniqid(), $image->getExtension());
        $image->move(sprintf('/uploads/%s', $destinationFilename));
    }
}

获取所有参数

# Get all
$values = input()->all();

# Only match specific keys
$values = input()->all([
    'company_name',
    'user_id'
]);

所有对象都实现了IInputItem接口，并且始终包含以下方法

  • getIndex() - 返回输入的索引/键。
  • setIndex() - 设置输入的索引/键。
  • getName() - 返回输入的人性化名称（company_name将变为公司名称等）。
  • setName() - 设置输入的人性化名称（company_name将变为公司名称等）。
  • getValue() - 返回输入的值。
  • setValue() - 设置输入的值。

InputFile具有与上面相同的方法，以及一些其他特定于文件的方法，例如

  • getFilename - 获取文件名。
  • getTmpName() - 获取文件的临时名称。
  • getSize() - 获取文件大小。
  • move($destination) - 将文件移动到目的地。
  • getContents() - 获取文件内容。
  • getType() - 获取文件的mime类型。
  • getError() - 获取文件上传错误。
  • hasError() - 如果上传过程中发生错误（如果getError不是0），则返回bool。
  • toArray() - 返回原始数组

检查参数是否存在

您可以使用exists方法轻松地检查是否存在多个项目。它与value类似，可以用于在请求方法中过滤，并支持string和array作为参数值。

示例

if(input()->exists(['name', 'lastname'])) {
	// Do stuff
}

/* Similar to code above */
if(input()->exists('name') && input()->exists('lastname')) {
	// Do stuff
}

事件

本节将帮助您了解如何将自定义回调注册到路由器的事件中。它还将涵盖事件处理程序的基本知识；如何使用路由器提供的处理程序以及如何创建您自己的自定义事件处理程序。

可用事件

本节包含可以使用EventHandler注册的所有可用事件。

所有事件回调都将检索一个EventArgument对象作为参数。此对象包含对事件名称、路由器和请求实例以及任何与给定事件相关的特殊事件参数的轻松访问。您可以在下面的列表中查看每个事件返回的特殊事件参数。

注册新事件

要注册新事件，您需要创建一个EventHandler对象的新实例。在此对象上，您可以通过调用registerEvent方法添加任意数量的回调。

注册事件后，请确保通过调用SimpleRouter::addEventHandler()将其添加到路由器中。我们建议您在routes.php中添加您的事件处理程序。

示例

use Pecee\SimpleRouter\Handlers\EventHandler;
use Pecee\SimpleRouter\Event\EventArgument;

// --- your routes goes here ---

$eventHandler = new EventHandler();

// Add event that fires when a route is rendered
$eventHandler->register(EventHandler::EVENT_RENDER_ROUTE, function(EventArgument $argument) {
   
   // Get the route by using the special argument for this event.
   $route = $argument->route;
   
   // DO STUFF...
    
});

SimpleRouter::addEventHandler($eventHandler);

自定义事件处理程序

EventHandler是管理事件并必须从IEventHandler接口继承的类。处理程序知道如何处理给定处理程序类型的事件。

大多数情况下，基本的\Pecee\SimpleRouter\Handler\EventHandler类对于大多数人来说将绰绰有余，因为您只需注册一个事件，该事件在触发时就会触发。

让我们看一下如何创建您自己的事件处理程序类。

以下是一个自定义事件处理器DatabaseDebugHandler的基本示例。这个示例的目的是在触发时将所有事件记录到数据库中。希望这能让你对事件处理器的工作方式有一个大致的了解。

namespace Demo\Handlers;

use Pecee\SimpleRouter\Event\EventArgument;
use Pecee\SimpleRouter\Router;

class DatabaseDebugHandler implements IEventHandler
{

    /**
     * Debug callback
     * @var \Closure
     */
    protected $callback;

    public function __construct()
    {
        $this->callback = function (EventArgument $argument) {
            // todo: store log in database
        };
    }

    /**
     * Get events.
     *
     * @param string|null $name Filter events by name.
     * @return array
     */
    public function getEvents(?string $name): array
    {
        return [
            $name => [
                $this->callback,
            ],
        ];
    }

    /**
     * Fires any events registered with given event-name
     *
     * @param Router $router Router instance
     * @param string $name Event name
     * @param array ...$eventArgs Event arguments
     */
    public function fireEvents(Router $router, string $name, ...$eventArgs): void
    {
        $callback = $this->callback;
        $callback(new EventArgument($router, $eventArgs));
    }

    /**
     * Set debug callback
     *
     * @param \Closure $event
     */
    public function setCallback(\Closure $event): void
    {
        $this->callback = $event;
    }

}

高级

禁用多个路由渲染

默认情况下，路由器将尝试执行所有与给定URL匹配的路由。为了阻止路由器执行任何其他路由，任何方法都可以返回一个值。

您可以通过在routes.php文件中设置SimpleRouter::enableMultiRouteRendering(false)来轻松禁用此行为。这与版本3及以下相同。

限制IP访问

您可以使用内置的IpRestrictAccess中间件来白名单和/或黑名单对IP的访问。

创建您自己的自定义中间件并扩展IpRestrictAccess类。

IpRestrictAccess类包含两个属性ipBlacklist和ipWhitelist，可以将它们添加到中间件中以更改可以访问您的路由的IP。

您可以使用*来限制对IP范围的访问。

use \Pecee\Http\Middleware\IpRestrictAccess;

class IpBlockerMiddleware extends IpRestrictAccess 
{

    protected $ipBlacklist = [
        '5.5.5.5',
        '8.8.*',
    ];

    protected $ipWhitelist = [
        '8.8.2.2',
    ];

}

您可以通过将中间件添加到一个组中，将其添加到多个路由中。

设置自定义基本路径

有时，为添加的所有路由添加一个自定义基本路径可能很有用。

这可以通过利用项目的事件处理器支持轻松完成。

$basePath = '/basepath';

$eventHandler = new EventHandler();
$eventHandler->register(EventHandler::EVENT_ADD_ROUTE, function(EventArgument $event) use($basePath) {

	$route = $event->route;

	// Skip routes added by group as these will inherit the url
	if(!$event->isSubRoute) {
		return;
	}
	
	switch (true) {
		case $route instanceof ILoadableRoute:
			$route->prependUrl($basePath);
			break;
		case $route instanceof IGroupRoute:
			$route->prependPrefix($basePath);
			break;

	}
	
});

SimpleRouter::addEventHandler($eventHandler);

在上面的示例中，我们创建了一个新的EVENT_ADD_ROUTE事件，当添加新路由时触发。我们跳过所有子路由，因为这些将继承其父路由的URL。然后，如果路由是组，我们更改前缀
否则我们更改URL。

URL重写

更改当前路由

有时，操作即将加载的路由可能很有用。simple-php-router允许您轻松操作和更改即将渲染的路由。有关当前路由的所有信息都存储在\Pecee\SimpleRouter\Router实例的loadedRoute属性中。

为了方便访问，您可以使用快捷助手函数request()而不是直接调用类\Pecee\SimpleRouter\SimpleRouter::router()。

request()->setRewriteCallback('Example\MyCustomClass@hello');

// -- or you can rewrite by url --

request()->setRewriteUrl('/my-rewrite-url');

Bootmanager：动态加载路由

有时，可能需要将URL存储在数据库、文件或类似的地方。在这个例子中，我们希望URL/my-cat-is-beatiful加载路由/article/view/1，这是路由器知道的，因为它在routes.php文件中定义。

为了干扰路由器，我们创建了一个实现IRouterBootManager接口的类。这个类将在routes.php文件中的任何其他规则之前加载，并允许我们在满足我们的任何标准（如来自URL /my-cat-is-beatiful）时“更改”当前路由。

use Pecee\Http\Request;
use Pecee\SimpleRouter\IRouterBootManager;
use Pecee\SimpleRouter\Router;

class CustomRouterRules implement IRouterBootManager 
{

    /**
     * Called when router is booting and before the routes is loaded.
     *
     * @param \Pecee\SimpleRouter\Router $router
     * @param \Pecee\Http\Request $request
     */
    public function boot(\Pecee\SimpleRouter\Router $router, \Pecee\Http\Request $request): void
    {

        $rewriteRules = [
            '/my-cat-is-beatiful' => '/article/view/1',
            '/horses-are-great'   => '/article/view/2',
        ];

        foreach($rewriteRules as $url => $rule) {

            // If the current url matches the rewrite url, we use our custom route

            if($request->getUrl()->contains($url)) {
                $request->setRewriteUrl($rule);
            }
        }

    }

}

上面的内容应该是相当直观的，并且可以轻松地更改以遍历存储在数据库、文件或缓存中的URL。

发生的事情是，如果当前路由与我们的$rewriteRules数组中的索引定义的路由匹配，我们将路由设置为数组值。

通过这样做，路由现在将加载URL/article/view/1而不是/my-cat-is-beatiful。

最后，我们需要在routes.php文件中添加我们的自定义启动管理器。您可以创建尽可能多的启动管理器，并轻松地将它们添加到routes.php文件中。

SimpleRouter::addBootManager(new CustomRouterRules());

手动添加路由

在先前的示例中引用的SimpleRouter类只是一个简单的辅助类，它知道如何与Router类通信。如果您想接受挑战、想要完全控制或者只是想创建自己的Router辅助类，这个示例就是为您准备的。

use \Pecee\SimpleRouter\Router;
use \Pecee\SimpleRouter\Route\RouteUrl;

/* Create new Router instance */
$router = new Router();

$route = new RouteUrl('/answer/1', function() {

    die('this callback will match /answer/1');

});

$route->addMiddleware(\Demo\Middlewares\AuthMiddleware::class);
$route->setNamespace('\Demo\Controllers');
$route->setPrefix('v1');

/* Add the route to the router */
$router->addRoute($route);

自定义类加载器

您可以通过利用添加自定义类加载器的功能来轻松扩展simple-router以支持自定义注入框架，如php-di。

类加载器必须继承IClassLoader接口。

示例

class MyCustomClassLoader implements IClassLoader
{
    /**
     * Load class
     *
     * @param string $class
     * @return object
     * @throws NotFoundHttpException
     */
    public function loadClass(string $class)
    {
        if (\class_exists($class) === false) {
            throw new NotFoundHttpException(sprintf('Class "%s" does not exist', $class), 404);
        }

        return new $class();
    }
    
    /**
     * Called when loading class method
     * @param object $class
     * @param string $method
     * @param array $parameters
     * @return object
     */
    public function loadClassMethod($class, string $method, array $parameters)
    {
        return call_user_func_array([$class, $method], array_values($parameters));
    }

    /**
     * Load closure
     *
     * @param Callable $closure
     * @param array $parameters
     * @return mixed
     */
    public function loadClosure(Callable $closure, array $parameters)
    {
        return \call_user_func_array($closure, array_values($parameters));
    }

}

接下来，我们需要配置我们的routes.php，以便路由器使用我们的MyCustomClassLoader类来加载类。这可以通过在您的routes.php文件中添加以下行来完成。

SimpleRouter::setCustomClassLoader(new MyCustomClassLoader());

与php-di集成

自版本4.3起，php-di不再支持，但您可以轻松地通过创建自己的类加载器来重新添加它，如下面的示例所示

use Pecee\SimpleRouter\Exceptions\ClassNotFoundHttpException;

class MyCustomClassLoader implements IClassLoader
{

    protected $container;

    public function __construct()
    {
        // Create our new php-di container
        $this->container = (new \DI\ContainerBuilder())
                    ->useAutowiring(true)
                    ->build();
    }

    /**
     * Load class
     *
     * @param string $class
     * @return object
     * @throws NotFoundHttpException
     */
    public function loadClass(string $class)
    {
        if (class_exists($class) === false) {
            throw new NotFoundHttpException(sprintf('Class "%s" does not exist', $class), 404);
        }

		try {
			return $this->container->get($class);
		} catch (\Exception $e) {
			throw new NotFoundHttpException($e->getMessage(), (int)$e->getCode(), $e->getPrevious());
		}
    }
    
    /**
     * Called when loading class method
     * @param object $class
     * @param string $method
     * @param array $parameters
     * @return object
     */
    public function loadClassMethod($class, string $method, array $parameters)
    {
		try {
			return $this->container->call([$class, $method], $parameters);
		} catch (\Exception $e) {
			throw new NotFoundHttpException($e->getMessage(), (int)$e->getCode(), $e->getPrevious());
		}
    }

    /**
     * Load closure
     *
     * @param Callable $closure
     * @param array $parameters
     * @return mixed
     */
    public function loadClosure(callable $closure, array $parameters)
    {
		try {
			return $this->container->call($closure, $parameters);
		} catch (\Exception $e) {
			throw new NotFoundHttpException($e->getMessage(), (int)$e->getCode(), $e->getPrevious());
		}
    }
}

参数

本节包含关于扩展参数使用的进阶技巧和窍门。

扩展

这是将集成到框架中的简单示例。

该框架有一个自己的Router类，它继承自SimpleRouter类。这允许框架添加自定义功能，如加载自定义的routes.php文件或添加调试信息等。

namespace Demo;

use Pecee\SimpleRouter\SimpleRouter;

class Router extends SimpleRouter {

    public static function start() {

        // change this to whatever makes sense in your project
        require_once 'routes.php';

        // change default namespace for all routes
        parent::setDefaultNamespace('\Demo\Controllers');

        // Do initial stuff
        parent::start();

    }

}

帮助和支持

本节将详细介绍如何调试路由器，并回答一些常见的问题和问题。

常见问题和解决方案

本节将概述常见的问题及其解决方法。

参数无法匹配或特殊字符不与路由一起工作

当参数中包含特殊字符时，人们经常遇到此问题。路由器使用一个稀疏的正则表达式来匹配字母a-z以及数字，以匹配参数，以提高性能。

所有其他字符都必须通过您的路由上的defaultParameterRegex选项来定义。

有关如何为参数匹配添加自己的正则表达式，请点击此处。

多个路由匹配？哪个具有优先级？

路由器将按照它们添加的顺序匹配路由，如果匹配，将渲染多个路由。

如果您希望路由器在匹配到路由时停止，您只需在回调中返回一个值或手动停止执行（使用response()->json()等）或简单地返回一个结果。

任何实现了__toString()魔法方法的返回对象也将阻止其他路由的渲染。

如果您希望路由器在每个请求中只执行一个路由，您可以禁用多个路由渲染。

在子路径上使用路由器

请参阅文档中的设置自定义基本路径部分。

调试

本节将向您展示如何为路由器编写单元测试，查看有用的调试信息，并回答一些常见问题。

它还将涵盖如何报告您可能遇到的问题。

创建单元测试

调试路由器中任何问题的最简单、最快方法是创建一个代表您遇到的问题的单元测试。

单元测试使用特殊的TestRouter类，该类模拟浏览器请求方法和请求URL。

TestRouter类可以直接返回输出或静默渲染路由。

public function testUnicodeCharacters()
{
    // Add route containing two optional paramters with special spanish characters like "í".
    TestRouter::get('/cursos/listado/{listado?}/{category?}', 'DummyController@method1', ['defaultParameterRegex' => '[\w\p{L}\s-]+']);
    
    // Start the routing and simulate the url "/cursos/listado/especialidad/cirugía local".
    TestRouter::debugNoReset('/cursos/listado/especialidad/cirugía local', 'GET');
    
    // Verify that the url for the loaded route matches the expected route.
    $this->assertEquals('/cursos/listado/{listado?}/{category?}/', TestRouter::router()->getRequest()->getLoadedRoute()->getUrl());
    
    // Start the routing and simulate the url "/test/Dermatología" using "GET" as request-method.
    TestRouter::debugNoReset('/test/Dermatología', 'GET');

    // Another route containing one parameter with special spanish characters like "í".
    TestRouter::get('/test/{param}', 'DummyController@method1', ['defaultParameterRegex' => '[\w\p{L}\s-\í]+']);

    // Get all parameters parsed by the loaded route.
    $parameters = TestRouter::request()->getLoadedRoute()->getParameters();

    // Check that the parameter named "param" matches the exspected value.
    $this->assertEquals('Dermatología', $parameters['param']);

    // Add route testing danish special characters like "ø".
    TestRouter::get('/category/økse', 'DummyController@method1', ['defaultParameterRegex' => '[\w\ø]+']);
    
    // Start the routing and simulate the url "/kategory/økse" using "GET" as request-method.
    TestRouter::debugNoReset('/category/økse', 'GET');
    
    // Validate that the URL of the loaded-route matches the expected url.
    $this->assertEquals('/category/økse/', TestRouter::router()->getRequest()->getLoadedRoute()->getUrl());

    // Reset the router, so other tests wont inherit settings or the routes we've added.
    TestRouter::router()->reset();
}

使用TestRouter辅助工具

根据您的测试，您可以在单元测试中渲染路由时使用以下方法。

调试信息

库可以输出调试信息，其中包含有关加载的路由、解析的请求URL等信息。它还包含在报告新问题时重要的信息，例如PHP版本、库版本、服务器变量、路由调试日志等。

您可以通过调用替代的启动方法来激活调试信息。

下面的示例将启动路由并返回包含调试信息的数组

示例

$debugInfo = SimpleRouter::startDebug();
echo sprintf('<pre>%s</pre>', var_export($debugInfo));
exit;

上面的示例将提供包含以下内容的输出

基准和日志记录

您可以通过在Router实例上调用setDebugEnabled方法来激活基准调试/日志记录。

您必须在开始路由之前启用调试。

示例

SimpleRouter::router()->setDebugEnabled(true);
SimpleRouter::start();

路由完成时，您可以通过在Router实例上调用getDebugLog()来获取调试日志。这将返回一个包含执行时间、跟踪信息和调试信息的数组。

示例

$messages = SimpleRouter::router()->getDebugLog();

报告新问题

在报告问题之前，请确保您遇到的问题在常见错误部分或GitHub上的已关闭问题页面上已有解答。

为了避免混淆并尽快解决您的问题，您应该提供您遇到问题的详细说明。

报告新问题的程序

  1. 前往此页面创建新问题。
  2. 尽可能用最少的词语添加描述您问题的标题。
  3. 将下面的模板复制粘贴到您的问题描述中，并用您自己的信息替换每个步骤。如果步骤与您的问题不相关，您可以删除它。

问题模板

将下面的模板复制粘贴到您的新问题描述中，并用您自己的信息替换。

您可以通过查看调试信息部分来了解如何生成调试信息。

### Description

The library fails to render the route `/user/æsel` which contains one parameter using a custom regular expression for matching special foreign characters. Routes without special characters like `/user/tom` renders correctly.

### Steps to reproduce the error

1. Add the following route:

```php
SimpleRouter::get('/user/{name}', 'UserController@show')->where(['name' => '[\w]+']);
```

2. Navigate to `/user/æsel` in browser.

3. `NotFoundHttpException` is thrown by library.

### Route and/or callback for failing route

*Route:*

```php
SimpleRouter::get('/user/{name}', 'UserController@show')->where(['name' => '[\w]+']);
```

*Callback:*

```php
public function show($username) {
    return sprintf('Username is: %s', $username);
}
```

### Debug info

```php

[PASTE YOUR DEBUG-INFO HERE]

```

请记住，更详细的 issue 描述和调试信息可能难以撰写，但它们将帮助他人理解和解决问题，而无需询问信息。

注意：在创建新问题时，请尽可能详细地描述。这将帮助他人更容易理解和解决问题。在描述中提供重现错误的必要步骤，添加有用的调试信息等，将帮助他人快速解决您报告的问题。

反馈和发展

如果库缺少您在项目中需要的功能或您有反馈，我们非常乐意听取您的意见。请通过创建新问题给我们反馈。

遇到问题了吗？

在报告新问题之前，请先参考文档中的帮助和支持部分。

贡献开发指南

  • 请尽量遵循PSR-2代码风格指南。

  • 请将您的拉取请求创建到与您想要更改的版本号相匹配的开发基础/分支。例如，当将更改推送到版本3时，拉取请求应使用v3-development基础/分支。

  • 为您的提交创建详细描述，因为这些将被用于新发布版本的变更日志。

  • 在更改现有功能时，请确保单元测试正在运行。

  • 在添加新内容时，请记住为该功能添加新的单元测试。

致谢

网站

以下是一些在生产中使用simple-router项目的网站。

许可

MIT许可（MIT）

版权所有（c）2016 Simon Sessingø / simple-php-router

在此特此授予任何人免费获得此软件及其相关文档文件（“软件”）的副本的权利，无限制地处理软件，包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或出售软件副本，并允许向提供软件的个人提供上述权利，但受以下条件约束：

上述版权声明和本许可声明应包含在软件的所有副本或主要部分中。

本软件按“现状”提供，不提供任何形式的保证，无论是明确的还是隐含的，包括但不限于适销性、适用于特定目的和非侵权性保证。在任何情况下，作者或版权所有者都不应对任何索赔、损害或其他责任负责，无论该责任是由于合同、侵权或其他原因产生，无论与软件本身、使用软件或对软件的其他处理有关。