作为一名初级开发人员，构建 Node.js 后端最具挑战性的方面之一不是编写代码本身 - 而是以可扩展的方式组织代码。今天，我们将探索一个可用于生产的 Node.js 项目结构，您可以将其用作应用程序的模板。
非结构化代码的问题
在我们深入研究之前，想象一下尝试在图书馆中找到一本特定的书，那里的书是随机放置在书架上的。令人沮丧，对吧？这同样适用于代码。如果没有适当的结构，您的 Node.js 应用程序很快就会变成意大利面条式代码的迷宫，难以维护和扩展。
更好的方法：现代 Node.js 项目结构
让我们分解一下许多成功公司使用的专业级 Node.js 项目结构：
？后端/
├─？ src/
│ └── ? @types # TypeScript 类型定义
│ └──？ config # 配置文件
│ └── ?控制器 # 请求处理程序
│ └── ?实体 # 数据库模型/实体
│ └── ? helper # 辅助/实用函数
│ └── ? middlewares # Express 中间件
│ └── ? paths # API 路由定义
│ └── ? services # 业务逻辑
│ └── ? types # 附加类型定义
│ └── ? utils # 实用函数
└──？ app.ts # 应用程序入口点
└──？ .eslintrc.js # ESLint 配置
└──？ .prettierrc # 更漂亮的配置
└──？ Dockerfile # Docker 配置
└──？ package.json # 项目依赖
└──？ tsconfig.json # TypeScript 配置
└──？ .dockerignore # Docker 忽略规则
└──？ .env # 环境变量
└──？ docker-compose.yml # Docker Compose 配置
了解每个组件
1. @类型和类型目录
`// @types/express/index.d.ts
declare namespace Express {
export interface Request {
user?: {
id: string;
role: string;
};
}
}`
这些文件夹包含 TypeScript 类型定义。 @types 文件夹通常包含外部模块的声明，而 types 保存特定于应用程序的类型。
2。配置目录
// config/database.ts
export const dbConfig = {
host: process.env.DB_HOST,
port: process.env.DB_PORT,
username: process.env.DB_USER,
// … other configuration
};
该目录包含所有配置文件，可以轻松管理不同的环境（开发、登台、生产）。
3。控制器
// controllers/userController.ts
export class UserController {
async getUser(req: Request, res: Response) {
try {
const user = await userService.findById(req.params.id);
res.json(user);
} catch (error) {
res.status(500).json({ error: error.message });
}
}
}
控制器处理 HTTP 请求和响应，充当路由和服务之间的桥梁。
4。实体
typescript// entity/User.ts
@Entity()
export class User {
@PrimaryGeneratedColumn()
id: number;
@Column()
username: string;
@Column()
email: string;
}
实体目录包含您的数据库模型，通常使用 TypeORM 或 Sequelize 等 ORM。
5。服务
services/userService.ts
export class UserService {
async createUser(userData: CreateUserDto) {
const user = new User();
Object.assign(user, userData);
return await this.userRepository.save(user);
}
}
服务包含您的业务逻辑，使其与控制器分开。
6。中间件
`// @types/express/index.d.ts
declare namespace Express {
export interface Request {
user?: {
id: string;
role: string;
};
}
}`
中间件处理横切问题，例如身份验证、日志记录和错误处理。
最佳实践和技巧
1。单一职责： 每个目录都应该有一个明确的、单一的目的。不要将业务逻辑与路由定义混合在一起。
2。依赖注入：使用依赖注入让你的代码更易于测试和维护。
// config/database.ts
export const dbConfig = {
host: process.env.DB_HOST,
port: process.env.DB_PORT,
username: process.env.DB_USER,
// … other configuration
};
3。环境配置：使用.env文件作为环境特定的变量，并且永远不要将它们提交到版本控制。
4。 Docker 集成： Dockerfile 和 docker-compose.yml 的存在表明容器化支持，使跨环境的部署保持一致。
要避免的常见陷阱
循环依赖：小心不要在模块之间创建循环依赖。
海量文件：如果文件变得太大，则可能是做得太多了。将其分成更小、更集中的模块。
不一致的错误处理：在您的应用程序中建立一致的错误处理策略。
结论
结构良好的 Node.js 应用程序对于长期可维护性和可扩展性至关重要。此结构提供了坚实的基础，您可以随着应用程序的增长而构建该基础。请记住，我们的目标不仅仅是让它发挥作用，而是让它可维护、可扩展并且使用起来愉快。
下次启动新的 Node.js 项目时，请考虑使用此结构作为模板。它将节省您无数的重构时间，并使您的代码库从第一天起就更加专业。
专业提示：使用此结构创建模板存储库，以便您可以快速启动具有相同组织的新项目。
以上是Node.js 后端构建可扩展的应用程序：项目结构实用指南的详细内容。更多信息请关注PHP中文网其他相关文章！
