使用nodejs註冊接口邏輯處理會比較複雜，直接通過express或者koa能夠簡化開發流程，這裏記錄用koa來搭建nodejs項目並註冊接口，對koa不太熟悉的話可以參考這一篇。讓nodejs開啓服務更簡單--koa篇
項目結構
項目整體結構如下，將不同功能的文件按模塊劃分，使得代碼邏輯更為清晰
node_modules // 安裝的包
src // 自己編碼的部分
app // 註冊的app
constants // 定義常量
controller // 註冊接口所使用到的方法
middleware // 處理數據的中間件
router // 路由
service // 定義sql語句
utils // 處理數據的方法
main.js // 入口
.env // 放到環境變量的配置文件
package-lock.json // 包的依賴關係
package.json // 需要安裝哪些包註冊app
koa中所有的操作都需要通過註冊的這個app對象來完成，先在 app/index.js 中註冊並導出
const Koa = require('koa')
const app = new Koa()
module.exports = apphttp開啓服務
src文件夾下建立 main.js文件，引入app對象，開啓http服務
const app = require('./app')
const { APP_PORT } = require('./app/config')
app.listen(APP_PORT, ()=>{
console.log('開啓服務啦')
})賬號密碼、端口號等信息直接寫在文件中是不安全的，上傳或共享項目的時候容易泄露，所以保存到不影響項目的的文件當中，根目錄中新增 .env 文件，使用 dotenv 將 .env 文件中的配置項註冊到環境變量中
APP_PORT=8000app文件夾中新增config.js文件用於保存配置信息，防止隨意更改
const dotenv = require('dotenv')
dotenv.config();
module.exports = {
APP_PORT
} = process.env啓動 main.js就已經可以監聽8000端口了，因為沒有對請求做出響應，所以此時訪問8000，只能返回 Not Find
註冊路由
一組路由就是一組映射關係，定義路徑與處理函數，如下演示註冊的接口邏輯，中間件用來判斷數據的正確性，控制層的函數用來進行響應
const Router = require('koa-router')
const RegisterRouter = new Router({ prefix: '/register' })
const { register } = require('../controller/register.controller')
const { verifyUser, encryptionPwd } = require('../middleware/register.middleware')
RegisterRouter.post('/', verifyUser, encryptionPwd, register)
module.exports = RegisterRouter中間件
判斷是否傳入了用户名和密碼以及是否已註冊，對傳入的隱私數據進行加密
const crypto = require('crypto')
const { hasUser } = require('../service/register.service')
const { USER_ALREADY_EXISTS,
NAME_OR_PASSWORD_REQUIRED } = require('../constants/error-types')
class RegisterMiddleWare {
async verifyUser(ctx, next) {
const { name, password } = ctx.request.body
if (!name || !password) {
const error = new Error(NAME_OR_PASSWORD_REQUIRED)
return ctx.app.emit('error', error, ctx)
}
let users = await hasUser(name)
if (users) {
const error = new Error(USER_ALREADY_EXISTS)
return ctx.app.emit('error', error, ctx)
}
await next()
}
async encryptionPwd(ctx, next) {
const { password } = ctx.request.body
const md5 = crypto.createHash('md5')
const pwd = md5.update(password).digest('hex')
ctx.request.body.password = pwd
await next()
}
}
module.exports = new RegisterMiddleWare()與數據庫建立連接
創建表結構
CREATE TABLE IF NOT EXISTS `user`(
id INT PRIMARY KEY AUTO_INCREMENT,
name varchar(50) NOT NULL UNIQUE,
password varchar(200) NOT NULL,
createAt TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
updateAt TIMESTAMP DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP
);service/register.service.js 中定義插入數據庫的方法
const connection = require('../app/database')
class RegisterService {
async hasUser(name) {
const statement = `SELECT * FROM user WHERE name = ?`
try {
const [result] = await connection.execute(statement, [name])
return result.length
} catch (error) {
console.log('LoginService-hasUser', error)
}
}
async insertUser(name, password) {
const statement = `INSERT INTO user(name, password) VALUES(?,?)`
try {
const [result] = await connection.execute(statement, [name, password])
return result
} catch (error) {
console.log('LoginService-insertUser', error)
}
}
}
module.exports = new RegisterService()很多地方都需要用到與數據庫的連接，所以在 app/databse.js 中統一建立連接池
const mysql = require('mysql2')
const { MYSQL_HOST,
MYSQL_PORT,
MYSQL_DATABASE,
MYSQL_USER,
MYSQL_PASSWORD, } = require('./config')
const connection = mysql.createPool({
database: MYSQL_DATABASE,
host: MYSQL_HOST,
port: MYSQL_PORT,
user: MYSQL_USER,
password: MYSQL_PASSWORD
})
connection.getConnection((error, conn)=>{
conn.connect((err)=>{
console.log(error, err)
})
})
module.exports = connection.promise()數據庫的賬號密碼直接硬編碼寫在代碼中會存在問題，同樣的寫到 .env 文件中，通過config.js 導出
// .env
MYSQL_HOST=localhost
MYSQL_PORT=3306
MYSQL_DATABASE=mall
MYSQL_USER=root
MYSQL_PASSWORD=123456
APP_PORT=8000// config.js
const dotenv = require('dotenv')
dotenv.config()
module.exports = {
APP_PORT,
MYSQL_HOST,
MYSQL_PORT,
MYSQL_DATABASE,
MYSQL_USER,
MYSQL_PASSWORD,
} = process.env
捕獲錯誤
當註冊賬號時，用户已註冊或者密碼不符合規範需要返回錯誤信息，在 constants/error-types 中定義常見的錯誤信息
const USER_ALREADY_EXISTS = 'user_already_exists'
const NAME_OR_PASSWORD_REQUIRED = 'name_or_password_required'
module.exports = {
USER_ALREADY_EXISTS,
NAME_OR_PASSWORD_REQUIRED
}app/error-handle.js 中對錯誤信息進行判斷
const {
USER_ALREADY_EXISTS
} = require('../constants/error-types')
const errorHandle = (error, ctx) => {
let code = 200
let message = ''
switch (error.message) {
case USER_ALREADY_EXISTS:
message = '該用户已存在'
break;
}
ctx.status = code
ctx.body = message
}
module.exports = errorHandleapp/index.js 引入路由定義的接口，獲取post請求傳遞的參數，並綁定錯誤的處理方式
const Koa = require('koa')
const app = new Koa()
const bodyParser = require('koa-bodyparser')
const LoginRouter = require('../router/register.router')
const errorHandle = require('./error-handle')
app.use(bodyParser())
app.use(LoginRouter.routes())
app.use(LoginRouter.allowedMethods())
app.on('error', errorHandle)
module.exports = app進行響應
在controller/register.controller.js中定義對應的處理方法
const { insertUser } = require('../service/register.service')
class RegisterController {
async register(ctx, next) {
const { name, password } = ctx.request.body
const result = await insertUser(name, password)
ctx.body = result
}
}
module.exports = new RegisterController()到這裏為止，我們就可以對接口進行訪問啦
以上就是註冊一個接口的完整流程，不同接口可能需要通過不同的中間件去處理，比如登錄接口需要驗證密碼，派發token，其他和用户權限有關的接口需要驗證token。
以下還有幾篇相關筆記可供參考
jwt實現token鑑權（nodejs koa
如何通過cookie、session鑑權（nodejs/koa）
超詳細的mysql總結（DQL）
超詳細的mysql總結（基本概念、DDL、DML）
nodejs中如何使用http創建一個服務
