StrongLoop / IBMによって提供されるこの翻訳.

本書は、英語の資料と比較すると古くなっている可能性があります。最新の更新については、英語版の資料を参照してください。

✖

ルーティング

ルーティング とは、アプリケーション・エンドポイント (URI) と、クライアントリクエストに対するそれらのレスポンスの定義のことです。ルーティングの概要については、基本的なルーティングを参照してください。

ルーティングはHTTPメソッドに対応するExpressのappオブジェクトのメソッドを使用して定義します。たとえば、GETリクエストを処理するapp.get()やPOSTリクエストを処理するapp.postがあります。完全なリストについては、app.METHODを参照してください。また、すべてのHTTPメソッドを制御するためにapp.all()を、ミドルウェアを指定するためにapp.use()をコールバック関数として使用することができます(詳細については、Using middlewareを参照してください)。

これらのルーティングメソッドは、アプリケーションが指定されたルート（エンドポイント）とHTTPメソッドへのリクエストを受け取ったときに呼び出されるコールバック関数（ハンドラ関数とも呼ばれます）を指定します。つまり、アプリケーションは指定されたルートとメソッドに一致するリクエストをリッスンし、一致を検出すると指定されたコールバック関数を呼び出します。

実際、ルーティングメソッドは複数のコールバック関数を引数として持つことができます。複数のコールバック関数では、コールバック関数に引数としてnextを指定し、次のコールバックに制御を渡す関数の本体内でnext()を呼び出すことが重要です。

次のコードは、極めて基本的なルートの例です。

const express = require('express')
const app = express()

// respond with "hello world" when a GET request is made to the homepage
app.get('/', (req, res) => {
  res.send('hello world')
})

route メソッド

route メソッドは、いずれかの HTTP メソッドから派生され、express クラスのインスタンスに付加されます。

次のコードは、アプリケーションのルートへの GET メソッドと POST メソッドに定義されたルートの例です。

// GET method route
app.get('/', (req, res) => {
  res.send('GET request to the homepage')
})

// POST method route
app.post('/', (req, res) => {
  res.send('POST request to the homepage')
})

Expressは、すべてのHTTPリクエストメソッドに対応するメソッド（get、postなど）をサポートしています。完全なリストについては、app.METHODを参照して下さい。

すべての HTTPリクエストメソッドのパスにミドルウェア関数をロードするために使用される特別なルーティングメソッド、app.all()があります。たとえば、GET、POST、PUT、DELETE、またはhttpモジュールでサポートされているその他のHTTPリクエストメソッドを使用するかどうかにかかわらず、”/secret”ルートへのリクエストに対して次のハンドラが実行されます。

app.all('/secret', (req, res, next) => {
  console.log('Accessing the secret section ...')
  next() // pass control to the next handler
})

ルート・パス

ルート・パスは、リクエストメソッドとの組み合わせにより、リクエストを実行できるエンドポイントを定義します。ルート・パスは、ストリング、ストリング・パターン、または正規表現にすることができます。

文字？、+、*、()は正規表現の部分集合です。ハイフン（-）とドット（.）は、文字列ベースのパスによって文字通り解釈されます。

パス文字列でドル文字（$）を使用する必要がある場合は、([と])の中にエスケープして囲みます。たとえば、”/data/$book”でのリクエストのパス文字列は”/data /([\$])book“となります。

Express は、ルート・パスのマッチングに path-to-regexp を使用します。ルート・パスの定義におけるすべての可能性については、path-to-regexp 資料を参照してください。Express Route Tester は、パターン・マッチングをサポートしていませんが、基本的な Express ルートをテストするための便利なツールです。

クエリ文字列は、ルート・パスの一部ではありません。

次に、ストリングに基づくルート・パスの例を示します。

このルート・パスは、リクエストをルートのルート / にマッチングします。

app.get('/', (req, res) => {
  res.send('root')
})

このルート・パスは、リクエストを /about にマッチングします。

app.get('/about', (req, res) => {
  res.send('about')
})

このルート・パスは、リクエストを /random.text にマッチングします。

app.get('/random.text', (req, res) => {
  res.send('random.text')
})

次に、ストリング・パターンに基づくルート・パスの例を示します。

このルート・パスは、acd および abcd をマッチングします。

app.get('/ab?cd', (req, res) => {
  res.send('ab?cd')
})

このルート・パスは、abcd、abbcd、abbbcd などをマッチングします。

app.get('/ab+cd', (req, res) => {
  res.send('ab+cd')
})

このルート・パスは、abcd、abxcd、abRABDOMcd、ab123cd などをマッチングします。

app.get('/ab*cd', (req, res) => {
  res.send('ab*cd')
})

このルート・パスは、/abe および /abcde をマッチングします。

app.get('/ab(cd)?e', (req, res) => {
  res.send('ab(cd)?e')
})

次に、正規表現に基づくルート・パスの例を示します。

このルート・パスは、ルート名に「a」が含まれるすべてのものをマッチングします。

app.get(/a/, (req, res) => {
  res.send('/a/')
})

このルート・パスは、butterfly および dragonfly をマッチングしますが、butterflyman、dragonfly man などはマッチングしません。

app.get(/.*fly$/, (req, res) => {
  res.send('/.*fly$/')
})

ルート・パラメータ

ルート・パラメータは、URL内の指定された値を取得するために使用されるURLセグメントのことを言います。捕捉された値はreq.paramsオブジェクトの中で、パスに指定されたルート・パラメータの名前をそれぞれのキーとして設定されます。

ルート・パス: /users/:userId/books/:bookId
リクエストURL: http://localhost:3000/users/34/books/8989
req.params: { "userId": "34", "bookId": "8989" }

ルート・パラメータを使用してルートを定義するには、以下に示すようにルートのパスにルート・パラメータを指定するだけです。

app.get('/users/:userId/books/:bookId', (req, res) => {
  res.send(req.params)
})

ルート・パラメータの名前は、「単語文字」([A-Za-z0-9_])で構成する必要があります。

ハイフン（-）とドット（.）は文字通りに解釈されるので、有用な目的のためにルート・パラメータとともに使用することができます。

ルート・パス: /flights/:from-:to
リクエストURL: http://localhost:3000/flights/LAX-SFO
req.params: { "from": "LAX", "to": "SFO" }

ルート・パス: /plantae/:genus.:species
リクエストURL: http://localhost:3000/plantae/Prunus.persica
req.params: { "genus": "Prunus", "species": "persica" }

ルート・パラメータで一致させることができる正確な文字列をより詳細に制御するために、括弧（()）内で正規表現を追加できます：

ルート・パス: /user/:userId(\d+)
リクエストURL: http://localhost:3000/user/42
req.params: {"userId": "42"}

正規表現は通常リテラル文字列の一部なので、\\d+のように\文字をバックスラッシュでエスケープしてください。

Express 4.xでは、正規表現の*文字は通常の方法で解釈されません。回避策として、*の代わりに{0,}を使用してください。これは、Express 5で修正される可能性があります。

ルート・ハンドラー

リクエストを処理するために、ミドルウェアのように動作する複数のコールバック関数を指定できます。唯一の例外は、これらのコールバックが next('route') を呼び出して、残りのルート・コールバックをバイパスすることです。このメカニズムを使用して、ルートに事前条件を適用し、現在のルートで続行する理由がない場合に後続のルートに制御を渡すことができます。

次の例に示すように、ルート・ハンドラーの形式は、関数、関数の配列、または両方の組み合わせにすることができます。

単一のコールバック関数で 1 つのルートを処理できます。次に例を示します。

app.get('/example/a', (req, res) => {
  res.send('Hello from A!')
})

複数のコールバック関数で1つのルートを処理できます (必ず、next オブジェクトを指定してください)。次に例を示します。

app.get('/example/b', (req, res, next) => {
  console.log('the response will be sent by the next function ...')
  next()
}, (req, res) => {
  res.send('Hello from B!')
})

コールバック関数の配列で 1 つのルートを処理できます。次に例を示します。

const cb0 = function (req, res, next) {
  console.log('CB0')
  next()
}

const cb1 = function (req, res, next) {
  console.log('CB1')
  next()
}

const cb2 = function (req, res) {
  res.send('Hello from C!')
}

app.get('/example/c', [cb0, cb1, cb2])

独立した関数と、関数の配列の組み合わせで1つのルートを処理できます。次に例を示します。

const cb0 = function (req, res, next) {
  console.log('CB0')
  next()
}

const cb1 = function (req, res, next) {
  console.log('CB1')
  next()
}

app.get('/example/d', [cb0, cb1], (req, res, next) => {
  console.log('the response will be sent by the next function ...')
  next()
}, (req, res) => {
  res.send('Hello from D!')
})

レスポンスメソッド

次の表に示すレスポンスオブジェクト (res) のメソッドは、レスポンスをクライアントに送信して、リクエストとレスポンスのサイクルを終了することができます。これらのメソッドのいずれもルート・ハンドラーから呼び出されない場合、クライアントリクエストはハングしたままになります。

メソッド	説明
res.download()	ファイルのダウンロードのプロンプトを出します。
res.end()	レスポンスプロセスを終了します。
res.json()	JSON レスポンスを送信します。
res.jsonp()	JSONP をサポートする JSON レスポンスを送信します。
res.redirect()	リクエストをリダイレクトします。
res.render()	ビュー・テンプレートをレンダリングします。
res.send()	さまざまなタイプのレスポンスを送信します。
res.sendFile	ファイルをオクテット・ストリームとして送信します。
res.sendStatus()	レスポンスのステータスコードを設定して、そのストリング表現をレスポンス本文として送信します。

app.route()

app.route() を使用して、ルート・パスの連結可能なルート・ハンドラーを作成できます。パスは単一の場所で指定されるため、モジュール式のルートを作成すると、便利であるほか、冗長性とタイプミスを減らすことができます。ルートについて詳しくは、Router() 資料を参照してください。

次に、app.route() を使用して定義された、チェーニングされたルート・ハンドラーの例を示します。

app.route('/book')
  .get((req, res) => {
    res.send('Get a random book')
  })
  .post((req, res) => {
    res.send('Add a book')
  })
  .put((req, res) => {
    res.send('Update the book')
  })

express.Router

モジュール式のマウント可能なルート・ハンドラーを作成するには、express.Router クラスを使用します。Router インスタンスは、完全なミドルウェアおよびルーティング・システムです。そのため、よく「ミニアプリケーション」と呼ばれます。

次の例では、ルーターをモジュールとして作成し、その中にミドルウェア関数をロードして、いくつかのルートを定義し、ルート・モジュールをメインアプリケーションのパスにマウントします。

アプリケーション・ディレクトリーに次の内容で birds.js というルーター・ファイルを作成します。

const express = require('express')
const router = express.Router()

// middleware that is specific to this router
router.use((req, res, next) => {
  console.log('Time: ', Date.now())
  next()
})
// define the home page route
router.get('/', (req, res) => {
  res.send('Birds home page')
})
// define the about route
router.get('/about', (req, res) => {
  res.send('About birds')
})

module.exports = router

次に、ルーター・モジュールをアプリケーションにロードします。

const birds = require('./birds')
// ...
app.use('/birds', birds)

これで、アプリケーションは、/birds および /birds/about に対するリクエストを処理するほか、ルートに固有の timeLog ミドルウェア関数を呼び出すことができるようになります。