Использование Node File Router для маршрутизации на основе файлов в Node.js

Node.js приобрела огромную популярность как гибкая и надежная среда выполнения, превосходная в написании сценариев на стороне сервера, создании сетей и разработке приложений в реальном времени. Хотя приложения Node обычно используют маршрутизацию на основе модулей, можно реализовать маршрутизацию на основе файлов для повышения производительности, масштабируемости и многого другого.

При разработке организованных веб-приложений маршрутизация помогает гарантировать, что ваше конечное приложение будет хорошо структурированным и упорядоченным. Маршрутизация на основе файлов достигается за счет сопоставления маршрутов приложения с определенными файлами. Это упрощает маршрутизацию и помогает с организацией кода, что упрощает обслуживание приложений.

В этой статье мы рассмотрим, как реализовать файл-функцию в Node.js приложении. Это позволит вам структурировано писать и поддерживать кода.

Чтобы извлечь максимальную пользу из этой статьи, вам потребуется базовое понимание того, как создавать веб-приложения с помощью Node.js. Вам также потребуется установить на свой компьютер Node.js вместе с любым редактором кода по вашему выбору.

Понимание маршрутизации на основе файлов

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

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

По мере углубления в тему мы рассмотрим преимущества и практическое применение маршрутизации на основе файлов в Node.js приложениях.

Реализация маршрутизации на основе файлов с помощью Node File Router

Популярные фреймворки, такие как Next.js широко известны тем, насколько эффективно они помогают упростить разработку веб-приложений благодаря эффективным встроенным возможностям маршрутизации на основе файлов. Хотя это может быть удобно, эти фреймворки обладают невыгодным потенциалом привязки к поставщику.

Что, если вам нравится свобода использования маршрутизации на основе файлов в чистом виде Node.js или любой библиотеки, которую вы выберете, не ограничиваясь конкретной платформой? Вот тут-то и пригодится Node File Router.

Node File Router обеспечивает независимый от технологий подход к внедрению маршрутизации на основе файлов в ваши приложения Node.js. Он без проблем работает как с ванилью Node.js, так и с такими библиотеками, как Express.js.

Некоторые функции, поддерживаемые Node File Router, включают:

• Динамические маршруты: Node File Router может эффективно обрабатывать динамические URL-адреса, такие как /products/[productId] путем сопоставления этих URL-адресов с соответствующими путями к файлам и извлечения параметров, таких как [productId], содержащихся в запросах.
• CommonJS и ES модули поддержки: Хорошо работает с CommonJS и ES модулями, делая Node File Router идеальным для каждого Node.js проекта.
• Поддержка TypeScript: Node File Router поддерживает TypeScript для написания типобезопасного кода маршрутизации.
• Поддержка других протоколов: Настраиваемый адаптер, поставляемый с Node File Router, позволяет запускать как HTTP, так и WebSockets с помощью Node.
• Совместимость с другими фреймворками и технологиями: Node File Router также совместим с Node.js веб-фреймворками, такими как Express и среда выполнения Bun.

Давайте углубимся в то, как мы можем настроить маршрутизацию на основе файлов в приложении Express с помощью Node File Router.

Настройка проекта

Нам нужно создать папку для проекта, установить package.json и инициализировать его как проект Node.js. Откройте терминал и введите следующие команды:

mkdir file-router-demo
cd file-router-demo
npm init -y

Далее нам нужно установить Node File Router и другие пакеты, которые будут использоваться в проекте:

npm install node-file-router express nodemon

Создайте новый server.js файл в корневом каталоге проекта, который будет служить точкой входа нашего приложения. В этот файл включите следующий код:

import express from "express";

const port = 4000;
const app = express();

app.listen(port, () => {
  console.log(`Server running on <http://localhost>:${port}`);
});

В package.json файле обновите поля type и scripts. Это предложит приложению использовать модули ES и запустить Express с помощью Nodemon соответственно:

{
  "type": "module",
  "scripts": {
    "dev": "nodemon ./server.js"
  }
}

До сих пор мы рассмотрели, что требуется для настройки нашего проекта Node.js для маршрутизации на основе файлов. В следующем разделе мы рассмотрим настройку Node File Router для работы с настроенным нами приложением Express, а также создание маршрутов.

Определение маршрутов

Прежде чем мы углубимся в создание маршрутов, нам нужно настроить Node File Router для работы с нашим Expressapplication. Обновите код в server.js файле следующим образом:

import express from "express";
import { initFileRouter } from "node-file-router";

const port = 4000;
const app = express();

const fileRouter = await initFileRouter();
app.use(fileRouter);

app.listen(port, () => {
  console.log(`Server running on <http://localhost>:${port}`);
});

Чтобы запустить Node File Router, мы используем initFileRouter() функцию и объявляем ее глобальным промежуточным программным обеспечением, которое обрабатывает входящие запросы в соответствии с назначенными файлами маршрутов.

По умолчанию система выполняет поиск этих маршрутов в ./api каталоге. Однако мы можем изменить это, включив baseDir атрибут в options объект внутри initFileRouter функции.

Создайте папку с именем api в корне проекта. Внутри этой папки создайте новый файл с именем index.js и добавьте следующий код:

export default {
  get: (req, res, next, routeParams) => {
    res.send("Hello world!");
  },
};

Этот код экспортирует объект, который определяет маршрут для обработки запроса GET. Когда делается запрос к / маршруту, сервер отправляет ответное сообщение Hello world!. Если нам нужно обрабатывать запросы, сделанные с помощью других HTTP-методов, мы можем легко добавить их в экспортируемый объект с помощью связанных с ними функций обработки.

Благодаря этому мы успешно создали наш первый маршрут с использованием маршрутизации на основе файлов в Node.js. В следующем разделе мы узнаем, как работать с динамическими параметрами маршрута.

Работа с параметрами маршрута

В большинстве случаев веб-приложения, которые мы создаем, динамичны и управляются данными. В таких случаях любой механизм маршрутизации, который мы используем, должен поддерживать работу с динамическими параметрами маршрута.

Для работы с динамическими параметрами Node File Router нам сначала нужно определить наши маршруты. Как только наши маршруты определены, мы можем реализовать наши обработчики маршрутов. Давайте посмотрим, как это сделать сейчас.

Создайте структуру каталогов для своих маршрутов, где каждый каталог будет представлять отдельный сегмент маршрута. Вы можете легко создать маршрут для просмотра продуктов, следуя структуре каталогов, показанной ниже:

api/
├── products/
│   ├── [productId].js
├── index.js

[productId] представляет собой динамический параметр. Когда пользователь посещает /products/[productId] маршрут, запускается обработчик маршрута, определенный в [productId].js файле.

Теперь, когда мы определили наши маршруты, мы можем реализовать наши обработчики маршрутов. Файл [productId].js для маршрута просмотра продукта должен содержать следующий код:

export default {
  get: (req, res, next, routeParams) => {
    const { productId } = routeParams;
    if (!productId) {
      res.end("Product id not specified");
    }
    fetch(`https://fakestoreapi.com/products/${productId}`)
      .then((response) => response.json())
      .then((json) => res.json(json));
  },
};

При посещении http://localhost:4000/products/1 в вашем браузере вы должны увидеть ответ, подобный этому:

Показанный ответ JSON содержит подробную информацию о продукте с id: 1 после попадания в /products/1 конечную точку. Он включает информацию о продукте, такую как название, цена, описание, категория, URL изображения и рейтинг.

Плюсы и минусы маршрутизации на основе файлов в Node.js

Хотя маршрутизация на основе файлов дает преимущества для Node.js проектов, у нее также есть некоторые недостатки. Ниже приведены преимущества и недостатки реализации маршрутизации на основе файлов в Node.js.

Некоторые плюсы маршрутизации на основе файлов в Node.js включают:

• Модульность: Использование маршрутизации на основе файлов позволяет нам создавать модульную базу кода. Файл для каждого маршрута определяет этот маршрут, упрощая поиск, редактирование и обновление только тех файлов, которые нам нужны для редактирования, не затрагивая другие.
• Удобочитаемость: Модульность также повышает удобочитаемость и ремонтопригодность кодовой базы. Отдельные файлы изолируют маршруты или группы связанных маршрутов, поэтому разработчик может просто проверить структуру файла, чтобы понять, как работает маршрутизация в приложении.
• Масштабируемость: Маршрутизация на основе файлов четко масштабируется по мере увеличения размера вашего приложения. Поскольку вам не нужно вносить существенные изменения в существующий код для постоянного добавления новых файлов маршрутов, управление вашей кодовой базой остается эффективным и простым.

Между тем, некоторые недостатки маршрутизации на основе файлов в Node.js включают:

• Сложность: Хотя маршрутизация на основе файлов может масштабироваться по мере увеличения размера вашего приложения, файловая структура особенно крупномасштабных приложений может становиться все более сложной и трудноуправляемой. Такие каталоги могут содержать много файлов маршрутов, что в конечном итоге приводит к неуправляемому расположению каталогов.
• Проблемы с адаптацией: Без четких стандартов и соглашений по именованию и организации файлов маршрутов структура маршрутизации проекта может быть неясной для новых разработчиков, присоединяющихся к команде проекта.
• Негибкость: Хотя решение для маршрутизации на основе файлов может быть более гибким, чем традиционная маршрутизация на основе модулей, оно может не обеспечивать достаточной гибкости для чрезвычайно динамичных или специфических потребностей маршрутизации. В таких случаях вам, возможно, придется изучить альтернативные решения маршрутизации, предлагаемые такими библиотеками, как Express.js, Fastify и Adonis.js.
• Ограниченные возможности маршрутизации: Решения для маршрутизации на основе файлов могут не поддерживать определенные расширенные функции маршрутизации, такие как присвоение имен маршрутам, промежуточное программное обеспечение маршрутов и привязка параметров.

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

Маршрутизация на основе файлов по сравнению с традиционной маршрутизацией на основе модулей

Выбор между маршрутизацией на основе файлов или традиционной маршрутизацией на основе модулей в основном зависит от потребностей вашего проекта. Вот сравнительная таблица, в которой сравниваются две стратегии маршрутизации:

Вообще говоря, маршрутизация на основе файлов хорошо работает для небольших проектов. Между тем, традиционная маршрутизация на основе модулей обеспечивает контроль для более сложных приложений, которые требуют некоторых специализированных конфигураций маршрутизации и иногда поддержки промежуточного программного обеспечения.

Заключение

Маршрутизация на основе файлов в Node.js - это мощный метод, улучшающий организацию кода, масштабируемость и ремонтопригодность. Применяя этот подход, разработчики могут оптимизировать свои проекты, улучшить совместную работу и упростить маршрутизацию в веб-приложениях.

Использование маршрутизации на основе файлов позволяет разработчикам создавать гибкие и отказоустойчивые приложения Node.js приложения, которые могут легко адаптироваться к меняющимся требованиям, в конечном итоге прокладывая путь к более надежной и приятной разработке. Приятного кодирования!