使用 TypeScript、Express.js、Joi 验证和面向对象编程的 REST API 中的自定义错误处理

嗨，开发人员！

构建健壮且可维护的 REST API 需要仔细考虑错误处理、验证和结构。在本文中，我们将探讨如何使用 TypeScript、Express.js、Joi 进行验证以及面向对象编程 (OOP) 的原理，在 REST API 中设置自定义错误处理机制。我们将按如下方式构建我们的项目：

结构：

---src
-----中间件
--------ErrorHanlder.ts
-----模型
--------用户.ts
-----存储库
--------UserRepository.ts
-----路线
--------UserRouter.ts
-----控制器
--------UserController.ts
-----服务
--------UserService.ts
-----验证
--------UserValidation.ts
---app.ts
---server.ts

设置项目

mkdir rest-api
cd rest-api
npm init -y
npm install express typescript @types/node @types/express ts-node-dev
npx tsc --init

错误处理中间件

// src/middlewares/ErrorHandler.ts
import { Request, Response, NextFunction } from 'express';

class ErrorHandler extends Error {
  statusCode: number;
  message: string;

  constructor(statusCode: number, message: string) {
    super();
    this.statusCode = statusCode;
    this.message = message;
  }
}

const handleError = (err: ErrorHandler, req: Request, res: Response, next: NextFunction) => {
  const { statusCode, message } = err;
  res.status(statusCode).json({
    status: 'error',
    statusCode,
    message,
  });
};

export { ErrorHandler, handleError };

用户模型

// src/models/User.ts
export interface User {
  id: number;
  name: string;
  email: string;
}

用户存储库

// src/repository/UserRepository.ts
import { User } from '../models/User';

class UserRepository {
  private users: User[] = [];

  findAll(): User[] {
    return this.users;
  }

  findById(id: number): User | undefined {
    return this.users.find(user => user.id === id);
  }

  create(user: User): User {
    this.users.push(user);
    return user;
  }
}

export default new UserRepository();

用户服务

// src/services/UserService.ts
import UserRepository from '../repository/UserRepository';
import { User } from '../models/User';
import { ErrorHandler } from '../middlewares/ErrorHandler';

class UserService {
  getAllUsers(): User[] {
    return UserRepository.findAll();
  }

  getUserById(id: number): User | undefined {
    const user = UserRepository.findById(id);
    if (!user) {
      throw new ErrorHandler(404, 'User not found');
    }
    return user;
  }

  createUser(user: User): User {
    const { error } = userSchema.validate(user);
    if (error) {
      throw new ErrorHandler(400, error.details[0].message);
    }
    return UserRepository.create(user);
  }
}

export default new UserService();

用户验证

// src/validations/UserValidation.ts
import Joi from 'joi';

const userSchema = Joi.object({
  id: Joi.number().required(),
  name: Joi.string().required(),
  email: Joi.string().email().required(),
});

export { userSchema };

用户控制器

// src/controllers/UserController.ts
import { Request, Response, NextFunction } from 'express';
import UserService from '../services/UserService';
import { ErrorHandler } from '../middlewares/ErrorHandler';

class UserController {
  getAllUsers(req: Request, res: Response, next: NextFunction) {
    try {
      const users = UserService.getAllUsers();
      res.json(users);
    } catch (error) {
      next(error);
    }
  }

  getUserById(req: Request, res: Response, next: NextFunction) {
    try {
      const user = UserService.getUserById(parseInt(req.params.id));
      res.json(user);
    } catch (error) {
      next(error);
    }
  }

  createUser(req: Request, res: Response, next: NextFunction) {
    try {
      const user = UserService.createUser(req.body);
      res.status(201).json(user);
    } catch (error) {
      next(error);
    }
  }
}

export default new UserController();

用户路线

// src/routes/UserRouter.ts
import { Router } from 'express';
import UserController from '../controllers/UserController';

const router = Router();

router.get('/users', UserController.getAllUsers);
router.get('/users/:id', UserController.getUserById);
router.post('/users', UserController.createUser);

export default router;

应用程序入口点

// src/app.ts
import express from 'express';
import UserRouter from './routes/UserRouter';
import { handleError } from './middlewares/ErrorHandler';

const app = express();

app.use(express.json());
app.use('/api', UserRouter);
app.use(handleError);

export default app;

服务器设置

// src/server.ts
import app from './app';

const PORT = process.env.PORT || 3000;

app.listen(PORT, () => {
  console.log(`Server running on port ${PORT}`);
});

通过使用 TypeScript、Express.js、Joi 和 OOP 原则构建我们的项目，我们实现了一个干净且可维护的代码库。自定义错误处理中间件提供了一种一致的方法来管理整个应用程序中的错误，而验证逻辑则确保数据完整性。此设置可以为更复杂的应用程序奠定坚实的基础。

联系人
电子邮件：luizcalaca@gmail.com
Instagram：https://www.instagram.com/luizcalaca
Linkedin：https://www.linkedin.com/in/luizcalaca/
推特：https://twitter.com/luizcalaca

以上是使用 TypeScript、Express.js、Joi 验证和面向对象编程的 REST API 中的自定义错误处理的详细内容。更多信息请关注PHP中文网其他相关文章！