openruntimes/swift

Swift Serverless Runtime 镜像文档

1. 镜像概述和主要用途

Swift Serverless Runtime 是一个轻量级 Docker 镜像，专为运行 Swift 编写的 Serverless 函数设计。该镜像提供标准化的运行时环境，支持 Swift 函数的本地开发、测试及部署，兼容主流 Serverless 架构（如 AWS Lambda、Azure Functions、Cloud Functions 等）的运行时规范。其核心价值在于简化 Swift Serverless 应用的开发流程，确保函数在不同环境中的一致性执行。

2. 核心功能和特性

2.1 运行时兼容性

• 支持 Swift 5.5+ 版本，预安装 Swift 标准库及常用依赖（如 Foundation、NIO 等）。
• 兼容 Serverless 函数生命周期管理（初始化、调用、销毁），符合 FaaS 平台运行时规范。

2.2 性能优化

• 冷启动加速：内置函数预编译机制，减少首次调用延迟。
• 资源轻量化：基于 Alpine Linux 构建，镜像体积小于 500MB，降低部署资源消耗。

2.3 开发与调试支持

• 内置日志聚合工具，支持结构化日志输出（JSON 格式），可配置日志级别（DEBUG/INFO/WARN/ERROR）。
• 提供本地 HTTP 调试接口，支持通过 HTTP 请求模拟函数调用，便于开发阶段测试。

2.4 灵活性与可扩展性

• 支持自定义函数入口点（Entrypoint），适配不同项目的代码组织结构。
• 可通过环境变量或配置文件注入外部依赖（如数据库连接、API 密钥等）。

3. 使用场景和适用范围

3.1 开发环境

• 本地开发 Swift Serverless 函数时，作为模拟运行时环境，验证函数逻辑及依赖兼容性。

3.2 测试场景

• 单元测试/集成测试：通过挂载测试代码，自动化验证函数在隔离环境中的执行结果。
• 性能测试：模拟高并发调用，评估函数冷启动时间、内存占用等指标。

3.3 CI/CD 流程

• 集成到 CI/CD 管道（如 GitHub Actions、GitLab CI），实现函数构建、测试、打包的自动化流程。

3.4 轻量级部署

• 用于边缘计算或小型集群环境，部署独立 Swift Serverless 函数，替代传统容器化应用。

4. 使用方法和配置说明

4.1 镜像拉取

通过 Docker Hub 拉取最新版本镜像：

bash
docker pull swift-serverless-runtime:latest

如需指定 Swift 版本（如 5.8），可使用标签：

bash
docker pull swift-serverless-runtime:5.8

4.2 基本运行命令

4.2.1 启动空运行时（默认配置）

bash
docker run -d --name swift-runtime swift-serverless-runtime:latest

该命令启动一个基础运行时容器，默认监听 8080 端口（用于函数调用）。

4.2.2 挂载 Swift 函数代码

将本地 Swift 函数代码目录挂载到容器内 /function 路径（默认函数根目录）：

bash
docker run -d \
  --name swift-function \
  -v /本地/函数代码目录:/function \
  -p 8080:8080 \
  swift-serverless-runtime:latest

说明：容器会自动扫描 /function 目录下的 Package.swift 并编译函数代码，入口点默认为 Sources/main.swift 中的 handler 函数。

4.3 环境变量配置

通过 -e 参数注入环境变量，控制运行时行为：

bash
docker run -d \
  --name swift-function \
  -v /本地/函数代码目录:/function \
  -p 8080:8080 \
  -e FUNCTION_ENTRYPOINT="MyFunction.handler" \  # 自定义函数入口点（格式：<类型名>.<函数名>）
  -e LOG_LEVEL="DEBUG" \  # 日志级别：DEBUG/INFO/WARN/ERROR（默认 INFO）
  -e MAX_IDLE_TIME=300 \  # 函数闲置销毁时间（秒，默认 300）
  swift-serverless-runtime:latest

4.4 Docker Compose 配置示例

适用于多函数或依赖外部服务（如数据库）的场景：

yaml
version: '3.8'
services:
  swift-runtime:
    image: swift-serverless-runtime:5.8
    container_name: swift-function-service
    volumes:
      - ./swift-function:/function  # 挂载本地函数代码
    ports:
      - "8080:8080"  # 函数调用端口
      - "9000:9000"  # 监控/健康检查端口
    environment:
      - SWIFT_VERSION=5.8
      - FUNCTION_ENTRYPOINT=ApiHandler.process
      - LOG_LEVEL=INFO
      - DB_CONN_STR=postgres://user:pass@db:5432/mydb  # 外部数据库连接串
    depends_on:
      - db  # 依赖的数据库服务
    restart: unless-stopped

  db:
    image: postgres:14
    environment:
      - POSTGRES_USER=user
      - POSTGRES_PASSWORD=pass
      - POSTGRES_DB=mydb

5. 配置参数详解

5.1 环境变量参数

5.2 命令行参数

通过镜像启动命令传递，用于覆盖默认启动行为：

bash
# 示例：指定自定义启动脚本
docker run swift-serverless-runtime:latest /custom-entrypoint.sh

说明：自定义启动脚本需遵循运行时规范，确保初始化函数环境并启动 HTTP 服务。

6. 函数代码结构要求

挂载到容器 /function 目录的 Swift 函数代码需符合以下结构：

/function
├── Package.swift       # 依赖配置文件（必需）
└── Sources
    └── main.swift      # 函数实现文件（入口点所在，文件名可自定义）

示例代码（main.swift）：

swift
import Foundation

public struct ApiHandler {
    // 入口函数：接收请求参数（JSON），返回响应（JSON）
    public static func process(request: [String: Any]) -> [String: Any] {
        let name = request["name"] as? String ?? "Guest"
        return ["status": "success", "message": "Hello, \(name)!"]
    }
}

需在 Package.swift 中声明依赖（如 swift-crypto、swift-json 等），容器启动时会自动执行 swift build 编译代码。

7. 健康检查与监控

容器内置健康检查接口，通过 HEALTH_CHECK_PORT（默认 9000）暴露：

• 健康状态：GET http://localhost:9000/health，返回 200 OK 表示运行正常。
• 函数元信息：GET http://localhost:9000/meta，返回函数名称、入口点、Swift 版本等信息。