Nodejs Express个人项目文件结构

Nodejs Express个人项目文件结构

在开发一个基于Node.js和Express的个人项目时，合理的文件结构对于项目的可维护性和扩展性至关重要。以下是一个我常用的文件结构示例，并附带了简单的说明和示例代码。

项目文件结构示例

my-express-app/
├── app.js
├── config/
│   └── db.js
├── controllers/
│   ├── userController.js
│   └── postController.js
├── models/
│   ├── user.js
│   └── post.js
├── routes/
│   ├── userRoutes.js
│   └── postRoutes.js
├── public/
│   ├── css/
│   │   └── style.css
│   ├── js/
│   │   └── script.js
│   └── images/
│       └── logo.png
├── views/
│   ├── layouts/
│   │   └── default.ejs
│   ├── partials/
│   │   └── header.ejs
│   └── index.ejs
├── middleware/
│   └── authMiddleware.js
├── utils/
│   └── helpers.js
├── .env
├── package.json
└── README.md

文件结构说明

1. app.js:

   • 这是应用的主要入口文件，负责初始化Express应用并引入其他模块。

   const express = require('express');
   const app = express();
   const userRoutes = require('./routes/userRoutes');
   
   app.use(express.json());
   app.use('/api/users', userRoutes);
   
   module.exports = app;
   

2. config/db.js:

   • 配置数据库连接信息。

   const mongoose = require('mongoose');
   
   mongoose.connect(process.env.DB_URL, {
       useNewUrlParser: true,
       useUnifiedTopology: true
   });
   
   const db = mongoose.connection;
   db.on('error', console.error.bind(console, 'connection error:'));
   db.once('open', function() {
       console.log("Connected to database");
   });
   

3. controllers/:

   • 包含处理请求逻辑的控制器文件。

   // userController.js
   const User = require('../models/user');
   
   exports.createUser = async (req, res) => {
       try {
           const user = await User.create(req.body);
           res.status(201).json(user);
       } catch (err) {
           res.status(400).json({ error: err.message });
       }
   };
   

4. models/:

   • 定义数据模型。

   // user.js
   const mongoose = require('mongoose');
   
   const UserSchema = new mongoose.Schema({
       username: { type: String, required: true },
       email: { type: String, required: true, unique: true }
   });
   
   module.exports = mongoose.model('User', UserSchema);
   

5. routes/:

   • 定义API路由。

   // userRoutes.js
   const express = require('express');
   const router = express.Router();
   const userController = require('../controllers/userController');
   
   router.post('/', userController.createUser);
   
   module.exports = router;
   

6. public/:

   • 存放静态资源（CSS、JS、图片等）。

7. views/:

   • 存放视图模板文件（如EJS模板）。

8. middleware/:

   • 自定义中间件，例如认证中间件。

   // authMiddleware.js
   const jwt = require('jsonwebtoken');
   
   exports.requireAuth = (req, res, next) => {
       if (!req.headers.authorization) {
           return res.status(401).json({ message: "Unauthorized" });
       }
       const token = req.headers.authorization.split(' ')[1];
       jwt.verify(token, process.env.JWT_SECRET, (err, decoded) => {
           if (err) {
               return res.status(401).json({ message: "Invalid token" });
           }
           req.user = decoded;
           next();
       });
   };
   

9. utils/:

   • 存放一些工具函数或辅助函数。

通过上述结构，你可以更清晰地组织代码，便于维护和扩展。希望这个示例对你有所帮助！