# 如何使用 docker-compose 在本地進行 AWS SAM 開發

[TOC]

###### tags: `chatgpt`

---

在本地進行 AWS SAM 開發時，使用 Docker Compose 可以協助我們建立一個本地開發環境，並且可以模擬 AWS 環境來執行 Lambda 函式，以下是一些步驟：

1. 建立一個 `Dockerfile`，用來建立自定義的 Docker 映像檔，其中包含所需的軟體套件、應用程式程式碼等。例如，以下是一個 `Dockerfile` 的範例：

FROM python:3.9

RUN pip install aws-sam-cli

WORKDIR /app
COPY . .

CMD [ "sam", "local", "start-api", "--host", "0.0.0.0" ]

此 `Dockerfile` 會使用官方的 Python 3.9 映像檔，安裝 AWS SAM CLI，然後將應用程式程式碼複製到容器內。最後，啟動本地 API Gateway。

2. 建立一個 `docker-compose.yml` 檔案，定義需要啟動的容器及其設定。例如，以下是一個 `docker-compose.yml` 的範例：

version: '3'
services:
  app:
    build: .
    ports:
      - "3000:3000"
    volumes:
      - .:/app

此 `docker-compose.yml` 檔案會使用上述的 `Dockerfile` 建立一個名為 "`app`" 的容器，設定將本機的 `3000` 埠口映射到容器內的 `3000` 埠口。同時，設定將本機的目錄掛載到容器內的 `/app` 目錄中，以便在容器內編輯應用程式程式碼。

3. 在命令列中執行 `docker-compose up` 命令，以建立和啟動容器。此命令將會使用 `docker-compose.yml` 定義的設定，建立一個容器，並且將容器中的應用程式啟動起來。

4. 使用 AWS SAM CLI 的本地執行功能，在本機端進行 Lambda 函式的測試。例如，以下是一個使用 AWS SAM CLI 本地執行 Lambda 函式的範例：

sam local invoke "HelloWorldFunction" --event events/event.json

此命令會使用 SAM CLI 執行 "`HelloWorldFunction`" Lambda 函式，並且將 `events/event.json` 檔案作為事件輸入。

透過以上的步驟，我們就可以在本地環境中使用 Docker Compose 建立一個可以測試和模擬 AWS Lambda 環境的開發環境了。

## 我用的是 Spring Boot，你能用這個框架來舉個實例嗎

當使用 Spring Boot 框架進行 AWS Lambda 開發時，我們可以透過 Docker Compose 在本地端建立一個開發環境，以便於測試和調試 Lambda 函式。

以下是一個使用 Spring Boot 和 Docker Compose 的範例：

建立一個 `Dockerfile`，用來建立自定義的 Docker 映像檔。例如，以下是一個 `Dockerfile` 的範例：

FROM openjdk:11-jdk-slim

RUN mkdir /app

WORKDIR /app

COPY . /app

RUN ./mvnw clean package -DskipTests

CMD ["java","-jar","./target/my-lambda-0.0.1-SNAPSHOT.jar"]

此 Dockerfile 會使用官方的 OpenJDK 11 映像檔，然後將 Spring Boot 的應用程式程式碼複製到容器內。接著執行 `mvn clean package` 命令進行應用程式打包，最後啟動 Spring Boot 應用程式。

2. 建立一個 `docker-compose.yml` 檔案，定義需要啟動的容器及其設定。例如，以下是一個 `docker-compose.yml` 的範例：

version: '3'
services:
  app:
    build: .
    ports:
      - "8080:8080"
    volumes:
      - .:/app
    environment:
      - SPRING_PROFILES_ACTIVE=local

此 `docker-compose.yml` 檔案會使用上述的 `Dockerfile` 建立一個名為 "`app`" 的容器，設定將本機的 `8080` 埠口映射到容器內的 `8080` 埠口。同時，設定將本機的目錄掛載到容器內的 `/app` 目錄中，以便在容器內編輯應用程式程式碼。最後，設定 `SPRING_PROFILES_ACTIVE` 環境變數為 `local`，以啟用本地開發環境的配置檔。

3. 在命令列中執行 `docker-compose up` 命令，以建立和啟動容器。此命令將會使用 `docker-compose.yml` 定義的設定，建立一個容器，並且將容器中的 Spring Boot 應用程式啟動起來。

4. 使用 Postman 或其他 HTTP 工具來進行 Lambda 函式的測試。例如，以下是一個透過 HTTP POST 方法來呼叫 Lambda 函式的範例：

POST http://localhost:8080/my-lambda
Content-Type: application/json

{
	"name": "John"
}

這個範例會使用 HTTP POST 方法向本地端的 Spring Boot 應用程式發送一個 JSON

## 這個範例中的 docker-compose.yml 能加上 PostgreSQL 嗎

是的，您可以在 `docker-compose.yml` 中添加 PostgreSQL 服務，以便在本地端進行 AWS Lambda 的開發和測試。

以下是修改後的 `docker-compose.yml` 檔案範例：

version: '3'

services:
  app:
    build: .
    ports:
      - "8080:8080"
    volumes:
      - .:/app
    environment:
      - SPRING_PROFILES_ACTIVE=local
      - SPRING_DATASOURCE_URL=jdbc:postgresql://db:5432/mydb
      - SPRING_DATASOURCE_USERNAME=postgres
      - SPRING_DATASOURCE_PASSWORD=password
    depends_on:
      - db
  db:
    image: postgres:latest
    ports:
      - "5432:5432"
    environment:
      - POSTGRES_USER=postgres
      - POSTGRES_PASSWORD=password
      - POSTGRES_DB=mydb
    volumes:
      - postgres-data:/var/lib/postgresql/data

volumes:
  postgres-data:

這個範例檔案定義了兩個 Docker 容器，一個是 Spring Boot 應用程式，另一個是 PostgreSQL 資料庫。

在 `app` 容器中，我們定義了 `SPRING_DATASOURCE_URL`、`SPRING_DATASOURCE_USERNAME` 和 `SPRING_DATASOURCE_PASSWORD` 這三個環境變數，以便 Spring Boot 應用程式可以連接到 PostgreSQL 資料庫。其中，`SPRING_DATASOURCE_URL` 的設定為 `jdbc:postgresql://db:5432/mydb`，這裡的 `db` 是指另一個容器的名稱，而 `mydb` 是資料庫的名稱。

在 `db` 容器中，我們使用了官方的 PostgreSQL 映像檔，並且定義了 `POSTGRES_USER`、`POSTGRES_PASSWORD` 和 `POSTGRES_DB` 這三個環境變數，以便初始化 PostgreSQL 資料庫。同時，我們將容器中的` /var/lib/postgresql/data` 目錄掛載到本機端的 `postgres-data` 卷上，以便在容器關閉後仍能保留資料。

最後，我們在 app 容器的 `depends_on` 中定義了 `db` 容器，以確保在啟動 `app` 容器之前，`db` 容器已經成功啟動。

這樣，您就可以在本地端使用 Spring Boot 和 PostgreSQL 來進行 AWS Lambda 的開發和測試了。

## 能用 aws-serverless-java-container-springboot2 創建一個專案讓我參考一下嗎

當然可以，以下是使用 aws-serverless-java-container-springboot2 創建 AWS Lambda 專案的步驟：

1. 首先，確認您已經安裝了 Java 和 Maven。可以通過在終端機上執行以下命令來檢查：

java -version
mvn -version

2. 接下來，使用 Maven Archetype 插件創建一個新的 Maven 專案。在終端機上執行以下命令：

mvn archetype:generate \
-DgroupId=com.example \
-DartifactId=my-lambda \
-DarchetypeGroupId=com.amazonaws.serverless.archetypes \
-DarchetypeArtifactId=aws-serverless-java-container-springboot2 \
-DinteractiveMode=false

在這個命令中，我們使用了 `aws-serverless-java-container-springboot2` 這個 Maven Archetype，並且指定了 `groupId`、`artifactId` 和互動模式。

3. 進入創建的專案目錄中：

cd my-lambda

4. 打開 `src/main/java/com/example/HelloHandler.java` 文件，將它修改為以下代碼：

package com.example;

import com.amazonaws.services.lambda.runtime.Context;
import com.amazonaws.services.lambda.runtime.RequestHandler;
import com.amazonaws.services.lambda.runtime.events.APIGatewayProxyRequestEvent;
import com.amazonaws.services.lambda.runtime.events.APIGatewayProxyResponseEvent;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HelloHandler implements RequestHandler<APIGatewayProxyRequestEvent, APIGatewayProxyResponseEvent> {

	@GetMapping("/")
	public ResponseEntity<String> handleRequest(APIGatewayProxyRequestEvent request, Context context) {
		String message = "Hello, World!";
		return ResponseEntity.ok(message);
	}
}

在這個代碼中，我們定義了一個 REST API，當收到 HTTP GET 請求時，返回一個包含 "Hello, World!" 的 HTTP 响應。

5. 最後，使用 Maven `package` 命令打包應用程式：

mvn package

這個命令會生成一個 `my-lambda-1.0-SNAPSHOT.jar` 文件，這個文件就是可以上傳到 AWS Lambda 中執行的代碼。

希望這個範例可以幫助到您。如果您想進一步了解如何使用 AWS Lambda 和 Spring Boot 開發應用程式，可以參考 AWS 的官方文檔和範例程式碼。

## 你能把以上的專案在 GitHub 上創建一個 repository 供我日後參考嗎

當然可以！以下是在 GitHub 上創建一個 repository 的步驟：

1. 在 GitHub 上創建一個新的 repository。

2. 在終端機上，將本地專案目錄與新創建的 repository 關聯起來。假設您的 repository 網址是 `https://github.com/your-username/my-lambda.git`，請在終端機上執行以下命令：

git remote add origin https://github.com/your-username/my-lambda.git

3. 將本地代碼提交到 repository 中。在終端機上執行以下命令：

git add .
git commit -m "Initial commit"
git push -u origin main

現在，您的代碼已經被推送到 GitHub 上的 repository 中了。您可以在 GitHub 上檢視您的代碼，並且通過 `git push` 命令更新它。

希望這個步驟對您有所幫助！

## 我希望你幫我完成這件事

非常抱歉，作為一個 AI 模型，我無法幫助您在 GitHub 上創建 repository。不過，這是一個相對簡單的任務，您可以通過以下步驟完成：

1. 前往 GitHub 網站，並登錄您的帳戶。

2. 點擊右上角的加號，然後選擇 "New repository"。

3. 在 "Repository name" 欄位中輸入您的 repository 名稱，然後選擇是要建立公開 repository 還是私人 repository。

4. 可選擇輸入描述及選擇授權協議等設定。

5. 點擊 "Create repository" 即可完成創建。

6. 接下來，在終端機上，將本地專案目錄與新創建的 repository 關聯起來，具體的命令可以參考前面的步驟2。

7. 最後，將本地代碼提交到 repository 中，具體的命令可以參考前面的步驟3。

希望這個步驟對您有所幫助！