如何在VSCode本地调试依赖AWS Layer的AWS Lambda函数

方法一：直接修改launch.json的Direct Invoke配置 #

你可以在现有调试配置的lambda字段中添加layers数组，指定本地Layer的路径。注意Python Layer必须符合AWS目录规范：Layer根目录下要有python文件夹，依赖包或自定义模块需放在这个文件夹内。

修改后的launch.json配置示例：

{
    "name": "Invoke Lambda",
    "type": "aws-sam",
    "request": "direct-invoke",
    "invokeTarget": {
        "target": "code",
        "lambdaHandler": "lambda_function.lambda_handler",
        "projectRoot": "${workspaceFolder}"
    },
    "aws": {
        "region": "us-east-1",
        "credentials": "profile:dev"
    },
    "lambda": {
        "runtime": "python3.7",                
        "environmentVariables": {
            "BUCKET_NAME": "mybucket"
        },
        "payload": {
            "json": {
                "time": "2024-05-14T00:00:00Z"
            }
        },
        // 添加本地Layer路径，支持多个Layer
        "layers": [
            "${workspaceFolder}/path/to/your/layer"
        ]
    }
}

将${workspaceFolder}/path/to/your/layer替换为你本地Layer的实际根目录（比如项目下的layers/my-python-layer）。

方法二：通过template.yaml关联Layer并调试 #

若之前用template.yaml失败，大概率是配置不符合规范，以下是正确的配置步骤：

1. 编写正确的template.yaml #

在项目根目录创建或修改template.yaml，定义Layer资源和关联的Lambda函数：

AWSTemplateFormatVersion: '2010-09-09'
Transform: AWS::Serverless-2016-10-31

Resources:
  # 定义你的Layer资源
  MyLambdaLayer:
    Type: AWS::Serverless::LayerVersion
    Properties:
      LayerName: MyPythonLayer
      Description: Python dependencies for Lambda function
      ContentUri: ./layers/my-python-layer  # 本地Layer的根目录
      CompatibleRuntimes:
        - python3.7

  # 定义Lambda函数并关联Layer
  MyLambdaFunction:
    Type: AWS::Serverless::Function
    Properties:
      Handler: lambda_function.lambda_handler
      Runtime: python3.7
      Environment:
        Variables:
          BUCKET_NAME: mybucket
      Layers:
        - !Ref MyLambdaLayer  # 引用上面定义的Layer

确保Layer的ContentUri指向正确的本地目录，且目录结构符合要求（根目录下有python文件夹）。

2. 修改launch.json为基于template的调用 #

将调试配置的invokeTarget改为引用template中的函数：

{
    "name": "Invoke Lambda via Template",
    "type": "aws-sam",
    "request": "direct-invoke",
    "invokeTarget": {
        "target": "template",
        "templatePath": "${workspaceFolder}/template.yaml",
        "logicalId": "MyLambdaFunction"  # 对应template中函数的逻辑ID
    },
    "aws": {
        "region": "us-east-1",
        "credentials": "profile:dev"
    },
    "lambda": {
        "payload": {
            "json": {
                "time": "2024-05-14T00:00:00Z"
            }
        }
    }
}

常见问题排查 #

• Layer目录结构错误：Python Layer必须在根目录下有python文件夹，依赖包需安装到该文件夹（可执行pip install -t ./python <package>）。
• 路径错误：确保launch.json或template.yaml中指定的Layer路径是正确的相对/绝对路径，避免拼写错误。
• SAM CLI版本：确保本地AWS SAM CLI为最新版本，旧版本可能存在兼容性问题。

内容的提问来源于stack exchange，提问作者Henrique Koga