README

快速、类型安全的请求路由、参数检索和链接生成，支持 PSR-7。

组件

HTTP 异常

代表 HTTP 应用中常见情况的异常类

• InternalServerError
• MethodNotAllowed
• NotFoundException

BaseRouter

一个简单的类型化请求路由器。示例

<?hh // strict
/** TResponder can be whatever you want; in this case, it's a
 * callable, but classname<MyWebControllerBase> is also a
 * common choice.
 */
type TResponder = (function(ImmMap<string, string>):string);

final class BaseRouterExample extends BaseRouter<TResponder> {
  protected function getRoutes(
  ): ImmMap<HttpMethod, ImmMap<string, TResponder>> {
    return ImmMap {
      HttpMethod::GET => ImmMap {
        '/' =>
          ($_params) ==> 'Hello, world',
        '/user/{user_name}' =>
          ($params) ==> 'Hello, '.$params['user_name'],
      },
      HttpMethod::POST => ImmMap {
        '/' => ($_params) ==> 'Hello, POST world',
      },
    };
  }
}

为了简洁而简化 - 有关完整可执行示例，请参阅 examples/BaseRouterExample.php。

UriPatterns

生成 FastRoute 片段、URI（用于链接）并在一致且类型安全的方式中检索 URI 参数

<?hh // strict
final class UserPageController extends WebController {
  public static function getUriPattern(): UriPattern {
    return (new UriPattern())
      ->literal('/users/')
      ->string('user_name');
  }
  // ...
}

参数可以检索，并在运行时对值和定义进行类型检查

public function getResponse(): string {
  return 'Hello, '.$this->getUriParameters()->getString('user_name');
}

您还可以生成指向控制器的链接

$link = UserPageController::getUriBuilder()
  ->setString('user_name', 'Mr Hankey')
  ->getPath();

为了简洁而简化了这些示例 - 有关完整可执行示例，请参阅 examples/UriPatternsExample.php。

代码生成

hhvm/hack-router-codegen 项目在此基础上构建，可以自动生成

• 基于控制器中定义的 UriPatterns 的完整请求路由对象和 URI 映射
• 每个控制器的参数类，允许使用 $params->getFoo() 而不是 $params->getString('Foo')；这允许类型检查器捕获更多错误，并支持参数的 IDE 自动完成功能。
• 每个控制器的 UriBuilder 类，具有类似的好处

贡献

我们欢迎 GitHub 问题和建议 - 请参阅 CONTRIBUTING.md 以获取详细信息。

许可证

hack-router 是 MIT 许可。