Un diagramme de séquence est un diagramme qui montre les interactions entre les entités lors d’une séquence de la vie de ces entités. Cela permet de voir qui fait quoi et qui dépend de quoi.
On utilisera ce diagramme pour représenté un morceau du code de manière très high level. Même si de la logique y est représenté, il n’est pas fait pour montrer des algorithmes complexes, pour ça nous utiliserons plutôt le Diagramme de flux.
Instance et Lignes de vie
Pour représenté les entités d’un programme, on les représentera par un rectangle dans lequel on notera sont nom suivit d’un ”:” et de la classe dont elle est l’instance.
Chaque entité aura une ligne de vie, qui montre quand elle commence à exister et quand elle s’arrête d’exister.
Voici un exemple de diagramme de séquence où l’on voit que apple est créer par tree et détruit par kirby.
--- config: mirrorActors: false --- sequenceDiagram participant Kirby as kirby: Kirby participant AppleTree as tree: AppleTree create participant Apple as apple: Apple AppleTree->>Apple: produces destroy Apple Kirby-xApple: eats
Messages
Les interactions entre les entités seront représentées par des flêches. Comme on peut le voir avec le diagramme si dessus, les messages partent d’une ligne de vie, vers une autre.
Chaque message peut avoir une réponse. Par exemple si une fonction a un retour. La fonction sera le message et la réponse sera le retour.
Dans ce diagramme on peut voir qu’il est totalement possible qu’une entité s’envoie un message. Ici messageBox envoie le message Hide a elle-même.
Aussi, les lignes de vie d’une entité deviennent des rectangles lorsqu’un message leur est envoyé jusqu’au moment où la réponse est retournée. On appelle ça une activation, car l’entité en question est en train de traiter le message.
La réponse peut ne pas contenir d’information (comme une fonction qui retourne None ou void).
Synchrone et asynchrone
Il y a deux type de messages possibles:
- Des messages synchrone, qui suivent le cours du programme
- Des messages asynchrones qui eut sont sur des thread parallèles et qui donc ne seront pas assujetti à la procédure principale.
Les messages synchrones sont représentés par des flêches pleines
--- config: mirrorActors: false --- sequenceDiagram participant entity 1 participant entity 2 entity 1 ->> +entity 2: synchronous message entity 2 -->> -entity 1: synchronous answer
Les messages asynchrones eut sont représenté par des flêches en batons
--- config: mirrorActors: false --- sequenceDiagram participant entity 1 participant entity 2 entity 1 -) +entity 2: synchronous message entity 2 --) -entity 1: synchronous answer
Notez que la réponse est du même type que le message.
Activations multiples
--- config: mirrorActors: false --- sequenceDiagram actor administrator participant button as validationButton: Button participant userData as userData: UserData participant security as security: SecurityServer administrator->>+button : Click() button ->>+ userData : AskPermission() userData ->> +security : AskPermission(userId) security ->> +userData : GetGroupId() userData -->> -security : groupId security -->> -userData : validation userData -->> -button : deactivate button
Dans ce diagramme de séquence, on voit que userData est activé plusieurs fois. Une fois pour par validationButton et une autre par security. Comme ce sont deux activation distinct, on les représentes l’une sur l’autre.
Acteur
Dans le diagramme précédent, on constate qu’il y a une “entité” particulière représentée par un petit personnage en batons. C’est la représentation d’un acteur.
Il arrive souvent qu’un acteur (un utilisateur) soit le déclencheur de la séquence que l’on veut représenter.
Alt-ernative
Pour représenter une décision, le diagramme de séquence offre l’alternative et l’option.
L’alternative représente le faite d’avoir plusieurs options. L’alternative est représenté par un bloc alt
--- config: mirrorActors: false --- sequenceDiagram actor player participant view as view: GNInterface participant controller as controller: GuessTheNumber player->>+view: EnterPropostion() view->>+player: Input() player-->>-view: proposition view->>+controller: checkAnswer(userProposition) alt answer is lower controller-->>view: Answer.lower else answer is greater controller-->>view: Answer.greater else controller-->>view: Answer.exact deactivate controller end view->>view: print(answer) view-->>-player:
Le text entre crochet (comme [answer is lower]) est nommé gardien, car il représente la condition pour rentrer dans l’option désignée par la sous-partie.
Par exemple, ici on explique que si la réponse est plus petite on renvoie Answer.lower, sinon si la réponse est plus grande on renvoie Anwser.greater et sinon on renvoie Answer.exact.
L’absence de gardien marque le faite que c’est l’option par défaut (si toutes les autres ne sont pas possible). Evidemment, il peut ne pas y avoir d’option par défaut.
Opt-ion
Dans le même ordre d’idée que l’alternative, il y a l’option. Ce cadrant représente une seul option qui peut être réalisée ou non, comme un alt à un seul cadrant.
--- config: mirrorActors: false --- sequenceDiagram Participant controler as controler: Controler participant messageBox as messageBox: MessageBox participant logger as logger:Logger participant user as user: User controler->>+messageBox: display() messageBox->>+user: get_name() user-->>-messageBox: name opt debug activate messageBox->>+logger : GetLogs() logger-->>-messageBox: logs end messageBox->>messageBox : Hide(false) messageBox-->>-controler :
Loop
Il est aussi possible de représenter une boucle (peut importe laquelle).
Pour ça nous avons le cadrant loop.
--- config: mirrorActors: false --- sequenceDiagram actor player participant view as view: GNInterface participant controller as controller: GuessTheNumber player->>+view: Start() view->>+controller: StartGame() controller->>controller: ChooseRandomAnswer() controller-->>-view: view-->>-player: loop while anwser != Answer.exact player->>+view: EnterPropostion() view->>+player: Input() player-->>-view: proposition view->>+controller: checkAnswer(userProposition) alt answer is lower controller-->>view: Answer.lower else answer is greater controller-->>view: Answer.greater else controller-->>view: Answer.exact deactivate controller end view->>view: print(answer) view-->>-player: end
Le gardien de la loop représente la condition de boucle, si il est absent, cela représente une boucle infinie.
Hors du code
Il est clairement possible d’imaginer un diagramme de séquence pour représenter autre chose d’un programme informatique
On peut, par exemple imaginer des interaction entre personne.
Voici le diagramme de séquence symbolisant une partie d’Echecs.
--- config: mirrorActors: false --- sequenceDiagram actor p1 as player 1 actor p2 as player 2 participant clock participant chessboard p1->>+clock: active loop player 1 not checkmate and player 2 not checkmate and player 1 on clock and player 2 on clock p1->>+p1: think p1-->>-p1: opt player 1 on clock p1 ->> +chessboard: play chessboard-->>-p1: opt not player 2 checkmate p1 ->> clock: press end p2->>+p2: think p2-->>-p2: opt player 1 on clock p2 ->> +chessboard: play chessboard-->>-p2: opt not player 1 checkmate p2 ->> clock: press end end end end alt player 1 wins p2 ->>+ p1: congratulate p1 -->>- p2: says thanks else p1 ->>+ p2: congratulate p2 -->>- p1: says thanks end