本文將詳細介紹如何使用?Node.js + Express + MongoDB?構建一個完整的 RESTful API 后端項目,涵蓋:
-
項目初始化
-
Express 服務器搭建
-
MongoDB 數據庫連接
-
REST API 設計(CRUD 操作)
-
錯誤處理與中間件
-
源碼結構與完整代碼
-
部署建議
一,Express 服務器搭建
1. 環境準備
1.1 安裝必要工具
-
Node.js(建議 LTS 版本)
-
MongoDB(本地或 Atlas 云數據庫)
-
代碼編輯器(如 VS Code)
-
Postman(API 測試)
1.2 初始化項目
mkdir node-express-mongodb-backend
cd node-express-mongodb-backend
npm init -y
2. 創建項目
express node-express-mongodb-backend
-
express:Web 框架
-
mongoose:MongoDB 對象建模
-
body-parser:解析請求體
-
cors:跨域支持
-
dotenv:環境變量管理
-
nodemon:開發熱重載
3.更新項目依賴
npm install
{
? "name": "node-express-mongodb-backend",
? "version": "0.0.0",
? "private": true,
? "scripts": {
? ? "start": "node ./bin/www"
? },
? "dependencies": {
? ? "cookie-parser": "~1.4.4",
? ? "debug": "~2.6.9",
? ? "express": "~4.16.1",
? ? "http-errors": "~1.6.3",
? ? "jade": "~1.11.0",
? ? "morgan": "~1.9.1"
? }
}
4. 項目結構
NODE-EXPRESS-MONGODB-BACKEND/
├── bin/? ? ? ? ? ? ? ? ? ? ? ? ? ? # 啟動腳本
├── node_modules/ ? ? ? ? # 依賴庫(npm install 生成)
├── public/? ? ? ? ? ? ? ? ? ? ? ?# 靜態資源(CSS/JS/圖片)
├── routes/? ? ? ? ? ? ? ? ? ? ? # 路由定義
├── views/? ? ? ? ? ? ? ? ? ? ? ?# 前端模板(Jade/Pug)
├── app.js? ? ? ? ? ? ? ? ? ? ? ? # 主應用入口文件
├── package.json? ? ? ? ? ? # 項目配置和依賴
└── package-lock.json ? ? # 依賴版本鎖定
5. 配置項目啟動信息
// app.listen(端口號,服務器啟動成功時調用的函數);
app.listen(3001,function(){console.log('服務器啟動成功,端口號為3001');
});
刪除app.js最后一行代碼,替換成上述代碼。端口占用可以修改端口號!
6.啟動項目
node app.js
啟動完成在終端會輸出:服務器啟動成功!端口號為3001
7.下載nodemon插件
目的是:為了讓以后代碼修改后,服務器自動啟動。我們需要下載nodemon插件!
npm i nodemon -g
8.? 啟動項目
nodemon app.js
注意要是端口占用,直接手動修改端口號,直到命令行輸出成功啟動!
[nodemon] restarting due to changes...
[nodemon] starting `node app.js`
后端服務器啟動,端口3001
[nodemon] restarting due to changes...
[nodemon] starting `node app.js`
后端服務器啟動,端口3011
9.app .js代碼的注釋 (方便理解代碼!)
/*** (1)引入項目中需要的模塊*/
var createError = require('http-errors');
var express = require('express');
var path = require('path');
var cookieParser = require('cookie-parser');
// 處理項目中日志,第三方寫好插件
var logger = require('morgan');var indexRouter = require('./routes/index');
var usersRouter = require('./routes/users');//通過express創建一個對象。項目對象
var app = express();// 后端配置頁面,我們目前不需要
app.set('views', path.join(__dirname, 'views'));
app.set('view engine', 'jade');/*** 加載項目運行插件*/
//配置日志環境
app.use(logger('dev'));
//前端發送json數據,后端可以接受
app.use(express.json());
//后端來處理請求地址。
app.use(express.urlencoded({ extended: false }));
//處理請求傳遞cookie信息
app.use(cookieParser());
//指定項目中public為靜態資源 ,這個文件夾里面資源前端直接訪問
app.use(express.static(path.join(__dirname, 'public')));//配置路由
app.use('/', indexRouter);
app.use('/users', usersRouter);// 配置404的訪問結果
app.use(function(req, res, next) {next(createError(404));
});// 后端報錯,錯誤信息在這里處理
app.use(function(err, req, res, next) {
// set locals, only providing error in developmentres.locals.message = err.message;res.locals.error = req.app.get('env') === 'development' ? err : {};// render the error pageres.status(err.status || 500);res.render('error');
});// module.exports = app;
// 啟動服務器,監聽3001端口
app.listen(3011,()=>{console.log("后端服務器啟動,端口3011");
})
二,MongoDB 數據庫下載及連接
MongoDB是一個分布式文件存儲的非關系型數據庫,適用于高并發讀寫、海量數據存儲和高可擴展性的場景。本文詳細介紹了MongoDB的安裝、啟動、連接方法,包括Windows和Linux環境,以及常用命令、數據類型、特點、復制集、備份還原等。同時,講解了MongoDB的可視化工具Compass的使用,以及如何通過mongoose在Node.js中進行數據操作。
1.下載安裝MongoDB
MongoDB官網:Download MongoDB Community Server | MongoDB
最后安裝時將這個勾選去掉!!!
2.下載安裝安裝圖形化界面軟件Navicat
下載地址:https://dn.navicat.com.cn/download/navicat17_premium_lite_cs_x64.exe
3.Nodejs獲取mongodb數據庫的數據
(1)安裝mongoose插件
npm i mongoose
(2)在項目種創建utils文件夾,里面創建db.js文件
const mongoose = require("mongoose");const connectDB = async () => {try {await mongoose.connect("mongodb://127.0.0.1:27017/unmannedAerialVehiclePipelineInspection");console.log("MongoDB連接成功");} catch (error) {console.log("連接數據庫失敗:", error);process.exit(1); // 退出進程}
};connectDB();
(3)找到app.js文件,引入db.js
// 處理項目中日志,第三方寫好插件
var logger = require('morgan');//路由請求之前,連接數據庫
require("./utils/db")
(4) 啟動MongoDB連接
提供一些方式:
首先在環境變量-用戶變量中,新增 path? --->? D:\MongoDB\bin
方法一:配置文件方式啟動服務
- 在MongoDB安裝路徑下,在bin同級新建conf文件夾;
- 在該文件中,用文件文檔建立?mongod.conf文件
storage:#The directory where the mongod instance stores its data.Default Value is "\data\db" on Windows.dbPath: D:\MongoDB\data\db
dbPath的路徑根據自己的路徑來寫!
方法二: Window 下安裝 Mongodb 并設置為開機自啟
- 在MongoDB文件下新建data 然后新建db? ? 順序是這樣:D:\MongoDB\data\db
在
MongoDB下新建文件夾?log
(存放日志文件),并且在里面新建文件?mongodb.log
- 在MongoDB文件建立mongod.conf文本文檔,內容如下:
systemLog:
? ? destination: file
? ? path: D:\MongoDB\log\mongod.log
? ? logAppend: true
storage:
? ? dbPath: D:\MongoDB\data\db
net:
? ? bindIp: 127.0.0.1
? ? port: 27017
? ? ? 4.在D:\MongoDB\bin 路徑下,啟動cmd命令框,輸入命令!
sc.exe create MongoDB binPath=D:\MongoDB\bin\mongod.exe\" --service --config=\"D:\MongoDB\mongod.cfg\"" DisplayName= "MongoDB" start= "auto"
? ? ? 5. 啟動完成后在任務管理器中可以看得
啟動不成功!請參考以下文章!【親身實踐已解決】Windows無法啟動MongoDB Server,錯誤:1053:服務沒有及時響應啟動或控制請求_錯誤1053 服務沒有及時響應啟動或控制請求-CSDN博客
三,后端MVC架構
項目根目錄下文件
? ? ? ? routes文件夾--->users.js
? ? ? ??controllers文件夾--->UserController.js
? ? ? ? models文件夾--->UserModel_DB.js
四,Node后端身份驗證
1.搭建身份認證環境? ?
(1)需要下載依賴引入jwt ;解決:生成token憑證
npm i jsonwebtoken express-jwt
#?express-jwt這個中間件,目的就算為了驗證token
(2)生成token
(3)UserController里面加入代碼
const UserModel_DB = require("../models/UserModel_DB");
const Response = require("../utils/Response");
const Jwt = require("jsonwebtoken");
const { getEncAes128 } = require("../utils/crypto");class usercontroller {/*** 所有用戶*/async alluser(req, res, next) {try {const data = await UserModel_DB.find();res.send(Response.success({ msg: "全部用戶", data }));} catch (error) {console.log(error);res.send(Response.error({ msg: "數據傳輸失敗" }));}}/*** 登錄*/async login(req, res, next) {try {const { username, password } = req.body;// 傳遞了一個對象,按照傳遞對象去數據篩選// 將password進行同樣加密,將結果放在數據庫中尋找const newPassword = getMD5(password);const data = await UserModel_DB.find({username: username,password: newPassword,});console.log(data);if (data.length) {//生成身份憑證//第一個參數生成保存用戶自己信息,//第二個參數screct密鑰//設置過期時間,以s作為單位const token = jwt.sign({ username }, "shuangxiangbabai", {expiresIn: 60 * 60,});res.send(Response.success({ data: "Bearer " + token }));} else {res.send(Response.error());}} catch (error) {console.log(error);res.send(Response.error({ msg: "服務器報錯" }));}}/*** 注冊*/async register(req, res, next) {const { username, password, age, phone, avatar, gender } = req.body;if (username && password && age && phone && avatar && gender) {const result = getEncAes128(password);const data = await UserModel_DB.create({username,password: result,age,phone,avatar,gender,});if (data) {res.send(Response.success({ msg: "注冊成功", data }));} else {res.send(Response.error({ msg: "注冊失敗" }));}} else {res.send(Response.error({ msg: "數據傳輸失敗" }));}}/*** 修改密碼*/async fixpsd(req, res, next) {try {const { id, newpassword } = req.body;const result = getEncAes128(newpassword);const data = await UserModel_DB.updateOne({ _id: id },{ password: result });if (data.acknowledged) {res.send(Response.success({ msg: "修改成功", data }));} else {res.send(Response.error({ msg: "修改失敗" }));}} catch (error) {console.log(error);res.send(Response.error({ msg: "數據傳輸失敗" }));}}/*** 根據token驗證用戶*/async UserInfo(req, res, next) {const token = req.get("Authorization");const obj = Jwt.verify(token.split(" ")[1], "baoyebabai");console.log(obj.username);const data = await UserModel_DB.find({ username: obj.username });console.log(data);res.send({ data });}
}module.exports = new usercontroller();
2.服務端驗證token
(1) 在utils文件夾下面創建jwt.js文件
// 引入的一個函數
const {expressjwt} = require("express-jwt")//在進行token認證
const jwtAuth = expressjwt({secret:"shuangxiangbabai", //加密的密鑰algorithms:["HS256"], //默認加密采用HS256credentialsRequired:true //true:不管請求有沒有攜帶token,都需要驗證,false:請求沒有帶token不驗證
})module.exports = jwtAuth
(2)需要在app.js中引入jwt.js文件并加載中間件
//引入jwt認證代碼
const jwtAuth = require("./utils/jwt")//指定項目中public為靜態資源 ,這個文件夾里面資源前端直接訪問
app.use(express.static(path.join(__dirname, 'public')));//先驗證token
app.use(jwtAuth)