搭建express项目模版

下面我们将一步步搭建一个基本的Express项目模板。这个模板包括项目结构、初始化、安装必要的依赖、创建主文件app.js、设置路由和控制器。最后,你可以根据项目需求进行修改和优化。

1. 项目结构

├── app.js
├── config
│   ├── config.default.js
├── controllers
│   ├── testController.js
├── package.json
├── router
│   ├── index.js
│   ├── test.js

2. 项目初始化

npm init -y

3. 安装

npm install express // express框架
npm install cors // 跨域
npm install morgan // 日志
npm install nodemon // 重启服务

4. 创建app.js文件

const express = require('express')
const app = express()
const cors = require('cors')
const morgan = require('morgan')

// 数据格式解析
app.use(express.json())
app.use(express.urlencoded())

// 跨域
app.use(cors())

//日志记录
app.use(morgan('dev'))

const PORT = process.env.PORT || 3000
app.listen(PORT, () => {
    console.log(`Server is running on http://localhost:${PORT}`)
})

5.路由&&控制器

新建/controllers/testController.js文件,并编写一个测试方法:

exports.testGet = async (req, res) => {
    console.log(req.method)
    res.send('testGet success')
}

exports.testPost = async (req, res) => {
    console.log(req.method)
    res.send('testPost success')
}

新建一个测试路由:/router/test.js,并导入控制器:

const express = require('express')
const router = express.Router()
const testController = require('../controller/testController')

router
    .get('/testGet', testController.testGet)
    .post('/testPost', testController.testPost)

module.exports = router

新建一个主路由:/router/index.js,并导入测试路由:

const express = require('express')
const router = express.Router()
const test = require('./test')

router.use(test)

module.exports = router

app.js中导入主路由:

const express = require('express')
const app = express()
const cors = require('cors')
const morgan = require('morgan')
// 导入主路由
const router = require('./router')

app.use(express.json())
app.use(express.urlencoded())
app.use(cors())
app.use(morgan('dev'))

// 路由
app.use('/api/v1', router)

const PORT = process.env.PORT || 3000

app.listen(PORT, () => {
    console.log(`Server is running on http://localhost:${PORT}`)
})

最基本的一个项目模版就搭建完毕了,后续可以根据项目需求进行修改和优化。