由于业务需要接触阿里云函数计算,为保证已有的 nodejs 应用迁移至阿里云函数计算。经过两天的摸索之后得到一些 express.js 应用迁移至函数计算的一些方法。
涉及技术及框架:
- nodejs
- 阿里云函数计算
主要流程:
- 对比函数计算 http 触发器 与 express 的相同点和不同点,对原先的应用进行兼容处理
- 解决函数计算触发器和 express 框架的数据传递问题
- 测试迁移之后的应用稳定性
- 开整实现
(1)对比函数计算 http 触发器,与普通的基于 express 的应用的不同
属性 | 函数计算 应用 | 普通 express 应用 |
---|---|---|
触发方式 | 由 exports.XXX.handle 方法触发 | 通过监听指定端口的网络请求触发 |
接收到的参数 | 入口函数会得到(request,response,context) | express 接收到(request,response) |
由于原先的应用基与 express 开发,在迁移至函数计算之后将不能通过监听端口的网络请求触发 request 事件。那么参考 express 中 listen 的实现
app.listen = function listen() {
var server = http.createServer(this);
return server.listen.apply(server, arguments);
};
因此只需通过向 http.createServer 传入 express 对象,来创建一个 http.server 实例。当函数计算触发器被触发,再通过server.emit(‘request’, requset , response ) 来触发express 应用的工作流。
(2)函数计算入口函数的参数的兼容性改造
只能从函数计算入口函数拿到request,response,context。但是request、response 并非 http.InComingMessage 、http.ServerResponse 实例,如何通过 server.emit(‘request’, req , res ) 将入口函数传入的信息传入 express 工作流中。我们需要对 requset、response 进行改造
request 结构体:
headers:<map>, //存放来自 HTTP 客户端的键值对
path:<string>, //为 HTTP URL
queries:<map>, // 类型,存放来自 HTTP URL 中的 query 部分的 key - value 键值对, value 的类型可以为字符串或是数组
method:<string>, // 类型,HTTP 方法
clientIP:<string>, // 类型,client 的 IP 地址
url:<string>, // 类型,request 的 url
response 结构体:
response.setStatusCode(statusCode) : 设置 status code
param statusCode : (required, type integer)
response.setHeader(headerKey, headerValue) :设置 header
param headerKey : (required, type string)
param headerValue : (required, type string)
response.deleteHeader(headerKey) :删除 header
param headerKey: (required, type string)
response.send(body): 发送 body
param body: (required, typeBuffer or a string or a stream.Readable )
http.InComingMessage 结构体:
参考 http://nodejs.cn/api/http.html#http_class_http_incomingmessage
http.ServerResponse 结构体:
参考http://nodejs.cn/api/http.html#http_class_http_serverresponse
其中 express 应用中的 req 和 res 实现了很多封装的方法,所以需要根据自己的需要来进行兼容性改造,以下是我的改造代码片段:
const http = require('http');
const express = require('express');
const app = express()
const FCServer = http.createServer(app);
module.exports.handler = (request, response, context) => {
try {
// 通过 app.request 和 app.response 创建 inComimgMessage 和serverResponse
const inComimgMessage = Object.create(app.request);
const serverResponse = Object.create(app.response);
// 将 request 的部分信息赋值给 inComimgMessage
inComimgMessage.headers = request.headers;
inComimgMessage.method = request.method;
inComimgMessage.path = request.path;
inComimgMessage.url = request.path;
inComimgMessage.query = request.queries;
// 使用 response 的方法替换掉 serverResponse 的一些方法
serverResponse.setHeader = (key, value) => response.setHeader(key, value);
serverResponse.end = (data, encoding, callback) => {
response.send(data);
};
serverResponse.send = serverResponse.end;
serverResponse.status = (code) => {
response.setStatusCode(code);
};
serverResponse.writeHead = (code, message, headers) => {
response.setStatusCode(code);
};
serverResponse.sendStatus = (code) => {
response.setStatusCode(code);
response.send(code);
};
serverResponse.json = (body) => {
response.setHeader('content-type', 'application/json');
if (typeof body === 'string') {
response.send(body);
} else {
response.send(JSON.parse(body));
}
};
FCServer.emit('request', inComimgMessage, serverResponse);
} catch (e) {
console.log(e);
response.send(JSON.stringify({ request, response, context, e }));
}
};
(3)数据接入:
在函数计算中,获取 http 请求的 body 信息需要使用 getRawBody 方法,通过其回调函数我们可以得到 body 信息,因此我们需要在 getRawBody 内触发 request 事件。
getRawBody(request, function (err, body) {
if (request.method === 'POST') {
inComimgMessage.body = JSON.parse(decodeURIComponent(body.toString()));
}
FCServer.emit('request', inComimgMessage, serverResponse);
});