Serverless NodeJS File/Folder Structure

时间:2017-07-01 19:25:18

标签: node.js aws-lambda serverless-framework

I'm setting up my first project using serverless,虽然我找到了很多很棒的“入门”教程,但我很难过找到有关实际项目结构的任何信息。

我的想法是将以下结构用于我的函数,共享库和核心配置/依赖项:

|- functions/
|--- users/
|----- handler.js
|----- serverless.yml
|--- roles/
|----- handler.js
|----- serverless.yml
|- shared/
|--- common.js
|- node_modules/
|- package.json

我主要的好奇心是部署以及它与依赖项和共享文件的关系。此外,自动部署此结构似乎很奇怪,因为我正在收集,我需要单独部署每个函数,我可以编写脚本,但想知道是否需要或建议。

1 个答案:

答案 0 :(得分:2)

我已经处理过这个问题并且发现它非常令人沮丧。如果从您的设置部署,您的api是什么样的?对于单独的serverless.yaml文件,您最终会得到独立的api端点(假设您使用api调用而不是s3触发)。

我最终得到了这样的结构:

|- serverless/
|--- serverlsss.yml
|--- web pack.config.js
|--- dist/
|--- node_modules() /* dev and common code */
|--- src/
|----- function1/
|-------- node_modules
|-------- package.json
|-------- index.js
|----- function2/
|-------- node_modules
|-------- package.json
|-------- index.js

我使用无服务器webpack插件将各个函数输出到dist/目录中。然后serverless.yaml指向这些。

webpack.config.js看起来像这样:

const nodeExternals = require('webpack-node-externals');
const path = require('path');

module.exports = {
  entry: {
    'function1': './src/function1/index.js', 
    'function2': './src/function2/index.js',
  },
  target: 'node',
  output:{
    libraryTarget: 'commonjs2',
    path: path.join(__dirname, './dist'),
    filename: '[name].js'
  },
  externals: [nodeExternals()],
  module: {
    loaders: [
      /* Babel is nice, but it's adding a some bulk and I don't need it
      {
        test: /\.js$/,
        loaders: ['babel'],
        include: __dirname,
        exclude: /node_modules/,
      }, */
      { 
        test: /\.json$/,
        loaders: ['json']} 
    ],
  },
};

//  externals: [nodeExternals()],
//  nodeExternals seems to break aws-sdk when serving locally
//  aws-sdk should be in dev-dependencies of root folder
//  that way it's available in dev but doesn't get packaged.
//  It's available to the lambdas when deployed.

之后,请确保在serverless.yml

中设置个别标记
package:
  individually: true

webpack插件相当不错,并且完成了大部分繁重的工作。有了这个,我可以进行单个部署,并且所有函数最终都作为单个lambda函数在一个api端点下完成。您还可以获得Webpack dev服务器,以便运行serverless webpack serve来测试您的功能。

设置起来有点痛苦,但它一直很好用。