求一个Nodejs项目目录结构规范

求一个Nodejs项目目录结构规范

我们知道java有mvn mvn有自己的一套代码目录结构体系。 src – main – java

但是我们的nodejs呢？ 求推荐，求解惑。

10 回复

当然可以。在Node.js项目中，虽然没有像Java的Maven那样的严格规范，但有一些流行的约定和最佳实践来组织项目的目录结构。以下是一个常见的Node.js项目目录结构示例，以及对每个部分的简要说明：

示例目录结构

my-nodejs-app/
├── .gitignore
├── README.md
├── package.json
├── .env
├── .eslintrc.json
├── .prettierrc
├── .babelrc
├── src/
│   ├── controllers/
│   │   └── userController.js
│   ├── models/
│   │   └── userModel.js
│   ├── routes/
│   │   └── userRoutes.js
│   ├── services/
│   │   └── userService.js
│   ├── utils/
│   │   └── logger.js
│   └── app.js
├── tests/
│   ├── unit/
│   │   └── userController.test.js
│   └── integration/
│       └── api.test.js
└── config/
    └── db.config.js

目录结构说明

  1. 根目录

    • .gitignore: 忽略Git版本控制系统不需要跟踪的文件和目录。
    • README.md: 项目说明文档。
    • package.json: 包管理文件，包含依赖项、脚本等信息。
    • .env: 环境变量配置文件。
    • .eslintrc.json: ESLint配置文件，用于代码风格检查。
    • .prettierrc: Prettier配置文件，用于代码格式化。
    • .babelrc: Babel配置文件，用于代码转译。

  2. src/: 源代码目录

    • controllers/: 控制器文件，处理路由请求并调用服务层逻辑。
    • models/: 数据模型文件，定义数据库表结构或数据验证规则。
    • routes/: 路由配置文件，定义API接口路径及关联控制器。
    • services/: 服务层文件，处理业务逻辑。
    • utils/: 工具函数文件，包含一些通用工具方法。
    • app.js: 应用入口文件，初始化应用并配置中间件。

  3. tests/: 测试目录

    • unit/: 单元测试文件，测试单个模块的功能。
    • integration/: 集成测试文件，测试多个模块之间的交互。

  4. config/: 配置文件目录

    • db.config.js: 数据库连接配置文件。

这种结构有助于保持项目的清晰和可维护性，使团队成员更容易理解和贡献代码。希望这对你有所帮助！


突然找到了一个：http://cnodejs.org/topic/52d51d4ce20b7c8214959407 对应的github地址：https://github.com/focusaurus/express_code_structure

另外一个：https://github.com/jifeng/node-app

我现在的目录结构 app.js ----base ----router ----controller ----proxy ----public ----views ----upload

可以看看yeoman

我觉得没有什么所谓的规范，可能有一些约定俗称的习惯。比如server端最好放到lib文件夹里面，front-end最好放到app文件夹里面，项目发布放到dist文件夹里面，临时文件放到.tmp文件夹等等。

其实项目结构主要还是需要根据项目需求来。

如果前端要用到mvc架构，那么简单的views文件夹就不是很好满足前端需求了，因为前端MVC里面的views层用这个文件夹名更适合。

如果需要写测试用例，那么可能根目录下就要多一个test文件夹，来对具体的代码进行控制，而这时候虽然后端是放在lib文件夹里面，但是为了更好的执行测试代码，那么server.js 或者app.js文件可能放到根目录就比较适合了。

再比如说前端项目中的库用bower来管理，那么就存在bower_components文件夹，那么bower_components放到app里面还是放到根目录可能就要根据具体你Grunt里面最终项目输出怎么方便来决定了。

现在 项目 的 目录 结果如下： –client ----bower_components ----images ----scripts ----styles ----views –controllers –dist –lib –models –node_modules –proxy –routes –test

其实目录结构 只要清晰和方便项目管理就好。

这不就是/nodeclub的目录结构吗？

试问，proxy目录具体是做何用？

是的，就是约定。 但是感觉都放到根目录，很不好似的。 我不知道是否应该借鉴java的目录模式。

–lib ----controllers ----db ----express ----utils –static –views app.js config.js

Node.js 项目的目录结构可以根据团队的需求和个人习惯有所不同，但还是有一些常用的最佳实践可以遵循。以下是一个典型的 Node.js 项目目录结构示例：

my-nodejs-app/
├── .github/
│   └── workflows/       # GitHub Actions 配置
├── config/              # 配置文件
├── dist/                # 编译后的文件（如 TypeScript 编译后）
├── docs/                # 文档
├── node_modules/        # npm 安装的依赖包
├── src/                 # 源代码
│   ├── controllers/     # 控制器逻辑
│   ├── middlewares/     # 中间件
│   ├── models/          # 数据模型
│   ├── routes/          # API 路由
│   ├── services/        # 业务逻辑服务
│   ├── utils/           # 工具函数
│   └── app.js           # 应用入口文件
├── tests/               # 测试文件
│   ├── integration/     # 集成测试
│   └── unit/            # 单元测试
├── .env                 # 环境变量配置
├── .gitignore           # Git 忽略文件
├── .prettierrc          # Prettier 配置
├── package.json         # npm 包信息和脚本命令
├── README.md            # 项目说明文档
└── tsconfig.json        # TypeScript 配置（如果使用 TypeScript）

示例代码

src/app.js (应用入口)

const express = require('express');
const bodyParser = require('body-parser');

const app = express();
app.use(bodyParser.json());

// 使用中间件
require('./middlewares/logger')(app);

// 导入路由
const router = require('./routes/api');
app.use('/api', router);

// 启动服务器
const port = process.env.PORT || 3000;
app.listen(port, () => {
    console.log(`Server is running on port ${port}`);
});

src/routes/api.js (API 路由)

const express = require('express');
const router = express.Router();

router.get('/example', (req, res) => {
    res.send({ message: 'Hello from API!' });
});

module.exports = router;

解释

  • src/ 目录存放所有的源代码。
  • controllers/ 存放处理请求的控制器逻辑。
  • models/ 存放数据模型或数据库操作逻辑。
  • routes/ 存放路由定义。
  • services/ 存放业务逻辑处理。
  • utils/ 存放工具函数或辅助函数。

这样的目录结构有助于保持代码的整洁与可维护性，并且便于团队协作开发。

回到顶部