nodejs koa框架使用

1: KOA 是express 打造的下一代web 開發框架提供更小更強的的核心功能，通過Promise 、async/await 進行異步編程，koa 可以不使用回調，解決了回調地獄的問題
blueBird 是nodejs 最出名的Primise 實現，除了實現標準的promise 之外，還提供了包裝方法，可以快速得獎回調包裝微Promise

2:bluebird 的使用
npm install bluebird -save
方法簽名: bluebird.promisifyAll(target,options);

target 表示需要包裝的對象，如果target是普通對象，包裝后api 只會被當前對象持有,如果是原型對象，則會被所有的實例持有
options：
suffix ：后綴，默認是Async
mutiArgs ：是否允許多個回調參數,默認是false,為true時，bluebird 將所有參數傳入一個數組，promise.then() 接受該數組，從而可以得到多個參數
編程案例:

const bluebird = require('bluebird');
const fs = require('fs');bluebird.promisifyAll(fs);//回調
fs.readFile('文件路徑',{encoding:'utf8'},(err,data)=>{if(err){console.error(err);return;}console.log(data);
});//Promise
fs.readFileAsync('文件路徑',{encoding:'utf8'},(err,data)=>{console.log(data);
}).catch((err)=>{console.error(err);
});

編寫第一個koa 程序:

//導入koa 模塊
const Koa = require('koa');
//實例化應用
const app = new Koa();//中間件
app.use(async (ctx)=>{ctx.body = 'hello world';
});app.listen(8080,()=>{console.log('start up 8080');
})

//Context 成為koa 的文件上下文,包含了對象的請求、響應、context 可以理解為一個容器
//常用的屬性和方法
//ctx.request koa的請求對象一般不直接使用，通過別名來訪問
//ctx.response koa的響應對象一般不直接使用，通過別名來訪問
//ctx.state 自定義數據存儲,比如中間件需要往請種種掛在變量，就可以存放在
//state 后續中間件可以讀取
//ctx.throw() 拋出http 異常
//ctx.headers 請求報頭，ctx.request.headers 的別名
//ctx.method 請求方法，ctx.request.method 的別名
//ctx.url 請求連接，ctx.request.url 的別名
//ctx.path 請求路徑，ctx.request.path 的別名
//ctx.query 請求參數，ctx.request.query 的別名,解析后的get請求參數對象
//ctx.host 請求域名地址，ctx.request.host 的別名
//ctx.ip 請求客戶端ip，ctx.request.ip 的別名
//ctx.ips 請求ip列表，ctx.request.ips 的別名 ,反向代理環境下IP列表
//ctx.get() 讀取請求報頭，ctx.request.get 的別名
//ctx.body 響應內容，支持字符串，數組，對象，buffer 等，，ctx.response.get 的別名
//ctx.type 響應體類型，ctx.response.type 的別名
//ctx.redirect（）重定向 ctx.response.redirect 的別名
//ctx.set() 設置相應報頭，ctx.response.set 的別名

代碼驗證:

//導入koa 模塊
const { method } = require('bluebird');
const Koa = require('koa');
//實例化應用
const app = new Koa();app.proxy = true;app.use(async (ctx)=>{ctx.set('x-version','1.0');ctx.body = {method: ctx.method,ip: ctx.ip,path: ctx.path,url: ctx.url,query: ctx.query,headers: ctx.headers} 
});app.listen(8080,()=>{console.log('start up 8080');
})

執行結果:
http://localhost:8080/?name=%E5%88%98%E4%BA%A6%E8%8F%B2

{"method":"GET","ip":"::ffff:127.0.0.1","path":"/","url":"/?name=%E5%88%98%E4%BA%A6%E8%8F%B2","query":{"name":"劉亦菲"},"headers":{"host":"localhost:8080","connection":"keep-alive","sec-ch-ua":"\"Not;A=Brand\";v=\"99\", \"Google Chrome\";v=\"139\", \"Chromium\";v=\"139\"","sec-ch-ua-mobile":"?0","sec-ch-ua-platform":"\"Windows\"","upgrade-insecure-requests":"1","user-agent":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/139.0.0.0 Safari/537.36","accept":"text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.7","sec-fetch-site":"none","sec-fetch-mode":"navigate","sec-fetch-user":"?1","sec-fetch-dest":"document","accept-encoding":"gzip, deflate, br, zstd","accept-language":"zh-CN,zh;q=0.9,en-US;q=0.8,en;q=0.7"}}

Cookie 的設置和讀取

//導入koa 模塊
const { method } = require('bluebird');
const Koa = require('koa');
//實例化應用
const app = new Koa();app.keys = ['13wweeiioo'];
//cookie 設置和讀取
app.use(async (ctx)=>{ctx.cookies.set('logined',1,{signed: true,httpOnly: true,maxAge: 3600 * 24 * 1000 //有效期一天});ctx.body = "ok la";
});app.listen(8080,()=>{console.log('start up 8080');
})

中間件
與expres 的中間件類似,Koa 的中間建也你能訪問請求對象響應對象和next 函數通常用來執行以下任務:
執行邏輯
更改請求和響應
結束請求-相應周期
調用下一個中間建
錯誤處理

koa 使用async /await 來進行異步編程，不需要執行回調函數，直接對ctx.body 賦值就行
Koa 的中間件是一個表中的異步函數，簽名如下:
async function middleware(ctx,next);
ctx 是上下文
next 下一個中間件
運行完代碼邏輯，將需要傳遞的數據掛在到ctx.state ,并且調用 await.next() 才能將請求轉發給下一個中間件
(洋蔥卷模型)
代碼案例:

const Koa = require('koa');
//實例化應用
const app = new Koa();async function mid1(ctx,next){console.log('mid1 begin');await next();console.log('mid1 end');
}async function mid2(ctx,next){console.log('mid2 begin');await next();console.log('mid2 end');
}app.use(mid1);
app.use(mid2);app.use(async (ctx)=>{console.log('request route!');ctx.body = 'Hello world';
});app.listen(8080,()=>{console.log('start up 8080');
})

執行結果:
mid1 begin
mid2 begin
request route!
mid2 end
mid1 end

日志中間件

const Koa = require('koa');
//實例化應用
const app = new Koa();async function logger(ctx,next) {const start = Date.now();await next();console.log(`${ctx.method} ${ctx.path} costTime:${Date.now() - start}ms`); 
}app.use(logger); //注冊日志中間件
app.use(async (ctx)=> {ctx.body = 'Hello World';
});app.listen(8080,()=>{console.log('start up 8080');
})

cookie 解析中間件:

const Koa = require('koa');
//實例化應用
const app = new Koa();//定義cookie中間件
async function cookieParser(ctx,next) {const headerCookie = ctx.headers.cookie;ctx.state.cookies = {};if(headerCookie){const cookies = headerCookie.split(";");cookies.forEach(cookie => {const parts = cookie.split('=');ctx.state.cookies[parts[0] = parts[1]];//掛在 ctx.state.cookies});await next();}
}//注冊中間件
app.use(cookieParser);//使用中間建
app.use(async (ctx)=>{ctx.body = ctx.state.cookies;
});//監聽服務啟動
app.listen(8000,()=>{console.log('start up 8000');
})

KOA 路由:
安裝路由模塊:
npm install koa-router -save
C:\Users\Lei.Wang170\Desktop\koa-01>npm install koa-router -save 這種寫法已經不適用了
npm warn deprecated koa-router@14.0.0: Please use @koa/router instead, starting from v9!

使用新的安裝命令:
C:\Users\Lei.Wang170\Desktop\koa-01>npm install @koa/router -save
added 1 package in 922ms
1 package is looking for funding
run npm fund for details
路由案例:

const Koa = require('koa');
const Router = require('koa-router');
//實例化應用
const app = new Koa();const router = new Router();//路由定義
router.get('/',async (ctx)=>{ctx.body ='hello world';
});router.get('/user',async (ctx)=>{ctx.body ='hello user';
});//掛載路由
app.use(router.routes());
app.use(router.allowedMethods());app.listen(8000,()=>{console.log('start up 8000');
})

錯誤處理:

const Koa = require('koa');
//實例化應用
const app = new Koa();//自定義中間件
async function errorHandler(ctx,next) {try {await next();} catch (error) {ctx.status = error.status || 500;ctx.body = `System Error: ${error.message}`;}
}
app.use(errorHandler);  //掛在中間件不需要括號，掛在路由需要括號()//拋出異常
app.use((ctx)=>{ctx.throw(403,'Forbidden');
});app.listen(8000,()=>{console.log('start up 8000');
})

注意錯誤處理器一定在在使用之前被掛載上，否則不成功

多個錯誤處理器的場景:
同時需要響應錯誤給調用端，并且要記錄日志

const Koa = require('koa');
//實例化應用
const app = new Koa();//自定義中間件
async function errorHandler(ctx,next) {try {await next();} catch (error) {ctx.status = error.status || 500;ctx.body = `System Error: ${error.message}`;}
}//錯誤日志記錄中間件
async function loggerHandler(ctx,next) {try {await next();} catch (error) {console.log(`error: ${ctx.path} ${ctx.ip}`);throw error;}
}app.use(errorHandler);  //掛在中間件不需要括號，掛在路由需要括號()
app.use(loggerHandler); 
//拋出異常
app.use((ctx)=>{ctx.throw(403,'Forbidden');
});app.listen(8010,()=>{console.log('start up 8010');
})

執行結果
在這里插入圖片描述

路由級別的中間件

const Koa = require('koa');
const Router = require('koa-router');
const router = new Router();
//實例化應用
const app = new Koa();
//錯誤日志記錄中間件
async function loggerHandler(ctx,next) {console.log(`error: ${ctx.path} ${ctx.ip}`);await next();      
}router.get('/',loggerHandler,async (ctx)=>{ctx.body ='hello world';
});app.listen(8010,()=>{console.log('start up 8010');
})

模塊化路由:
student.js
const Router = require(‘koa-router’);
//定義帶有前綴的路由
const router = new Router({ prefix: ‘/student’ });
//路由定義
router.get(‘/name’, (ctx)=>{
ctx.body =‘student’;
});
module.exports = router;

teacher.js
const Router = require(‘koa-router’);
//定義帶有前綴的路由
const router = new Router({ prefix: ‘/teacher’ });
//路由定義
router.get(‘/id’, (ctx)=>{
ctx.body =‘teacher’;
});
module.exports = router;

koa.js
const Koa = require(‘koa’);
//實例化應用
const app = new Koa();

const stuRouter = require(‘./routes/student’);
const teaRouter = require(‘./routes/teacher’);

app.use(stuRouter.routes()).use(stuRouter.allowedMethods());
app.use(teaRouter.routes()).use(teaRouter.allowedMethods());

app.listen(8010,()=>{
console.log(‘start up 8010’);
})

koa-ejs 模板渲染:
npm install koa-ejs --save