AWS Lambda

AWS Lambda 是 Amazon Web Services 提供的 serverless 平台。 你可以运行代码来响应事件，并且它会自动为你管理底层的计算资源。

Hono 可以在 AWS Lambda 的 Node.js 18+ 环境下工作。

1. Setup

在 AWS Lambda 上创建应用时， CDK 对于设置诸如 IAM Role，API Gateway 和其他功能非常有用。

使用 cdk CLI 初始化你的项目。

npm

mkdir my-app
cd my-app
cdk init app -l typescript
npm i hono
mkdir lambda
touch lambda/index.ts

yarn

mkdir my-app
cd my-app
cdk init app -l typescript
yarn add hono
mkdir lambda
touch lambda/index.ts

pnpm

mkdir my-app
cd my-app
cdk init app -l typescript
pnpm add hono
mkdir lambda
touch lambda/index.ts

bun

mkdir my-app
cd my-app
cdk init app -l typescript
bun add hono
mkdir lambda
touch lambda/index.ts

2. Hello World

编辑 lambda/index.ts。

import { Hono } from 'hono'
import { handle } from 'hono/aws-lambda'

const app = new Hono()

app.get('/', (c) => c.text('Hello Hono!'))

export const handler = handle(app)

3. Deploy

编辑 lib/cdk-stack.ts。

import * as cdk from 'aws-cdk-lib'
import { Construct } from 'constructs'
import * as lambda from 'aws-cdk-lib/aws-lambda'
import * as apigw from 'aws-cdk-lib/aws-apigateway'
import { NodejsFunction } from 'aws-cdk-lib/aws-lambda-nodejs'

export class MyAppStack extends cdk.Stack {
  constructor(scope: Construct, id: string, props?: cdk.StackProps) {
    super(scope, id, props)

    const fn = new NodejsFunction(this, 'lambda', {
      entry: 'lambda/index.ts',
      handler: 'handler',
      runtime: lambda.Runtime.NODEJS_20_X,
    })
    fn.addFunctionUrl({
      authType: lambda.FunctionUrlAuthType.NONE,
    })
    new apigw.LambdaRestApi(this, 'myapi', {
      handler: fn,
    })
  }
}

最后，运行命令来部署：

cdk deploy

Serve Binary data

Hono 支持二进制数据作为响应。 在 Lambda 中，需要 base64 编码来返回二进制数据。 一旦二进制类型被设置为 Content-Type header，Hono 会自动将数据编码为 base64。

app.get('/binary', async (c) => {
  // ...
  c.status(200)
  c.header('Content-Type', 'image/png') // 意味着二进制数据
  return c.body(buffer) // 支持 `ArrayBufferLike` 类型，编码为 base64。
})

Access AWS Lambda Object

在 Hono 中，你可以通过绑定 LambdaEvent，LambdaContext 类型并使用 c.env 来访问 AWS Lambda Events 和 Context

import { Hono } from 'hono'
import type { LambdaEvent, LambdaContext } from 'hono/aws-lambda'
import { handle } from 'hono/aws-lambda'

type Bindings = {
  event: LambdaEvent
  lambdaContext: LambdaContext
}

const app = new Hono<{ Bindings: Bindings }>()

app.get('/aws-lambda-info/', (c) => {
  return c.json({
    isBase64Encoded: c.env.event.isBase64Encoded,
    awsRequestId: c.env.lambdaContext.awsRequestId,
  })
})

export const handler = handle(app)

Access RequestContext

在 Hono 中，你可以通过绑定 LambdaEvent 类型并使用 c.env.event.requestContext 来访问 AWS Lambda 请求上下文。

import { Hono } from 'hono'
import type { LambdaEvent } from 'hono/aws-lambda'
import { handle } from 'hono/aws-lambda'

type Bindings = {
  event: LambdaEvent
}

const app = new Hono<{ Bindings: Bindings }>()

app.get('/custom-context/', (c) => {
  const lambdaContext = c.env.event.requestContext
  return c.json(lambdaContext)
})

export const handler = handle(app)

Before v3.10.0 (deprecated)

在 v3.10.0 之前 (已弃用)，你可以通过绑定 ApiGatewayRequestContext 类型并使用 c.env 来访问 AWS Lambda 请求上下文。

import { Hono } from 'hono'
import type { ApiGatewayRequestContext } from 'hono/aws-lambda'
import { handle } from 'hono/aws-lambda'

type Bindings = {
  requestContext: ApiGatewayRequestContext
}

const app = new Hono<{ Bindings: Bindings }>()

app.get('/custom-context/', (c) => {
  const lambdaContext = c.env.requestContext
  return c.json(lambdaContext)
})

export const handler = handle(app)

Lambda response streaming

通过更改 AWS Lambda 的调用模式，你可以实现 Streaming Response。

fn.addFunctionUrl({
  authType: lambda.FunctionUrlAuthType.NONE,
+  invokeMode: lambda.InvokeMode.RESPONSE_STREAM,
})

通常，该实现需要使用 awslambda.streamifyResponse 将 chunks 写入 NodeJS.WritableStream，但是使用 AWS Lambda Adaptor，你可以通过使用 streamHandle 而不是 handle 来实现 Hono 的传统流式响应。

import { Hono } from 'hono'
import { streamHandle } from 'hono/aws-lambda'

const app = new Hono()

app.get('/stream', async (c) => {
  return streamText(c, async (stream) => {
    for (let i = 0; i < 3; i++) {
      await stream.writeln(`${i}`)
      await stream.sleep(1)
    }
  })
})

const handler = streamHandle(app)