TypeScript – 创建自定义的express中间件定义

在本文中，我们将介绍如何使用TypeScript创建自定义的express中间件定义。Express是一个流行的Node.js框架，用于构建Web应用程序和API。通过使用TypeScript，我们可以为Express中间件编写类型安全的定义，提高代码的可维护性和可读性。

阅读更多：TypeScript 教程

了解Express中间件

在开始编写自定义中间件定义之前，让我们先了解一下什么是Express中间件。中间件是一个函数，它可以在请求到达路由处理程序之前或之后执行一些操作。中间件函数可以访问请求对象（req）、响应对象（res）和下一个中间件函数（next）。

下面是一个简单的Express应用程序示例，展示了如何使用中间件：

import express from 'express';

const app = express();

// 日志中间件
app.use((req, res, next) => {
  console.log(`[ ${new Date()}]$ {req.method} ${req.url}`);
  next();
});

// 路由处理程序
app.get('/', (req, res) => {
  res.send('Hello, Express!');
});

app.listen(3000, () => {
  console.log('Server started on port 3000');
});

在上面的代码中，我们使用了一个日志中间件来打印每个请求的方法和URL。注意，我们通过调用next()方法来将控制权传递给下一个中间件或路由处理程序。

创建自定义中间件定义文件

为了使TypeScript理解我们自定义的中间件函数，我们需要为其编写类型定义文件。类型定义文件的扩展名是.d.ts。

首先，我们需要安装@types/express包，它包含了Express的类型定义。在终端中运行以下命令：

npm install @types/express --save-dev

接下来，创建一个名为express.d.ts的文件，并添加以下内容：

import { Request, Response, NextFunction } from 'express';

declare global {
  namespace Express {
    interface Request {
      // 在这里添加自定义的请求属性
    }
  }
}

declare module 'express' {
  export interface Request {
    // 在这里添加自定义的请求属性
  }
}

在上面的代码中，我们使用declare namespace来扩展Request接口，添加我们自定义的请求属性。我们还使用declare module来导出Request接口，以便其他地方可以正确使用这些自定义属性。

使用自定义中间件定义

一旦我们创建了自定义的中间件定义文件，我们就可以在Express应用程序中使用它。

例如，假设我们想为每个请求添加一个名为userInfo的自定义属性，其中包含关于用户的信息。我们可以修改上面的代码，如下所示：

import express from 'express';

const app = express();

app.use((req, res, next) => {
  // 模拟从数据库中获取用户信息
  const userInfo = {
    id: 1,
    name: 'John Doe',
    email: 'john@example.com'
  };

  // 将userInfo添加到请求对象中
  req.userInfo = userInfo;

  next();
});

app.get('/', (req, res) => {
  // 使用userInfo属性
  console.log(req.userInfo);

  res.send('Hello, Express!');
});

app.listen(3000, () => {
  console.log('Server started on port 3000');
});

在上面的代码中，我们将自定义的userInfo对象添加到请求对象中，并在路由处理程序中使用它。由于我们已经为请求对象添加了自定义属性的类型定义，TypeScript将能够正确地推断出这些属性的类型。