url_routes_generator.adoc

Генератор маршрутов URL

Since7.1

Иногда необходимо получить правильный URL некоторого экрана приложения, который можно отправить по электронной почте или показать пользователю. Самый простой способ создать его – использовать генератор маршрутов URL.

Генератор маршрутов URL предоставляет API для генерации ссылок на экран редактирования сущности или на экран, определенный его идентификатором или классом. Ссылка также может содержать параметры URL, которые позволяют отобразить внутреннее состояние экрана на URL, чтобы использовать его позже.

В бине UrlRouting реализован метод getRouteGenerator(), позволяющий получить экземпляр RouteGenerator. RouteGenerator имеет следующие методы:

• getRoute(String screenId) – возвращает маршрут для экрана с заданным screenId, например:

  link:../../../../../source/gui/url_route_generation1.java[role=include]

  Результирующий URL выглядит следующим образом:

  route = "http://host:port/context/#main/customers"

• getRoute(Class<? extends Screen> screenClass) – генерирует маршрут для экрана с заданным screenClass, например:

  link:../../../../../source/gui/url_route_generation2.java[role=include]

  Результирующий URL выглядит следующим образом:

  route = "http://host:port/context/#main/customers"

• getEditorRoute(Entity entity) – генерирует маршрут к дефолтному экрану редактирования заданной сущности, например:

  link:../../../../../source/gui/url_route_generation3.java[role=include]

  Результирующий URL выглядит следующим образом:

  route = "http://localhost:8080/app/#main/customers/edit?id=5jqtc3pwzx6g6mq1vv5gkyjn0s"

• getEditorRoute(Entity entity, Class<? extends Screen> screenClass) – генерирует маршрут для экрана редактирования с заданными screenClass и entity.

• getRoute(Class<? extends Screen> screenClass, Map<String, String> urlParams) – генерирует маршрут для экрана с заданными screenClass и urlParams.

Пример использования генератора маршрутов URL

Предположим, что у нас есть сущность Customer со стандартными экранами, для которых зарегистрированы маршруты. Добавим на экран браузера кнопку, которая генерирует ссылку на экран редактирования выбранной сущности:

link:../../../../../source/gui/url_route_generation.java[role=include]

Результирующий маршрут выглядит следующим образом: