@testboard/common

简介

@testboard/common 是 TestBoard 平台的通用工具库，提供了一系列基础组件和工具函数，用于简化和标准化 NestJS 应用程序的开发。

特性

• 基础控制器和服务类，用于快速构建 CRUD 操作
• 通用拦截器，用于统一响应格式和日志记录
• 全局异常过滤器，用于标准化错误处理
• 实用工具函数，包括加密和格式化
• 完整的 TypeScript 类型支持

安装

1pnpm add @testboard/common

快速开始

基础控制器和服务

使用基础控制器和服务类可以快速实现标准的 CRUD 操作：

1import { BaseController, BaseService } from '@testboard/common';
2import { PrismaService } from '../prisma/prisma.service';
3import { User, Prisma } from '@prisma/client';
4
5// 服务类实现
6@Injectable()
7export class UsersService extends BaseService<
8  PrismaClient['user'],
9  {
10    model: User;
11    create: Prisma.UserCreateArgs;
12    findUnique: Prisma.UserFindUniqueArgs;
13    findMany: Prisma.UserFindManyArgs;
14    update: Prisma.UserUpdateArgs;
15    delete: Prisma.UserDeleteArgs;
16    upsert: Prisma.UserUpsertArgs;
17    createMany: Prisma.UserCreateManyArgs;
18    updateMany: Prisma.UserUpdateManyArgs;
19    deleteMany: Prisma.UserDeleteManyArgs;
20  }
21> {
22  constructor(private prisma: PrismaService) {
23    super(prisma.user);
24  }
25}
26
27// 控制器实现
28@Controller('users')
29export class UsersController extends BaseController<{
30  model: User;
31  create: Prisma.UserCreateArgs;
32  findUnique: Prisma.UserFindUniqueArgs;
33  findMany: Prisma.UserFindManyArgs;
34  update: Prisma.UserUpdateArgs;
35  delete: Prisma.UserDeleteArgs;
36  upsert: Prisma.UserUpsertArgs;
37  createMany: Prisma.UserCreateManyArgs;
38  updateMany: Prisma.UserUpdateManyArgs;
39  deleteMany: Prisma.UserDeleteManyArgs;
40}> {
41  constructor(private readonly usersService: UsersService) {
42    super(usersService);
43  }
44}

全局异常过滤器

在应用程序中注册全局异常过滤器：

1import { AllExceptionsFilter } from '@testboard/common';
2import { NestFactory } from '@nestjs/core';
3import { AppModule } from './app.module';
4
5async function bootstrap() {
6  const app = await NestFactory.create(AppModule);
7  app.useGlobalFilters(new AllExceptionsFilter());
8  await app.listen(3000);
9}
10bootstrap();

拦截器

使用拦截器统一响应格式和添加日志：

1import { Module } from '@nestjs/common';
2import { APP_INTERCEPTOR } from '@nestjs/core';
3import { TransformInterceptor, LoggingInterceptor, TimeoutInterceptor } from '@testboard/common';
4
5@Module({
6  providers: [
7    {
8      provide: APP_INTERCEPTOR,
9      useClass: TransformInterceptor
10    },
11    {
12      provide: APP_INTERCEPTOR,
13      useClass: LoggingInterceptor
14    },
15    {
16      provide: APP_INTERCEPTOR,
17      useClass: TimeoutInterceptor
18    }
19  ]
20})
21export class AppModule {}

工具函数

使用加密工具函数：

1import { CryptoUtil } from '@testboard/common';
2
3// 加密密码
4const hashedPassword = await CryptoUtil.hashPassword('password123');
5
6// 验证密码
7const isValid = await CryptoUtil.comparePassword('password123', hashedPassword);

文档

详细文档请参阅 docs 目录：

• 基础控制器和服务 - 基础类的使用方法和示例
• 拦截器 - 拦截器的配置和使用
• 异常处理 - 异常过滤器和自定义异常
• 工具函数 - 实用工具函数的说明

API 参考

基础类

• BaseController - 提供标准 CRUD 操作的控制器基类
• BaseService - 提供标准 CRUD 操作的服务基类

拦截器

• TransformInterceptor - 统一响应格式
• LoggingInterceptor - 请求日志记录
• TimeoutInterceptor - 请求超时处理

异常

• BusinessException - 业务逻辑异常
• AllExceptionsFilter - 全局异常过滤器

工具

• CryptoUtil - 加密相关工具函数
• FormatUtil - 格式化工具函数

贡献

欢迎贡献代码、报告问题或提出建议。

许可证

ISC