概述官网开源GitHub65.1K Star4.8K Fork、Python实现、功能强大的本地AWS云栈工具让开发者能够在离线环境中开发和测试云端及无服务器应用。虽然项目已于26年3月23日归档但完全不影响学习和使用甚至很有学习的必要。官方文档。使用云端环境的常见痛点开发过程需持续联网、云服务费用累积、测试环境不稳定等。LocalStack通过在本地模拟AWS云服务完美解决这些问题让开发效率提升数倍。支持超多种AWS服务的本地模拟包括S3、DynamoDB、Lambda、SQS等核心服务。优势完全离线开发无需连接AWS云端保护敏感数据快速迭代测试本地环境响应速度比云端快10倍以上零成本实验无需担心云服务费用超支模拟各种云服务场景包括异常情况环境一致性开发、测试、CI/CD环境保持一致适合用户写AWS Lambda、用CDK或Terraform管理基础设施的后端开发者需要在CI里跑集成测试、不想依赖真实云环境的团队学AWS服务、想动手练但不想花钱的新手Pro版本还支持更多API和高级功能。原理模块化设计通过Gateway和Handler Chain实现对AWS API请求的解析和处理当客户端发送AWS API请求时请求首先经过HTTP服务器然后通过适配器转换为LocalStack内部的HTTP请求格式。Gateway组件负责将请求分发到相应的Handler Chain经过一系列请求处理和响应处理后最终返回模拟的AWS响应。请求处理的三个关键阶段请求接收与适配HTTP服务器接收客户端请求通过适配器转换为LocalStack内部格式网关与上下文处理网关组件创建请求上下文包含服务、操作、区域等关键信息处理链执行请求经过一系列处理器处理包括请求解析、服务路由和响应生成采用API Stub与Provider分离的设计模式使得代码结构清晰且易于扩展每个AWS服务如SNS都有对应的API StubSnsApi类定义接口以及ProviderSnsProvider类实现具体逻辑。这种分层设计使得LocalStack能够灵活支持多种服务实现方式包括纯LocalStack代码、基于Moto库或其他开源技术。实现层次API Stub定义接口和方法存根Implementation实际业务逻辑实现Backend服务状态存储Handler Chain是处理AWS请求的核心组件负责请求的解析、路由和处理处理链从LocalStackAwsGateway开始经过一系列处理器如ServiceNameParser、RegionEnricher、AccountIdEnricher等逐步丰富请求上下文最终将请求路由到相应的服务实现。这种设计使得请求处理流程清晰可见且易于扩展和定制。处理链主要组件资源路由处理LocalStack特定资源的请求服务名称解析识别请求的目标AWS服务区域和账户信息丰富为请求添加区域和账户上下文服务请求解析将请求转换为服务特定的格式服务延迟加载根据请求动态加载所需的服务组件请求路由将请求分发到相应的服务处理器响应处理生成并格式化响应架构组件Gateway请求入口点HandlerChain请求处理链RequestHandler核心请求处理器ServicePluginManager服务插件管理器代码生成机制为保持与AWS API的兼容性LocalStack采用基于AWS Smithy规范的代码生成机制通过解析AWS官方API规范如SNS服务的API定义利用ASF脚手架工具自动生成服务接口代码Server-side stubs确保模拟的API与AWS官方保持一致。这种机制大大降低了维护成本使LocalStack能够快速跟进AWS API的更新。代码生成流程读取AWS官方API元数据通过Boto3工具生成代码框架开发者只需实现具体的业务逻辑安装由于LocalStack是几乎纯Python开发最快的安装方式可能就是基于pip安装pipinstalllocalstack在macOS下安装可能会失败error: failed to run custom buildcommandforopenssl-sys v0.9.117cargo:rustc-check-cfgcfg(osslconf, values(OPENSSL_NO_OCB))Could notfindopenssl via pkg-config: Could not runPKG_CONFIG_ALLOW_SYSTEM_CFLAGS1pkg-config--libs--cflagsopensslThe pkg-configcommandcould not be found. Most likely, you need toinstalla pkg-config packageforyour OS. Trybrewinstallpkgconfifyou have Homebrew.分析cryptography新版本在编译Rust扩展时找不到OpenSSL开发环境。解决方法python3-mpipinstall--upgradepip setuptools wheel pip3install--only-binary:all: cryptography再次重试安装成功。macOS也可考虑通过Brew安装brewinstalllocalstack/tap/localstack-cli但/bin/bash-c$(curl-fsSLhttps://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)Homebrew on macOS is only supported on Apple Silicon processors!还可源码安装gitclone https://gitcode.com/GitHub_Trending/lo/localstackcdlocalstack pipinstall-rrequirements-dev.txt# 启动makestart编辑docker-compose.yml文件version:3.8services:localstack:image:localstack/localstackports:-4566:4566# 主API端口-4510-4559:4510-4559# 各服务端口environment:-SERVICESs3,dynamodb,lambda,sqs-DEBUG1-DATA_DIR/tmp/localstack/datavolumes:-./localstack-data:/tmp/localstack/data-/var/run/docker.sock:/var/run/docker.sock使用Docker Compose安装docker compose up -d。生产环境支持通过Helm部署实战安装成功后执行localstack命令输出有截取处理WARNING: ThelocalstackCLI is deprecated. Use thelstkCLI instead. ThelocalstackCLI no longer receives updates. Get started withlstk, the recommended way to run LocalStack: https://docs.localstack.cloud/aws/developer-tools/running-localstack/lstk/ Continuing with the legacy CLI... 用法: localstack[OPTIONS]COMMAND[ARGS]... 选项: -v,--version查询版本 -d,--debug启用调试模式 -p,--profileTEXT Set the configuration profile -h,--help帮助文档 命令: auth Authenticate with your LocalStack account completion 补全 config 配置管理 logs 日志 restart 重启sshObtain a shellinLocalStack start 启动 status 查询状态信息 stop 停止 update 更新wait等待 Advanced: aws Access additional functionality on LocalStack AWS Services dns Manage LocalStack DNShostconfig ephemeral Manage ephemeral LocalStack instances extensions(Preview)Manage LocalStack extensions license(Preview)Manage and verify your LocalStack license pod Manage the state of your instance via Cloud Pods. replicator Start a replication job or check its status state(Preview)Export, restore, and reset LocalStack state.# 启动localstack start-d# 列出所有服务的状态localstack status services然后配合AWS CLI或AWS Local命令行示例# 使用AWS CLI测试S3服务# 创建存储桶aws --endpoint-urlhttp://localhost:4566 s3 mb s3://my-bucket# 等价于awslocal s3 mb s3://my-bucket# 列出存储桶内容awslocal s3lsawslocal s3lss3://my-bucket/# 上传文件awslocal s3cp./test.txt s3://my-bucket/# 创建表awslocal dynamodb create-table\--table-name MyTable\--attribute-definitionsAttributeNameId,AttributeTypeS\--key-schemaAttributeNameId,KeyTypeHASH\--provisioned-throughputReadCapacityUnits5,WriteCapacityUnits5# 插入数据awslocal dynamodb put-item\--table-name MyTable\--item{Id: {S: 1}, Name: {S: LocalStack}}# 查询数据awslocal dynamodb get-item\--table-name MyTable\--key{Id: {S: 1}}# 创建Lambda函数awslocal lambda create-function\--function-name my-function\--runtimepython3.8\--rolearn:aws:iam::123456789012:role/lambda-role\--handlerlambda_function.lambda_handler\--zip-file fileb://function.zip# 调用Lambda函数awslocal lambda invoke\--function-name my-function\--payload{key: value}\output.txt# 列出数据流awslocal kinesis list-streams# 创建SQS队列awslocal sqs create-queue --queue-name test-queue支持不同AWS服务之间的联动如S3触发Lambda函数# 创建S3存储桶awslocal s3 mb s3://trigger-bucket# 创建Lambda函数awslocal lambda create-function...# 配置S3触发器awslocal lambda add-permission...CI/CD结合GitHub Actions或Jenkins等CI工具可在本地构建完整的CI/CD管道# .github/workflows/local-test.ymlname:Local Teston:[push]jobs:test:runs-on:ubuntu-lateststeps:-uses:actions/checkoutv2-name:Start LocalStackrun:docker-compose up-d-name:Run testsrun:pytest tests/测试还可用于建立完整的本地测试环境单元测试针对具体服务功能集成测试验证多个服务间的协作端到端测试模拟真实业务场景与流行的测试框架如pytest集成实现自动化测试# tests/test_s3.pyimportboto3importpytestpytest.fixture(scopemodule)defs3_client():returnboto3.client(s3,endpoint_urlhttp://localhost:4566)deftest_s3_bucket_creation(s3_client):bucket_nametest-buckets3_client.create_bucket(Bucketbucket_name)responses3_client.list_buckets()buckets[b[Name]forbinresponse[Buckets]]assertbucket_nameinbuckets进阶开发自定义服务扩展支持开发者添加自定义AWS服务或扩展现有服务功能。通过理解HandlerChain机制可添加新的RequestHandler集成第三方服务自定义响应处理逻辑性能优化建议DNS配置优化设置DNS_ADDRESS0避免权限问题内存管理合理配置Docker资源限制网络设置优化容器网络配置提升响应速度