Node.js ルーティング

Node.js では、ルーティングは HTTP リクエストを処理する上で重要な部分であり、異なる URL や HTTP メソッド(GET、POST、PUT、DELETE など)に基づいてリクエストを振り分ける方法を決定します。

ルーティングは通常、Web アプリケーション、特に RESTful API を構築するために使用されます。

Node.js 自体には組み込みのルーティング機構はありませんが、ミドルウェアライブラリ(Express など)を使用して実装できます。

ルーティングは通常、以下の側面を含みます:

  • URL マッチング:リクエストの URL に基づいてルーティングルールをマッチングします。
  • HTTP メソッドマッチング:リクエストの HTTP メソッド(GET、POST、PUT、DELETE など)に基づいてルーティングルールをマッチングします。
  • リクエスト処理:適切なルーティングルールにマッチすると、対応する処理関数を呼び出してリクエストを処理します。

Node.js では、http モジュールを使用して簡単なルーティングを作成できます。次の例を参照してください:

例

const http = require('http');

// サーバーを作成しルートを定義する
const server = http.createServer((req, res) => {
  const { url, method } = req;

  if (url === '/' && method === 'GET') {
    res.writeHead(200, { 'Content-Type': 'text/plain' });
    res.end('Home Page');
  } else if (url === '/about' && method === 'GET') {
    res.writeHead(200, { 'Content-Type': 'text/plain' });
    res.end('About Page');
  } else {
    res.writeHead(404, { 'Content-Type': 'text/plain' });
    res.end('404 Not Found');
  }
});

server.listen(3000, () => {
  console.log('Server is running on http://localhost:3000');
});

ブラウザでアクセスhttp://localhost:3000次のように表示されます:

ブラウザでアクセスhttp://localhost:3000/about次のように表示されます:

他の URL アドレスにアクセスした場合は、直接表示されます404 Not Found。

その他の HTTP リクエストについては、以下を参照してください:HTTP チュートリアル。


リクエストパラメータ

完全な URL には、http://localhost:8888/start?foo=bar&hello=worldホスト、パス、クエリ文字列が含まれます。

これらのデータを解析するには、次を使用できます:URLオブジェクトとquerystringモジュール。

const myUrl = new URL("http://localhost:8888/start?foo=bar&hello=world");

// 提取路径名
console.log(myUrl.pathname); // 输出: /start

// 提取查询参数
console.log(myUrl.searchParams.get("foo"));   // 输出: bar
console.log(myUrl.searchParams.get("hello")); // 输出: world
myUrl.pathname
          |
          |
        -----
http://localhost:8888/start?foo=bar&hello=world
                                ---       -----
                                 |          |
                                 |          |
           myUrl.searchParams.get("foo")    |
                                            |
                                     myUrl.searchParams.get("hello")

もちろん、querystring モジュールを使用して POST リクエストボディ内のパラメータを解析することもできます。関連内容は後のNode.js GET/POST リクエストで紹介します。

必要なすべてのリクエストデータは request オブジェクトに含まれており、このオブジェクトは onRequest() コールバック関数の最初の引数として渡されます。

次に、http モジュールの onRequest() 関数に、ブラウザがリクエストした URL パスを特定するためのロジックを追加します:

server.js ファイルのコード:

var http = require("http"); var url = require("url"); function start() { function onRequest(request, response) { //URL コンストラクタを使用してリクエストパスを解析 const pathname = new URL(request.url, `http://${request.headers.host}`).pathname; console.log(`Request for ${pathname} received.`); //リクエストパスを出力 //レスポンスヘッダーとレスポンス内容を設定 response.writeHead(200, { "Content-Type": "text/plain" }); //ステータスコードとコンテンツタイプを設定 response.write("Hello World"); //クライアントにレスポンス内容を送信 response.end(); //レスポンスを終了 } //サーバーを作成し、指定ポートを監視 http.createServer(onRequest).listen(8888); console.log("Server has started."); //サーバー起動メッセージを出力 } //start 関数をエクスポートして他のモジュールで使用できるようにする module.exports.start = start;

これで、アプリケーションはリクエストされた URL パスに基づいて異なるリクエストを区別できるようになりました。これにより、ルーティング(まだ未完成)を使用して、リクエストを URL パスに基づいてハンドラーにマッピングできるようになります。

私たちが構築するアプリケーションでは、/start と /upload からのリクエストを異なるコードで処理できることを意味します。後ほど、これらがどのように統合されるかを見ていきます。

それでは、ルーティングを作成しましょう。次の名前のファイルを作成します:router.jsファイルに以下の内容を追加します:

router.js ファイルのコード:

function route(pathname) { console.log("About to route a request for " + pathname); } //route 関数をエクスポートしました exports.route = route;

router.js はルーティングロジックを処理し、サーバーがリクエストを受信したときに異なるパスを処理するための route 関数を定義してエクスポートします。

サーバーはルーティングの存在を認識し、効果的に利用する必要があります。もちろん、この依存関係をサーバーにハードコーディングで結び付けることもできますが、他の言語でのプログラミング経験から、これは非常に厄介なことだとわかっています。そのため、依存性注入を使用してルーティングモジュールをより緩やかに追加します。

まず、サーバーの start() 関数を拡張して、ルーティング関数を引数として渡せるようにします。server.jsファイルのコードは次のとおりです

server.js ファイルのコード:

// server.js const http = require("http"); //Node.js の http モジュールを導入してサーバーを作成する const { URL } = require("url"); //url モジュールから URL コンストラクタを導入する //start 関数を定義してエクスポートし、サーバーを起動する function start(route) { //onRequest 関数を定義して各リクエストを処理する function onRequest(request, response) { //URL コンストラクタを使用してリクエストパスを解析 const pathname = new URL(request.url, `http://${request.headers.host}`).pathname; console.log(`Request for ${pathname} received.`); //リクエストパスを出力 route(pathname); //ルーティング関数を呼び出してパスを処理 //レスポンスヘッダーとレスポンス内容を設定 response.writeHead(200, { "Content-Type": "text/plain" }); response.write("Hello World"); response.end(); } //サーバーを作成し、指定ポートを監視 http.createServer(onRequest).listen(8888); console.log("Server has started."); } //start 関数をエクスポートして他のモジュールで使用できるようにする module.exports.start = start;

server.js はサーバーの起動ロジックを定義し、リクエストを受信したときにルーティング関数を呼び出します。

同時に、index.js を拡張して、ルーティング関数をサーバーに注入できるようにします:

index.js ファイルのコード:

var server = require("./server"); var router = require("./router"); server.start(router.route);

index.js はプログラムのエントリーファイルであり、サーバーを起動し、ルーティングモジュールをサーバーモジュールに渡す役割を担います。

アプリケーションを起動し(node index.js、このコマンドラインを常に覚えておいてください)、次に URL をリクエストすると、アプリケーションが対応する情報を出力するのを確認できます。これは、HTTP サーバーがルーティングモジュールを使用しており、リクエストされたパスをルーティングに渡していることを示しています:

$ node index.js
Server has started.

ブラウザでアクセスhttp://localhost:8888/、サーバーはコンソールにパスに関連するルーティングメッセージを出力し、"Hello World" レスポンスを返します:

バックグラウンドのターミナルにアクセス情報が表示されます:

Request for / received.
About to route a request for /
Request for /favicon.ico received.
About to route a request for /favicon.ico

Express を使用したルーティング

Express は人気のある Node.js フレームワークで、強力なルーティング機能を提供します。

Express に関する詳細は、以下を参照してください:Node.js Express フレームワーク。

Express のインストール

まず、Express がインストールされていることを確認してください。まだインストールされていない場合は、npm を使用してインストールできます:

npm install express

基本ルーティング

以下は、基本的なルーティングを設定する方法を示す簡単な Express アプリケーションです:

例

const express = require('express');
const app = express();
const port = 3000;

// GET ルートを定義する
app.get('/', (req, res) => {
    res.send('Hello, World!');
});

// POST ルートを定義する
app.post('/submit', (req, res) => {
    res.send('Form submitted!');
});

// サーバーを起動する
app.listen(port, () => {
    console.log(`Server is running on http://localhost:${port}`);
});

動的ルーティング

動的ルーティングでは、パラメータ化された URL を使用できます。

例えば、次のようなルートを定義して処理できます:/users/:id、ここで:idは動的パラメータです。

app.get('/users/:id', (req, res) => {
    const userId = req.params.id;
    res.send(`User ID: ${userId}`);
});

ルートパラメータ

Express では、URL からパラメータを抽出し、req.params オブジェクトを介してこれらのパラメータにアクセスできます。

例

app.get('/users/:id', (req, res) => {
    const userId = req.params.id;
    res.send(`User ID: ${userId}`);
});

app.get('/search/:query', (req, res) => {
    const query = req.params.query;
    res.send(`Search query: ${query}`);
});

クエリパラメータ

クエリパラメータは URL 内のキーと値のペアで、通常は追加情報を渡すために使用されます。req.query オブジェクトを介してクエリパラメータにアクセスできます。

app.get('/search', (req, res) => {
    const query = req.query.q;
    res.send(`Search query: ${query}`);
});

ルートミドルウェア

ルートミドルウェアは、リクエストの処理前または処理後に実行される関数です。ミドルウェアを使用して、認証やログ記録などのタスクを処理できます。

// 日志记录中间件
const logger = (req, res, next) => {
    console.log(`Request Type: ${req.method} ${req.url}`);
    next();
};

// 使用中间件
app.use(logger);

app.get('/', (req, res) => {
    res.send('Hello, World!');
});

ルートグループ

コードをより適切に整理するために、ルートグループを使用できます。Express は express.Router オブジェクトを提供しており、モジュール化されたマウント可能なルートハンドラーを作成するために使用できます。

例

const express = require('express');
const app = express();
const port = 3000;

// ルーターインスタンスを作成する
const userRouter = express.Router();

// ユーザー関連のルートを定義する
userRouter.get('/', (req, res) => {
    res.send('List of users');
});

userRouter.get('/:id', (req, res) => {
    const userId = req.params.id;
    res.send(`User ID: ${userId}`);
});

// ユーザールーターをマウントする
app.use('/users', userRouter);

// サーバーを起動する
app.listen(port, () => {
    console.log(`Server is running on http://localhost:${port}`);
});

高度なルーティングテクニック

1. エラーハンドリング:エラーハンドリングミドルウェアを定義して、ルート内のエラーをキャッチして処理できます。

app.use((err, req, res, next) => {
    console.error(err.stack);
    res.status(500).send('Something broke!');
});

2. ルートの優先順位:ルートの定義順序が優先順位を決定し、先に定義されたルートが最初にマッチします。

3. ルートの制限:ミドルウェアを使用して特定のルートへのアクセスを制限できます。例えば、認証されたユーザーのみにアクセスを許可するなどです。

例

const authMiddleware = (req, res, next) => {
    if (req.headers.authorization) {
        next();
    } else {
        res.status(401).send('Unauthorized');
    }
};

app.get('/admin', authMiddleware, (req, res) => {
    res.send('Admin page');
});
その他の拡張