当前位置: 开发笔记 > 编程语言 > 正文

做了一个Nest.js上手项目，很丑，但适合练手和收藏

作者：6057318491 | 来源：互联网 | 2023-09-15 12:23

大厂技术高级前端Node进阶点击上方程序员成长指北，关注公众号回复1，加入高级Node交流群前言最近爱了上Nest.js这个框架，边学边做

大厂技术高级前端 Node进阶

点击上方程序员成长指北&＃xff0c;关注公众号

回复1&＃xff0c;加入高级Node交流群

前言

最近爱了上 Nest.js 这个框架&＃xff0c;边学边做了一个 nest-todo 这个项目。

https://github.com/haixiangyan/nest-todo

没错&＃xff0c;就是一个 UI 很丑陋的 Todo List App。不知道为啥&＃xff0c;慢慢开始喜欢上这种原始风味的 UI 样式了&＃xff0c;不写 CSS 也挺好看的。

虽然皮肤很丑&＃xff0c;但是项目里面包含了大量 Nest.js 文档里的知识点&＃xff08;除了 GraphQL 和微服务&＃xff0c;这部分平常用得不多就不瞎整了&＃xff09;&＃xff0c;能实现的点我基本都想个需求实现了&＃xff1a;

为什么

为什么要做这个项目呢&＃xff1f;市面上的文章和博客看了不少&＃xff0c;很多都浅尝辄止&＃xff0c;写个 CRUD 就完事了&＃xff0c;也太 easy 了&＃xff0c;一行 nest g resource 就搞定。所以&＃xff0c;就想实现一个 大而全 的 Nest.js 的 Demo 出来。

除此之外&＃xff0c;这个 Demo 还能给很多要马上上手的前端一个示范。虽然 Nest.js 文档也齐全&＃xff0c;但是如果你稍微做重一点的业务&＃xff0c;它就有点顶不住了&＃xff0c;很多东西都要试。那这个时候 nest-todo 就可以站出来说&＃xff1a;“不会就抄我吧&＃xff0c;我肯定能 Work”。

前端

前端部分主要使用 React 来实现&＃xff0c;仅有 0.0000001% 的样式&＃xff0c;几乎都是 JS 逻辑&＃xff0c;且有 100% TypeScript 类型提示&＃xff0c;可大胆学习观看。

由于本项目以后端为主&＃xff0c;所以前端也只有这些东西&＃xff1a;

后端

后端内容则比较多了&＃xff0c;主要就是主角 Nest.js&＃xff0c;以及非常多的模块&＃xff1a;

下面例举几个我觉得比较重要的模块来说说吧&＃xff0c;当然下面都是一些代码片段&＃xff0c;想了解更具体的实现&＃xff0c;可以到 Github 的 nest-todo 查看。

Todo 模块

最基础的增、删、改、查。相信很多人在一些博客或文章都见过这样的写法。

TodoController 负责路由实现&＃xff1a;

&＃64;ApiTags(&＃39;待办事项&＃39;) &＃64;ApiBearerAuth() &＃64;Controller(&＃39;todo&＃39;) export class TodoController {constructor(private readonly todoService: TodoService) {}&＃64;Post()async create(&＃64;Request() request,&＃64;Body() createTodoDto: CreateTodoDto,): Promise {return this.todoService.create(request.user.id, createTodoDto);}&＃64;Get()async findAll(&＃64;Request() request): Promise {const { id, is_admin } &＃61; request.user;if (is_admin &＃61;&＃61;&＃61; 1) {return this.todoService.findAll();} else {return this.todoService.findAllByUserId(id);}}&＃64;Get(&＃39;:id&＃39;)async findOne(&＃64;Param(&＃39;id&＃39;, ParseIntPipe) id: number): Promise {return this.todoService.findOne(id);}&＃64;Patch(&＃39;:id&＃39;)async update(&＃64;Param(&＃39;id&＃39;, ParseIntPipe) id: number,&＃64;Body() updateTodoDto: UpdateTodoDto,) {await this.todoService.update(id, updateTodoDto);return updateTodoDto;}&＃64;Delete(&＃39;:id&＃39;)async remove(&＃64;Param(&＃39;id&＃39;, ParseIntPipe) id: number) {await this.todoService.remove(id);return { id };} }

而 TodoService 则实现更底层的业务逻辑&＃xff0c;这里则是要从数据库增、删、改、查&＃xff1a;

&＃64;Injectable() export class TodoService {constructor(private todoRepository: TodoRepository,private userRepository: UserRepository,) {}async create(userId: number, createTodoDto: CreateTodoDto): Promise {const user &＃61; await this.userRepository.findOne(userId);const { title, description, media } &＃61; createTodoDto;const todo &＃61; new Todo();todo.title &＃61; title;todo.description &＃61; description;todo.status &＃61; createTodoDto.status || TodoStatus.TODO;todo.media &＃61; media;todo.author &＃61; user;return this.todoRepository.save(todo);}async findAll(): Promise {return this.todoRepository.find();}async findAllByUserId(userId: number): Promise {const user &＃61; await this.userRepository.findOne({relations: [&＃39;todos&＃39;],where: { id: userId },});return user ? user.todos : [];}async findOne(id: number): Promise {return this.todoRepository.findOne(id);}async update(id: number, updateTodoDto: UpdateTodoDto) {const { title, description, status, media } &＃61; updateTodoDto;return this.todoRepository.update(id, {title,description,status: status || TodoStatus.TODO,media: media || &＃39;&＃39;,});}async remove(id: number) {return this.todoRepository.delete({id,});} }

可惜的是&＃xff0c;这些文章和博客到此就结束了&＃xff0c;可能作者看到这里也不想再继续搞下去了。不过&＃xff0c;我并不打算到此结束&＃xff0c;这才刚开始呢。

数据库模块

上面的 TodoService 里用到了数据库&＃xff0c;那就来聊聊数据库模块。我这里的选型是 TypeORM &＃43; mariadb&＃xff0c;为啥不用 mysql 呢&＃xff1f;因为我用 M1 的 Mac&＃xff0c;装不了 mysql 这个镜像&＃xff0c;非常蛋疼。

要使用 TypeORM&＃xff0c;就需要在 AppModule 上添加这个配置&＃xff0c;然而&＃xff0c;明文写配置是个沙雕做法&＃xff0c;更好的实现应该用 Nest.js 提供的 ConfigModule 来读取配置。

这里的读取配置目前我先采用读取 .env 的配置实现&＃xff0c;其实一般在公司里都应该有个配置中心&＃xff0c;里面存放了 username, password 这些敏感字段&＃xff0c;ConfigModule 则负责开启应用时读取这些配置。

读取配置这里使用 读取 .env 文件” 实现&＃xff1a;

const loadConfig &＃61; () &＃61;> {const { env } &＃61; process;return {db: {database: env.TYPEORM_DATABASE,host: env.TYPEORM_HOST,port: parseInt(env.TYPEORM_PORT, 10) || 3306,username: env.TYPEORM_USERNAME,password: env.TYPEORM_PASSWORD,},redis: {host: env.REDIS_HOST,port: parseInt(env.REDIS_PORT) || 6379,},}; };

然后再在 AppModule 使用 ConfigModule 和 TypeORMModule&＃xff1a;

const libModules &＃61; [ConfigModule.forRoot({load: [loadConfig],envFilePath: [DOCKER_ENV ? &＃39;.docker.env&＃39; : &＃39;.env&＃39;],}),ScheduleModule.forRoot(),TypeOrmModule.forRootAsync({imports: [ConfigModule],inject: [ConfigService],useFactory: (configService: ConfigService) &＃61;> {const { host, port, username, password, database } &＃61;configService.get(&＃39;db&＃39;);return {type: &＃39;mariadb&＃39;,// .env 获取host,port,username,password,database,// entitiesentities: [&＃39;dist/**/*.entity{.ts,.js}&＃39;],};},}), ];&＃64;Module({imports: [...libModules, ...businessModules],controllers: [AppController],providers: [AppService], }) export class AppModule {}

最后一步&＃xff0c;在 Todo 业务模块里注入数据表对应的 Repository&＃xff0c;这里一来 TodoService 就可以用 Repository 来操作数据库表了&＃xff1a;

&＃64;Module({imports: [TypeOrmModule.forFeature([TodoRepository, UserRepository]),UserModule,],controllers: [TodoController],providers: [TodoService], }) export class TodoModule {}

数据库模块还没完...

除了连接数据库&＃xff0c;数据库的迁移与初始化是很多人经常忽略的点。

先说初始化&＃xff0c;非常简单&＃xff0c;就是一个脚本的事&＃xff1a;

const checkExist &＃61; async (userRepository: Repository) &＃61;> {console.log(&＃39;检查是否已初始化...&＃39;);const userNum &＃61; await userRepository.count();const exist &＃61; userNum > 0;if (exist) {console.log(&＃96;已存在 ${userNum} 条用户数据&＃xff0c;不再初始化。&＃96;);return true;}return false; };const seed &＃61; async () &＃61;> {console.log(&＃39;开始插入数据...&＃39;);const connection &＃61; await createConnection(ormConfig);const userRepository &＃61; connection.getRepository(User);const dataExist &＃61; await checkExist(userRepository);if (dataExist) {return;}const initUsers &＃61; getInitUsers();console.log(&＃39;生成初始化数据...&＃39;);initUsers.forEach((user) &＃61;> {user.todos &＃61; lodash.range(3).map(getRandomTodo);});const users &＃61; lodash.range(10).map(() &＃61;> {const todos &＃61; lodash.range(3).map(getRandomTodo);return getRandomUser(todos);});const allUsers &＃61; [...initUsers, ...users];console.log(&＃39;插入初始化数据...&＃39;);await userRepository.save(allUsers);console.log(&＃39;数据初始化成功&＃xff01;&＃39;); };seed().then(() &＃61;> process.exit(0)).catch((e) &＃61;> {console.error(e);process.exit(1);});

当然&＃xff0c;最好也提供重置数据库的能力&＃xff1a;

const reset &＃61; async () &＃61;> {const connection &＃61; await createConnection(ormConfig);await connection.createQueryBuilder().delete().from(Todo).execute();await connection.createQueryBuilder().delete().from(User).execute(); };reset().then(() &＃61;> process.exit(0)).catch((e) &＃61;> {console.error(e);process.exit(1);});

这样一来&＃xff0c;小白上手完全不慌。只要改坏数据库&＃xff0c;一个 reset &＃43; seed 的操作&＃xff0c;数据库又回来的了。当然&＃xff0c;这一步仅仅是针对数据来说的。

针对数据库表结构则需要 数据库迁移。令人激动的是 TypeORM 已经提供了一条非常 NB 的迁移命令&＃xff1a;

// package.json "db:seed": "ts-node scripts/db/seed.ts", "db:reset": "ts-node scripts/db/reset.ts", "migration:generate": "npm run build && npm run typeorm migration:generate -- -n", "migration:run": "npm run build && npm run typeorm migration:run"

但是&＃xff0c;TypeORM 是从哪知道数据表的结构的呢&＃xff1f;这就是 Entity 的作用了&＃xff0c;下面就是一个 Todo entity&＃xff1a;

&＃64;Entity() export class Todo {&＃64;ApiProperty()&＃64;PrimaryGeneratedColumn()id: number; // 自增 id&＃64;ApiProperty()&＃64;Column({ length: 500 })title: string; // 标题&＃64;ApiProperty()&＃64;Column(&＃39;text&＃39;)description?: string; // 具体内容&＃64;ApiProperty()&＃64;Column(&＃39;int&＃39;, { default: TodoStatus.TODO })status: TodoStatus; // 状态&＃64;ApiProperty({ required: false })&＃64;Column(&＃39;text&＃39;)media?: string;&＃64;ManyToOne(() &＃61;> User, (user) &＃61;> user.todos)author: User; }

然后在 .env 里添加配置&＃xff1a;

# Type ORM 专有变量 # 详情&＃xff1a;https://typeorm.io/#/using-ormconfig # 生产环境在服务器上的容器里配置 TYPEORM_CONNECTION&＃61;mariadb TYPEORM_DATABASE&＃61;nest_todo TYPEORM_HOST&＃61;127.0.0.1 TYPEORM_PORT&＃61;3306 TYPEORM_USERNAME&＃61;root TYPEORM_PASSWORD&＃61;123456 TYPEORM_ENTITIES&＃61;dist/**/*.entity{.ts,.js} TYPEORM_MIGRATIONS&＃61;dist/src/db/migrations/*.js TYPEORM_MIGRATIONS_DIR&＃61;src/db/migrations

有了上面的命令&＃xff0c;还有什么数据库我不敢删的&＃xff1f;遇事不决 npm run migration:run &＃43; npm run db:seed 一下。

上传模块

从上面 Demo 可看到&＃xff0c;Todo 是支持图片上传的&＃xff0c;所以这里还需要提供上传功能。Nest.js 非常给力&＃xff0c;直接内置了 multer 这个库&＃xff1a;

&＃64;ApiTags(&＃39;文件上传&＃39;) &＃64;ApiBearerAuth() &＃64;Controller(&＃39;upload&＃39;) export class UploadController {&＃64;Post(&＃39;file&＃39;)&＃64;UseInterceptors(FileInterceptor(&＃39;file&＃39;))uploadFile(&＃64;UploadedFile() file: Express.Multer.File) {return {file: staticBaseUrl &＃43; file.originalname,};}&＃64;Post(&＃39;files&＃39;)&＃64;UseInterceptors(FileInterceptor(&＃39;files&＃39;))uploadFiles(&＃64;UploadedFiles() files: Array) {return {files: files.map((f) &＃61;> staticBaseUrl &＃43; f.originalname),};} }

当然&＃xff0c;必不可少&＃xff0c;需要在 UploadModule 里注入模块&＃xff1a;

&＃64;Module({imports: [MulterModule.register({storage: diskStorage({destination: path.join(__dirname, &＃39;../../upload_dist&＃39;),filename(req, file, cb) {cb(null, file.originalname);},}),}),],controllers: [UploadController],providers: [UploadService], }) export class UploadModule {}

静态资源模块

首先&＃xff0c;必须说明一下上面的上传应该是要上传到 COS 桶或者 CDN 上&＃xff0c;而不应该上传到自己服务器&＃xff0c;使用自己服务器来管理文件。这里仅为了用一用这个静态资源模块。

回到主题&＃xff0c;上面上传是上传到 /upload_dist 这个文件夹里&＃xff0c;那我们静态资源就是要 host 这个文件夹下面的文件&＃xff1a;

const uploadDistDir &＃61; join(__dirname, &＃39;../../&＃39;, &＃39;upload_dist&＃39;);&＃64;Controller(&＃39;static&＃39;) export class StaticController {&＃64;SkipJwtAuth()&＃64;Get(&＃39;:subPath&＃39;)render(&＃64;Param(&＃39;subPath&＃39;) subPath, &＃64;Res() res) {const filePath &＃61; join(uploadDistDir, subPath);return res.sendFile(filePath);} }

&＃64;Module({controllers: [StaticController], }) export class StaticModule {}

Very easy ~ 过

登录模块

相信细心的你一定看到上面的 &＃64;SkipJwtAuth&＃xff0c;这是因为我全局开了 JWT 鉴权&＃xff0c;只有请求头带有 Bearer Token 才能访问这个接口&＃xff0c;而 &＃64;SkipJwtAuth 则表示这个接口不需要 JWT 鉴权。不妨来看看普通的鉴权是怎么实现的。

首先&＃xff0c;你必要熟悉 Passport.js 里的 Strategy 和 verifyCallback 概念&＃xff0c;否则咱还是别聊了。这里 Nest.js 将这个 verifyCallback 封装成了 Strategy 里的 validate 方法&＃xff0c;当编写 valiate 则是在写 verifyCallback&＃xff1a;

&＃64;Injectable() export class LocalStrategy extends PassportStrategy(Strategy) {constructor(private moduleRef: ModuleRef,private reportLogger: ReportLogger,) {super({ passReqToCallback: true });this.reportLogger.setContext(&＃39;LocalStrategy&＃39;);}async validate(request: Request,username: string,password: string,): Promise> {const contextId &＃61; ContextIdFactory.getByRequest(request);// 现在 authService 是一个 request-scoped providerconst authService &＃61; await this.moduleRef.resolve(AuthService, contextId);const user &＃61; await authService.validateUser(username, password);if (!user) {this.reportLogger.error(&＃39;无法登录&＃xff0c;SB&＃39;);throw new UnauthorizedException();}return user;} }

上面是用 username &＃43; password 实现鉴权的一种策略&＃xff0c;当然我们正常服务是可以存在多种鉴权策略的&＃xff0c;要使用这个策略&＃xff0c;需要用到 Guard&＃xff1a;

&＃64;Injectable() export class LocalAuthGuard extends AuthGuard(&＃39;local&＃39;) {}

然后将这个 Guard 放在对应的接口头顶就 O 了&＃xff1a;

&＃64;ApiTags(&＃39;登录验证&＃39;) &＃64;Controller(&＃39;auth&＃39;) export class AuthController {constructor(private authService: AuthService) {}&＃64;ApiBody({ type: LoginDto })&＃64;SkipJwtAuth()&＃64;UseGuards(LocalAuthGuard)&＃64;Post(&＃39;login&＃39;)async login(&＃64;Request() req) {return this.authService.login(req.user);} }

和 local 这个 Strategy 相似的&＃xff0c;JWT 也有对应的 Strategy&＃xff1a;

&＃64;Injectable() export class JwtStrategy extends PassportStrategy(Strategy) {constructor(private userService: UserService) {super({jwtFromRequest: ExtractJwt.fromAuthHeaderAsBearerToken(),ignoreExpiration: false,secretOrKey: jwtConstants.secret,});}async validate(payload: any) {const existUser &＃61; this.userService.findOne(payload.sub);if (!existUser) {throw new UnauthorizedException();}return { ...payload, id: payload.sub };} }

而在 JwtGuard 里&＃xff0c;用 canActive 实现了 权限控制&＃xff1a;

&＃64;Injectable() export class JwtAuthGuard extends AuthGuard(&＃39;jwt&＃39;) {constructor(private reflector: Reflector) {super();}canActivate(context: ExecutionContext,): boolean | Promise | Observable {// 自定义用户身份验证逻辑const isPublic &＃61; this.reflector.getAllAndOverride(IS_PUBLIC_KEY, [context.getHandler(),context.getClass(),]);// skipif (isPublic) return true;return super.canActivate(context);}handleRequest(err, user) {// 处理 infoif (err || !user) {throw err || new UnauthorizedException();}return user;} }

格式化输出

写完接口了&＃xff0c;就得格式化输出&＃xff0c;我比较喜欢的格式是&＃xff1a;

{retcode: 0,message: "",data: ... }

我们更希望不要在 Controller 里重复添加上面的 “格式化” 数据结构。Nest.js 提供了 Interceptor&＃xff0c;可以让我们在拉数据给前端之前 “加点料”&＃xff1a;

export class TransformInterceptorimplements NestInterceptor> {intercept(context: ExecutionContext, next: CallHandler) {return next.handle().pipe(map((data) &＃61;> ({retcode: 0,message: &＃39;OK&＃39;,data,})),);} }

然后在 main.ts 入口里全局使用&＃xff1a;

app.useGlobalInterceptors(new LogInterceptor(reportLogger),new TransformInterceptor(), );

测试

写完了一个接口&＃xff0c;肯定免不了要写测试。我相信绝大部分人是不会写测试&＃xff0c;当然他们自己也是不会写的。

它不是 “Jest”&＃xff0c;也不是 “Cypress”&＃xff0c;而是一个可以研究得很深的领域。它难的点并不在于 “写”&＃xff0c;而在于 “造”&＃xff0c;以及 测试策略。

先来说测试策略吧&＃xff0c;请问什么东西应该测&＃xff1f;什么东西可以不测&＃xff1f;什么东西不应该测&＃xff1f;这三问是个人觉得是个玄学问题&＃xff0c;没有正确答案&＃xff0c;只能根据自己的项目来判断。并不是 100% 的覆盖率就是好的&＃xff0c;也要看更新迭代时测试代码的改造成本。

我先给出这个项目的测试原则&＃xff1a;

数据库操作不测&＃xff0c;因为这个测试内容 TypeORM 能保证 API 的调用是 OK 的
简单实现不测&＃xff0c;比如一个函数只有一行&＃xff0c;那还测个 P
我只测一个模块&＃xff0c;因为我懒&＃xff0c;剩下大家自己看我那个模块的测试就能学会了
我的 测试策略 不一定正确&＃xff0c;只能说是我目前想到比较好的 测试策略

对 TodoService 进行测试&＃xff0c;比较难的点是对 TypeOrm 的 Repository 进行 Mock&＃xff0c;这玩意我自己搞了一整天才搞通&＃xff0c;相信没人有耐心整这些了&＃xff1a;

const { mockTodos, mockUsers } &＃61; createMockDB();describe(&＃39;TodoService&＃39;, () &＃61;> {let mockTodoRepository;let mockUserRepository;let service: TodoService;beforeEach(async () &＃61;> {mockUserRepository &＃61; new MockUserRepository(mockUsers);mockTodoRepository &＃61; new MockTodoRepository(mockTodos);const module: TestingModule &＃61; await Test.createTestingModule({providers: [TodoService,{provide: TodoRepository,useValue: mockTodoRepository,},{provide: UserRepository,useValue: mockUserRepository,},],}).compile();service &＃61; module.get(TodoService);});it(&＃39;create&＃39;, async () &＃61;> {expect(service).toBeDefined();// 创建一个 todoconst returnTodos &＃61; await service.create(99, {title: &＃39;title99&＃39;,description: &＃39;desc99&＃39;,status: TodoStatus.TODO,});// expectexpect(returnTodos.title).toEqual(&＃39;title99&＃39;);expect(returnTodos.description).toEqual(&＃39;desc99&＃39;);expect(returnTodos.status).toEqual(TodoStatus.TODO);});it(&＃39;findAll&＃39;, async () &＃61;> {expect(service).toBeDefined();const returnTodos &＃61; await service.findAll();// expectexpect(returnTodos).toEqual(mockTodos);});it(&＃39;findAllByUserId&＃39;, async () &＃61;> {expect(service).toBeDefined();// 直接返回第一个 userjest.spyOn(mockUserRepository, &＃39;findOne&＃39;).mockImplementation(async () &＃61;> {return mockUsers[0];});// 找到 userId 为 0 的所有 todoconst returnTodos &＃61; await service.findAllByUserId(0);const [firstTodo] &＃61; returnTodos;// expectexpect(mockUserRepository.findOne).toBeCalled();expect(firstTodo.id).toEqual(0);expect(firstTodo.title).toEqual(&＃39;todo1&＃39;);expect(firstTodo.description).toEqual(&＃39;desc1&＃39;);});it(&＃39;findOne&＃39;, async () &＃61;> {expect(service).toBeDefined();// 找到一个 todoconst returnTodo &＃61; await service.findOne(0);// expectexpect(returnTodo.id).toEqual(0);expect(returnTodo.title).toEqual(&＃39;todo1&＃39;);expect(returnTodo.description).toEqual(&＃39;desc1&＃39;);});it(&＃39;update&＃39;, async () &＃61;> {expect(service).toBeDefined();// 所有 todoconst allTodos &＃61; await service.findAll();// 更新一个 todoawait service.update(0, {title: &＃39;todo99&＃39;,description: &＃39;desc99&＃39;,});// expectconst targetTodo &＃61; allTodos.find((todo) &＃61;> todo.id &＃61;&＃61;&＃61; 0);expect(targetTodo.id).toEqual(0);expect(targetTodo.title).toEqual(&＃39;todo99&＃39;);expect(targetTodo.description).toEqual(&＃39;desc99&＃39;);});it(&＃39;remote&＃39;, async () &＃61;> {expect(service).toBeDefined();// 删除 todoawait service.remove(0);// 获取所有 todoconst allTodos &＃61; await service.findAll();// expectexpect(allTodos.length).toEqual(1);expect(allTodos.find((todo) &＃61;> todo.id &＃61;&＃61;&＃61; 0)).toBeUndefined();}); });

对 TodoController 的单元测试&＃xff0c;我觉得这个 class 没什么可测的&＃xff0c;因为里面的函数太简单了&＃xff1a;

const { mockTodos, mockUsers } &＃61; createMockDB();describe(&＃39;TodoController&＃39;, () &＃61;> {let todoController: TodoController;let todoService: TodoService;let mockTodoRepository;let mockUserRepository;beforeEach(async () &＃61;> {mockTodoRepository &＃61; new MockTodoRepository(mockTodos);mockUserRepository &＃61; new MockUserRepository(mockUsers);const app: TestingModule &＃61; await Test.createTestingModule({controllers: [TodoController],providers: [TodoService,{provide: TodoRepository,useValue: mockTodoRepository,},{provide: UserRepository,useValue: mockUserRepository,},],}).compile();todoService &＃61; app.get(TodoService);todoController &＃61; app.get(TodoController);});describe(&＃39;findAll&＃39;, () &＃61;> {const [firstTodo] &＃61; mockTodos;it(&＃39;普通用户只能访问自己的 todo&＃39;, async () &＃61;> {jest.spyOn(todoService, &＃39;findAllByUserId&＃39;).mockImplementation(async () &＃61;> {return [firstTodo];});const todos &＃61; await todoController.findAll({user: { id: 0, is_admin: 0 },});expect(todos).toEqual([firstTodo]);});it(&＃39;管理员能访问所有的 todo&＃39;, async () &＃61;> {jest.spyOn(todoService, &＃39;findAll&＃39;).mockImplementation(async () &＃61;> {return mockTodos;});const todos &＃61; await todoController.findAll({user: { id: 0, is_admin: 1 },});expect(todos).toEqual(mockTodos);});}); });

最后就是 e2e 的测试&＃xff0c;难点在于 Bearer Token 鉴权的获取&＃xff0c;这玩意也同样搞了我一天时间&＃xff1a;

describe(&＃39;TodoController (e2e)&＃39;, () &＃61;> {const typeOrmModule &＃61; TypeOrmModule.forRoot({type: &＃39;mariadb&＃39;,database: &＃39;nest_todo&＃39;,username: &＃39;root&＃39;,password: &＃39;123456&＃39;,entities: [User, Todo],});let app: INestApplication;let bearerToken: string;let createdTodo: Todo;beforeAll(async (done) &＃61;> {const moduleFixture: TestingModule &＃61; await Test.createTestingModule({imports: [TodoModule, AuthModule, typeOrmModule],providers: [TodoRepository, UserRepository],}).compile();app &＃61; moduleFixture.createNestApplication();await app.init();// 生成测试用户的 tokenrequest(app.getHttpServer()).post(&＃39;/auth/login&＃39;).send({ username: &＃39;user&＃39;, password: &＃39;user&＃39; }).expect(201).expect((res) &＃61;> {bearerToken &＃61; &＃96;Bearer ${res.body.token}&＃96;;}).end(done);});it(&＃39;GET /todo&＃39;, (done) &＃61;> {return request(app.getHttpServer()).get(&＃39;/todo&＃39;).set(&＃39;Authorization&＃39;, bearerToken).expect(200).expect((res) &＃61;> {expect(typeof res.body).toEqual(&＃39;object&＃39;);expect(res.body instanceof Array).toBeTruthy();expect(res.body.length >&＃61; 3).toBeTruthy();}).end(done);});it(&＃39;POST /todo&＃39;, (done) &＃61;> {const newTodo: CreateTodoDto &＃61; {title: &＃39;todo99&＃39;,description: &＃39;desc99&＃39;,status: TodoStatus.TODO,media: &＃39;&＃39;,};return request(app.getHttpServer()).post(&＃39;/todo&＃39;).set(&＃39;Authorization&＃39;, bearerToken).send(newTodo).expect(201).expect((res) &＃61;> {createdTodo &＃61; res.body;expect(createdTodo.title).toEqual(&＃39;todo99&＃39;);expect(createdTodo.description).toEqual(&＃39;desc99&＃39;);expect(createdTodo.status).toEqual(TodoStatus.TODO);}).end(done);});it(&＃39;PATCH /todo/:id&＃39;, (done) &＃61;> {const updatingTodo: UpdateTodoDto &＃61; {title: &＃39;todo9999&＃39;,description: &＃39;desc9999&＃39;,};return request(app.getHttpServer()).patch(&＃96;/todo/${createdTodo.id}&＃96;).set(&＃39;Authorization&＃39;, bearerToken).send(updatingTodo).expect(200).expect((res) &＃61;> {expect(res.body.title).toEqual(updatingTodo.title);expect(res.body.description).toEqual(updatingTodo.description);}).end(done);});it(&＃39;DELETE /todo/:id&＃39;, (done) &＃61;> {return request(app.getHttpServer()).delete(&＃96;/todo/${createdTodo.id}&＃96;).set(&＃39;Authorization&＃39;, bearerToken).expect(200).expect((res) &＃61;> {expect(res.body.id).toEqual(createdTodo.id);}).end(done);});afterAll(async () &＃61;> {await app.close();}); });

Swagger

Swagger 是一个非常强大的文档工具&＃xff0c;可以识别接口的 URL&＃xff0c;入参&＃xff0c;出参&＃xff0c;简直是前端使用者的福音&＃xff1a;

首先在 main.ts 里接入 Swagger&＃xff1a;

const setupSwagger &＃61; (app) &＃61;> {const config &＃61; new DocumentBuilder().addBearerAuth().setTitle(&＃39;待办事项&＃39;).setDescription(&＃39;nest-todo 的 API 文档&＃39;).setVersion(&＃39;1.0&＃39;).build();const document &＃61; SwaggerModule.createDocument(app, config);SwaggerModule.setup(&＃39;docs&＃39;, app, document, {swaggerOptions: {persistAuthorization: true,},}); };

然后在 nest-cli.json 里也接入 Swagger 的插件&＃xff0c;这样才能自动识别&＃xff0c;不然就要一个 ApiProperty 一个 ApiProperty 去声明了&＃xff1a;

{"collection": "&＃64;nestjs/schematics","sourceRoot": "src","compilerOptions": {"plugins": ["&＃64;nestjs/swagger"]} }

最后

还有非常多的模块没讲&＃xff0c;我觉得那些并不是那么重要&＃xff0c;只要看过文档就会了。上面的模块我是踩了很多坑才实现出来的&＃xff0c;中间走走停停花了大概 1 个月左右的时间。

本来是可以上线给大家一个在线 Demo 看的&＃xff0c;但是我的域名还在备案&＃xff0c;大家先本地 Clone 玩吧。

如果你对 Nest.js 也感兴趣&＃xff0c;也想学一下它&＃xff0c;不妨 Clone 一下我的 nest-todo 这个项目&＃xff0c;抄抄改改学一下吧。

Node 社群

我组建了一个氛围特别好的 Node.js 社群&＃xff0c;里面有很多 Node.js小伙伴&＃xff0c;如果你对Node.js学习感兴趣的话&＃xff08;后续有计划也可以&＃xff09;&＃xff0c;我们可以一起进行Node.js相关的交流、学习、共建。下方加考拉好友回复「Node」即可。

“分享、点赞、在看” 支持一波