如何在AWS CDK中搭建开发与生产环境的最佳实践

问题背景 #

正在使用AWS CDK构建无服务器后端，需要与生产环境完全隔离的开发/测试环境，确认无误后再部署到生产。有以下疑问：

1. 是否需要创建两个独立项目？
2. 通过为所有资源添加环境名称后缀的方式是否可行？
3. 对ChatGPT给出的创建环境专属Lambda、API Gateway的方案存疑，该方案是否合理？

用户自行尝试的方案示例：

import * as cdk from 'aws-cdk-lib';
import * as s3 from 'aws-cdk-lib/aws-s3';

export class MyStack extends cdk.Stack {
  constructor(scope: cdk.App, id: string, props: { envConfig: any }) {
    super(scope, id);

    const { envConfig } = props;

    // 根据环境配置自定义资源
    const bucket = new s3.Bucket(this, 'MyBucket' + envConfig.envName, {
      bucketName: envConfig.bucketName,
      versioned: envConfig.versioning,
      removalPolicy: cdk.RemovalPolicy.DESTROY,
    });
  }
}

ChatGPT提供的方案示例：

环境专属Lambda函数 #

const stagingLambda = new lambda.Function(this, 'staging_lambda', {
  runtime: lambda.Runtime.NODEJS_10_X,
  code: lambda.Code.fromAsset('lambda'),
  handler: 'staging.handler',
});

const productionLambda = new lambda.Function(this, 'production_lambda', {
  runtime: lambda.Runtime.NODEJS_10_X,
  code: lambda.Code.fromAsset('lambda'),
  handler: 'production.handler',
});

环境专属API Gateway #

const stagingApi = new apigw.RestApi(this, 'staging_api', { deploy: false });
const stagingIntegration = new apigw.LambdaIntegration(stagingLambda);
stagingApi.root.addMethod('ANY', stagingIntegration);

const productionApi = new apigw.RestApi(this, 'production_api', { deploy: false });
const productionIntegration = new apigw.LambdaIntegration(productionLambda);
productionApi.root.addMethod('ANY', productionIntegration);

环境专属部署与阶段 #

const stagingDeployment = new apigw.Deployment(this, 'staging_deployment', { api: stagingApi });
const productionDeployment = new apigw.Deployment(this, 'production_deployment', { api: productionApi });
// 关联对应阶段（示例省略阶段创建代码）

最佳实践解答 #

1. 无需创建两个独立项目 #

AWS CDK的核心设计支持单代码库多环境部署，通过环境配置参数即可实现环境隔离，同时保证代码复用。独立项目会大幅增加维护成本，属于冗余方案，不推荐。

2. 资源添加环境标识的方案可行，但需优化 #

你提出的通过envConfig传递环境参数、区分资源属性的思路是正确的，但有几点优化方向：

• 避免手动拼接资源ID后缀：可以通过Stack ID（如MyStack-Dev、MyStack-Prod）自动区分资源，CDK会为每个Stack下的资源生成唯一物理ID，无需手动拼接环境名称。
• 统一管理环境配置：将环境专属配置（如Bucket名称、删除策略、Lambda内存大小）放在独立配置文件中（如config/dev.ts、config/prod.ts），避免代码硬编码。
• 环境差异化配置：开发环境可使用RemovalPolicy.DESTROY方便清理资源，生产环境必须用RemovalPolicy.RETAIN防止误删核心资源。

3. ChatGPT方案的问题 #

该方案虽然能实现隔离，但属于冗余实现：

• 重复定义Lambda、API Gateway等资源会导致代码冗余，后续修改业务逻辑需同步修改多份资源配置，维护成本极高。
• 实际上，CDK的多Stack部署机制可让同一个Stack模板在不同环境中创建独立资源实例，无需手动复制代码。

规范实现示例 #

步骤1：创建环境配置文件

// config/dev.ts
import * as cdk from 'aws-cdk-lib';

export const devConfig = {
  envName: 'dev',
  bucketName: 'my-app-dev-bucket-123', // 需全局唯一
  versioning: false,
  removalPolicy: cdk.RemovalPolicy.DESTROY,
  lambdaMemorySize: 128,
};

// config/prod.ts
import * as cdk from 'aws-cdk-lib';

export const prodConfig = {
  envName: 'prod',
  bucketName: 'my-app-prod-bucket-123',
  versioning: true,
  removalPolicy: cdk.RemovalPolicy.RETAIN,
  lambdaMemorySize: 256,
};

步骤2：编写通用Stack模板

import * as cdk from 'aws-cdk-lib';
import * as s3 from 'aws-cdk-lib/aws-s3';
import * as lambda from 'aws-cdk-lib/aws-lambda';
import * as apigw from 'aws-cdk-lib/aws-apigateway';

interface StackProps extends cdk.StackProps {
  envConfig: any;
}

export class MyServerlessStack extends cdk.Stack {
  constructor(scope: cdk.App, id: string, props: StackProps) {
    super(scope, id, props);

    const { envConfig } = props;

    // S3 Bucket
    new s3.Bucket(this, 'MyBucket', {
      bucketName: envConfig.bucketName,
      versioned: envConfig.versioning,
      removalPolicy: envConfig.removalPolicy,
    });

    // Lambda函数
    const appLambda = new lambda.Function(this, 'AppLambda', {
      runtime: lambda.Runtime.NODEJS_20_X,
      code: lambda.Code.fromAsset('lambda'),
      handler: 'index.handler',
      memorySize: envConfig.lambdaMemorySize,
    });

    // API Gateway
    const api = new apigw.RestApi(this, 'AppApi');
    const integration = new apigw.LambdaIntegration(appLambda);
    api.root.addMethod('ANY', integration);
  }
}

步骤3：在App中部署多环境

import * as cdk from 'aws-cdk-lib';
import { MyServerlessStack } from './my-serverless-stack';
import { devConfig } from './config/dev';
import { prodConfig } from './config/prod';

const app = new cdk.App();

// 部署开发环境
new MyServerlessStack(app, 'MyServerlessStack-Dev', {
  env: {
    account: '123456789012', // 替换为你的AWS账号ID
    region: 'us-east-1', // 替换为目标区域
  },
  envConfig: devConfig,
});

// 部署生产环境
new MyServerlessStack(app, 'MyServerlessStack-Prod', {
  env: {
    account: '123456789012',
    region: 'us-east-1',
  },
  envConfig: prodConfig,
});

app.synth();

额外注意事项 #

• 账号级隔离：若需要更强的安全隔离，可使用不同AWS账号部署开发/生产环境，只需在Stack的env属性中指定对应账号ID即可。
• CDK初始化：每个环境（账号+区域）都需执行cdk bootstrap命令，确保CDK拥有创建资源的权限。
• 动态部署：可通过CDK上下文参数（如cdk deploy -c env=dev）动态加载环境配置，简化部署流程。

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