Création d'une machine à états d'activité à l'aide de Step Functions - AWS Step Functions

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Création d'une machine à états d'activité à l'aide de Step Functions

Ce didacticiel explique comment créer une machine d'état basée sur les activités à l'aide de Java et AWS Step Functions. Les activités vous permettent de contrôler le code de travail qui s'exécute ailleurs depuis votre machine d'état. Pour accéder à une présentation, consultez En savoir plus sur les activités dans Step Functions dans En savoir plus sur les machines à états dans Step Functions.

Pour suivre ce didacticiel, vous aurez besoin des éléments suivants :

  • Le SDKpour Java. L'exemple d'activité présenté dans ce didacticiel est une application Java qui utilise AWS SDK for Java pour communiquer avec AWS.

  • AWS informations d'identification dans l'environnement ou dans la norme AWS fichier de configuration. Pour plus d'informations, voir Configurer votre AWS Informations d'identification dans le AWS SDK for Java Guide du développeur.

Étape 1 : Créer une activité

Vous devez informer Step Functions de l'activité dont vous souhaitez créer le worker (un programme). Step Functions répond par un Amazon Resource Name (ARN) qui définit l'identité de l'activité. Utilisez cette identité pour coordonner les informations transmises entre votre machine d'état et l'application de travail.

Important

Assurez-vous que votre tâche d'activité est identique AWS compte en tant que machine d'État.

  1. Dans la console Step Functions, dans le volet de navigation de gauche, choisissez Activities.

  2. Choisissez Create activity (Créer une activité).

  3. Entrez un nom pour l'activité, par exempleget-greeting, puis choisissez Créer une activité.

  4. Lorsque votre tâche d'activité est créée, notez-laARN, comme indiqué dans l'exemple suivant.

    arn:aws:states:us-east-1:123456789012:activity:get-greeting

Étape 2 : Création d'une machine à états

Créez une machine d'état qui détermine à quel moment votre activité est appelée et à quel moment votre application de travail doit effectuer son travail principal, collecter ses résultats et les renvoyer. Pour créer la machine à états, vous allez utiliser Workflow Studio. Éditeur de code

  1. Dans la console Step Functions, dans le volet de navigation de gauche, choisissez State machines.

  2. Sur la page State machines, choisissez Create state machine.

  3. Dans la boîte de dialogue Choisir un modèle, sélectionnez Vide.

  4. Choisissez Sélectionner pour ouvrir Workflow Studio dansMode de conception.

  5. Pour ce didacticiel, vous allez écrire la définition Amazon States Language (ASL) de votre machine à états dans l'éditeur de code. Pour ce faire, sélectionnez Code.

  6. Supprimez le code standard existant et collez le code suivant. N'oubliez pas de remplacer l'exemple ARN de ce code par celui ARN de la tâche d'activité que vous avez créée précédemment dans le Resource champ.

    { "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 } } }

    Il s'agit d'une description de votre machine à états utilisant le Amazon States Language (ASL). Elle décrit un seul état Task nommé getGreeting. Pour plus d'informations, consultez Structure de la machine d'état.

  7. Sur leVisualisation de graphe, assurez-vous que le graphique du flux de travail correspondant à la ASL définition que vous avez ajoutée ressemble au graphique suivant.

    Visualisation graphique de la machine à états avec l'état des RunActivity tâches.
  8. Spécifiez un nom pour votre machine à états. Pour ce faire, cliquez sur l'icône d'édition à côté du nom de la machine à états par défaut de MyStateMachine. Ensuite, dans Configuration de la machine d'état, spécifiez un nom dans le champ Nom de la machine d'état.

    Pour ce didacticiel, saisissez le nom ActivityStateMachine.

  9. (Facultatif) Dans Configuration de la machine à états, spécifiez d'autres paramètres de flux de travail, tels que le type de machine à états et son rôle d'exécution.

    Pour ce didacticiel, conservez toutes les sélections par défaut dans les paramètres State Machine.

    Si vous avez déjà créé un IAM rôle avec les autorisations appropriées pour votre machine d'état et que vous souhaitez l'utiliser, dans Autorisations, sélectionnez Choisir un rôle existant, puis sélectionnez un rôle dans la liste. Vous pouvez également sélectionner Entrer un rôle, ARN puis fournir un ARN pour ce IAM rôle.

  10. Dans la boîte de dialogue Confirmer la création du rôle, choisissez Confirmer pour continuer.

    Vous pouvez également choisir Afficher les paramètres des rôles pour revenir à la configuration de la machine State.

    Note

    Si vous supprimez le IAM rôle créé par Step Functions, Step Functions ne pourra pas le recréer ultérieurement. De même, si vous modifiez le rôle (par exemple, en supprimant Step Functions des principes de la IAM politique), Step Functions ne pourra pas restaurer ses paramètres d'origine ultérieurement.

Étape 3 : Implémentation d'une application de travail

Créez une application de travail. Une application de travail est un programme qui a en charge les opérations suivantes :

  • Polling Step Functions pour les activités utilisant l'GetActivityTaskAPIaction.

  • Exécution du travail de l'activité à l'aide de votre code (par exemple, la méthode getGreeting() dans le code ci-dessous).

  • Renvoyer les résultats à l'aide des SendTaskHeartbeat API actions SendTaskSuccessSendTaskFailure, et.

Note

Pour obtenir un exemple plus complet d'un travail d'activité, consultez Exemple : Activity Worker dans Ruby. Cet exemple fournit une implémentation basée sur les bonnes pratiques, qui peut être utilisée comme référence pour l'application de travail de votre activité. Le code implémente un modèle consommateur-producteur avec un nombre configurable de threads pour les observateurs et les travaux d'activité.

Pour implémenter l'application de travail

  1. Créez un fichier nommé GreeterActivities.java.

  2. Ajoutez-lui le code suivant.

    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); } } } }
    Note

    La classe EnvironmentVariableCredentialsProvider de cet exemple suivant suppose que les variables d'environnement AWS_ACCESS_KEY_ID (ou AWS_ACCESS_KEY) et AWS_SECRET_KEY (ou AWS_SECRET_ACCESS_KEY) sont définies. Pour plus d'informations sur la fourniture des informations d'identification requises à l'usine, consultez AWSCredentialsProviderle AWS SDK for Java APIRéférence et configuration AWS Compétences et région pour le développement dans le AWS SDK for Java Guide du développeur.

    Par défaut, AWS SDKattendra jusqu'à 50 secondes pour recevoir les données du serveur pour toute opération. GetActivityTask est une opération d'attente active de longue durée qui attendra la prochaine tâche disponible pendant 60 secondes au maximum. Pour éviter de recevoir une SocketTimeoutException erreur, réglez SocketTimeout ce paramètre sur 70 secondes.

  3. Dans la liste des paramètres du GetActivityTaskRequest().withActivityArn() constructeur, remplacez la ACTIVITY_ARN valeur par celle de la tâche ARN d'activité que vous avez créée précédemment.

Étape 4 : Exécutez la machine d'état

Lorsque vous lancez l'exécution de la machine à états, votre assistant interroge Step Functions pour connaître les activités, effectue son travail (en utilisant les entrées que vous fournissez) et renvoie ses résultats.

  1. Dans la page ActivityStateMachinepage, choisissez Démarrer l'exécution.

    La boîte de dialogue Démarrer l'exécution s'affiche.

  2. Dans la boîte de dialogue Démarrer l'exécution, procédez comme suit :

    1. (Facultatif) Entrez un nom d'exécution personnalisé pour remplacer le nom par défaut généré.

      ASCIINon-noms et journalisation

      Step Functions accepte les noms des machines d'état, des exécutions, des activités et des étiquettes contenant des caractères autres que des ASCII caractères. Comme ces caractères ne fonctionneront pas avec Amazon CloudWatch, nous vous recommandons de n'utiliser que des ASCII caractères afin de pouvoir suivre les statistiques CloudWatch.

    2. Dans la zone de saisie, entrez l'JSONentrée suivante pour exécuter votre flux de travail.

      { "who": "AWS Step Functions" }
    3. Choisissez Start execution (Démarrer l'exécution).

    4. La console Step Functions vous dirige vers une page intitulée avec votre ID d'exécution. Cette page est connue sous le nom de page Détails de l'exécution. Sur cette page, vous pouvez consulter les résultats de l'exécution au fur et à mesure que l'exécution progresse ou une fois celle-ci terminée.

      Pour consulter les résultats de l'exécution, choisissez des états individuels dans la vue graphique, puis choisissez les onglets individuels du Détails de l'étape volet pour afficher les détails de chaque état, y compris les entrées, les sorties et la définition respectivement. Pour plus de détails sur les informations d'exécution que vous pouvez consulter sur la page Détails de l'exécution, voirVue d'ensemble des détails d'exécution.

Étape 5 : Exécuter et arrêter l'application de travail

Pour que l'application de travail interroge les activités de votre machine d'état, vous devez exécuter l'application de travail.

  1. Sur la ligne de commande, accédez au répertoire dans lequel vous avez créé GreeterActivities.java.

  2. Pour utiliser le plugin AWS SDK, ajoutez le chemin complet des third-party répertoires lib et aux dépendances de votre fichier de compilation et à votre JavaCLASSPATH. Pour plus d'informations, voir Téléchargement et extraction SDK du AWS SDK for Java Guide du développeur.

  3. Compilez le fichier.

    $ javac GreeterActivities.java
  4. Exécutez le fichier .

    $ java GreeterActivities
  5. Sur la console Step Functions, accédez à la page Détails de l'exécution.

  6. Lorsque l'exécution est terminée, examinez les résultats de votre exécution.

  7. Arrêtez l'application de travail.