后端微服务云原生【免费下载链接】midway A Node.js Serverless Framework for front-end/full-stack developers. Build the application for next decade. Works on AWS, Alibaba Cloud, Tencent Cloud and traditional VM/Container. Super easy integrate with React and Vue. 项目地址https://gitcode.com/gh_mirrors/mi/midway点击查看免费下载在 Midway Serverlessmidwayjs/faas框架中函数上下文Function Context是每一次函数调用的核心载体它承载着平台传入的原始event/context并经过框架统一包装后对外提供一套近似 Koa 的编程 API。本文围绕 serverless_context.md 展开结合packages/faas与packages-serverless/serverless-http-parser的源码实现系统讲解事件转换机制、Context与FaaSHTTPContext的完整 API 结构及底层原理。读完本文你将能够在 Serverless 函数中熟练使用ctx读写请求参数、设置响应状态码与响应头并理解这些 API 在不同平台触发API 网关、HTTP 触发器下的行为差异与适用范围。一、事件转换统一不同平台的输入参数Midway Serverless 针对不同云平台阿里云函数计算 FC、腾讯云 SCF、AWS Lambda 等的差异化输入参数做了统一包装。当函数使用 API 网关apigw和 HTTP阿里云触发器时框架对输入参数event做了特殊处理将 event 统一、规范化成类似 Koa 的写法以简化并统一函数代码的书写方式。普通触发器场景普通触发器非 HTTP/API 网关下ctx可以直接注入到类属性中handler方法可以接收原始event参数import { Context } from midwayjs/faas; import { Provide } from midwayjs/core; Provide() export class Index { Inject() ctx: Context; ServerlessTrigger(...) async handler(event) { return hello world; } }HTTP 与 API 网关触发器场景在 HTTP 与 API 网关触发器下两种返回值写法等价——既可以像 Koa 一样通过this.ctx.body赋值也可以直接return返回值框架会统一将返回值写入ctx.bodyimport { Context } from midwayjs/faas; import { Provide } from midwayjs/core; Provide() export class Index { Inject() ctx: Context; ServerlessTrigger(...) async handler() { // The following two writing methods are the same // this.ctx.body hello world; return hello world; } }从源码看这一行为由 framework.ts 中的invokeTriggerFunction保证对于 HTTP 函数当result ! undefined时若非null则直接执行ctx.body result若为null则绕过 Koa 的_explicitStatus赋值机制将_body置空。也就是说直接return与显式赋值ctx.body在 HTTP 场景下最终走的是同一条路径。二、Context每次调用的请求作用域容器每调用一次函数框架就会创建一个全新的ctx函数上下文。对于ctx上的属性和方法框架都提供了 TypeScript 类型定义。:::info 在 Serverless v1 时代这个定义被命名为FaaSContext到 v2 之后定义与应用被统一写法更加一致。 :::在 interface.ts 中可以看到FaaSContext继承自IMidwayContextFaaSHTTPContext并声明了logger、env、requestContext、originContext四个基础成员而对外导出的Context类型就是FaaSContext的别名见 interface.ts。ctx.logger返回类型ILogger语义运行时传入的每次请求对应的日志对象默认值为consolectx.logger.info(hello); ctx.logger.warn(hello); ctx.logger.error(hello);在 framework.ts 的getContext方法中可以看到底层细节当设置了环境变量MIDWAY_SERVERLESS_REPLACE_LOGGER true或者平台没有提供context.logger时框架会通过createContextLogger生成_serverlessLogger并通过Object.defineProperty重新定义logger访问器。注释指出由于 FC 公有云环境的 logger 存在已知 bug默认会替换为框架日志其他平台视情况而定。ctx.env返回类型string语义当前启动环境即NODE_ENV或MIDWAY_SERVER_ENV的值默认值为prodctx.env; //default prod源码层面getContext中有一个兜底逻辑如果平台传入的context上没有env字段则调用this.environmentService.getCurrentEnvironment()填充见 framework.ts保证任意平台下ctx.env始终有值。ctx.requestContext返回类型MidwayRequestContainer语义Midway FaaS 的 IoC 请求作用域容器用于获取其他 IoC 容器中的对象实例const userService await ctx.requestContext.getAsync(UserService);这一容器与 Midway 的依赖注入体系打通函数处理器handler自身由context.requestContext.getAsync(routerInfo.controllerId)实例化见 framework.ts因此你在 handler 中通过Inject()注入的服务与通过ctx.requestContext.getAsync()获取的实例来自同一个请求作用域可以安全地在一次请求内共享状态。三、FaaSHTTPContextKoa 风格的应用开发体验Context的定义继承自FaaSHTTPContext。Context保留了后者的全部能力在大多数场景下可以直接使用ContextFaaSHTTPContext仅在 API 网关apigw和 HTTP阿里云触发器下可用。对普通用户而言直接使用Context定义即可import { Context } from midwayjs/faas; Inject() ctx: Context;在ctx对象中框架提供了大量与传统 Koa Web 应用相似的 API。这样设计的好处是降低用户的学习成本并在一定程度上兼容原有的传统代码与社区中间件。注意不同平台提供的 API 可能不完全相同下文会指出具体 API 的适用范围。ctx.request返回类型FaaSHTTPRequest语义FaaS 模拟的 HTTP Request 对象ctx.response返回类型FaaSHTTPResponse语义FaaS 模拟的 HTTP Response 对象从类型定义看FaaSHTTPContext同时继承ContextDelegatedRequest与ContextDelegatedResponse见 interface.ts这意味着它把请求侧的属性和响应侧的属性全部委托到同一个ctx上。此外它还提供req/res原生 mock 对象不建议直接使用、originEvent原始 event 对象、cookiesCookie 对象与state请求状态存储。ctx.params代理的是request.pathParameters仅在 HTTP 触发器阿里云和 API 网关触发器下可用。// /api/user/[id] /api/user/faas ctx.params.id; // faas底层实现中request.params的 getter 直接返回this.req.pathParameters || {}见 request.ts而pathParameters由 http/req.ts 从 event 中读取并支持 setter 覆写。在 HTTP 路由匹配时框架会用PathToRegexpUtil.match将路径参数写入context.req.pathParameters见 framework.ts因此ctx.params.id能取到/api/user/faas中的faas。ctx.set设置响应头是response.setHeader的代理。ctx.set(X-FaaS-Duration, 2100);底层实现位于 response.tsset方法支持「字段 值」与「整个对象批量设置」两种形态最终调用this.res.setHeader(field, val)当传入数组时会统一转为字符串数组。ctx.status设置返回状态码是response.statusCode的代理。ctx.status 404;在 response.ts 中statussetter 会校验状态码必须为 100999 之间的整数并置位_explicitStatus标记如果当前状态码对应空响应语义且已有 body则自动清空 body。Request 别名以下属性均来自request对象的代理ctx.headers— 请求头对象ctx.method— 请求方法ctx.url— 完整请求 URLctx.path— 请求路径ctx.ip— 客户端 IPctx.query— 解析后的查询字符串ctx.get()— 获取指定请求头字段Response 别名以下属性均来自response对象的代理ctx.body— 设置响应体ctx.status— 设置状态码response.statusCode别名ctx.type— 设置 Content-Typectx.set()— 设置响应头response.setHeader别名补充说明原文档中列出的 Request/Response 锚点链接在版本化文档中已失效此处不再引用。你可以在 interface.ts 中查看ContextDelegatedRequest与ContextDelegatedResponse的完整成员定义。四、FaaSHTTPRequest从 event 转换出的请求对象FaaSHTTPRequest对象由函数的event和context输入参数转换而来。类型定义见 interface.ts实现逻辑见 request.ts 与 http/req.ts。request.headers包含所有请求头的对象以键值对存储。注意 http/req.ts 中会对原始 event 的 headers 做key 小写化处理保证ctx.headers[Content-Type]与ctx.headers[content-type]均能命中。request.ip获取客户端请求 IP 地址。:::info 在阿里云 FC 上只有 HTTP 触发器可以获取到该值API 网关暂无法获取。 :::实现上request.ip优先读取this.req?.clientIP || this.req.ip见 request.ts而HTTPRequest.ip则从event.clientIP || event.requestContext?.sourceIp中取值见 http/req.ts——这也解释了为何只有携带这些字段的 HTTP 触发器才能取到 IP。request.url客户端请求的完整 URL。若 event 中缺失url框架会用path querystring拼接生成见 http/req.ts。request.path客户端请求路径。request.method请求方法。实现上兼容event.method与event.httpMethod两种字段名见 http/req.ts这也是不同云平台 event 结构差异被抹平的一个典型例子。request.bodyPOST 请求体已被解析为 JSON。解析逻辑分层完成http/req.ts 负责从 event 中提取原始 bodyGET/HEAD/OPTIONS 请求返回undefined支持isBase64Encoded的 base64 解码bodyParsed标记用于判断 body 是否已被上层解析。request.ts 负责按 Content-Type 解析json类型执行JSON.parse解析失败抛出invalid json receivedurlencoded类型用querystring.parse解析其余类型原样返回。五、FaaSHTTPResponse模拟的响应对象FaaSHTTPResponse同样由event和context转换而来提供三个核心能力。response.setHeader设置响应头。通过ctx.set()调用底层委托给原生res.setHeader见 response.ts。response.statusCode设置返回状态码。通过ctx.status code调用见上文第三节对statussetter 的说明。response.body设置响应体内容类型为string或buffer。setter 逻辑见 response.ts会根据值的类型自动处理string自动计算并设置Content-Length默认 Content-Type 为textBuffer默认 Content-Type 为bin对象JSON移除Content-Length并设置 Content-Type 为jsonnull若当前状态码不是空响应语义则自动改为 204响应在返回平台之前会经过 framework.ts 的formatHttpResponse统一格式化当 body 为null/undefined且未显式设置状态码时输出 204字符串默认text/plainBuffer 在未开启supportBufferResponse时转 base64 并标记isBase64Encoded对象默认application/json并序列化为字符串。最终组装为{ isBase64Encoded, statusCode, headers, body }的标准网关响应结构。六、实战把 API 串起来写一个 HTTP 函数结合仓库中的测试示例 base-app-controller/src/controller/api.ts可以看到ctx相关 API 在真实 Controller 中的组合用法import { Controller, Post, Get, Provide, Inject, Query, Body, HttpCode, SetHeader, Logger } from midwayjs/core; Provide() Controller(/api) export class APIController { Inject() ctx: any; Logger() logger; Get(/, { middleware: [] }) HttpCode(201) async home(Query(name) name: string, Query(age) age: number) { this.ctx.logger.info(my home router); this.logger.warn(my home warn router) return hello world, name age; } Get(/set_header) SetHeader(bbb, aaa) SetHeader({ ccc: ddd }) async homeSet() { return bbb; } Get(/ctx-body) async getCtxBody() { this.ctx.body ctx-body; } Get(/login) Redirect(/) async redirect() {} }从中可以总结出几个关键实践读请求通过Query()等参数装饰器或ctx.query/ctx.params读取请求参数在非 Controller 类函数中直接使用ctx.params.id、ctx.headers即可。写响应return返回值与ctx.body xxx等价HTTP 函数场景需要定制状态码与响应头时使用ctx.status 404、ctx.set(X-FaaS-Duration, 2100)或使用HttpCode()、SetHeader()等装饰器后者在底层同样通过context.status/context.set生效见 framework.ts。取服务在需要手动获取 IoC 实例时使用await ctx.requestContext.getAsync(UserService)实现请求级共享。记日志统一使用ctx.logger或Logger()注入避免直接console.log保证日志对象与请求生命周期、平台日志能力对齐。七、小结Midway Serverless 通过「事件转换 Context 包装」两层设计把千差万别的云平台 event 归一为熟悉的 Koa 式编程模型普通触发器handler(event)直接拿到原始 eventctx提供logger、env、requestContext等运行时能力HTTP/API 网关触发器ctx额外具备完整的FaaSHTTPContext能力——ctx.request/ctx.response模拟对象、ctx.params路径参数、ctx.set/ctx.status响应控制以及一整套 Request/Response 别名底层实现请求对象转换在packages-serverless/serverless-http-parser的HTTPRequest/request中完成响应格式化与 HTTP 函数调用链在packages/faas/src/framework.ts中完成类型定义集中在packages/faas/src/interface.ts可供进一步阅读源码验证。在实际开发中只需记住一个原则普通场景直接用ContextHTTP 场景优先使用return返回值其余细节参数解析、状态码、Content-Type、Buffer 编码都可以放心交给框架处理。赞分享后端微服务云原生【免费下载链接】midway A Node.js Serverless Framework for front-end/full-stack developers. Build the application for next decade. Works on AWS, Alibaba Cloud, Tencent Cloud and traditional VM/Container. Super easy integrate with React and Vue. 项目地址https://gitcode.com/gh_mirrors/mi/midway点击查看免费下载相关推荐Midway Serverless 函数上下文Function Context完全指南从 Event 统一到 Koa 风格 APIMidway Serverless 函数上下文Function Context完全指南从 Event 统一到 Koa 风格 API Midway Serv后端微服务云原生Midway Serverless 函数上下文Context全面解析从 Event 转换到 FaaSHTTPContext 的 Koa 风格统一封装Midway Serverless 函数上下文Context全面解析从 Event 转换到 FaaSHTTPContext 的 Koa 风格统一封装 Mi后端微服务云原生RedwoodJS 自定义 Serverless Function 完全指南从 generate function 到请求方法过滤与 CORS 实战RedwoodJS 自定义 Serverless Function 完全指南从 generate function 到请求方法过滤与 CORS 实战 导读 R后端前端Web框架开发工具创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考