# easy-statemachine

**Repository Path**: openquartz/easy-statemachine

## Basic Information

- **Project Name**: easy-statemachine
- **Description**: 一款轻量级，高性能的状态机框架
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: https://openquartz.github.io/
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 0
- **Created**: 2024-10-28
- **Last Updated**: 2025-06-10

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Easy-Statemachine
> **注意**：本项目未发布到maven中央仓库，需要手动添加到本地仓库 或者 到私有仓库中使用。

一款简单易用的轻量级状态机框架。基于COLA StateMachine实现。

## 核心概念
- State: 状态
- Transition: 状态转移
    - InitTransitionBuilder: 初始化状态转移。（null -> 初始化状态）
    - ExternalTransitionBuilder: 外部状态转移。(非初始化状态 -> 目标状态)
    - InternalTransitionBuilder: 内部状态转移。(非初始化状态 -> 非初始化状态)
- EventStateMachine: 状态机

## 快速开始

### 入口代码

`com.openquartz.easystatemachine.builder.StateMachineBuilderFactory`

#### 1、声明

```java
StateMachineBuilderFactory.declare(PriceAdjustmentTaskStatusEnum.class);
```

#### 2、指定开始状态与结束状态

```java
       StateMachineBuilder<PriceAdjustmentTaskStatusEnum, PriceAdjustmentTaskEventEnum, Context> builder =
    StateMachineBuilderFactory.<PriceAdjustmentTaskStatusEnum, PriceAdjustmentTaskEventEnum, Context>declare(PriceAdjustmentTaskStatusEnum.class)
        .end(Closed)
        .create();
```

#### 3、构建状态机
```java


        builder.externalTransition()
            .from(None)
            .to(Supplier_Processing)
            .on(Create)
            .when(checkCondition())
            .perform(doAction());

        // 商家调价
        Stream.of(Supplier_Processing, Supplier_Manager_Processing, Price_Manager_Processing)
            .forEach(status ->
                builder.externalTransition()
                    .from(status)
                    .to(Closed)
                    .on(Supplier_Agree)
                    .when(checkCondition())
                    .perform(doAction())
            );

        // 商家 -上升至-> 控商小二
        builder.externalTransition()
            .from(Supplier_Processing)
            .to(Supplier_Manager_Processing)
            .on(Supplier_Reject)
            .when(checkCondition())
            .perform(doAction());

        builder.externalTransition()
            .from(Supplier_Processing)
            .to(Supplier_Manager_Processing)
            .on(Supplier_Timeout)
            .when(checkCondition())
            .perform(doAction());

        // 申请申请高于P0售卖
        builder.externalTransition()
            .from(Supplier_Manager_Processing)
            .to(Price_Manager_Processing)
            .on(Apply_Over_P0_Sell)
            .when(checkCondition())
            .perform(doAction());

        // 同意高于P0价售卖
        builder.externalTransition()
            .from(Price_Manager_Processing)
            .to(Closed)
            .on(Agree_Over_P0_Sell)
            .when(checkCondition())
            .perform(doAction());

        // 拒绝高于P0价售卖
        builder.externalTransition()
            .from(Price_Manager_Processing)
            .to(Supplier_Manager_Processing)
            .on(Reject_Over_P0_Sell)
            .when(checkCondition())
            .perform(doAction());

        // 普通字段更新事件
        Stream.of(Supplier_Processing, Supplier_Manager_Processing, Price_Manager_Processing)
            .forEach(status -> builder
                .internalTransition()
                .within(status)
                .on(Normal_Update)
                .when(checkCondition())
                .perform(doAction())
            );

        // P0价变更事件、页面价高于合理价事件
        Stream.of(P0_Changed, Page_Price_changed)
            .forEach(event -> builder.externalTransitions()
                .fromAmong(Supplier_Processing, Supplier_Manager_Processing, Price_Manager_Processing)
                .to(Closed)
                .on(event)
                .when(checkCondition())
                .perform(doAction()));
```

#### 4、创建状态机
```java
    StateMachine<PriceAdjustmentTaskStatusEnum, PriceAdjustmentTaskEventEnum, Context> stateMachine =
            builder.build("AdjustPriceTask");
```

#### 5、输出状态机图
```java
stateMachine.show(Visitor.PLANT_UML);
```
得到plantuml格式的图 ![UML状态机](./doc/image/uml.png)
```puml

@startuml
[*] --> None
Price_Manager_Processing --> Closed : Supplier_Agree
Price_Manager_Processing --> Supplier_Manager_Processing : Reject_Over_P0_Sell
Price_Manager_Processing --> Closed : Page_Price_changed
Price_Manager_Processing --> Closed : P0_Changed
Price_Manager_Processing --> Closed : Agree_Over_P0_Sell
Price_Manager_Processing --> Price_Manager_Processing : Normal_Update
Supplier_Processing --> Closed : Supplier_Agree
Supplier_Processing --> Supplier_Manager_Processing : Supplier_Timeout
Supplier_Processing --> Closed : Page_Price_changed
Supplier_Processing --> Closed : P0_Changed
Supplier_Processing --> Supplier_Processing : Normal_Update
Supplier_Processing --> Supplier_Manager_Processing : Supplier_Reject
Supplier_Manager_Processing --> Closed : Supplier_Agree
Supplier_Manager_Processing --> Price_Manager_Processing : Apply_Over_P0_Sell
Supplier_Manager_Processing --> Closed : Page_Price_changed
Supplier_Manager_Processing --> Closed : P0_Changed
Supplier_Manager_Processing --> Supplier_Manager_Processing : Normal_Update
None --> Supplier_Processing : Create
Closed --> [*]
@enduml

```

#### 6、触发状态机
```java
 stateMachine.fireEvent(None, Normal_Update, new Context());
```
触发开始初始化的状态机
```java
 stateMachine.startEvent(None, Normal_Update, new Context());
```