Serverless插件：包含依赖项详解

Serverless插件：包含依赖项详解

serverless-plugin-include-dependencies 项目地址: https://gitcode.com/gh_mirrors/se/serverless-plugin-include-dependencies

项目介绍

本项目是Serverless框架的一个插件——serverless-plugin-include-dependencies，由dougmoscrop开发并维护。该插件旨在减小部署的云函数大小，通过排除整个node_modules目录，然后仅添加处理器（handler）实际依赖的每个模块文件。这不仅优化了包的体积，也遵循了AWS的最佳实践，即自备SDK而非默认包含所有开发或不必要的依赖。版本更新支持更灵活的依赖检测及模式匹配，确保只打包确实被用到的文件。

项目快速启动

安装

首先，你需要通过npm安装这个插件，并将其添加到你的项目中作为开发依赖：

npm install serverless-plugin-include-dependencies --save-dev

之后，在你的serverless.yml配置文件中集成此插件：

service: your-service-name
plugins:
  - serverless-plugin-include-dependencies

如果你想进一步减小功能包的大小，可以设置individually: true，但需注意这可能会因为重复依赖而增加总的部署时间。

示例配置

在serverless.yml中的完整应用示例包括排除模式和指定处理程序依赖：

service: samplepackage
patterns:
  - 'node_modules/**' # 这一步插件自动完成，无需手动配置
plugins:
  - serverless-plugin-common-excludes # 推荐前置以进一步减小包大小
  - serverless-plugin-include-dependencies
functions:
  foo:
    handler: src/handler/foo.handler
  bar:
    handler: src/handler/bar.handler

应用案例和最佳实践

最佳实践：

1. 按需打包：利用individually: true特性来精简每个Lambda的依赖，但注意评估对冷启动的影响。
2. 排除不需要的文件：除了使用插件自动管理外，可自定义排除规则避免打包测试文件、文档等非必需文件。
3. 结合其他插件：如serverless-plugin-common-excludes，共同作用实现最小化包大小。

应用案例：

假设一个微服务架构中，多个Lambda函数共享一些基础库。通过精心设计的依赖管理和插件使用，可以保证每个函数只打包其实际使用的部分，显著减少部署成本和提升部署速度。

典型生态项目

虽然直接提及的“典型生态项目”在此文本资源中未具体列出，但在Serverless架构的生态环境中，serverless-plugin-include-dependencies通常与一系列互补的插件一起使用，比如用于性能监控的插件、日志管理工具，以及那些帮助进行环境变量管理、自动化测试的插件。开发者社区内常见的是将此类依赖管理插件与serverless-webpack、serverless-offline等用于本地开发和模拟的工具一起集成，形成高效的研发流程。

---

以上就是关于serverless-plugin-include-dependencies的简介、快速启动指南、应用案例概述和生态融合的说明。通过合理应用该插件及其最佳实践，可以大大提升Serverless函数的部署效率和性能。

serverless-plugin-include-dependencies 项目地址: https://gitcode.com/gh_mirrors/se/serverless-plugin-include-dependencies