本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
使用 Step Functions 創建活動狀態機
本教程向您展示如何使用 Java 和創建基於活動的狀態機 AWS Step Functions。 活動可讓您控制從狀態機器執行的其他位置的 Worker 程式碼。如需概觀,請參閱 在 Step Functions 中了解狀態機 中的 瞭解 Step Functions 中的活動。
為了完成本教學,您需要以下項目:
步驟 1:建立活動
您必須讓 Step Functions 知道您要建立其 Worker (程式) 的活動。Step Functions 會使用建立活動身分的 Amazon 資源名稱 (ARN) 回應。使用此身分來協調狀態機器和工作者之間傳遞的資訊。
重要
確保您的活動任務處於相同狀態 AWS 帳戶作為您的狀態機。
-
在「Step Functions」主控台
的左側導覽窗格中,選擇「活動」。 -
選擇 Create activity (建立活動)。
-
輸入活動的 [名稱],例如
,然後選擇 [建立活動]。get-greeting
-
當您建立活動任務時,請記下它ARN,如下列範例所示。
arn:aws:states:us-east-1:123456789012:activity:get-greeting
步驟 2:建立狀態機
建立狀態機器以決定何時呼叫您的活動,以及您的工作者何時應執行其主要工作、收集並傳回結果。若要建立狀態機,您將使用程式碼編輯器的工作流程工作室。
-
在 [Step Functions] 主控台
的左側導覽窗格中,選擇 [狀態機器]。 -
在 [狀態機器] 頁面上,選擇 [建立狀態機器]。
-
在「選擇範本」對話方塊中,選取「空白」。
-
選擇選取以在中開啟工作流程工作室設計模式。
-
在本教程中,您將在代碼編輯器中編寫狀態機的Amazon States Language(ASL)定義。若要這麼做,請選擇 [程式碼]。
-
刪除現有的樣板代碼並粘貼以下代碼。請記得將此程式碼ARN中ARN的範例取代為您先前在Resource欄位中建立的活動任務。
{ "Comment": "An example using a Task state.", "StartAt": "getGreeting", "Version": "1.0", "TimeoutSeconds": 300, "States": { "getGreeting": { "Type": "Task", "Resource": "
arn:aws:states:us-east-1:123456789012:activity:get-greeting
", "End": true } } }這是使用Amazon States Language(ASL)對狀態機的描述。它定義名為
getGreeting
的單一Task
狀態。如需詳細資訊,請參閱狀態機器結構。 -
在上圖形視覺化,請確ASL定您新增之定義的工作流程圖看起來與下圖類似。
-
指定狀態機的名稱。若要執行此操作,請選擇的預設狀態機器名稱旁邊的編輯圖示MyStateMachine。然後,在 [狀態機器組態] 中,在 [狀態機器名稱] 方塊中指定名稱。
針對本教學課程,輸入名稱
ActivityStateMachine
。 -
(選擇性) 在狀態機器組態中,指定其他工作流程設定,例如狀態機器類型及其執行角色。
在本教學課程中,請保留狀態機器設定中的所有預設選項。
如果您先前已建立具有狀態機器正確權限的IAM角色,並想要使用它,請在 [權限] 中選取 [選擇現有角色],然後從清單中選取角色。或選取 [輸入角色],ARN然後ARN為該IAM角色提供。
-
在 [確認角色建立] 對話方塊中,選擇 [確認] 以繼續。
您也可以選擇 [檢視角色設定] 以返回 [狀態機器組態]。
注意
如果刪除 Step Functions 所建立的IAM角色,則 Step Functions 稍後無法重新建立。同樣地,如果您修改角色 (例如,從原則中的主參與者中移除 Step Functions),IAM則 Step Functions 稍後無法還原其原始設定。
步驟 3:實作工作者
建立工作者。工作者是一種程式,負責:
-
使用動
GetActivityTask
API作之活動的輪詢 Step Functions。 -
使用您的程式碼執行活動工作 (例如,以下程式碼中的
getGreeting()
方法)。 -
使用
SendTaskSuccess
、SendTaskFailure
和SendTaskHeartbeat
API動作傳回結果。
注意
如需活動工作者的更完整範例,請參閱 範例:Ruby 中的活動工作者。此範例根據最佳實務提供實作,可供您的活動工作者參考。此程式碼會實作可為輪詢器和活動工作者設定執行緒數量的消費者-生產者模式。
實作工作者
-
建立名為
GreeterActivities.java
的檔案。 -
新增以下程式碼至其中。
import com.amazonaws.ClientConfiguration; import com.amazonaws.auth.EnvironmentVariableCredentialsProvider; import com.amazonaws.regions.Regions; import com.amazonaws.services.stepfunctions.AWSStepFunctions; import com.amazonaws.services.stepfunctions.AWSStepFunctionsClientBuilder; import com.amazonaws.services.stepfunctions.model.GetActivityTaskRequest; import com.amazonaws.services.stepfunctions.model.GetActivityTaskResult; import com.amazonaws.services.stepfunctions.model.SendTaskFailureRequest; import com.amazonaws.services.stepfunctions.model.SendTaskSuccessRequest; import com.amazonaws.util.json.Jackson; import com.fasterxml.jackson.databind.JsonNode; import java.util.concurrent.TimeUnit; public class GreeterActivities { public String getGreeting(String who) throws Exception { return "{\"Hello\": \"" + who + "\"}"; } public static void main(final String[] args) throws Exception { GreeterActivities greeterActivities = new GreeterActivities(); ClientConfiguration clientConfiguration = new ClientConfiguration(); clientConfiguration.setSocketTimeout((int)TimeUnit.SECONDS.toMillis(70)); AWSStepFunctions client = AWSStepFunctionsClientBuilder.standard() .withRegion(Regions.US_EAST_1) .withCredentials(new EnvironmentVariableCredentialsProvider()) .withClientConfiguration(clientConfiguration) .build(); while (true) { GetActivityTaskResult getActivityTaskResult = client.getActivityTask( new GetActivityTaskRequest().withActivityArn(ACTIVITY_ARN)); if (getActivityTaskResult.getTaskToken() != null) { try { JsonNode json = Jackson.jsonNodeOf(getActivityTaskResult.getInput()); String greetingResult = greeterActivities.getGreeting(json.get("who").textValue()); client.sendTaskSuccess( new SendTaskSuccessRequest().withOutput( greetingResult).withTaskToken(getActivityTaskResult.getTaskToken())); } catch (Exception e) { client.sendTaskFailure(new SendTaskFailureRequest().withTaskToken( getActivityTaskResult.getTaskToken())); } } else { Thread.sleep(1000); } } } }
注意
此範例中的
EnvironmentVariableCredentialsProvider
類別假設已設定AWS_ACCESS_KEY_ID
(或AWS_ACCESS_KEY
) 和AWS_SECRET_KEY
(或AWS_SECRET_ACCESS_KEY
) 環境變數。如需將所需認證提供給工廠的詳細資訊,請參閱AWSCredentialsProvider中的 AWS SDK for Java API參考與設定 AWS 認證和發展區域 AWS SDK for Java 開發人員指南。默認情況下 AWS SDK將等待最多 50 秒,從服務器接收任何操作的數據。此
GetActivityTask
操作是長時間輪詢操作,將等待最多 60 秒,以取得下一個可用任務。若要避免收到SocketTimeoutException
錯誤訊息, SocketTimeout 請設定為 70 秒。 -
在建
GetActivityTaskRequest().withActivityArn()
構函式的參數清單中,將ACTIVITY_ARN
值取代為您先前建立ARN的活動工作的值。
步驟 4:運行狀態機
當您開始執行狀態機器時,Worker 會輪詢 Step Functions 的活動,執行其工作 (使用您提供的輸入),並傳回其結果。
-
在「」
ActivityStateMachine
頁面上,選擇開始執行。此時會顯示「開始執行」對話方塊。
-
在 [開始執行] 對話方塊中,執行下列動作:
-
(選擇性) 輸入自訂執行名稱,以覆寫產生的預設值。
非ASCII名稱和記錄
Step Functions 接受包含非ASCII字元的狀態機器、執行項目、活動和標籤的名稱。由於此類字元不適用於 Amazon CloudWatch,因此我們建議您僅使用ASCII字元,以便在中追蹤指標 CloudWatch。
-
在「輸入」方塊中,輸入以下JSON輸入以執行工作流程。
{ "who": "AWS Step Functions" }
-
選擇 Start execution (開始執行)。
-
Step Functions 主控台會將您導向至標題為執行 ID 的頁面。此頁面稱為「執行詳細資訊」頁面。在此頁面上,您可以在執行進行時或完成之後複查執行結果。
若要複查執行結果,請在「圖形」檢視中選擇個別狀態,然後選擇步驟詳情窗格上的個別索引標籤,分別檢視每個狀態的詳細資訊,包括輸入、輸出和定義。如需有關可在「執行詳細資訊」頁面檢視之執行資訊的詳細資訊,請參閱執行細節概述。
-
步驟 5:執行和停用工作者
若要讓工作者輪詢您的活動狀態機器,您必須執行工作者。
-
在命令列上,導覽至您建立
GreeterActivities.java
的目錄。 -
若要使用 AWS SDK,將
lib
和third-party
目錄的完整路徑添加到構建文件的依賴項和 Java 中CLASSPATH
。如需詳細資訊,請參閱SDK中的下載和解壓縮 AWS SDK for Java 開發人員指南。 -
編譯檔案。
$ javac GreeterActivities.java
-
執行 檔案。
$ java GreeterActivities
-
在「Step Functions」主控台
上,瀏覽至「執行詳細資訊」頁面。 -
執行完成時,請檢查執行結果。
-
停用工作者。