Маршрутизация
Маршрутизация определяет, как приложение отвечает на клиентский запрос к конкретному адресу (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.js
Если вы занимались разработкой для платформы node.js, то вы, наверняка, слышали об express.js. Это — один из самых популярных легковесных фреймворков, используемых при создании веб-приложений для node.
Базовый пример использования express
Для начала взглянем на традиционный в деле освоения новых компьютерных технологий «Hello World!»-пример. Его можно найти на официальном сайте фреймворка, он послужит отправной точкой в наших исследованиях.
Создание нового приложения express
Создание нового маршрута
Взглянем теперь на код, который ответственен за создание метода app.get из нашего примера.
Метод маршрутизатора route() объявлен в lib/router/index.js:
Неудивительно то, что объявление метода route.get в lib/router/route.js похоже на объявление app.get :
Объекты типа Layer
При создании объектов типа Layer им передают путь, некие параметры, и функцию. В случае нашего маршрутизатора этой функцией является route.dispatch (подробнее о ней мы поговорим ниже, в общих чертах, она предназначена для передачи запроса отдельному маршруту). В случае с самим маршрутом, эта функция является функцией-обработчиком, объявленной в коде нашего примера.
У каждого объекта типа Layer есть метод handle_request, который отвечает за выполнение функции, переданной при инициализации объекта.
Вспомним, что происходит при создании маршрута с использованием метода app.get :
Объекты типа Layer в стеке маршрутизатора и в стеке маршрутов
Поступающие HTTP-запросы обрабатываются в соответствии с этой логикой. Мы поговорим о них ниже.
Запуск HTTP-сервера
После понимания того, что, в итоге, всё, что даёт нам express.js, может быть сведено к весьма интеллектуальной функции-обработчику, фреймворк выглядит уже не таким сложным и таинственным, как раньше.
Обработка HTTP-запроса
Теперь, когда мы знаем, что app — это всего лишь обработчик запросов, проследим за путём, который проходит HTTP-запрос внутри приложения express. Этот путь ведёт его в объявленный нами обработчик.
Сначала запрос поступает в функцию createApplication (lib/express.js):
Потом он идёт в метод app.handle (lib/application.js):
Здесь, наконец, HTTP-запрос попадает в область кода нашего приложения.
Путь запроса в приложении express
Итоги
Надеемся, этот материал помог вам разобраться в основных особенностях устройства express, и теперь вы, при необходимости, сможете понять всё остальное, самостоятельно проанализировав интересующие вас части исходного кода этой библиотеки.
Routing
Routing refers to how an application’s endpoints (URIs) respond to client requests. For an introduction to routing, see Basic routing.
You define routing using methods of the Express app object that correspond to HTTP methods; for example, app.get() to handle GET requests and app.post to handle POST requests. For a full list, see app.METHOD. You can also use app.all() to handle all HTTP methods and app.use() to specify middleware as the callback function (See Using middleware for details).
These routing methods specify a callback function (sometimes called “handler functions”) called when the application receives a request to the specified route (endpoint) and HTTP method. In other words, the application “listens” for requests that match the specified route(s) and method(s), and when it detects a match, it calls the specified callback function.
In fact, the routing methods can have more than one callback function as arguments. With multiple callback functions, it is important to provide next as an argument to the callback function and then call next() within the body of the function to hand off control to the next callback.
The following code is an example of a very basic route.
Route methods
A route method is derived from one of the HTTP methods, and is attached to an instance of the express class.
The following code is an example of routes that are defined for the GET and the POST methods to the root of the app.
Route paths
Route paths, in combination with a request method, define the endpoints at which requests can be made. Route paths can be strings, string patterns, or regular expressions.
Express uses path-to-regexp for matching the route paths; see the path-to-regexp documentation for all the possibilities in defining route paths. Express Route Tester is a handy tool for testing basic Express routes, although it does not support pattern matching.
Query strings are not part of the route path.
Here are some examples of route paths based on strings.
Here are some examples of route paths based on string patterns.
Examples of route paths based on regular expressions:
This route path will match anything with an “a” in it.
Route parameters
Route parameters are named URL segments that are used to capture the values specified at their position in the URL. The captured values are populated in the req.params object, with the name of the route parameter specified in the path as their respective keys.
To define routes with route parameters, simply specify the route parameters in the path of the route as shown below.
The name of route parameters must be made up of “word characters” ([A-Za-z0-9_]).
To have more control over the exact string that can be matched by a route parameter, you can append a regular expression in parentheses ( () ):
Route handlers
You can provide multiple callback functions that behave like middleware to handle a request. The only exception is that these callbacks might invoke next(‘route’) to bypass the remaining route callbacks. You can use this mechanism to impose pre-conditions on a route, then pass control to subsequent routes if there’s no reason to proceed with the current route.
Route handlers can be in the form of a function, an array of functions, or combinations of both, as shown in the following examples.
A single callback function can handle a route. For example:
More than one callback function can handle a route (make sure you specify the next object). For example:
An array of callback functions can handle a route. For example:
A combination of independent functions and arrays of functions can handle a route. For example:
Response methods
The methods on the response object ( res ) in the following table can send a response to the client, and terminate the request-response cycle. If none of these methods are called from a route handler, the client request will be left hanging.
| Method | Description |
|---|---|
| res.download() | Prompt a file to be downloaded. |
| res.end() | End the response process. |
| res.json() | Send a JSON response. |
| res.jsonp() | Send a JSON response with JSONP support. |
| res.redirect() | Redirect a request. |
| res.render() | Render a view template. |
| res.send() | Send a response of various types. |
| res.sendFile() | Send a file as an octet stream. |
| res.sendStatus() | Set the response status code and send its string representation as the response body. |
app.route()
express.Router
Use the express.Router class to create modular, mountable route handlers. A Router instance is a complete middleware and routing system; for this reason, it is often referred to as a “mini-app”.
The following example creates a router as a module, loads a middleware function in it, defines some routes, and mounts the router module on a path in the main app.
Create a router file named birds.js in the app directory, with the following content:
Then, load the router module in the app:
Учебник 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, и ознакомились с некоторыми подходами по структурированию маршрутов и контроллеров.
В следующей статье мы создадим настоящую страничку приветствия нашего сайта, для чего используем представления (шаблоны) и данные, хранящиеся в наших моделях.
Начало работы с Node — Часть 2: Базовая маршрутизация
Перевод серии статей по основам работы с Node.js, написанной Ником Даггером. Оригинал статей находится на tech.pro.
В первой части серии статей, мы исследовали возможности Node и то, как создать базовый сервер, обслуживающий один HTML-файл.
Да, это классно, но это не делает нас крутыми — мы застряли на странице с одним статичным видом. Прежде чем начать разбираться с маршрутизацией, давайте обратимся к коду из первой части.
Реструктуризация сервера
Код, написанный в первой части очень простой. Но что, если мы хотим, чтобы выполнялись какие-либо действия до запуска сервера (например, получение маршрутов)? Давайте реструктуризируем наш предыдущий код в класс и добавим пару методов:
Как вы можете заметить, мы используем тот же код, чтобы запустить сервер, но теперь он представлен структурированным классом со своими статическими методами.
Хранение маршрутов
Следующим шагом будет создание файла routes.json и его структуры. В этом файле будут храниться данные, в зависимости от которых сервер будет отвечать на запросы.
Первое свойство родительского объекта — это путь. Внутри пути находятся имена обработчика и метода, которые вы хотите вызвать.
Теперь, когда у нас есть файл маршрутов, нужно прочесть его перед тем, как создать сервер. Для этого мы снова используем модуль для работы с файловой системой.
Обещания (Promises)
Реализуем чтение из файла с помощью readFile :
Куда мы идем?
Подключаем модуль url в начале файла (так же, как и с предыдущими модулями) и добавляем следующую строку внутри функции обратного вызова у http.createServer :
Ну, сейчас мы знаем куда хочет пойти браузер, но как мы можем попросить сервер отвести нас туда? Для этого у нас есть маршруты. Создадим маршрутизатор и проверим запрошенный путь.
Поиск маршрута
Так как мы строим очень простой маршрутизатор, теперь, все что нам нужно — это перебрать все маршруты и сравнить их с тем, что запросил браузер.
Здесь мы возвращаем маршрут, конечно, если он существует. Теперь нужно использовать маршрутизатор на нашем сервере по требованию обработчика при выполнении действий или методов. Я обещаю, что это легко!
Выполнение маршрута
Обработка запроса
Новый обработчик должен выглядеть следующим образом:
Теперь вы видите, как это соотносится с нашим маршрутизатором. Поле «обработчик» в нашем JSON-файле ссылается на имя JS-файла и действие, соответствующее статическому методу внутри нашего класса.
Связываем все вместе
Сейчас, когда у нас есть обработчик, пишущий ответ на запрос, нам нужен сервер, который бы его использовал.
Великолепно! Теперь у нас есть сервер, перестроенный в класс, а также маршрутизатор, использующий запрошенный URL-адрес для поиска маршрута. После того, как маршрут найден, мы пытаемся подключить указанный в routes.json обработчик и вызвать метод, передав объект ответа.
Все вместе это будет выглядеть следующим образом:
routes.json:
main.js:
Мы должны быть очень горды своей работой, но лишь до тех пор, пока мы не захотим передать параметры в наш маршрут, например, идентификатор записи в блоге. В следующей части этой серии статей мы научим наш маршрутизатор работать с передаваемыми параметрами и расширим его.
Для удобства чтения и рассмотрения кода я собрал весь код из статьи в репозиторий, доступный на GitHub по этой ссылке.
Навигация
Делимся на оплату хостинга или кофе.
Чем чаще пью кофе, тем чаще пишу статьи.
