中間件
Egg 是基于 Koa 實現(xiàn)的睬愤，所以 Egg 的中間件形式和 Koa 的中間件形式是一樣的，都是基于洋蔥圈模型猎莲。每次我們編寫一個中間件流济，就相當于在洋蔥外面包了一層锐锣。
一般來說中間件也會有自己的配置。在框架中绳瘟，一個完整的中間件是包含了配置處理的雕憔。我們約定一個中間件是一個放置在 app/middleware 目錄下的單獨文件，它需要 exports 一個普通的 function糖声，接受兩個參數(shù)：
options: 中間件的配置項斤彼，框架會將 app.config[${middlewareName}] 傳遞進來。
app: 當前應用 Application 的實例蘸泻。
示例
中間件
async function middlewareFn (ctx, next) {
await next();
}
config/config.default.js
module.exports = {
// 配置需要的中間件琉苇，數(shù)組順序即為中間件的加載順序
middleware: [ 'middlewareName' ],
// 配置中間件的配置
middlewareName: {
option: 'value',
},
};
該項目中使用的中間件及用途 （['fm', 'errorHandler', 'responseFormatter', 'jwtErrorHandler']）
- fm 處理輸入相關數(shù)據(jù)的格式化
- errorHandler 處理相關報錯
- responseFormatter 格式化輸出數(shù)據(jù)格式
- jwtErrorHandler 處理JWT相關錯誤以及收集用戶UA/ip等
app/middleware/fm.js
const { userAgent } = require('ua_parser');
module.exports = (options, app) => {
//返回一個異步的方法
return async(ctx, next) => {
//打印時間操作
// console.log(ctx.ip)
// const JSON = userAgent(ctx.headers['user-agent']);
let { query: { page = null, limit = null, status = null }, method } = ctx;
if (method === 'GET') {
!!page && (ctx.query.page = page * 1);
!!limit && (ctx.query.limit = limit * 1);
!!status && (ctx.query.status = status * 1)
}
await next();
}
}
app/middleware/errorHandler.js
module.exports = () => {
return async function errorHandler(ctx, next) {
try {
await next();
} catch (err) {
// console.log(err)
let JSONS = Object.assign({}, ctx.app.config.JSONS);
ctx.app.emit('error', err, ctx);
const status = err.status || err.status_code || 500;
// const error = status === 500 && ctx.app.config.env === 'prod' ?
// 'Internal Server Error' :
// err.message;
// if (status === 422) {
// ctx.body.detail = err.errors;
// }
ctx.status = status;
ctx.body = Object.assign(JSONS, {
code: err.error_code || status,
// message: err.errors || err.message
message: err.message || err.errors
});
}
};
};
app/middleware/responseFormatter.js
module.exports = () => {
return async function responseFormatter(ctx, next) {
let JSONS = Object.assign({}, ctx.app.config.JSONS);
await next();
// console.log((ctx.body))
const { code, message, data } = { code: 200, message: 'success', ...ctx.body };
if (ctx.body) {
ctx.body = {
code,
message,
data: ctx.body.data ? ctx.body.data : (ctx.body['code'] ? [] : ctx.body) || [],
_: new Date() - 0
};
} else {
ctx.body = Object.assign(JSONS, {
code: '404',
message: '接口不存在，或被永久移除悦施！'
});
ctx.status = 404
}
}
}
app/middleware/jwtErrorHandler.js
module.exports = (options, app) => {
return async (ctx, next) => {
try {
await next();
const {
state: {
user: {
uid: _uid = null
} = {}
} = {},
ip
} = ctx;
const UA = ctx.headers['user-agent'];
console.log(ip,UA);
} catch (err) {
if (
ctx.path.includes('unauthorerror') &&
err instanceof app.jwt.UnauthorizedError
) {
ctx.status = 200;
ctx.body = 'UnauthorizedError';
return;
}
throw err;
}
};
};
框架擴展
在開發(fā)中并扇，我們既可以使用已有的擴展 API 來方便開發(fā)，也可以對以上對象進行自定義擴展抡诞，進一步加強框架的功能拜马。
Context
Context 指的是 Koa 的請求上下文，這是 請求級別 的對象沐绒，每次請求生成一個 Context 實例俩莽，通常我們也簡寫成 ctx。在所有的文檔中乔遮，Context 和 ctx 都是指 Koa 的上下文對象扮超。
app/extend/context.js
const uid = Symbol('Context#uid');
const apiscope = Symbol('Context#apiscope');
const mid = Symbol('Context#mid');
const openId = Symbol('Context#openId');
const role = Symbol('Context#role')
module.exports = {
//獲取用戶id
get uid() {
!this[uid] && (this[uid] = this.state.user.uid);
return this[uid]
},
//獲取店鋪id
get mid() {
// console.log(this.state.user); 查看token封裝的數(shù)據(jù)
!this[mid] && (this[mid] = this.state.user.mid);
return this[mid]
},
//獲取用戶權限
get role() {
!this[role] && (this[role] = this.state.user.role);
return this[role]
},
//獲取用戶openId
get openId() {
!this[openId] && (this[openId] = this.state.user.openId);
return this[openId]
},
//ask授權接口信息（第三方調(diào)用）
get apiscope() {
!this[apiscope] && (this[apiscope] = this.state.user.apiscope);
return this[apiscope]
}
};