Security News
Introducing the Socket Python SDK
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.
@e22m4u/js-trie-router
Advanced tools
ES-модуль HTTP роутера для Node.js, использующий Trie для разрешения маршрутов.
cookie
.preHandler
и postHandler
хуков.npm install @e22m4u/js-trie-router
Для загрузки ES-модуля требуется установить "type": "module"
в файле
package.json
, или использовать .mjs
расширение.
Базовый пример создания экземпляра роутера, объявления маршрута
и передачи слушателя запросов http
серверу.
import http from 'http';
import {TrieRouter} from '@e22m4u/js-path-trie';
const server = new http.Server(); // создание экземпляра HTTP сервера
const router = new TrieRouter(); // создание экземпляра роутера
router.defineRoute({
method: 'GET', // метод запроса "GET", "POST" и т.д.
path: '/', // шаблон пути, пример "/user/:id"
handler(ctx) { // обработчик маршрута
return 'Hello world!';
},
});
server.on('request', router.requestListener); // подключение роутера
server.listen(3000, 'localhost'); // прослушивание запросов
// Open in browser http://localhost:3000
Первый параметр обработчика маршрута принимает экземпляр класса
RequestContext
с набором свойств, содержащих разобранные
данные входящего запроса.
container: ServiceContainer
экземпляр сервис-контейнераreq: IncomingMessage
нативный поток запроса модуля http
res: ServerResponse
нативный поток ответа модуля http
params: ParsedParams
объект ключ-значение с параметрами путиquery: ParsedQuery
объект ключ-значение с параметрами строки запросаheaders: ParsedHeaders
объект ключ-значение с заголовками запросаcookie: ParsedCookie
объект ключ-значение разобранного заголовка cookie
method: string
метод запроса в верхнем регистре, например GET
, POST
и т.д.path: string
путь включающий строку запроса, например /myPath?foo=bar
pathname: string
путь запроса, например /myMath
Пример доступа к контексту из обработчика маршрута.
router.defineRoute({
method: 'GET',
path: '/users/:id',
handler(ctx) {
// GET /users/10?include=city
// Cookie: foo=bar; baz=qux;
console.log(ctx.req); // IncomingMessage
console.log(ctx.res); // ServerResponse
console.log(ctx.params); // {id: 10}
console.log(ctx.query); // {include: 'city'}
console.log(ctx.headers); // {cookie: 'foo=bar; baz=qux;'}
console.log(ctx.cookie); // {foo: 'bar', baz: 'qux'}
console.log(ctx.method); // "GET"
console.log(ctx.path); // "/users/10?include=city"
console.log(ctx.pathname); // "/users/10"
// ...
},
});
Возвращаемое значение обработчика маршрута используется в качестве ответа
сервера. Тип значения влияет на представление возвращаемых данных. Например,
если результатом будет являться тип object
, то такое значение автоматически
сериализуется в JSON.
value | content-type |
---|---|
string | text/plain |
number | application/json |
boolean | application/json |
object | application/json |
Buffer | application/octet-stream |
Stream | application/octet-stream |
Пример возвращаемого значения обработчиком маршрута.
router.defineRoute({ // регистрация маршрута
// ...
handler(ctx) { // обработчик входящего запроса
return {foo: 'bar'}; // ответ будет представлен в виде JSON
},
});
Контекст запроса ctx
содержит нативный экземпляр класса ServerResponse
,
который может быть использован для ручного управления ответом.
router.defineRoute({
// ...
handler(ctx) {
res.statusCode = 404;
res.setHeader('content-type', 'text/plain; charset=utf-8');
res.end('404 Not Found', 'utf-8');
},
});
Определение маршрута методом defineRoute
позволяет задать хуки
для отслеживания и перехвата входящего запроса и ответа
конкретного маршрута.
preHandler
выполняется перед вызовом обработчикаpostHandler
выполняется после вызова обработчикаПеред вызовом обработчика маршрута может потребоваться выполнение
таких операции как авторизация и проверка параметров запроса. Для
этого можно использовать хук preHandler
.
router.defineRoute({ // регистрация маршрута
// ...
preHandler(ctx) {
// вызывается перед обработчиком
console.log(`Incoming request ${ctx.method} ${ctx.path}`);
// Incoming request GET /myPath
},
handler(ctx) {
return 'Hello world!';
},
});
Если хук preHandler
возвращает значение отличное от undefined
и null
,
то такое значение будет использовано в качестве ответа сервера, а вызов
обработчика маршрута будет пропущен.
router.defineRoute({ // регистрация маршрута
// ...
preHandler(ctx) {
// возвращение ответа сервера
return 'Are you authorized?';
},
handler(ctx) {
// данный обработчик не вызывается, так как
// хук "preHandler" уже отправил ответ
},
});
Возвращаемое значение обработчика маршрута передается вторым аргументом
хука postHandler
. По аналогии с preHandler
, если возвращаемое
значение отличается от undefined
и null
, то такое значение будет
использовано в качестве ответа сервера. Это может быть полезно для
модификации возвращаемого ответа.
router.defineRoute({
// ...
handler(ctx) {
return 'Hello world!';
},
postHandler(ctx, data) {
// выполняется после обработчика маршрута
return data.toUpperCase(); // HELLO WORLD!
},
});
Экземпляр роутера TrieRouter
позволяет задать глобальные хуки, которые
имеют более высокий приоритет перед хуками маршрута, и вызываются
в первую очередь.
preHandler
выполняется перед вызовом обработчикаpostHandler
выполняется после вызова обработчикаДобавить глобальные хуки можно методом addHook
экземпляра роутера,
где первым параметром передается название хука, а вторым его функция.
router.addHook('preHandler', (ctx) => {
// вызов перед обработчиком маршрута
});
router.addHook('postHandler', (ctx, data) => {
// вызов после обработчика маршрута
});
Аналогично хукам маршрута, если глобальный хук возвращает значение
отличное от undefined
и null
, то такое значение будет использовано
как ответ сервера.
Установка переменной DEBUG
перед командой запуска включает вывод логов.
DEBUG=jsPathTrie* npm run test
npm run test
MIT
FAQs
Trie-роутер для Node.js
The npm package @e22m4u/js-trie-router receives a total of 17 weekly downloads. As such, @e22m4u/js-trie-router popularity was classified as not popular.
We found that @e22m4u/js-trie-router demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.
Security News
Floating dependency ranges in npm can introduce instability and security risks into your project by allowing unverified or incompatible versions to be installed automatically, leading to unpredictable behavior and potential conflicts.
Security News
A new Rust RFC proposes "Trusted Publishing" for Crates.io, introducing short-lived access tokens via OIDC to improve security and reduce risks associated with long-lived API tokens.