Обработка переменных пути #

Описание маршрутизатора и обработчика с переменной пути #

При описании маршрутов в маршрутизаторе http4k разработчик может указать переменную пути:

val triangleStorage = TriangleStorage()
val getTriangleByIdOperation = getTriangleByIdOperationImpl(triangleStorage)
val triangleHandler = TriangleHandler(getTriangleByIdOperation)
routes(
    "/triangles/{id}" bind Method.GET to triangleHandler,
)

Внутри обработчика можно получить доступ к переменной пути с помощью метода Request.path:

class TriangleHandler(
    private val getTriangleByIdOperation: GetTriangleByIdOperation
) : HttpHandler {
    override fun invoke(request: Request): Response {
        val id: String? = request.path("id")
        ...
    }
}

• Данные приходят в строковом формате.
• Данные могут не придти от пользователя.

Как работает функция Request.path #

Рассмотрим реализацию функции Request.path:

fun Request.path(name: String): String? = when (this) {
    is RequestWithRoute -> xUriTemplate.extract(uri.path)[name]
    else -> throw IllegalStateException("Request was not routed, so no uri-template present")
}

Из реализации видно, что функция работает не с интерфейсом Request, а с интерфейсом RequestWithRoute. Единственный класс, который реализует данный интерфейс внутри библиотеки http4k — это класс RoutedRequest, обладающий следующим конструктором:

RoutedRequest(private val delegate: Request, override val xUriTemplate: UriTemplate)

Описание шаблона пути происходит с помощью класса UriTemplate, который можно создать с помощью фукнции-конструктора UriTemplate.from.

Задание № 1. Реализация хранилища треугольников #

Добавьте к треугольнику новое поле — уникальный идентификатор. В качестве типа идентификатора удобно выбрать число: целое число или UUID. Рекомендуется оформить класс треугольника как класс данных с неизменяемыми полями.

Для управления списком уникальных треугольников реализуйте хранилище треугольников. Данный класс должен предоставлять следующие возможности:

• Хранение списка треугольников.
• Получение всех треугольников.
• Добавление треугольника.
• Получение треугольника по его уникальному идентификатору. Данная функция может вернуть либо объект треугольника, либо null, если не был найден треугольник с данным идентификатором.

Данными этого класса должны стать:

• Словарь с ключами уникального идентификатора и значением объектами треугольниками. Поля класса должны быть приватными, т.к. они являются изменяемыми.

Параметрами конструктора должен стать список треугольников. На основании данного списка формируются данные класса.

Задание № 2. Реализация отображения конкретного треугольника #

Реализуйте отображение информации о конкретном треугольнике по пути /v1/triangle/{triangle-id}. Если по указанному пути треугольник не был найден, то обработчик должен возвращать статус 404, NOT_FOUND.

Ключевые части по решению задачи:

• Добавьте операцию по получению треугольника из хранилища.
• Реализуйте HTTP-обработчик для отображения информации о треугольнике:
  • Он должен принимать в качестве аргумента объекты генератора JSON и операции.
  • Из запроса извлеките значение переменной пути triangle-id, преобразуйте его к идентификатору.
  • Если данные не были переданы или они не содержат корректный UUID,то должен быть возвращён ответ с кодом 400, BAD REQUEST, и следующим содержимым:

    {
      "error": "Некорректный идентификатор треугольника. Для параметра triangle-id ожидается UUID, но получено значение «ЗНАЧЕНИЕ»"
    }

    Тип документа тоже должен быть указан корректно.
  • Используйте операцию, передав ей полученный идентификатор.
  • Если извлечь данные не удалось (операция вернула null), то обработчик должен вернуть ответ с кодом 404, NOT FOUND, и следующим содержимым:

    {
    
      "triangle-id": "f0dcea8c-7a56-4223-ae43-3c664b50a603",
      "error": "Треугольник не найден"
    
    }

  • При успешном получении треугольника из операции верните ответ со статусом 200, OK, и следующим JSON-документом:

    {
    
      "Id": "66ade672-2301-4408-9471-8a17aa883d65",
      "SideA": 1,
      "SideB": 2,
      "SideC": 3,
      "RegistrationDateTime": "2024-07-01T00:00:00.0",
      "BorderColor": "BLUE",
      "FillColor": "GREEN",
      "Description": "странные данные, это не треугольник",
      "Area": null,
      "Type": "некорректный"
    }

• Реализуйте модульные тесты на созданный HTTP-обработчик.
• Свяжите данный обработчик HTTP-запроса с маршрутом /v1/triangle/{triangle-id}.

Задание № 3. Обработка отсутствия параметра #

Особенностью http4k является то, что запрос по маршруту /v1/triangle/ без указания дополнительной информации, не будет передан связанному обработчику HTTP-запроса.

Доработайте приложение таким образом, чтобы при обращении по маршруту /v1/triangle/ приложение также возвращало ответ с кодом 400, BAD REQUEST, с сообщением, соответствующем некорректному идентификатору треугольника.