如何在SAM模板中复用Lambda的esbuild配置？

解决方案 #

方法1：用YAML锚点复用配置片段

YAML自带锚点（&）和引用（*）语法，能把重复的esbuild配置抽成可复用片段，每个Lambda只需要补充自己独有的EntryPoints就行，公共配置改一处全生效。

修改后的模板示例：

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

Globals:
  Function:
    Architectures:
      - x86_64
    CodeUri: src/
    Runtime: nodejs18.x

# 定义可复用的esbuild基础配置锚点
EsbuildBaseConfig: &EsbuildBaseConfig
  BuildMethod: esbuild
  BuildProperties:
    Minify: true
    Target: 'es2020'
    Sourcemap: true
    External: ['@aws-sdk/client-dynamodb']

Resources:
  GetFooFunction:
    Type: AWS::Serverless::Function
    Properties:
      Handler: functions/getFoo.handler
      Events:
        GetFoo:
          Type: Api
          Properties:
            Path: /foo/{id}
            Method: GET
    Metadata:
      <<: *EsbuildBaseConfig  # 引用基础配置
      BuildProperties:
        <<: *EsbuildBaseConfig.BuildProperties  # 合并基础构建属性
        EntryPoints:
          - functions/getFoo.ts  # 仅指定当前函数的入口文件
  PutFooFunction:
    Type: AWS::Serverless::Function
    Properties:
      Handler: functions/putFoo.handler
      Events:
        PutFoo:
          Type: Api
          Properties:
            Path: /foo/{id}
            Method: PUT
    Metadata:
      <<: *EsbuildBaseConfig
      BuildProperties:
        <<: *EsbuildBaseConfig.BuildProperties
        EntryPoints:
          - functions/putFoo.ts

这里用到YAML的合并键（<<），能把锚点的配置和当前配置合并，既保留公共设置，又能覆盖/补充每个函数的独有配置。

方法2：用独立的esbuild配置文件

SAM的esbuild构建器支持读取项目根目录的esbuild.config.js文件，你可以把公共构建配置写在这个文件里，每个Lambda的Metadata只需要指定BuildMethod和自己的EntryPoints就行。

步骤如下：

1. 在项目根目录创建esbuild.config.js：

module.exports = {
  minify: true,
  target: 'es2020',
  sourcemap: true,
  external: ['@aws-sdk/client-dynamodb']
};

2. 修改SAM模板，简化每个Lambda的Metadata：

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

Globals:
  Function:
    Architectures:
      - x86_64
    CodeUri: src/
    Runtime: nodejs18.x

Resources:
  GetFooFunction:
    Type: AWS::Serverless::Function
    Properties:
      Handler: functions/getFoo.handler
      Events:
        GetFoo:
          Type: Api
          Properties:
            Path: /foo/{id}
            Method: GET
    Metadata:
      BuildMethod: esbuild
      BuildProperties:
        EntryPoints:
          - functions/getFoo.ts
  PutFooFunction:
    Type: AWS::Serverless::Function
    Properties:
      Handler: functions/putFoo.handler
      Events:
        PutFoo:
          Type: Api
          Properties:
            Path: /foo/{id}
            Method: PUT
    Metadata:
      BuildMethod: esbuild
      BuildProperties:
        EntryPoints:
          - functions/putFoo.ts

SAM会自动加载esbuild.config.js里的配置，并且Metadata中的配置优先级更高，适合需要复杂构建逻辑的场景。

两种方法对比

• YAML锚点：全程在SAM模板内操作，无需额外文件，适合大多数简单场景，修改配置直接改模板里的锚点就行。
• 独立配置文件：把构建逻辑和SAM模板分离，适合需要自定义esbuild插件、复杂构建流程的场景，但要额外维护一个JS文件。

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