Node.js ミドルウェアがどのように機能するかについての簡単な説明

Express ミドルウェアとは何ですか?

• ミドルウェアとは、文字通り、ソフトウェアの 1 つの層と別の層の間に配置されるものを意味します。
• Express ミドルウェアは、Express サーバーへのリクエストのライフサイクル中に実行される機能です。
• 各ミドルウェアは、接続されているすべてのルートの HTTP 要求と応答にアクセスできます。
• さらに、ミドルウェアは HTTP リクエストを終了したり、next を使用して別のミドルウェア関数に渡すことができます。このミドルウェアの「チェーン」により、コードを分割し、再利用可能なミドルウェアを作成できます。

Express ミドルウェアを作成するための要件

Express ミドルウェアを作成、使用、テストするには、いくつかのものをインストールする必要があります。まず、Node と NPM が必要です。インストールされていることを確認するには、次のコマンドを実行します。

npm -v && node -v

インストールされている Node と NPM のバージョンが表示されるはずです。エラーが発生した場合は、Node をインストールする必要があります。すべての例は、Node ver 8 および NPM ver 5 で使用する必要があります。

この記事では Express バージョン 4.x を使用します。バージョン 3.x からバージョン 4.x では大幅な変更が加えられたため、これは重要です。

Express ミドルウェア: 基本

まず、Express の最も基本的な組み込みミドルウェアを使用します。新しいプロジェクトを作成し、npm で初期化します...

npm init
npm install express --save

Create server.js and paste the following code:

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

app.get('/', (req, res, next) => {
  res.send('Welcome Home');
});

app.listen(3000);

ミドルウェアはどのような問題を解決しますか?なぜそれを使うのでしょうか？

Web サーバー上で Node.js と Express を使用して Web アプリケーションを実行しているとします。このアプリでは、一部のページでログインが必要となります。

Web サーバーがデータのリクエストを受信すると、Express はユーザーとユーザーがリクエストしたデータに関する情報を含むリクエスト オブジェクトを提供します。 Express では、Web サーバーがユーザーに応答する前に変更できる応答オブジェクトへのアクセスも提供します。これらのオブジェクトは通常、

req、res に短縮されます。

ミドルウェア関数は、関連情報を含む

req オブジェクトと res オブジェクトを変更するのに最適な場所です。たとえば、ユーザーがログインした後、データベースからユーザーの詳細を取得し、これらの詳細を res.user に保存できます。

ミドルウェア機能とはどのようなものですか?

async function userMiddleware (req, res, next) {
    try {
        const userData = await getUserData(req.params.id);  //see app.get below

        if(userData) {
                req.user = userData;
                next();
        }
    } catch(error)  {
        res.status(500).send(error.message); //replace with proper error handling
    }
}

エラーが発生し、他のコードを実行したくない場合は、この関数を呼び出さないでください。この場合は必ず応答を送信してください。送信しないと、クライアントはタイムアウトになるまで応答を待機することになります。

var app = express();

//your normal route Handlers
app.get('/user/:id', userMiddleware, userController);

ミドルウェア チェーン

ミドルウェア配列内で、または複数の

app.use 呼び出しを使用してミドルウェアをチェーンできます:

app.use(middlewareA);
app.use(middlewareB);
app.get('/', [middlewareC, middlewareD], handler);

Express リクエストを受信した後、リクエストに一致した各ミドルウェアは、終了操作があるまで初期化の順序で実行されます。

したがって、エラーが発生した場合、エラーを処理するすべてのミドルウェアが順番に呼び出され、そのうちの 1 つが

next() を呼び出さなくなるまで、関数が呼び出されるまで続きます。と呼ばれます。

Express ミドルウェアの種類

ルーター レベルのミドルウェア (例: router.use)
組み込みミドルウェア (例: Express.static、express)。 json、express.urlencoded
エラー処理ミドルウェア、例: app.use(err、req、res、next)
サードパーティ ミドルウェア、例: bodyparser、cookieparser
ルーター レベルのミドルウェア
• express.Router モジュール式のインストール可能なルーティング処理を作成するには、express.Router クラスを使用します。ルーティング インスタンスは、完全なミドルウェアおよびルーティング システムです。
  ロギング、認証などにミドルウェアを使用できます。以下に示すように、ユーザーの最新のアクティビティを記録し、認証ヘッダーを解析するには、それを使用して現在ログインしているユーザーを特定し、それを Request オブジェクトに追加します。
  この関数は、プログラムがリクエストを受信するたびに実行されます。エラーが発生した場合、後続のミドルウェアやルート処理を呼び出すことなく、単に応答を終了します。

var router = express.Router()
//Load router-level middleware by using the router.use() and router.METHOD() functions.
//The following example creates a router as a module, loads a middleware function in it,
//   defines some routes, and mounts the router module on a path in the main app.
var express = require(‘express’);
var router = express.Router();

// a middleware function with no mount path. This code is executed for
//   every request to the router
// logging
async function logMiddleware (req, res, next) {
    try {
         console.log(req.user.id, new Date());
     next();
    } catch() {
        res.status(500).send(error.message);
    }
}
// authentication
    async function checkAuthentication(req, res, next) => {
// check header or url parameters or post parameters for token
const token = req.body.token || req.query.token || req.headers['x-access-token']
 || req.headers['authorization'];
      if (token) {
        try {
            // verifies secret
            req.decoded = await jwt.verify(token, config.secret)

            let checkUser = await authenticateTokenHelper.getUserDetail(req);

            // if everything is good, save to request for use in other routes
                if (checkUser) {
                        req.user = req.decoded
                        next()
                } else {
                    return res.status(403).json({ 
                    message: responseMessage.noAuthorized 
                    })
                }
        } catch (err) {
            return res.status(401).json({ message: responseMessage.invalidToken })
        }
  } else {
    // if there is no token
    return res.status(400).json({ message: responseMessage.invalidRequest })
  }
}
router.use(logMiddleware);
    router.get('/user, checkAuthentication, handler);

組み込みミドルウェア

Express には、次の組み込みミドルウェア機能があります:

• express。 static HTML ファイルや画像などの静的リソースを提供します。
• express.json ペイロードは、JSON で受信したリクエストを解析します。
• express.urlencoded 受信した URL エンコードされたペイロード要求を解析します。

エラー処理ミドルウェア

エラー処理ミドルウェアは常に 4 つのパラメーター

(err、req、res、next) を受け取ります。 4 つのパラメーターを指定して、エラー処理ミドルウェア関数として識別する必要があります。次のオブジェクトを使用する必要がない場合でも、それを指定する必要があります。それ以外の場合、次のオブジェクトは通常のミドルウェアとして解釈され、エラーは処理されません。基本的な署名は次のようになります:

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

例 1:

app.get('/users', (req, res, next) => {
  next(new Error('I am passing you an error!'));
});
app.use((err, req, res, next) => {
  console.log(err);    
  if(!res.headersSent){
    res.status(500).send(err.message);
  }
});

在这种情况下，管道末端的错误处理中间件将会处理该错误。你可能还会注意到，我检查了 res.headersSent 属性。这只是检查响应是否已经将标头发送到客户端。如果还没有，它将向客户端发送 HTTP 500 状态和错误消息。

例2：

你还可以链接错误处理中间件。通常以不同的方式处理不同类型的错误：

app.get('/users, (req, res, next) => {
  let err = new Error('I couldn\'t find it.');
  err.httpStatusCode = 404;
  next(err);
});

app.get('/user, (req, res, next) => {
  let err = new Error('I\'m sorry, you can\'t do that, Dave.');
  err.httpStatusCode = 304;
  next(err);
});

app.use((err, req, res, next) => {
   // handles not found errors
  if (err.httpStatusCode === 404) {
    res.status(400).render('NotFound');
  }
   // handles unauthorized errors 
  else if(err.httpStatusCode === 304){
    res.status(304).render('Unauthorized');
  }
    // catch all
   else if (!res.headersSent) {
     res.status(err.httpStatusCode || 500).render('UnknownError');
  }
  next(err);
});

• 在这种情况下，中间件检查是否抛出了 404（not found）错误。如果是，它将渲染 “NotFound” 模板页面，然后将错误传递到中间件中的下一项。
• 下一个中间件检查是否抛出了 304（unauthorized）错误。如果是，它将渲染“Unauthorized”页面，并将错误传递到管道中的下一个中间件。
• 最后，“catch all” 错误处理仅记录错误，如果未发送响应，它将发送错误的 httpStatusCode（如果未提供则发送 HTTP 500 状态）并渲染 “UnknownError” 模板。

第三方级别的中间件

在某些情况下，我们将向后端添加一些额外的功能。先安装 Node.js 模块获取所需的功能，然后在应用级别或路由器级别将其加载到你的应用中。

示例：当 body-parser 处理 Content-Type 请求标头时，所有中间件都将使用解析的正文填充 req.body 属性。

const express = require('express');
const bodyParser = require('body-parser');
const app = express();
app.use(bodyParser.urlencoded({extended:false}))
app.use(bodyParser.json())
app.post('/save',(req,res)=>{
    res.json({
        "status":true,
         "payload":req.body
    })
}
app.listen(3000,(req,res)=>{
    console.log('server running on port')
})

总结

中间件功能是一种非常好的方式，可以对每个请求或针对特定路由的每个请求运行代码，并对请求或响应数据采取措施。中间件是现代 Web 服务器的重要组成部分，并且非常有用。

英文原文地址：https://www.thirdrocktechkno.com/blog/how-Node-JS-middleware-works/

为了保证的可读性，本文采用意译而非直译。

更多编程相关知识，请访问：编程入门！！

以上がNode.js ミドルウェアがどのように機能するかについての簡単な説明の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。