一慨蛙,在 Express 中使用 Session 認證
1. 安裝 express-session 中間件
在 Express 項目中,只需要安裝 express-session 中間件瞳遍,即可在項目中使用Session:
npm install express-session
2. 配置 express-session 中間件
express-session 中間件安裝成功后,需要通過app.use() 來注冊 session 中間件,示例代碼如下:
const session = require('express-session')
app.use(
session({
secret: 'itheima',
resave: false,
saveUninitialized: true,
})
)
3. 向 session 中存數據
當 express-session 中間件配置成功后辙浑,即可通過req.session 來訪問和使用session 對象,存儲用戶的關鍵信息:
// 登錄的 API 接口
app.post('/api/login', (req, res) => {
// 判斷用戶提交的登錄信息是否正確
if (req.body.username !== 'admin' || req.body.password !== '000000') {
return res.send({ status: 1, msg: '登錄失敗' })
}
// TODO_02:請將登錄成功后的用戶信息拟糕,保存到 Session 中
// 注意:只有成功配置了 express-session 這個中間件之后判呕,才能夠通過 req 點出來 session 這個屬性
req.session.user = req.body // 用戶的信息
req.session.islogin = true // 用戶的登錄狀態(tài)
res.send({ status: 0, msg: '登錄成功' })
})
4. 從 session 中取數據
也可以直接從req.session 對象上獲取之前存儲的數據,示例代碼如下:
// 獲取用戶姓名的接口
app.get('/api/username', (req, res) => {
// TODO_03:請從 Session 中獲取用戶的名稱送滞,響應給客戶端
if (!req.session.islogin) {
return res.send({ status: 1, msg: 'fail' })
}
res.send({
status: 0,
msg: 'success',
username: req.session.user.username,
})
})
5. 清空 session
調用 req.session.destroy() 函數侠草,即可清空服務器保存的session 信息。
// 退出登錄的接口
app.post('/api/logout', (req, res) => {
// TODO_04:清空 Session 信息
req.session.destroy()
res.send({
status: 0,
msg: '退出登錄成功',
})
})
二犁嗅,在 Express 中使用 JWT
1. 安裝 JWT 相關的包
運行如下命令边涕,安裝如下兩個 JWT 相關的包:
npm install jsonwebtoken express-jwt
// 其中:
jsonwebtoken 用于生成JWT字符串
express-jwt 用于將JWT字符串解析還原成JSON對象
2. 導入 JWT 相關的包
使用 require() 函數,分別導入JWT 相關的兩個包:
// TODO_01:安裝并導入 JWT 相關的兩個包褂微,分別是 jsonwebtoken 和 express-jwt
const jwt = require('jsonwebtoken')
const expressJWT = require('express-jwt')
3. 定義 secret 密鑰
為了保證 JWT 字符串的安全性功蜓,防止JWT 字符串在網絡傳輸過程中被別人破解,我們需要專門定義一個用于加密和解密 的 secret 密鑰:
① 當生成 JWT 字符串的時候宠蚂,需要使用secret 密鑰對用戶的信息進行加密式撼,最終得到加密好的 JWT 字符串
② 當把 JWT 字符串解析還原成 JSON 對象的時候,需要使用secret 密鑰進行解密
// TODO_02:定義 secret 密鑰求厕,建議將密鑰命名為 secretKey
const secretKey = 'skyblue city ^_^'
4. 在登錄成功后生成 JWT 字符串
調用 jsonwebtoken包提供的 sign() 方法著隆,將用戶的信息加密成JWT 字符串,響應給客戶端:
// 登錄接口
app.post('/api/login', function (req, res) {
// 將 req.body 請求體中的數據呀癣,轉存為 userinfo 常量
const userinfo = req.body
// 登錄失敗
if (userinfo.username !== 'admin' || userinfo.password !== '000000') {
return res.send({
status: 400,
message: '登錄失斆榔帧!',
})
}
// 登錄成功
// TODO_03:在登錄成功之后项栏,調用 jwt.sign() 方法生成 JWT 字符串浦辨。并通過 token 屬性發(fā)送給客戶端
// 參數1:用戶的信息對象
// 參數2:加密的秘鑰
// 參數3:配置對象,可以配置當前 token 的有效期
// 記渍由颉:千萬不要把密碼加密到 token 字符中
const tokenStr = jwt.sign({ username: userinfo.username }, secretKey, { expiresIn: '30s' })
res.send({
status: 200,
message: '登錄成功荤牍!',
token: tokenStr, // 要發(fā)送給客戶端的 token 字符串
})
})
5. 注冊將 JWT 字符串還原為 JSON 對象的中間件
客戶端每次在訪問那些有權限接口的時候案腺,都需要主動通過請求頭中的Authorization 字段,將 Token 字符串發(fā) 送到服務器進行身份認證康吵。
此時劈榨,服務器可以通過 express-jwt 這個中間件,自動將客戶端發(fā)送過來的Token 解析還原成 JSON 對象:
// TODO_04:注冊將 JWT 字符串解析還原成 JSON 對象的中間件
// 注意:只要配置成功了 express-jwt 這個中間件晦嵌,就可以把解析出來的用戶信息同辣,掛載到 req.user 屬性上
app.use(expressJWT({ secret: secretKey }).unless({ path: [/^\/api\//] }))
6. 使用 req.user 獲取用戶信息
當 express-jwt 這個中間件配置成功之后,即可在那些有權限的接口中惭载,使用req.user 對象旱函,來訪問從JWT 字符串 中解析出來的用戶信息了,示例代碼如下:
// 這是一個有權限的 API 接口
app.get('/admin/getinfo', function (req, res) {
// TODO_05:使用 req.user 獲取用戶信息描滔,并使用 data 屬性將用戶信息發(fā)送給客戶端
console.log(req.user)
res.send({
status: 200,
message: '獲取用戶信息成功棒妨!',
data: req.user, // 要發(fā)送給客戶端的用戶信息
})
})
7. 捕獲解析 JWT 失敗后產生的錯誤
當使用 express-jwt 解析 Token 字符串時,如果客戶端發(fā)送過來的Token 字符串過期或不合法含长,會產生一個解析失敗 的錯誤券腔,影響項目的正常運行。我們可以通過 Express 的錯誤中間件拘泞,捕獲這個錯誤并進行相關的處理纷纫,示例代碼如下:
// TODO_06:使用全局錯誤處理中間件,捕獲解析 JWT 失敗后產生的錯誤
app.use((err, req, res, next) => {
// 這次錯誤是由 token 解析失敗導致的
if (err.name === 'UnauthorizedError') {
return res.send({
status: 401,
message: '無效的token',
})
}
res.send({
status: 500,
message: '未知的錯誤',
})
})