koa搭建nodejs專案並註冊介面
使用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 = app
http開啟服務
專案根目錄建立 main.js檔案，引入app物件，開啟http服務
constapp=require('./app')
const{APP_PORT}=require('./app/config')
app.listen(APP_PORT,()=>{
console.log('開啟服務啦')
})
賬號密碼、埠號等資訊直接寫在檔案中是不安全的，上傳或共享專案的時候容易洩露，所以儲存到不影響專案的的檔案當中，根目錄中新增 .env 檔案，使用 dotenv 將 .env 檔案中的配置項註冊到環境變數中
APP_PORT=8000
app資料夾中新增config.js檔案用於儲存配置資訊，防止隨意更改
const dotenv = require('dotenv')
dotenv.config();
module.exports = {
APP_PORT
} = process.env
啟動 main.js就已經可以監聽8000埠了，因為沒有對請求做出響應，所以此時訪問8000，只能返回 Not Find
註冊路由
一組路由就是一組對映關係，定義路徑與處理函式，如下演示註冊的介面邏輯，中介軟體用來判斷資料的正確性，控制層的函式用來進行響應
constRouter=require('koa-router') constRegisterRouter=newRouter({prefix:'/register'}) const{register}=require('../controller/register.controller') const{verifyUser,encryptionPwd}=require('../middleware/register.middleware') RegisterRouter.post('/',verifyUser,encryptionPwd,register) module.exports=RegisterRouter
中介軟體
判斷是否傳入了使用者名稱和密碼以及是否已註冊，對傳入的隱私資料進行加密
constcrypto=require('crypto')
const{hasUser}=require('../service/register.service')
const{USER_ALREADY_EXISTS,
NAME_OR_PASSWORD_REQUIRED}=require('../constants/error-types')
classRegisterMiddleWare{
asyncverifyUser(ctx,next){
const{name,password}=ctx.request.body
if(!name||!password){
consterror=newError(NAME_OR_PASSWORD_REQUIRED)
returnctx.app.emit('error',error,ctx)
}
letusers=awaithasUser(name)
if(users){
consterror=newError(USER_ALREADY_EXISTS)
returnctx.app.emit('error',error,ctx)
}
awaitnext()
}
asyncencryptionPwd(ctx,next){
const{password}=ctx.request.body
constmd5=crypto.createHash('md5')
constpwd=md5.update(password).digest('hex')
ctx.request.body.password=pwd
awaitnext()
}
}
module.exports=newRegisterMiddleWare()
與資料庫建立連線
建立表結構
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 中定義插入資料庫的方法
constconnection=require('../app/database')
classRegisterService{
asynchasUser(name){
conststatement=`SELECT*FROMuserWHEREname=?`
try{
const[result]=awaitconnection.execute(statement,[name])
returnresult.length
}catch(error){
console.log('LoginService-hasUser',error)
}
}
asyncinsertUser(name,password){
conststatement=`INSERTINTOuser(name,password)VALUES(?,?)`
try{
const[result]=awaitconnection.execute(statement,[name,password])
returnresult
}catch(error){
console.log('LoginService-insertUser',error)
}
}
}
module.exports=newRegisterService()
很多地方都需要用到與資料庫的連線，所以在 app/databse.js 中統一建立連線池
constmysql=require('mysql2')
const{MYSQL_HOST,
MYSQL_PORT,
MYSQL_DATABASE,
MYSQL_USER,
MYSQL_PASSWORD,}=require('./config')
constconnection=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
constdotenv=require('dotenv')
dotenv.config()
module.exports={
APP_PORT,
MYSQL_HOST,
MYSQL_PORT,
MYSQL_DATABASE,
MYSQL_USER,
MYSQL_PASSWORD,
}=process.env
捕獲錯誤
當註冊賬號時，使用者已註冊或者密碼不符合規範需要返回錯誤資訊，在 constants/error-types 中定義常見的錯誤資訊
constUSER_ALREADY_EXISTS='user_already_exists'
constNAME_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')
consterrorHandle=(error,ctx)=>{
letcode=200
letmessage=''
switch(error.message){
caseUSER_ALREADY_EXISTS:
message='該使用者已存在'
break;
}
ctx.status=code
ctx.body=message
}
module.exports=errorHandle
app/index.js 引入路由定義的介面，獲取post請求傳遞的引數，並繫結錯誤的處理方式
constKoa=require('koa')
constapp=newKoa()
constbodyParser=require('koa-bodyparser')
constLoginRouter=require('../router/register.router')
consterrorHandle=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')
classRegisterController{
asyncregister(ctx,next){
const{name,password}=ctx.request.body
constresult=awaitinsertUser(name,password)
ctx.body=result
}
}
module.exports=newRegisterController()
到這裡為止，我們就可以對介面進行訪問啦
以上就是註冊一個介面的完整流程，不同介面可能需要通過不同的中介軟體去處理，比如登入介面需要驗證密碼，派發token，其他和使用者許可權有關的介面需要驗證token。
以下還有幾篇相關筆記可供參考
jwt實現token鑑權（nodejs koa
如何通過cookie、session鑑權（nodejs/koa）
超詳細的mysql總結（DQL）
超詳細的mysql總結（基本概念、DDL、DML）
nodejs中如何使用http建立一個服務