Orientação gerada a partir de informações públicas. Apenas para referência.
Uma biblioteca Flutter/Dart para implementar máquinas de estado finitas, permitindo que desenvolvedores definam e gerenciem transições de estado legais com facilidade. Oferece mudanças de estado orientadas por eventos claras e suporta escuta de eventos de entrada, saída e transição de estado. Ideal para modelar fluxos de trabalho complexos onde a consistência do estado e o comportamento previsível são críticos. O pacote é independente de plataforma, suportando todas as principais plataformas do Flutter. Promove código limpo e sustentável ao desacoplar a lógica de estado dos componentes da interface.
Casos de uso
Gerenciando fluxos de usuário de múltiplos passos
Modelagem de estados do ciclo de vida do aplicativo
Gerenciamento de fluxos assíncronos
Implementando máquinas de estado de validação de formulários
Garantia da conformidade com regras de negócios
Principais recursos
Transições de estado acionadas por eventos
Callbacks para entrada/saída/transições de estado
Definições de estado seguras por tipo
Suporte a estados aninhados e hierárquicos
Design extensível e testável
Indicado para
Desenvolvedores construindo aplicativos complexos com estado
Equipes que precisam de gerenciamento de estado determinístico
Projetos que exigem auditoria de mudanças de estado
Aplicações com regras estritas de fluxo de trabalho
Considerações
Curva de aprendizado mais acentuada para iniciantes
Requer planejamento cuidadoso do gráfico de estado
Pode introduzir sobrecarga em cenários simples de estado
Integração de UI interna limitada
README original
Snapshot do README original do repositório-fonte vinculado. Consulte o repositório para o conteúdo mais recente.
Dart State Machine
Easily create a finite state machine and define legal state transitions. Listen to state entrances, departures, and transitions.
Getting Started
Import the state_machine package:
import'package:state_machine/state_machine.dart';
Create a Machine
Once created, the StateMachine will be used to create states and state transitions.
StateMachine light = newStateMachine('light');
Define a Set of States
Use the machine to create all required states. A string name is required for ease of debugging.
State isOn = light.newState('on');
State isOff = light.newState('off');
It's recommended that states be named in the format "is[State]".
This may seem strange at first, but it has two main benefits:
It helps differentiate states from transitions, which can be confusing
since many words in English are the same as a verb and an adjective
("open" or "secure", for example).
It reads better when calling the state to determine if it's active,
as will be demonstrated later.
Define the Legal State Transitions
By defining legal state transitions, you can prevent certain actions based on the current state of the machine.
Defining a state transition requires a name (again for ease of debugging), a list of valid "from" states, and
the state to transition the machine to.
The StateTransition class exposes a listen() method that allows you to listen to the transition and receive an
event every time the transition executes.
turnOn.listen((StateChange change) {
print('Light transitioned from ${change.from.name} to ${change.to.name}');
});
light.start(isOff);
turnOn(); // "Light transitioned from off to on"
Passing Data with a State Transition
State transitions accept an optional payload in case you need to pass data along to listeners.
turnOn.listen((StateChange change) {
print('Light turned on. Wattage: ${change.payload}');
});
light.start(isOff);
turnOn('15w'); // "Light turned on. Wattage: 15w"
Listening for State Entrances and Departures
The State class exposes two streams so that you can listen for the state being entered and the state being left.
The State class exposes a static instance State.any that can be used as a wildcard when defining a state transition.
StateMachine machine = newStateMachine('machine');
State isFailed = machine.newState('failed');
// This transition will be valid regardless of which state the machine is in.StateTransition fail = machine.newStateTransition('fail', [State.any], isFailed);
Illegal State Transitions
When you create state transitions, you must define the list of valid "from" states. The machine must be in one of these
states in order to execute the transition. If that's not the case, an IllegalStateTransition exception will be thrown.
// Consider a door with the following states and transitions.StateMachine door = newStateMachine('door');
State isOpen = door.newState('open');
State isClosed = door.newState('closed');
State isLocked = door.newState('locked');
StateTransition open = door.newStateTransition('open', [isClosed], isOpen);
StateTransition close = door.newStateTransition('close', [isOpen], isClosed);
StateTransition lock = door.newStateTransition('lock', [isClosed], isLocked);
StateTransition unlock = door.newStateTransition('unlock', [isLocked], isClosed);
// Let's transition the door from open, to closed, to locked.
door.start(isOpen);
close();
lock();
// In order to open the door, we must first unlock it.// If we try to open it first, an exception will be thrown.open(); // throws IllegalStateTransition
Canceling State Transitions
State machines have a set of legal state transitions that are set in stone and provide the required structure.
But, there may be scenarios where a state transition may or may not be desirable based on additional logic.
To handle this, state transitions support cancellation conditions.
// Consider two state machines - a person and a door.// The door can be locked or unlocked and the person// can be with or without a key.StateMachine door = newStateMachine('door');
State isLocked = door.newState('locked');
State isUnlocked = door.newState('unlocked');
StateTransition unlock = door.newStateTransition('unlock', [isLocked], isUnlocked);
StateMachine person = newStateMachine('person');
State isWithKey = person.newState('withKey');
State isWithoutKey = person.newState('withoutKey');
StateTransition obtainKey = person.newStateTransition('obtainKey', [isWithoutKey], isWithKey);
door.start(isLocked);
person.start(isWithoutKey);
// Add a cancellation condition for unlocking the door:// If the person is without a key, cancel the unlock transition.
unlock.cancelIf((StateChange change) => isWithoutKey());
unlock(); // false (canceled)isUnlocked(); // falseobtainKey();
unlock(); // true (not canceled)isUnlocked(); // true
Example
To run the example:
dart pub global activate webdev
webdev serve example:8080
open http://localhost:8080/