概述
- 围绕 NestJS 项目中用户登录注册功能的模块化开发进行深入讲解,包括模块创建、接口设计、服务逻辑实现、数据库交互、跨模块调用、接口测试等关键环节,旨在帮助开发者掌握模块化开发思想及 NestJS 的工程化实践
模块结构设计与初始化
在项目的开发过程中,对于用户登录注册功能,我们通常会将其独立为一个名为 auth 的模块,以实现功能解耦和逻辑清晰。
这样做的主要原因是:
- 保持模块职责单一性:user 模块用于处理与用户数据相关的增删改查操作,而 alt 模块则专注于登录和注册的认证逻辑。
- 便于后期维护与扩展:模块化设计使得代码结构更加清晰,也更易于团队协作与后期功能扩展。
- 虽然这种设计看似增加了复杂度,但长远来看有利于逻辑的可维护性和可测试性
模块命名建议:
auth(Authentication)
创建命令示例:
nest generate module auth
nest generate controller auth
nest generate service auth
我们使用 --dry-run(或 -d)参数来预览将要生成的文件和修改内容:
nest generate module auth -d
生成完成后,auth 模块会自动在 app.module.ts 中引入
控制器(Controller)与接口定义
在 auth.controller.ts 中,我们定义两个核心接口:
- 登录接口:
POST /api/auth/signin - 注册接口:
POST /api/auth/signup
import { Controller, Post, Body, HttpException, HttpStatus } from '@nestjs/common';
import { AuthService } from './auth.service';
@Controller('auth')
export class AuthController {
constructor(private readonly authService: AuthService) {}
@Post('signin')
async signIn(@Body() dto: { username: string; password: string }) {
return this.authService.signin(dto.username, dto.password);
}
@Post('signup')
async signUp(@Body() dto: { username: string; password: string }) {
return this.authService.signup(dto.username, dto.password);
}
}
接口测试建议使用如 Postman 或 Bruno 工具进行,便于调试和环境变量管理
服务逻辑(Service)与用户验证
auth.service.ts 是业务逻辑的核心部分, 这里我们引入了 UserRepository 来进行数据库操作。
- 核心逻辑:
- 接收用户名和密码参数
- 调用数据库查询用户是否存在
- 实现登录逻辑(如 JWT 签发)
- 实现注册逻辑(如密码加密、写入数据库)
import { Injectable } from '@nestjs/common';
import { UserRepository } from '../user/user.repository';
@Injectable()
export class AuthService {
constructor(private readonly userRepository: UserRepository) {}
async signin(username: string, password: string) {
const user = await this.userRepository.findByName(username);
if (!user) {
throw new Error('用户不存在');
}
// 验证密码逻辑
return { token: 'mocked-jwt-token' }; // 假设返回 token
}
async signup(username: string, password: string) {
// 检查用户是否已存在
const existing = await this.userRepository.findByName(username);
if (existing) {
throw new Error('用户名已存在');
}
// 密码加密、写入数据库等逻辑
return { message: '注册成功' };
}
}
数据访问层(Repository)与数据库交互
在 NestJS 中,通常使用 Prisma ORM 来操作数据库
UserRepository 是一个封装了数据库访问逻辑的类,用于与 User 表进行交互
import { Injectable } from '@nestjs/common';
import { PrismaService } from '../prisma/prisma.service';
@Injectable()
export class UserRepository {
constructor(private readonly prisma: PrismaService) {}
async findByName(username: string) {
return this.prisma.user.findUnique({
where: { username },
});
}
async username: string; password: string }) {
return this.prisma.user.create({
data,
});
}
}
若数据库中没有对应的 user 表,可使用以下命令同步结构:
npx prisma db push
推荐结合 docker-compose.yml 启动 PostgreSQL 容器,方便本地测试
模块间通信与依赖注入
在 NestJS 中,模块(Module)是组织代码的核心单位。为了在 auth 模块中使用 user 模块中的 UserRepository,我们需要在 user.module.ts 中导出该服务。
// user.module.ts
import { Module } from '@nestjs/common';
import { UserRepository } from './user.repository';
@Module({
providers: [UserRepository],
exports: [UserRepository], // 关键:导出供其他模块使用
})
export class UserModule {}
随后在 auth.module.ts 中导入 UserModule:
// auth.module.ts
import { Module } from '@nestjs/common';
import { AuthController } from './auth.controller';
import { AuthService } from './auth.service';
import { UserModule } from '../user/user.module';
@Module({
imports: [UserModule],
controllers: [AuthController],
providers: [AuthService],
})
export class AuthModule {}
通过这种方式,我们实现了跨模块的服务调用,确保了模块之间的低耦合性。
接口测试与环境配置
为方便测试,建议在接口请求工具中设置环境变量,如使用 Postman 或 Bruno:
-
环境变量配置示例:
{ "baseURL": "http://localhost:3000/api" } -
请求示例:
POST {{baseURL}}/auth/signin Body: { "username": "test", "password": "123456" }
通过这种方式,可以避免重复书写完整路径,提高开发效率
总结要点
- 模块化开发是 NestJS 的核心思想,将用户登录注册功能独立为
auth模块,有助于逻辑清晰、结构清晰 - 控制器(Controller)负责接收请求,服务(Service)处理核心逻辑,Repository 负责数据库交互
- 跨模块调用需导出并导入模块,确保服务实例的共享,避免重复初始化
- 接口测试建议使用工具+环境变量管理,提高开发效率和可维护性
- 数据库结构同步使用
npx prisma db push,确保本地开发环境与代码一致
如需进一步扩展功能,可考虑:
- 实现 JWT 认证机制
- 添加密码加密与验证(如 bcrypt)
- 用户权限管理模块
- 登录日志记录
- 用户 Token 刷新机制
218



被折叠的 条评论
为什么被折叠?



