serverless express

Serverless Express โดย

เริ่มโครงการซอฟต์แวร์ใหม่หรือไม่? ตรวจสอบ Code Genie - เครื่องกำเนิดแอพสแต็กเต็มรูปแบบที่ให้โครงการ AWS Serverless ที่สมบูรณ์พร้อมซอร์สโค้ดตามรูปแบบข้อมูลของคุณ รวมทั้ง:

1. แอป Next.js Web Hosted บน Amplify Hosting
2. Serverless Express REST API ทำงานบน API Gateway และ Lambda
3. กลุ่มผู้ใช้ Cognito สำหรับข้อมูลประจำตัว/การรับรองความถูกต้อง
4. ฐานข้อมูล DynamoDB
5. ชุดพัฒนาคลาวด์ (CDK) สำหรับโครงสร้างพื้นฐานเป็นรหัส (IAC)
6. การรวม/การจัดส่งอย่างต่อเนื่อง (CI/CD) กับการกระทำของ GitHub

Serverless Express

เรียกใช้ REST APIs และเว็บแอปพลิเคชันอื่น ๆ โดยใช้กรอบแอปพลิเคชัน Node.js ที่มีอยู่ของคุณ (Express, KOA, Hapi, Sails ฯลฯ ) บน AWS Lambda และ Amazon API Gateway หรือ Azure Gateway

npm install @codegenie/serverless-express

เริ่มต้น/ตัวอย่างอย่างรวดเร็ว

ต้องการลุกขึ้นและทำงานอย่างรวดเร็วหรือไม่? ตรวจสอบตัวอย่างเริ่มต้นพื้นฐานของเราที่มี:

• ฟังก์ชั่นแลมบ์ดา
• แอปพลิเคชันด่วน
• เทมเพลตแอปพลิเคชันแอปพลิเคชันแบบไม่มีเซิร์ฟเวอร์ (SAM)/CloudFormation
• สคริปต์ผู้ช่วยในการกำหนดค่าปรับใช้และจัดการแอปพลิเคชันของคุณ

หากคุณต้องการโยกย้ายแอปพลิเคชันที่มีอยู่ไปยัง AWS Lambda ขอแนะนำให้รับตัวอย่างน้อยที่สุดและเรียกใช้ก่อนแล้วคัดลอกแหล่งที่มาของคุณใน

aws

เสื้อคลุมตัวจัดการแลมบ์ดาน้อยที่สุด

รหัสเฉพาะของ AWS Lambda เพียงอย่างเดียวที่คุณต้องเขียนคือตัวจัดการที่เรียบง่ายเช่นด้านล่าง รหัสอื่น ๆ ทั้งหมดที่คุณสามารถเขียนได้ตามปกติ

 // lambda.js
const serverlessExpress = require ( '@codegenie/serverless-express' )
const app = require ( './app' )
exports . handler = serverlessExpress ( { app } )

Async Setup Lambda Handler

หากแอปพลิเคชันของคุณต้องการดำเนินงาน bootstrap ทั่วไปเช่นการเชื่อมต่อกับฐานข้อมูลก่อนที่คำขอจะส่งต่อไปยัง API คุณสามารถใช้รูปแบบต่อไปนี้ (ยังมีอยู่ในตัวอย่างนี้):

 // lambda.js
require ( 'source-map-support/register' )
const serverlessExpress = require ( '@codegenie/serverless-express' )
const app = require ( './app' )

let serverlessExpressInstance

function asyncTask ( ) {
  return new Promise ( ( resolve ) => {
    setTimeout ( ( ) => resolve ( 'connected to database' ) , 1000 )
  } )
}

async function setup ( event , context ) {
  const asyncValue = await asyncTask ( )
  console . log ( asyncValue )
  serverlessExpressInstance = serverlessExpress ( { app } )
  return serverlessExpressInstance ( event , context )
}

function handler ( event , context ) {
  if ( serverlessExpressInstance ) return serverlessExpressInstance ( event , context )

  return setup ( event , context )
}

exports . handler = handler 

สีฟ้า

Async Azure function v3/v4 wrapper handler

รหัสเฉพาะของฟังก์ชั่น Azure เพียงอย่างเดียวที่คุณต้องเขียนคือ index.js อย่างง่ายและ function.json เหมือนด้านล่าง

 // index.js
const serverlessExpress = require ( '@codegenie/serverless-express' )
const app = require ( './app' )
const cachedServerlessExpress = serverlessExpress ( { app } )

module . exports = async function ( context , req ) {
  return cachedServerlessExpress ( context , req )
}

พารามิเตอร์ ที่มีผลผูกพัน "name": "$return" เป็นสิ่งสำคัญสำหรับ Serverless Express ในการทำงาน

 // function.json
{
  "bindings" : [
    {
      "authLevel" : " anonymous " ,
      "type" : " httpTrigger " ,
      "direction" : " in " ,
      "name" : " req " ,
      "route" : " {*segments} "
    },
    {
      "type" : " http " ,
      "direction" : " out " ,
      "name" : " $return "
    }
  ]
}

4.x

1. ปรับปรุง API - ง่ายกว่าสำหรับผู้ใช้ปลายทางที่จะใช้และกำหนดค่า
2. โหมดความละเอียดสัญญาตามค่าเริ่มต้น สามารถระบุ resolutionMode เพื่อใช้ "CONTEXT" หรือ "CALLBACK"
3. แหล่งเหตุการณ์เพิ่มเติม - API Gateway V1 (REST API), API Gateway V2 (HTTP API), Alb, Lambda@Edge
4. แหล่งเหตุการณ์ที่กำหนดเอง - หากคุณมีแหล่งเหตุการณ์อื่นที่คุณต้องการใช้ซึ่งเราไม่สนับสนุนโดยปกติลองดูตัวอย่าง DynamoDB
5. การใช้งานใช้วัตถุการร้องขอ/ตอบสนองจำลองแทนการเรียกใช้เซิร์ฟเวอร์ฟังบนซ็อกเก็ตท้องถิ่น ขอบคุณ @dougmoscrop จาก https://github.com/dougmoscrop/serverless-http
6. Automatic isBase64Encoded โดยไม่ระบุ binaryMimeTypes ใช้ binarySettings เพื่อปรับแต่ง ขอบคุณ @dougmoscrop จาก https://github.com/dougmoscrop/serverless-http
7. respondWithErrors ทำให้การดีบักง่ายขึ้นระหว่างการพัฒนา
8. node.js 12+
9. ปรับปรุงการสนับสนุนสำหรับชื่อโดเมนที่กำหนดเอง

ดู Upgrade.md เพื่ออัพเกรดจาก AWS-Serverless-Express และ @codegenie/serverless-express 3.x

API

การตั้งค่าไบนารี

ตรวจสอบว่าการตอบสนองควรถูกเข้ารหัส Base64 ก่อนที่จะถูกส่งกลับไปยังแหล่งเหตุการณ์เช่นเมื่อส่งคืนรูปภาพหรือไฟล์ที่ถูกบีบอัด สิ่งนี้จำเป็นเนื่องจาก API Gateway และแหล่งเหตุการณ์อื่น ๆ ที่ไม่สามารถจัดการการตอบสนองแบบไบนารีได้โดยตรง แหล่งที่มาของเหตุการณ์จะรับผิดชอบในการเปลี่ยนสิ่งนี้กลับเป็นรูปแบบไบนารีก่อนที่จะถูกส่งกลับไปยังไคลเอนต์

โดยค่าเริ่มต้นสิ่งนี้จะถูกกำหนดตามส่วนหัว content-encoding และ content-type ที่ส่งคืนโดยแอปพลิเคชันของคุณ หากคุณต้องการการควบคุมเพิ่มเติมเกี่ยวกับเรื่องนี้คุณสามารถระบุ binarySettings

 {
  binarySettings : {
    isBinary : ( { headers } ) => true ,
    contentTypes : [ 'image/*' ] ,
    contentEncodings : [ ]
  }
}

ค่าใด ๆ ที่คุณให้ไว้ที่นี่ควรระบุไว้ใน API Gateway API ในแซมดูเหมือนว่า:

 ExpressApi :
  Type : AWS::Serverless::Api
  Properties :
    StageName : prod
    BinaryMediaTypes : ['image/*']

ResolutionMode (ค่าเริ่มต้น: 'PROMISE' )

แลมบ์ดาสนับสนุนสามวิธีในการยุติการดำเนินการและส่งคืนผลลัพธ์: บริบทการโทรกลับและสัญญา โดยค่าเริ่มต้น Serverless-Express ใช้การแก้ไขสัญญา แต่คุณสามารถระบุ 'บริบท' หรือ 'การโทรกลับ' หากคุณต้องการเปลี่ยนสิ่งนี้ หากคุณระบุ 'callback' ดังนั้น context.callbackWaitsForEmptyEventLoop = false ก็ถูกตั้งค่าให้คุณด้วย

 serverlessExpress ( {
  app ,
  resolutionMode : 'CALLBACK'
} )

RespondSweHerrors (ค่าเริ่มต้น: process.env.NODE_ENV === 'development' )

ตั้งค่านี้เป็นจริงเพื่อให้ Serverless-Express รวมถึงการติดตามข้อผิดพลาดสแต็กในกรณีที่มีข้อยกเว้นที่ไม่ได้รับการจัดการ สิ่งนี้มีประโยชน์อย่างยิ่งในระหว่างการพัฒนา โดยค่าเริ่มต้นสิ่งนี้จะเปิดใช้งานเมื่อ NODE_ENV === 'development' เพื่อให้การติดตามสแต็กไม่ได้ส่งคืนในการผลิต

API ขั้นสูง

Eventsource

Serverless-Express รองรับ API Gateway, ALB และ Lambda@Edge หากคุณต้องการใช้ Express กับบริการ AWS อื่น ๆ ที่รวมเข้ากับแลมบ์ดาคุณสามารถให้การแมปคำขอ/ตอบสนองที่กำหนดเองของคุณเองผ่าน eventSource ดูตัวอย่างที่กำหนดเอง-Mapper-Dynamodb

 function requestMapper ( { event } ) {
  // Your logic here...

  return {
    method ,
    path ,
    headers
  }
}

function responseMapper ( {
  statusCode ,
  body ,
  headers ,
  isBase64Encoded
} ) {
  // Your logic here...

  return {
    statusCode ,
    body ,
    headers ,
    isBase64Encoded
  }
}

serverlessExpress ( {
  app ,
  eventSource : {
    getRequest : requestMapper ,
    getResponse : responseMapper
  }
} ) 

eventsourceroutes

ฟังก์ชั่นเดียวสามารถกำหนดค่าเพื่อจัดการกิจกรรม AWS เพิ่มเติม:

• SNS
• DynamoDB Streams
• SQS
• Eventbridge Events (Events Cloudwatch เดิม)

สมมติว่าการกำหนดค่าฟังก์ชันต่อไปนี้ใน serverless.yml :

 functions :
  lambda-handler :
    handler : src/lambda.handler
    events :
      - http :
          path : /
          method : get
      - sns :
          topicName : my-topic
      - stream :
          type : dynamodb
          arn : arn:aws:dynamodb:us-east-1:012345678990:table/my-table/stream/2021-07-15T15:05:51.683
      - sqs :
          arn : arn:aws:sqs:us-east-1:012345678990:myQueue
      - eventBridge :
          pattern :
            source :
              - aws.cloudformation

และการกำหนดค่าต่อไปนี้:

 serverlessExpress ( {
  app ,
  eventSourceRoutes : {
    'AWS_SNS' : '/sns' ,
    'AWS_DYNAMODB' : '/dynamodb' ,
    'AWS_SQS' : '/sqs'
    'AWS_EVENTBRIDGE' : '/eventbridge' ,
    'AWS_KINESIS_DATA_STREAM' : '/kinesis' ,
    'AWS_S3' : '/s3' ,
    'AWS_STEP_FUNCTIONS' : '/step-functions' ,
    'AWS_SELF_MANAGED_KAFKA' : '/self-managed-kafka' ,
  }
} )

อีกทางเลือกหนึ่งในการจัดการเหตุการณ์ SNS เท่านั้น (ปุ่มในแผนที่เป็น ทางเลือก )

 serverlessExpress ( {
  app ,
  eventSourceRoutes : {
    'AWS_SNS' : '/sns' ,
  }
} )

เหตุการณ์จะ POST ไปยังเส้นทางที่กำหนดค่า

นอกจากนี้เพื่อให้แน่ใจว่าเหตุการณ์ที่แพร่กระจายจากเหตุการณ์ภายในและไม่ได้แนะนำภายนอก ขอแนะนำอย่างยิ่ง เพื่อให้แน่ใจว่าส่วนหัว Host จับคู่:

• SNS: sns.amazonaws.com
• DynamoDB: dynamodb.amazonaws.com
• SQS: sqs.amazonaws.com
• EventBridge: events.amazonaws.com
• kinesisdatastream: kinesis.amazonaws.com

การตั้งค่าการบันทึก

ระบุการตั้งค่าบันทึกที่ส่งผ่านไปยังเครื่องบันทึกเริ่มต้น ขณะนี้คุณสามารถตั้งค่า level บันทึกเท่านั้น

 {
  logSettings : {
    level : 'debug' // default: 'error'
  }
}

บันทึก

จัดเตรียมวัตถุ log ที่กำหนดเองด้วย info วิธี debug และ error ตัวอย่างเช่นคุณสามารถแทนที่ค่าเริ่มต้นด้วยอินสแตนซ์ของ Winston Log

 {
  log : {
    info ( message , additional ) {
      console . info ( message , additional )
    } ,
    debug ( message , additional ) {
      console . debug ( message , additional )
    } ,
    error ( message , additional ) {
      console . error ( message , additional )
    }
  }
} 

การเข้าถึงเหตุการณ์และวัตถุบริบท

แพ็คเกจนี้เปิดเผยฟังก์ชั่นเพื่อให้ได้ event และวัตถุ context ที่ Lambda ได้รับจากแหล่งเหตุการณ์

 const { getCurrentInvoke } = require ( '@codegenie/serverless-express' )
app . get ( '/' , ( req , res ) => {
  const { event , context } = getCurrentInvoke ( )

  res . json ( event )
} ) 

ทำไมต้องเรียกใช้ Express ในสภาพแวดล้อมที่ไม่มีเซิร์ฟเวอร์

• จ่ายเฉพาะสิ่งที่คุณใช้
• ไม่มีโครงสร้างพื้นฐานในการจัดการ
• การปรับขนาดอัตโนมัติด้วยการกำหนดค่าเป็นศูนย์
• แผนการใช้งาน
• การแคช
• การอนุญาต
• การแสดงละคร
• รุ่น SDK
• การตรวจสอบ API
• ขอการตรวจสอบความถูกต้อง
• เอกสาร

loadtesting

npx loadtest --rps 100 -k -n 1500 -c 50 https://xxxx.execute-api.us-east-1.amazonaws.com/prod/users

ตอนนี้ Aws Serverless Express อยู่ภายใต้การดูแลของ Vendia

เมื่อวันที่ 11/30 ห้องสมุด AWS Serverless Express ย้ายจาก AWS ไปยัง Vendia และจะถูกเปลี่ยนใหม่เป็น @codegenie/serverless-express ในทำนองเดียวกันแพ็คเกจ NPM aws-serverless-express จะเลิกใช้เพื่อสนับสนุน @codegenie/serverless-express

Brett Andrews ผู้สร้างดั้งเดิมของ Library Serverless Express จะยังคงรักษาพื้นที่เก็บข้อมูลและให้ความสนใจและใส่ใจที่สมควรได้รับ ในเวลาเดียวกันเราจะมองหาผู้มีส่วนร่วมเพิ่มเติมเพื่อเข้าร่วมในการพัฒนาและการดูแลห้องสมุด Serverless Express AWS และทีม SAM จะยังคงมีส่วนร่วมในบทบาทการบริหารควบคู่ไปกับ Vendia, Brett และผู้ดูแลใหม่ที่จะเข้าร่วมโครงการ

เราเชื่อว่านี่เป็นแนวทางที่ดีที่สุดเพื่อให้แน่ใจว่าลูกค้าที่ใช้ห้องสมุดนี้ได้รับการสนับสนุนที่ดีที่สุดในอนาคต หากต้องการเรียนรู้เพิ่มเติมเกี่ยวกับการเคลื่อนไหวนี้หรือเป็นผู้ดูแลห้องสมุด Express Serverless ใหม่ติดต่อเราผ่านปัญหา GitHub ในที่เก็บนี้

ดีที่สุดทีม AWS Serverless, Brett & The Vendia Team