spry_router 1.2.1

A request router for the Spry web framework that supports matching handlers from path expressions.

Spry Router

Spry makes it easy to build web applications and API applications in Dart with middleware composition processors. This package provides Spry with request routing handlers that dispatch requests to handlers by routing matching patterns.

Installation

Add the following to your pubspec.yaml file:

dependencies:
  spry_router: any

Or install it from the command line:

$ dart pub add spry_router

Example

import 'package:spry/spry.dart';
import 'package:spry_router/spry_router.dart';

void main() async {
  final spry = Spry();
  final router = Router();

  router.get('/hello', (Context context) {
    context.response.text('Hello World!');
  });

  await spry.listen(router, port: 3000);

  print('Server running on port 3000');
}

Handler

The Spry router is a standard Spry processor that takes a Context object as a parameter and returns a void object.

The router can be passed directly as a handler through spry.listen.

spry.listen(router, port: 3000);

It is also possible to create a standard HttpServer handler via spry.call.

final handler = await spry(router);

final server = await HttpServer.bind('localhost', 3000);
server.listen(handler);

Path expression

In Spry, route matching is achieved through path expressions, which are strings that can contain the following:

• String
• Parameter
• Wildcard
• Regular expression

String

A string is the simplest path expression, it's just an ordinary string, for example:

router.get('/hello', (Context context) {
   context.response.text('Hello World!');
});

Parameter

The parameter is a special string that can match any string, but it will pass the matched string as a parameter to the processor, for example:

router.get('/hello/:name', (Context context) {
   context.response.text('Hello ${context.request.params['name']}!');
});

Wildcard

A wildcard is a special string that can match any string, but it will not pass the matched string as a parameter to the processor, for example:

router.get('/hello/*', (Context context) {
   context.response.text('Hello World!');
});

The > represents any string, for example /hello/world, /hello/123, /hello/abc can all be matched.

Regular expression

A regular expression is a special string that can match any string, but it will not pass the matched string as a parameter to the processor, for example:

router.get(RegExp(r'/hello/\d+'), (Context context) {
   context.response.text('Hello World!');
});

The path expressions of Spry router are implemented through Prexp, so all path expressions supported by Preexp are supported.

To know more about the usage of Preexp, please refer to Prexp.

HTTP methods

Spry supports all registered Http methods, i.e. in [HTTP/1.1](https://tools.ietf. org/html/rfc2616) all methods defined in .

Also supports all method, which can match all Http methods.

router.route('get', '/hello', (Context context) {
   context.response.text('Hello World!');
});

Of course, every time you register a route through the route method, you need to specify the Http method, which will be very cumbersome, so Spry provides some shortcut methods, such as all, get, post, put , delete, head, options, patch, trace.

Middleware

Spry router supports standard Spry middleware, which can be registered through use method.

router.use((Context context, Next next) async {
   print('Before');
   await next();
   print('After');
});

Routing group middleware

In addition to being a standard Spry handler, each Router object is also a routing group, so middleware can be registered through the use method.

router.use((Context context, Next next) async {
   print('Before');
   await next();
   print('After');
});

For middleware registered through the use method, all routes under this Router object will take effect.

Routing middleware

Routes registered through the route method or routes registered through the shortcut method can register middleware through the use method.

final hello = router.route('get', '/hello', (Context context) {
   context.response.text('Hello World!');
});

hello.use((Context context, Next next) async {
   print('Before');
   await next();
   print('After');
});

The middleware registered in this way will only take effect under the /hello route.

Parameter middleware

When defining a routing group/routing, we may need to do some processing on the parameters before entering the processor, for example:

router.get('/hello/:name', (Context context) {
   context.response.text('Hello ${context.request.params['name']}!');
});

For the route defined in this way, we can get the name parameter through context.request.params, but if we need to do some processing on the name parameter, such as converting it to uppercase, then we can pass param method to register a parametric middleware.

router.param('name', (Context context, Object? value, ParamNext next) async {
   final String toUpper = value.toString().toUpperCase();
   await next(toUpper);
});

Thus, when we visit /hello/spry, the value of context.request.params['name'] is SPRY.

Get routing parameters

In the route handler, we can get route parameters through context.request.params.

router.get('/hello/:name', (Context context) {
   context.response.text('Hello ${context.request.params['name']}!');
});

Of course, we can also get routing parameters through context.request.param method.

router.get('/hello/:name', (Context context) {
   context.response.text('Hello ${context.request.param('name')}!');
});

Moduleization of routing

In Spry, routing can be modularized through Router objects.

final router = Router();

router.get('/hello', (Context context) {
   context.response.text('Hello World!');
});

final api = Router();

api.get('/users', (Context context) {
   context.response.text('Users');
});

router.mount('/api', router: api);

You can create your routes in groups without having to mount them uniformly.

Of course, if you need to merge multiple routers, it is also possible:

final root = Router();

router.get('/hello', (Context context) {
   context.response.text('Hello World!');
});

final users = Router();

users.get('/users', (Context context) {
   context.response.text('Users');
});

final posts = Router();

posts.get('/posts', (Context context) {
   context.response.text('Posts');
});


root..merge(users)..merge(posts);

Efficient Routing Spry Application

Manually defining routing files is always boring, we have a routing tool based on the file system, you only need to create directories and agreed files according to the rules, without manually defining routers.

Read the Spry Filesystem Router documentation for more information.