Nodejs Express插件express-http-context实现请求上下文管理的使用

Nodejs Express插件express-http-context实现请求上下文管理的使用
express-http-context 是一个 Node.js 的中间件，用于在 HTTP 请求期间管理请求上下文。它可以用来存储和访问与特定请求相关的数据，比如用户ID、请求ID等，这对于日志记录、审计等功能非常有用。

下面是如何使用 express-http-context 的基本步骤：

  1. 安装 express-http-context：
npm install express-http-context
  1. 在你的 Express 应用中设置中间件：
const express = require('express');
const createHttpContextMiddleware = require('express-http-context');

const app = express();
const contextMiddleware = createHttpContextMiddleware();

// 使用中间件
app.use(contextMiddleware);
  1. 设置请求上下文数据：
app.use((req, res, next) => {
    // 设置请求ID
    req.context.set('requestId', '1234567890');
    // 设置用户ID
    req.context.set('userId', 'user123');
    next();
});
  1. 在路由处理函数中访问请求上下文数据：
app.get('/', (req, res) => {
    const requestId = req.context.get('requestId');
    const userId = req.context.get('userId');
    console.log(`Request ID: ${requestId}, User ID: ${userId}`);
    res.send('Hello World!');
});
  1. 如果你需要在异步操作中访问请求上下文，可以使用 asyncLocalStorage：
const asyncLocalStorage = new createHttpContextMiddleware.AsyncLocalStorage();

app.use(async (req, res, next) => {
    asyncLocalStorage.run(new Map(), () => {
        asyncLocalStorage.getStore().set('requestId', '1234567890');
        asyncLocalStorage.getStore().set('userId', 'user123');
        next();
    });
});

app.get('/', async (req, res) => {
    const store = asyncLocalStorage.getStore();
    const requestId = store.get('requestId');
    const userId = store.get('userId');
    console.log(`Request ID: ${requestId}, User ID: ${userId}`);
    res.send('Hello World!');
});

以上就是使用 express-http-context 的基本方法。你可以根据自己的需求调整代码。希望这对你有所帮助！


3 回复

当然，让我用一种轻松的方式给你讲解express-http-context插件的使用方法。

想象一下，你正在经营一家咖啡店，每个顾客进来点单时，你都得记住他们的名字和他们点了什么。但如果你有了一种魔法笔，只要一写上顾客的名字，所有关于这个顾客的信息就自动出现在你的记事本上，这样你就再也不用担心记错了。express-http-context就是那个魔法笔！

首先，你需要安装这个魔法笔（也就是插件）：

npm install express-http-context --save

然后，在你的Express应用中，你可以这样使用它：

const express = require('express');
const httpContext = require('express-http-context');

const app = express();
app.use(httpContext.middleware);

app.use((req, res, next) => {
    httpContext.set('customerName', '张三'); // 写下顾客的名字
    httpContext.set('order', '拿铁咖啡'); // 写下顾客的订单
    next();
});

app.get('/', (req, res) => {
    const customerName = httpContext.get('customerName'); // 查看魔法笔记录的名字
    const order = httpContext.get('order'); // 查看魔法笔记录的订单
    res.send(`欢迎${customerName}，您的${order}已准备好！`);
});

这样，无论你的应用多么复杂，只要你设置了这些上下文信息，就可以在任何地方轻松获取到它们，就像魔法一样！

希望这个比喻能帮你更好地理解express-http-context的使用方式。


express-http-context 是一个用于 Node.js 和 Express 的库，它允许你在 HTTP 请求的生命周期中存储和访问数据。这个库非常适合用来处理像用户身份验证令牌、语言设置或数据库连接这样的请求特定数据。

安装

首先，你需要安装 express-http-context：

npm install express-http-context

基本使用

  1. 引入必要的模块：

    const express = require('express');
const createHttpTerminator = require('http-terminator').createHttpTerminator;
const expressHttpContext = require('express-http-context');

  2. 创建应用实例并使用中间件：

    const app = express();
app.use(expressHttpContext.middleware);

  3. 设置请求上下文中的值：

    app.use((req, res, next) => {
    expressHttpContext.set('requestId', '12345');
    next();
});

  4. 从请求上下文中获取值：

    app.get('/', (req, res) => {
    const requestId = expressHttpContext.get('requestId');
    res.send(`Request ID: ${requestId}`);
});

  5. 启动服务器：

    const httpTerminator = createHttpTerminator({ server });

app.listen(3000, async () => {
    console.log('Server is running on port 3000');
    // 在这里可以添加更多的初始化逻辑
});

// 当你需要停止服务器时
await httpTerminator.terminate();

更高级的用法

你还可以使用 express-http-context 来封装异步函数，确保它们在同一个请求上下文中运行。例如，如果你正在编写一个处理数据库查询的应用程序，你可以将数据库连接信息存储在请求上下文中，并在所有相关的中间件和路由处理器中共享它。

app.use(async (req, res, next) => {
    expressHttpContext.set('dbConnection', await connectToDatabase());
    next();
});

app.get('/data', async (req, res) => {
    const dbConnection = expressHttpContext.get('dbConnection');
    const data = await dbConnection.query('SELECT * FROM users');
    res.json(data);
});

通过这种方式，你可以在整个请求生命周期中保持一致的数据访问模式，这使得代码更加清晰和易于维护。

express-http-context 插件用于在 Node.js 的 Express 应用中管理 HTTP 请求的上下文。主要通过 createContextMiddleware() 创建中间件，并使用 get() 和 set() 方法来获取和设置请求上下文。

示例代码：

const express = require('express');
const createHttpContext = require('express-http-context');

const app = express();
const context = createHttpContext();

app.use(context.middleware());

app.get('/', (req, res) => {
  context.set('exampleKey', 'exampleValue');
  res.send(context.get('exampleKey'));
});

app.listen(3000);

此示例中，在根路由中设置了一个名为 exampleKey 的请求上下文，并将其值返回给客户端。

回到顶部