TypeScript 中的 Koa2 示例

Koa 2 是一个现代的、轻量级的 Node.js web 框架，它基于 ES6/ES7 异步语法，使用实验性的 ES6 module，适合于构建高效的 web 应用程序。在 TypeScript 中，通过使用 Koa 2 ，可以更加方便的进行类型检查和错误处理。本文将介绍 TypeScript 中如何使用 Koa 2 ，包括路由设计、中间件、错误处理和类型校验等方面。我们将建立一个一个简单的 web 应用程序，其中包括用户注册、登录、查询等功能。

准备工作

此示例中需要用到以下的库：

• koa 用于构建 web 框架
• koa-router 用于路由管理
• koa-bodyparser 用于解析请求体
• koa-jwt 用于 JWT 身份验证和令牌管理

首先，我们需要新建一个项目文件夹，然后通过 npm init 命令初始化项目并安装依赖：

$ npm init -y 
$ npm i koa koa-router koa-bodyparser koa-jwt

现在我们创建一个 index.ts 文件，并在其中引入我们需要的库。

import Koa from 'koa';
import Router from 'koa-router';
import bodyParser from 'koa-bodyparser';
import jwt from 'koa-jwt';

路由设计

接下来，我们需要为我们的应用程序设计路由。首先，我们需要为用户注册、登录、查询等功能设置不同的 API 端点。

我们在 index.ts 文件中添加路由，并使用 koa-bodyparser 中间件，以便能够解析请求主体。同时，我们需要使用 koa-jwt 来验证所有 API 请求是否含有有效的 JWT 授权令牌。

const app = new Koa();
const router = new Router();

// 路由设计
router.post('/register', registerUser);
router.post('/login', loginUser);
router.get('/user', jwt({ secret: 'jwt_secret' }), getUser);

// 中间件处理
app.use(bodyParser());
app.use(router.routes());
app.use(router.allowedMethods());

// 错误处理
app.on('error', err => {
  console.log('Server error: ', err);
});

其中， jwt_secret 是您需要随机生成的加密密钥，该密钥将用于加密 JWT 令牌。

接下来，我们需要针对用户注册、登录和查询操作编写相应的处理程序。这些处理程序将检查并处理请求中的数据，并返回相应的 JSON 响应。下面，我们定义了三个函数处理用户相关的请求。

export const registerUser: Koa.Middleware = async ctx => {
  const { username, password, email } = ctx.request.body;
  // 处理注册请求，代码略
};

export const loginUser: Koa.Middleware = async ctx => {
  const { username, password } = ctx.request.body;
  // 处理登录请求，代码略
};

export const getUser: Koa.Middleware = async ctx => {
  // 处理查询请求，代码略
};

以上代码将在注册、登录和查询操作上进行处理。

错误处理

接下来，我们设置错误处理程序。我们定义了一个错误处理中间件函数，它将检测所有错误，并将错误信息打印到控制台上。

app.on('error', err => {
  console.log('Server error: ', err);
});

类型检查

最后一步，我们需要设置 TypeScript 的类型检查。我们将从安装必需的 TypeScript 相关库，开始编写 TypeScript 类型定义，并在代码中使用这些类型。

我们需要安装以下库：

$ npm i typescript ts-node @types/koa @types/koa-router @types/koa-bodyparser @types/jsonwebtoken

首先，我们将通过添加 tsconfig.json 文件在项目中启用 TypeScript。以下是 tsconfig.json 的文件内容：

{
  "compilerOptions": {
    "target": "es5",
    "module": "commonjs",
    "strict": true,
    "esModuleInterop": true,
    "sourceMap": true
  }
}

接下来，我们需要使用 TypeScript 类型定义文件来定义请求和响应类型。我们将定义一个新的 types.ts 文件，其中包含所有的请求和响应类型。

export interface IUser {
  id: number;
  username: string;
  password: string;
  email: string;
}

export interface IUserInputDTO {
  username: string;
  password: string;
  email: string;
}

export interface IAuthResponse {
  token: string;
}

export interface IContext extends Koa.Context {
  state: {
    user: IUser;
  };
}

export interface IDatabase {
  users: IUser[];
}

以上代码将定义我们的用户、用户输入、授权响应和数据库相关类型。

现在，我们修改我们处理请求的三个函数，将类型签名与输入或输出的 JSON 对象相匹配。以下是如何定义修改后的登录函数。

export const loginUser: Koa.Middleware = async (ctx: IContext) => {
  const { body } = ctx.request;
  if (!body.username || !body.password) {
    ctx.throw(400, '缺少必要的参数');
  }

  const user = database.users.find(user => user.username === body.username);

  if (!user) {
    ctx.throw(401, '用户名或密码不正确');
  }

  if (user.password !== body.password) {
    ctx.throw(401, '用户名或密码不正确');
  }

  const token = jwt.sign({ id: user.id }, 'jwt_secret', { expiresIn: '1h' });

  ctx.body = { token };
};

我们还需要在 index.ts 中定义我们的数据库，以确保类型校验符合我们的期望。我们需要在应用程序中定义一个变量 database ，并赋值为包含硬编码的用户数据的对象。

const database: IDatabase = {
  users: [
    {
      id: 1,
      username: 'admin',
      password: '123456',
      email: 'example@gmail.com'
    }
  ]
};

完整代码示例

下面展示了完整的代码示例。

import Koa from 'koa';
import Router from 'koa-router';
import bodyParser from 'koa-bodyparser';
import jwt from 'koa-jwt';
import { IUserInputDTO, IUser, IAuthResponse, IContext, IDatabase } from './types';

const app = new Koa();
const router = new Router();

// 路由设计
router.post('/register', registerUser);
router.post('/login', loginUser);
router.get('/user', jwt({ secret: 'jwt_secret' }), getUser);

// 中间件处理
app.use(bodyParser());
app.use(router.routes());
app.use(router.allowedMethods());

// 错误处理
app.on('error', err => {
  console.log('Server error: ', err);
});

// 数据库定义
const database: IDatabase = {
  users: [
    {
      id: 1,
      username: 'admin',
      password: '123456',
      email: 'example@gmail.com'
    }
  ]
};

export const registerUser: Koa.Middleware = async ctx => {
  const { username, password, email } = ctx.request.body;
  // 处理注册请求，代码略
};

export const loginUser: Koa.Middleware = async (ctx: IContext) => {
  const { body } = ctx.request;
  if (!body.username || !body.password) {
    ctx.throw(400, '缺少必要的参数');
  }

  const user = database.users.find(user => user.username === body.username);

  if (!user) {
    ctx.throw(401, '用户名或密码不正确');
  }

  if (user.password !== body.password) {
    ctx.throw(401, '用户名或密码不正确');
  }

  const token = jwt.sign({ id: user.id }, 'jwt_secret', { expiresIn: '1h' });

  ctx.body = { token };
};

export const getUser: Koa.Middleware = async (ctx: IContext) => {
  // 处理查询请求，代码略
};

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

总结

通过使用 TypeScript ，我们可以更加方便的在 Koa 2 中进行类型检查和错误处理。我们可以使用 TypeScript 类型定义，声名对象的属性类型、函数的输入输出类型等等，在编写代码时维护类型的正确性。这样可以大大提高代码的质量和优雅程度。

来源：JavaScript中文网 ，转载请注明来源 本文地址：https://www.javascriptcn.com/post/659fb9cfadd4f0e0ff83ee55