Express アプリケーションで使用するミドルウェアの作成

概説

ミドルウェア 関数は、リクエストオブジェクト (req)、レスポンスオブジェクト (res)、およびアプリケーションのリクエストレスポンスサイクルにおける次のミドルウェア関数に対するアクセス権限を持つ関数です。次のミドルウェア関数は一般的に、next という変数で表されます。

ミドルウェア関数は以下のタスクを実行できます。

• 任意のコードを実行する。
• リクエストオブジェクトとレスポンスオブジェクトを変更する。
• リクエストレスポンスサイクルを終了する。
• スタック内の次のミドルウェアを呼び出す。

現在のミドルウェア関数がリクエストレスポンスサイクルを終了しない場合は、next() を呼び出して、次のミドルウェア関数に制御を渡す必要があります。そうしないと、リクエストはハングしたままになります。

次の例は、ミドルウェア関数呼び出しの要素を示しています。

ミドルウェア関数が適用される HTTP メソッド。 ミドルウェア関数が適用されるパス (ルート)。 ミドルウェア関数。 ミドルウェア関数へのコールバック引数 (慣習的に「next」と呼ばれます)。 ミドルウェア関数への HTTP レスポンス引数 (慣習的に「res」と呼ばれます)。 ミドルウェア関数への HTTP リクエスト引数 (慣習的に「req」と呼ばれます)。

例

次に、簡単な「Hello World」Expressアプリケーションの例を示します。 この記事の残りの部分では、アプリケーションに2つのミドルウェア関数、つまり単純なログメッセージを出力するmyLoggerと、HTTP要求のタイムスタンプを表示するrequestTimeという2つのミドルウェア関数を定義して追加します。

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

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

app.listen(3000)

ミドルウェア関数 myLogger

次に、”myLogger”というミドルウェア関数の簡単な例を示します。この関数は、アプリケーションへのリクエストがそれを通過するときに、単に “LOGGED”を出力します。ミドルウェア関数は、myLoggerという名前の変数に割り当てられます。

const myLogger = function (req, res, next) {
  console.log('LOGGED')
  next()
}

ミドルウェア関数をロードするには、ミドルウェア関数を指定して app.use() を呼び出します。 例えば、次のコードは、ルート・パス (/) へのルートの前に myLogger ミドルウェア関数をロードします。

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

const myLogger = function (req, res, next) {
  console.log('LOGGED')
  next()
}

app.use(myLogger)

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

app.listen(3000)

アプリケーションは、リクエストを受け取るたびに、端末にメッセージ「LOGGED」を出力します。

ミドルウェアのロードの順序は重要です。最初にロードされたミドルウェア関数が常に最初に実行されます。

myLogger がルート・パスの後にロードされた場合、リクエストが到達することはなく、アプリケーションは「LOGGED」を出力しません。ルート・パスのルート・ハンドラーがリクエストレスポンスサイクルを終了するためです。

ミドルウェア関数 myLogger は、単にメッセージを出力してから、next() 関数を呼び出して、スタック内の次のミドルウェア関数へのリクエストに移ります。

ミドルウェア関数 requestTime

次に、「requestTime」というミドルウェア関数を作成し、requestTimeというプロパティとしてリクエストオブジェクトに追加します。

const requestTime = function (req, res, next) {
  req.requestTime = Date.now()
  next()
}

これで、アプリケーションが requestTime ミドルウェア関数を使用するようになります。また、ルート・パス・ルートのコールバック関数は、ミドルウェア関数が req (リクエストオブジェクト) に追加するプロパティーを使用します。

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

const requestTime = function (req, res, next) {
  req.requestTime = Date.now()
  next()
}

app.use(requestTime)

app.get('/', (req, res) => {
  let responseText = 'Hello World!<br>'
  responseText += `<small>Requested at: ${req.requestTime}</small>`
  res.send(responseText)
})

app.listen(3000)

アプリケーションのルートにリクエストすると、アプリケーションは、リクエストのタイムスタンプをブラウザーに表示します。

リクエストオブジェクト、レスポンスオブジェクト、スタック内の次のミドルウェア関数、および Node.js API を利用できるため、ミドルウェア関数が持つ可能性は無限です。

Express ミドルウェアについて詳しくは、Express ミドルウェアの使用を参照してください。

設定可能なミドルウェア

ミドルウェアを設定可能にする必要がある場合は、optionsオブジェクトまたはその他のパラメータを受け入れる関数をエクスポートし、入力パラメータに基づいてミドルウェアの実装を返します。

File: my-middleware.js

module.exports = function (options) {
  return function (req, res, next) {
    // Implement the middleware function based on the options object
    next()
  }
}

ミドルウェアは以下のように使用できるようになりました。

const mw = require('./my-middleware.js')

app.use(mw({ option1: '1', option2: '2' }))

設定可能なミドルウェアの例については、cookie-sessionおよびcompressionを参照してください。