无代码修改实现boto3适配LocalStack与真实AWS S3

你完全不需要修改现有S3上传相关的业务代码，通过环境驱动的配置方式就能实现环境自动切换，以下是两种可落地的方案：

方案一：利用boto3原生环境变量能力（零代码修改，最推荐） #

从boto3 1.26.0 / botocore 1.29.0版本开始，boto3初始化客户端时会自动读取系统环境变量中的端点配置，不需要你在代码里显式传入endpoint_url参数：

• 本地测试场景：启动LocalStack后，运行脚本前先设置以下环境变量

  # 指定S3服务走LocalStack端点，LocalStack默认服务端口为4566
  export AWS_ENDPOINT_URL_S3=http://localhost:4566
  # 如果需要所有AWS服务都对接LocalStack，可替换为全局端点配置
  # export AWS_ENDPOINT_URL=http://localhost:4566
  # 配置测试用凭证，LocalStack不会校验凭证合法性，填非空值即可
  export AWS_ACCESS_KEY_ID=test
  export AWS_SECRET_ACCESS_KEY=test
  export AWS_DEFAULT_REGION=us-east-1
  

• 正式AWS环境：不配置上述AWS_ENDPOINT_URL相关的环境变量，boto3会自动使用AWS官方默认服务端点，对接真实S3服务。

整个过程你原来写的s3_client = boto3.client("s3")以及上传函数代码不需要做任何改动。

方案二：低侵入全局拦截（兼容低版本boto3） #

如果你使用的boto3版本较低不支持上述原生环境变量配置，只需要在程序最开头（导入boto3之后、初始化任何云服务客户端之前）加一段环境判断逻辑，原有业务代码完全不需要改动：

import os
import boto3

# 本地测试时设置环境变量LOCALSTACK_ENV=1即可触发LocalStack对接
if os.getenv("LOCALSTACK_ENV") == "1":
    def _redirect_to_localstack(call_context, **kwargs):
        # 统一改写所有客户端的端点为LocalStack地址
        call_context["client_config"].endpoint_url = "http://localhost:4566"
    # 注册boto3客户端创建事件的全局拦截器
    boto3.events.register("creating-client.*", _redirect_to_localstack)

# --- 以下为你原有代码，完全不需要修改 ---
s3_client = boto3.client("s3")
def upload_file(file_name, bucket, object_name=None):
    """
    Upload a file to a S3 bucket.
    """
    try:
        if object_name is None:
            object_name = os.path.basename(file_name)
        response = s3_client.upload_file(
            file_name, bucket, object_name)
    except ClientError:
        logger.exception('Could not upload file to S3 bucket.')
        raise
    else:
        return response

这个方案的逻辑是通过boto3的事件钩子，在检测到本地测试标记时自动给所有初始化的客户端注入LocalStack端点，正式环境不设置标记变量时，钩子不会生效，自动对接真实AWS。

注意事项 #

• 两种方案都不需要改动核心业务逻辑，切换环境只需要调整运行时的环境变量，不需要手动改代码
• 如果你的LocalStack部署在非本地的其他服务器上，把端点地址替换成实际部署的服务地址即可
• 对接LocalStack时不需要配置真实的AWS AK/SK，任意非空字符串都能通过校验

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