что такое router node js
Маршрутизация
Маршрутизация определяет, как приложение отвечает на клиентский запрос к конкретному адресу (URI). Вводную информацию о маршрутизации можно найти в разделе Основы маршрутизации.
Приведенный ниже код служит примером одного из самых простых маршрутов.
Методы Route
Приведенный ниже код служит примером маршрутов, определенных для методов запросов GET и POST к корневому каталогу приложения.
В приведенном ниже примере обработчик будет запущен для запросов, адресованных “/secret”, независимо от того, используется ли GET, POST, PUT, DELETE или какой-либо другой метод запроса HTTP, поддерживаемый в модуле http.
Пути маршрутов
Пути маршрутов, в сочетании с методом запроса, определяют конкретные адреса (конечные точки), в которых могут быть созданы запросы. Пути маршрутов могут представлять собой строки, шаблоны строк или регулярные выражения.
Строки запросов не являются частью пути маршрута.
Ниже приводятся примеры путей маршрутов на основе строк.
Ниже приводятся примеры путей маршрутов на основе шаблонов строк.
Примеры путей маршрутов на основе регулярных выражений:
Данный путь маршрута сопоставляет любой элемент с “a” в имени маршрута.
Обработчики маршрутов
Для обработки запроса можно указать несколько функций обратного вызова, подобных middleware. Единственным исключением является то, что эти обратные вызовы могут инициировать next(‘route’) для обхода остальных обратных вызовов маршрута. С помощью этого механизма можно включить в маршрут предварительные условия, а затем передать управление последующим маршрутам, если продолжать работу с текущим маршрутом не нужно.
Обработчики маршрутов могут принимать форму функции, массива функций или их сочетания, как показано в примерах ниже.
Одна функция обратного вызова может обрабатывать один маршрут. Например:
Один маршрут может обрабатываться несколькими функциями обратного вызова (обязательно укажите объект next ). Например:
Массив функций обратного вызова может обрабатывать один маршрут. Например:
Маршрут может обрабатываться сочетанием независимых функций и массивов функций. Например:
Методы ответа
Методы в объекте ответа ( res ), перечисленные в таблице ниже, могут передавать ответ клиенту и завершать цикл “запрос-ответ”. Если ни один из этих методов не будет вызван из обработчика маршрута, клиентский запрос зависнет.
| Метод | Описание |
|---|---|
| res.download() | Приглашение загрузки файла. |
| res.end() | Завершение процесса ответа. |
| res.json() | Отправка ответа JSON. |
| res.jsonp() | Отправка ответа JSON с поддержкой JSONP. |
| res.redirect() | Перенаправление ответа. |
| res.render() | Вывод шаблона представления. |
| res.send() | Отправка ответа различных типов. |
| res.sendFile | Отправка файла в виде потока октетов. |
| res.sendStatus() | Установка кода состояния ответа и отправка представления в виде строки в качестве тела ответа. |
app.route()
Метод app.route() позволяет создавать обработчики маршрутов, образующие цепочки, для пути маршрута. Поскольку путь указан в одном расположении, удобно создавать модульные маршруты, чтобы минимизировать избыточность и количество опечаток. Дополнительная информация о маршрутах приводится в документации Router().
express.Router
С помощью класса express.Router можно создавать модульные, монтируемые обработчики маршрутов. Экземпляр Router представляет собой комплексную систему промежуточных обработчиков и маршрутизации; по этой причине его часто называют “мини-приложением”.
В приведенном ниже примере создается маршрутизатор в виде модуля, в него загружается функция промежуточной обработки, определяется несколько маршрутов, и модуль маршрутизатора монтируется в путь в основном приложении.
Создайте файл маршрутизатора с именем birds.js в каталоге приложения со следующим содержанием:
Потом загрузите модуль маршрутизации в приложение:
Учебник Express часть 4: Маршруты и контроллеры
В этом уроке мы настроим маршруты (код обработки URL) с «фиктивными» функциями-обработчиками для всех конечных точек ресурса, которые нам понадобятся на веб-сайте LocalLibrary. По завершении мы получим модульную структуру для нашего кода обработки маршрута, который будет расширен реальными функциями-обработчиками в следующих статьях. У нас также будет хорошее понимание того, как создавать модульные маршруты с помощью Express!
Обзор
В последней статье мы определили модели Mongoose для взаимодействия с базой данных, и использовали (автономный) скрипт, который создал некоторые исходные записи библиотеки. Теперь можно написать код, чтобы представить эту информацию пользователям. Первое, что нужно сделать, это решить, какие возможности для отображения информации мы хотим иметь на наших страницах, а затем определить соответствующие URL-адреса для получения этих ресурсов. Затем нужно будет создать маршруты (обработчики URL-адресов) и представления (шаблоны) для отображения этих страниц.
Поскольку модели уже созданы, основные элементы, которые следует создать, таковы:
В первом разделе ниже приведён краткие основы того, как использовать промежуточное средство (middleware) Express Router. Эти знания будут использованы в следующих разделах при настройке маршрутов для LocalLibrary.
Есть несколько способов создания маршрутов. В этом уроке мы используем промежуточные запросы express.Router, так как они позволяют группировать обработчики маршрутов для определённой части сайта и получать к ним доступ через общий префикс маршрута. Все маршруты, связанные с библиотекой, будут сохранены в модуле «catalog», и если мы добавим маршруты для обработки учётных записей пользователей или других функций, мы сможем сгруппировать их отдельно.
В оставшейся части этого раздела представлен обзор того, как Router может быть использован для определения маршрутов.
Определение и использование отдельных модулей маршрутов
Код ниже является реальным примером того, как можно создать модуль маршрута, а затем использовать его в приложении Express.
Примечание: В примере колбэк-функции обработчиков маршрутов определены непосредственно в функциях роутеров. А в LocalLibrary мы определим эти колбэк-функции в отдельном модуле контроллера.
Чтобы использовать модуль роутера в главном приложении, прежде всего следует выполнить require() модуля маршрута (wiki.js). Потом вызовем use() для приложения Express с аргументом, в котором указан URL-путь ‘wiki’, что добавит Router к пути обработки промежуточного слоя.
Функции Route
HTTP глаголы (действия)
Рассмотренный пример использует метод Router.get() для ответа на HTTP GET- запросы с указанным путём.
Например, код ниже делает то же, что и предыдущий, с путём /about, но отвечает на HTTP POST-запросы.
Маршруты путей
Маршруты путей определяют конечные точки, в которых могут быть сделаны запросы. В уже рассмотренных примерах это были просто строки, которые использовались точно так, как были записаны: ‘/’, ‘/about’, ‘/book’, ‘/any-random.path’.
Примечание: Большинство наших маршрутов для библиотеки будут просто строками, а не образцами строк или регулярными выражениями. Кроме того, будут использоваться параметры маршрутов, что обсуждается в следующем разделе.
Параметры маршрутов
Имена параметров пути должны состоять из “символов слова” (A-Z, a-z, 0-9, и _).
Маршруты, необходимые для библиотеки LocalLibrary
Первая домашняя страница и страницы со списками не кодируют никакой дополнительной информации. Хотя результаты, возвращаемые запросами, будут зависеть от типа модели и от содержимого БД, запросы для получения этой информации всегда будут одинаковы (подобно тому, как код для создания объектов всегда будет одним и тем же).
В противоположность этому, другие URL используются для работы с определёнными экземплярами документов и моделей— индивидуальность элементов кодируется в URL (как выше). Параметры путей используются для извлечения информации и передачи её в обработчик пути (и в следующей статье мы применим этот приём для того, чтобы динамически определять, какую информацию следует получить из БД). By encoding the information in our URL we only need one route for every resource of a particular type (e.g. one route to handle the display of every single book item).
Далее мы создадим колбэк-функции обработчиков маршрутов и код маршрутов для всех указанных выше URL.
Создаём колбэк-функции обработчиков маршрутов
Начнём с создания каталога для контроллеров в корне проекта (/controllers), а затем создадим отдельные файлы (модули) контроллеров для работы с моделями:
Контроллер автора
Скопируем следующий код в файл /controllers/authorController.js:
BookInstance controller
Скопируйте следующий код в файл /controllers/bookinstanceController.js (он построен по образцу модуля контроллера для автора Author ):
Контроллер жанра
Скопируйте следующий код в файл /controllers/genreController.js (он построен по образцу модулей контроллеров для автора Author и экземпляра книги BookInstance ):
Контроллер книги
Скопируйте следующий код в файл /controllers/bookController.js. Он построен по образцу других модулей контроллеров, но ещё содержит функцию index() для вывода странички с приветствием:
Создание модуля для маршрута catalog
Далее мы создадим маршруты для всех URL, необходимых веб-сайту LocalLibrary, которые будут вызывать функции контроллеров, определённые в предыдущем разделе.
Каркас приложения уже содержит каталог ./routes, в котором есть маршруты для index и users. Внутри этого каталога создадим ещё один файл маршрутов — catalog.js ( см. ниже).
Скопируйте приведённый ниже код в файл /routes/catalog.js :
Все функции-обработчики импортируются из созданных в предыдущем разделе модулей контроллеров.
Обновление модуля маршрута index
Все новые маршруты заданы, а маршрут на начальную страницу остался без изменения. Давайте перенаправим его на новую страницу «index», которая создана в каталоге ‘/catalog’.
Откройте /routes/index.js и замените существующий маршрут приведённую ниже.
Обновление app.js
Откройте файл app.js и поместите require для маршрута каталог ниже других маршрутов (добавьте третью строку. показанную ниже, после имеющихся двух строк):
Далее, добавьте маршрут каталога в стек промежуточного слоя после других маршрутов (добавить третью строку после имеющихся двух):
Вот так. Теперь у нас есть пути и фиктивные функции, подготовленные для всех URL, которые мы собираемся поддерживать на веб-сайте LocalLibrary.
Проверка маршрутов
Чтобы проверить маршруты, сначала запустим веб-сайт обычным способом
После запуска перейдите к совокупности URL нашей LocalLibrary, и проверьте, что не появляется страница ошибки (HTTP 404). Небольшая часть наших URL для удобства приводится ниже:
Созданы все маршруты для нашего сайта. Созданы также фиктивные функции контроллеров, которые мы полностью реализуем в последующих статьях. Попутно мы изучили массу базовых сведений о маршрутах Express, и ознакомились с некоторыми подходами по структурированию маршрутов и контроллеров.
В следующей статье мы создадим настоящую страничку приветствия нашего сайта, для чего используем представления (шаблоны) и данные, хранящиеся в наших моделях.