Custom Routing

Play provides a mechanism to bind types from path or query string parameters.

PathBindable

PathBindable allows to bind business objects from the URL path; this means we’ll be able to define routes like /user/3 to call an action such as the following:

controller

@path

The user parameter will automatically be retrieved using the id extracted from the URL path, e.g. with the following route definition:

/conf/routes

@user

You can provide an implementation of PathBindable[A] for any type A you want to be able to bind directly from the request path. It defines abstract methods bind (build a value from the path) and unbind (build a path fragment from a value).

For a class definition:

@declaration

A simple example of the binder's use binding the :id path parameter:

@bind

In this example findById method is invoked to retrieve User instance; note that in real world such method should be lightweight and not involve e.g. DB access, because the code is called on the server IO thread and must be totally non-blocking.

You would therefore for example use simple objects identifier as path bindable, and retrieve the real values using action composition.

QueryStringBindable

A similar mechanism is used for query string parameters; a route like /age can be defined to call an action such as:

controller

@query

The age parameter will automatically be retrieved using parameters extracted from the query string e.g. /age?from=1&to=10

You can provide an implementation of QueryStringBindable[A] for any type A you want to be able to bind directly from the request query string. Similar to PathBindable, it defines abstract methods bind and unbind.

For a class definition:

@declaration

A simple example of the binder's use binding the :from and :to query string parameters:

@bind

All binders Play provides automatically apply form URL encoding in their unbind methods, so all special characters are safely URL encoded. This doesn't happen automatically however when implementing custom binders, therefore make sure to encode key/value parts if necessary:

@unbind