Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bermudaphp/router
SImple, flexible and very fast http-router with support psr-7 and psr-15
https://github.com/bermudaphp/router
http-router php php-router php8 php81 psr-15 psr-7 router routing uri url
Last synced: 2 months ago
JSON representation
SImple, flexible and very fast http-router with support psr-7 and psr-15
- Host: GitHub
- URL: https://github.com/bermudaphp/router
- Owner: bermudaphp
- License: mit
- Created: 2020-05-13T17:29:27.000Z (over 4 years ago)
- Default Branch: v4
- Last Pushed: 2024-05-22T14:33:42.000Z (7 months ago)
- Last Synced: 2024-05-23T00:56:10.580Z (7 months ago)
- Topics: http-router, php, php-router, php8, php81, psr-15, psr-7, router, routing, uri, url
- Language: PHP
- Homepage:
- Size: 487 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Installation
```bash
composer require bermudaphp/router
````
## Usage
```php
use Bermuda\Router\Routes;
$routes = new Routes;
$router = Router::fromDnf($routes);
$routes->addRoute(
RouteRecord::get('home', '/hello/[name]', static function(string $name): void {
echo sprintf('Hello, %s!', $name)
})
);
$route = $router->match($_SERVER['REQUEST_URI'], $_SERVER['REQUEST_METHOD']);
if (!route) {
// route not found logics
}
call_user_func($route->handler, $route->params['name']);
```
## Route path generation
```php
echo $router->generate('home', ['name' => 'Jane Doe']); // Output /hello/Jane%20Doe
```
## Usage with PSR-15
```php
$pipeline = new \Bermuda\Pipeline\Pipeline();
$factory = new \Bermuda\MiddlewareFactory\MiddlewareFactory($container, $responseFactory);
class Handler implements RequestHandlerInterface
{
public function handle(ServerRequestInterface $request): ResponseInterface
{
return new TextResponse(sprintf('Hello, %s!', $request->getAttribute('name')))
}
};
$routes->addRoute(
RouteRecord::get('home', '/hello/[name:[a-z]]', Handler::class)
);
$pipeline->pipe($factory->make(Bermuda\Router\Middleware\MatchRouteMiddleware::class));
$pipeline->pipe($factory->make(Bermuda\Router\Middleware\DispatchRouteMiddleware::class)
->setFallbackHandler($container->get(Bermuda\Router\Middleware\RouteNotFoundHandler::class)));
$response = $pipeline->handle($request);
send($response)
```
## Get current route data
```php
class Handler implements RequestHandlerInterface
{
public function handle(ServerRequestInterface $request): ResponseInterface
{
$route = $request->getAttribute('Bermuda\Router\Middleware\RouteMiddleware')->route; // MatchedRoute instance
}
};
```
## RouteRecord HTTP verbs helpers
```php
RouteRecord::get(string $name, string $path, mixed $handler): RouteRecord ;
RouteRecord::post(string $name, string $path, mixed $handler): RouteRecord ;
RouteRecord::patch(string $name, string $path, mixed $handler): RouteRecord ;
RouteRecord::put(string $name, string $path, mixed $handler): RouteRecord ;
RouteRecord::delete(string $name, string $path, mixed $handler): RouteRecord ;
RouteRecord::options(string $name, string $path, mixed $handler): RouteRecord ;
RouteRecord::head(string $name, string $path, mixed $handler): RouteRecord ;
```
## Set attribute placeholder pattern
```php
$routes->addRoute(RouteRecord::get('users.get, '/api/v1/users/[id:[a-zA-Z]]', static function(ServerRequestInterface $request): ResponseInterface {
return findUser($request->getAttribute('id'));
}));
alternative:
$routes->addRoute(RouteRecord::get('users.get, '/api/v1/users/[id]', static function(ServerRequestInterface $request): ResponseInterface {
return findUserById($request->getAttribute('id'));
})->withToken('id', '[a-zA-Z]'));
```
## Optional attribute
```php
$routes->addRoute(RouteRecord::get('users.get, '/api/v1/users/[?id]', static function(ServerRequestInterface $request): ResponseInterface {
if (($id = $request->getAttribute('id')) !== null) {
return findUserById($id);
}
return get_all_users();
}));
```
## Predefined placeholders
````
id: \d+
any: .*
````
Other placeholders passed to path as a string without being explicitly defined will match the pattern `.+`
## Routes Group
```php
$group = $routes->group(name: 'api', prifix: '/api'); // set routes group
$group->addRoute(RouteRecord::get('users.get, 'users/[?id]', GetUserHandler::class));
$group->addRoute(RouteRecord::post(user.create, 'users', CreateUserHandler::class));
$group->setMiddleware([GuardMiddleware::class]) // set middleware for all routes in group
$group->setTokens(['id' => '[a-zA-Z]']) // set tokens for all routes in group
$group = $routes->group('api') // get routes group from name
```
## Cache
Once all routes are registered in the route map and they will no longer be changed. Call the $routes->cache method to cache the route map in a php file. Then use the `Routes::createFromCache('/path/to/cached/routes/filename.php')` method to create a map instance with preloaded routes.
```php
$routes->cache('path/to/cached/routes/file.php');
$routes = Routes::createFromCache('path/to/cached/routes/file.php')
$router = Router::fromDnf($routes);
```
# Cache context
If you are using a parent-context-bound closure (the use construct) as a route handler, then you must pass an array of bound variables to the `Routes::createFromCache` method. See example below
```php
$app = new App;
$repository = new UserRepository;
$routes->addRoute(RouteRecord::get('user.get', '/users/[id]', static function(ServerRequest $request) use ($app, $repository): ResponseInterface {
return $app->respond(200, $repository->findById($request->getAttribute('id')));
}));
$routes->cache('path/to/cached/routes/file.php');
$routes = Routes::createFromCache('path/to/cached/routes/file.php', compact('app', 'repository'));
```
# Cache limitations
Currently, the caching implementation does not allow caching routes using object instances and callback functions based on object instances.
# Benchmark
```
+---------------------------+-------------------+------------+-----------------+-------+--------------+-------------------+
| benchmark | registered_routes | cache_mode | exec_time | its | memory_usage | memory_peak_usage |
+---------------------------+-------------------+------------+-----------------+-------+--------------+-------------------+
| Benchmark\RouterBenchmark | 1001 | disable | 32.680938005447 | 10000 | 16 MB | 16 MB |
| Benchmark\RouterBenchmark | 1001 | enable | 1.298574924469 | 10000 | 16 MB | 16 MB |
+---------------------------+-------------------+------------+-----------------+-------+--------------+-------------------+
````