JAVA-stateless4j StateMachine从入门到实战

简介: JAVA-stateless4j StateMachine从入门到实战

1、入门

1.1、为什么引入有限状态机?

最近做一个项目,项目中很多实体(Entity),每个实体都有很多状态(State),各状态会经过不同事件(Event)触发后转换到另一个状态。这些事件包括但不限于:用户页面点击触发,生效时间或失效时间到达,其他依赖实体状态变更等。在状态变更后还会有一系列动作(Action)处理一旦相互依赖实体或实体本身状态增多,状态转换变多,处理这些状态的业务代码也会分散在各处,代码处理很容易漏掉,维护成本很高。所以考虑引入有限状态机。

1.2、什么是有限状态机?

有限状态机,也称为FSM(Finite State Machine),其在任意时刻都处于有限状态集合中的某一状态。当其获得一个输入字符时,将从当前状态转换到另一个状态,或者仍然保持在当前状态。任何一个FSM都可以用状态转换图来描述,图中的节点表示FSM中的一个状态,有向(方向表示从一个初态转换到次态)加权(权表示事件)边表示输入字符时状态的变化。如果图中不存在与当前状态与输入字符对应的有向边,则FSM将进入“消亡状态(Doom State)”,此后FSM将一直保持“消亡状态”。状态转换图中还有两个特殊状态:状态1称为“起始状态”,表示FSM的初始状态。状态6称为“结束状态”。

在启动一个FSM时,首先必须将FSM置于“起始状态”,然后触发一系列时间,最终,FSM会到达“结束状态”或者“消亡状态”。

说明:

在通常的FSM模型中,一般还存在一个“接受状态”,并且FSM可以从“接受状态”转换到另一个状态,只有在识别最后一个字符后,才会根据最终状态来决定是否接受所输入的字符串。此外,也可以将“起始状态”也作为接受状态,因此空的输入序列也是可以接受的。

TCP协议中的有限状态机

1.3、状态机要素

状态机可归纳为4个要素,即现态、条件、动作、次态。“现态”和“条件”是因,“动作”和“次态”是果。详解如下:

①现态:是指当前所处的状态。

②条件:又称为“事件”。当一个条件被满足,将会触发一个动作,或者执行一次状态的迁移。

③动作:条件满足后执行的动作。动作执行完毕后,可以迁移到新的状态,也可以仍旧保持原状态。动作不是必需的,当条件满足后,也可以不执行任何动作,直接迁移到新状态。

④次态:条件满足后要迁往的新状态。“次态”是相对于“现态”而言的,“次态”一旦被激活,就转变成新的“现态”了。

我们可以用状态表了表示整个过程,如下图所示。

2. 有限状态机表示方法

①状态转换图,例如图1

②状态转换表,例如图2

2、实战

有限状态机实现方式

2.1. Java switch case 或者 Scala 模式匹配实现
2.2、Java枚举实现

Java枚举实现有限状态机

2.3、设计模式:状态模式实现
2.4、使用stateless4j实现

github地址

使用浅析1

使用浅析2

使用浅析3

2.5、Spring Statemachine实现

github地址

2.6、Akka FSM 状态机实现

github地址

2.7、通过squirrel-foundation实现

github地址

自己做了些实例及封装

3、在项目中的应用

3.1 状态机在商品状态的转换

业务场景:

/**
 * 商品审核状态枚举
 */
public enum GoodsAuditStateEnum {
    // 商品审核状态
    NORMAL(0, "正常"),
    IN_CREATE(1, "申请新增中"),
    IN_UPDATE(2, "申请变更中"),
    IN_DELETE(3, "申请删除中"),
    IN_ON_SHELF(4, "申请上架中"),
    IN_UNDER_SHELF(5, "申请下架中"),
    IN_FROZEN(6, "申请冻结中"),
    IN_UNFREEZE(7, "申请解冻中");
}
/**
 * 触发动作
 */
 private enum Trigger {
     CREATE,
     UPDATE,
     DELETE,
     ON_SHELF,
     UNDER_SHELF,
     FROZEN,
     UNFREEZE,
     PASS,
     REJECT,
     REVOKE
 }
package cn.gov.zcy.service.agreement.item.fsm;
import cn.gov.zcy.service.agreement.item.enums.GoodsAuditStateEnum;
import com.googlecode.stateless4j.StateMachine;
import io.terminus.common.exception.ServiceException;
import lombok.extern.slf4j.Slf4j;
/**
 * 商品审核状态机
 */
@Slf4j
public class GoodsAuditStateFSM {
  private StateMachine<GoodsAuditStateEnum, GoodsAuditStateFSM.Trigger> stateMachine;
  private GoodsAuditStateFSM(GoodsAuditStateEnum state) throws Exception {
        this.stateMachine = new StateMachine<>(state);
    stateMachine.Configure(GoodsAuditStateEnum.IN_CREATE).Permit(Trigger.PASS, GoodsAuditStateEnum.NORMAL).Permit(Trigger.REJECT, GoodsAuditStateEnum.NORMAL).Permit(Trigger.REVOKE, GoodsAuditStateEnum.NORMAL);
        stateMachine.Configure(GoodsAuditStateEnum.IN_UPDATE).Permit(Trigger.PASS, GoodsAuditStateEnum.NORMAL).Permit(Trigger.REJECT, GoodsAuditStateEnum.NORMAL).Permit(Trigger.REVOKE, GoodsAuditStateEnum.NORMAL);
        stateMachine.Configure(GoodsAuditStateEnum.IN_DELETE).Permit(Trigger.PASS, GoodsAuditStateEnum.NORMAL).Permit(Trigger.REJECT, GoodsAuditStateEnum.NORMAL).Permit(Trigger.REVOKE, GoodsAuditStateEnum.NORMAL);
        stateMachine.Configure(GoodsAuditStateEnum.IN_ON_SHELF).Permit(Trigger.PASS, GoodsAuditStateEnum.NORMAL).Permit(Trigger.REJECT, GoodsAuditStateEnum.NORMAL).Permit(Trigger.REVOKE, GoodsAuditStateEnum.NORMAL);
        stateMachine.Configure(GoodsAuditStateEnum.IN_UNDER_SHELF).Permit(Trigger.PASS, GoodsAuditStateEnum.NORMAL).Permit(Trigger.REJECT, GoodsAuditStateEnum.NORMAL).Permit(Trigger.REVOKE, GoodsAuditStateEnum.NORMAL);
        stateMachine.Configure(GoodsAuditStateEnum.IN_FROZEN).Permit(Trigger.PASS, GoodsAuditStateEnum.NORMAL).Permit(Trigger.REJECT, GoodsAuditStateEnum.NORMAL).Permit(Trigger.REVOKE, GoodsAuditStateEnum.NORMAL);
        stateMachine.Configure(GoodsAuditStateEnum.IN_UNFREEZE).Permit(Trigger.PASS, GoodsAuditStateEnum.NORMAL).Permit(Trigger.REJECT, GoodsAuditStateEnum.NORMAL).Permit(Trigger.REVOKE, GoodsAuditStateEnum.NORMAL);
        stateMachine.Configure(GoodsAuditStateEnum.NORMAL)
                .Permit(Trigger.CREATE, GoodsAuditStateEnum.IN_CREATE)
                .Permit(Trigger.UPDATE, GoodsAuditStateEnum.IN_UPDATE)
                .Permit(Trigger.DELETE, GoodsAuditStateEnum.IN_DELETE)
                .Permit(Trigger.ON_SHELF, GoodsAuditStateEnum.IN_ON_SHELF)
                .Permit(Trigger.UNDER_SHELF, GoodsAuditStateEnum.IN_UNDER_SHELF)
                .Permit(Trigger.FROZEN, GoodsAuditStateEnum.IN_FROZEN)
                .Permit(Trigger.UNFREEZE, GoodsAuditStateEnum.IN_UNFREEZE);
    }
}
import com.github.oxo42.stateless4j.StateMachine;
import org.junit.Test;
/**
 * Created by qiwenjie on 2021/06/30.
 *
 * 状态机测试类
 */
public class RunStateMachine {
    private static StateMachine<CurrentState,Trigger> stateMachine = new StateMachine<CurrentState, Trigger>(CurrentState.SMALL,GoodsAuditStateFSM.config);
    @Test
    public void testStateMachine(){
        stateMachine.Fire(Trigger.UPDATE);
        System.out.println("currentState-->"+stateMachine.getState());
    }
}
3.2 状态机在品牌状态的转换

业务场景:

/**
* 品牌审核状态
*/
public enum BrandAuditStatus {
    AUDIT_FAILED(-1, "审核不通过"),
    WAIT_SUBMIT(0, "待提交"),
    WAIT_AUDIT(1, "待审核"),
    AUDIT_PASSED(3, "审核通过");
}
/**
 * 品牌审核动作枚举
 */
public enum BrandAuditTrigger {
    /**
     * 提交审核
     */
    SUBMIT_AUDIT(0, "提交审核"),
    /**
     * 审核通过
     */
    AUDIT_APPROVE(1, "审核通过"),
    /**
     * 审核不通过
     */
    AUDIT_REJECT(2, "审核不通过"),
    /** 审核不通过再次提交 */
    SUBMIT_AUDIT_AGAIN(3, "审核不通过再次提交");
}
package cn.gov.zcy.audit.internal;
import com.googlecode.stateless4j.StateMachine;
import cn.gov.zcy.audit.enums.BrandAuditStatus;
import cn.gov.zcy.audit.enums.BrandAuditTrigger;
import lombok.extern.slf4j.Slf4j;
/**
* 注册trigger
*/
@Slf4j
public class BrandAuditFSM {
    private final StateMachine<BrandAuditStatus, BrandAuditTrigger> stateMachine;
    public BrandAuditFSM(BrandAuditStatus status) {
        this.stateMachine = new StateMachine<>(status);
        /**
         * [待提交]----------[提交审核]----------[待审核]
         */
        stateMachine.Configure(BrandAuditStatus.WAIT_SUBMIT)
                .Permit(BrandAuditTrigger.SUBMIT_AUDIT, BrandAuditStatus.WAIT_AUDIT);
        /**
         * [待审核]----------[审核通过]----------[审核通过]
         *
         * [待审核]----------[审核不通过]----------[审核不通过]
         */
        stateMachine.Configure(BrandAuditStatus.WAIT_AUDIT)
                .Permit(BrandAuditTrigger.AUDIT_APPROVE,BrandAuditStatus.AUDIT_PASSED)
                .Permit(BrandAuditTrigger.AUDIT_REJECT,BrandAuditStatus.AUDIT_FAILED);
        /**
         * [审核不通过]----------[不通过再次修改]----------[待提交]
         */
        stateMachine.Configure(BrandAuditStatus.AUDIT_FAILED)
                .Permit(BrandAuditTrigger.SUBMIT_AUDIT_AGAIN, BrandAuditStatus.WAIT_SUBMIT);
    }
import com.github.oxo42.stateless4j.StateMachine;
import org.junit.Test;
/**
 * Created by qiwenjie on 2021/06/30.
 *
 * 状态机测试类
 */
public class RunStateMachine {
    private static StateMachine<CurrentState,Trigger> stateMachine = new StateMachine<CurrentState, Trigger>(CurrentState.SMALL,BrandAuditFSM.config);
    @Test
    public void testStateMachine(){
        stateMachine.Fire(BrandAuditTrigger.AUDIT_APPROVE);
        System.out.println("currentState-->"+stateMachine.getState());
    }
}
3.3 状态机在SPU状态的转换

业务场景

/**
 * spu审核状态
 */
public enum SpuAuditStatus {
    AUDIT_FAILED(-1, "审核不通过"),
    WAIT_SUBMIT(0, "待提交"),
    WAIT_AUDIT(1, "待审核"),
    AUDIT_PASSED(3, "审核通过");
}
/**
 * spu审核动作枚举
 */
public enum SpuAuditTrigger {
    /**
     * 提交审核
     */
    SUBMIT_AUDIT(0, "提交审核"),
    /**
     * 审核通过
     */
    AUDIT_APPROVE(1, "审核通过"),
    /**
     * 审核不通过
     */
    AUDIT_REJECT(2, "审核不通过");
}
package cn.gov.zcy.audit.internal;
import cn.gov.zcy.audit.enums.SpuAuditStatus;
import cn.gov.zcy.audit.enums.SpuAuditTrigger;
import com.googlecode.stateless4j.StateMachine;
import lombok.extern.slf4j.Slf4j;
@Slf4j
public class SpuAuditFSM {
    private final StateMachine<SpuAuditStatus, SpuAuditTrigger> stateMachine;
    public SpuAuditFSM(SpuAuditStatus status) throws Exception {
        this.stateMachine = new StateMachine<>(status);
        /**
         * [待提交]----------[提交审核]----------[待审核]
         */
       stateMachine.Configure(SpuAuditStatus.WAIT_SUBMIT).Permit(SpuAuditTrigger.SUBMIT_AUDIT,
            SpuAuditStatus.WAIT_AUDIT);
        /**
         * [待审核]----------[审核通过]----------[审核通过]
         *
         * [待审核]----------[审核被拒]----------[审核不通过]
         */
        stateMachine.Configure(SpuAuditStatus.WAIT_AUDIT)
            .Permit(SpuAuditTrigger.AUDIT_APPROVE, SpuAuditStatus.AUDIT_PASSED)
            .Permit(SpuAuditTrigger.AUDIT_REJECT, SpuAuditStatus.AUDIT_FAILED);
    }
}
import com.github.oxo42.stateless4j.StateMachine;
import org.junit.Test;
/**
 * Created by qiwenjie on 2021/06/30.
 *
 * 状态机测试类
 */
public class RunStateMachine {
    private static StateMachine<CurrentState,Trigger> stateMachine = new StateMachine<CurrentState, Trigger>(CurrentState.SMALL,SpuAuditFSM.config);
    @Test
    public void testStateMachine(){
        stateMachine.Fire(SpuAuditTrigger.AUDIT_APPROVE);
        System.out.println("currentState-->"+stateMachine.getState());
    }
}

自律是解决人生问题最主要的工具,也是消除人生痛苦最重要的方法

相关文章
|
3月前
|
存储 Oracle Java
java零基础学习者入门课程
本课程为Java零基础入门教程,涵盖环境搭建、变量、运算符、条件循环、数组及面向对象基础,每讲配示例代码与实践建议,助你循序渐进掌握核心知识,轻松迈入Java编程世界。
347 0
|
3月前
|
安全 Java 开发者
告别NullPointerException:Java Optional实战指南
告别NullPointerException:Java Optional实战指南
289 119
|
4月前
|
Java
java入门代码示例
本文介绍Java入门基础,包含Hello World、变量类型、条件判断、循环及方法定义等核心语法示例,帮助初学者快速掌握Java编程基本结构与逻辑。
439 0
|
5月前
|
安全 Java 数据库连接
2025 年最新 Java 学习路线图含实操指南助你高效入门 Java 编程掌握核心技能
2025年最新Java学习路线图,涵盖基础环境搭建、核心特性(如密封类、虚拟线程)、模块化开发、响应式编程、主流框架(Spring Boot 3、Spring Security 6)、数据库操作(JPA + Hibernate 6)及微服务实战,助你掌握企业级开发技能。
770 3
|
5月前
|
Java 关系型数据库 数据库
Java 项目实战教程从基础到进阶实战案例分析详解
本文介绍了多个Java项目实战案例,涵盖企业级管理系统、电商平台、在线书店及新手小项目,结合Spring Boot、Spring Cloud、MyBatis等主流技术,通过实际应用场景帮助开发者掌握Java项目开发的核心技能,适合从基础到进阶的学习与实践。
779 3
|
4月前
|
存储 前端开发 Java
【JAVA】Java 项目实战之 Java Web 在线商城项目开发实战指南
本文介绍基于Java Web的在线商城技术方案与实现,涵盖三层架构设计、MySQL数据库建模及核心功能开发。通过Spring MVC + MyBatis + Thymeleaf实现商品展示、购物车等模块,提供完整代码示例,助力掌握Java Web项目实战技能。(238字)
482 0
|
5月前
|
Java API Maven
2025 Java 零基础到实战最新技术实操全攻略与学习指南
本教程涵盖Java从零基础到实战的全流程,基于2025年最新技术栈,包括JDK 21、IntelliJ IDEA 2025.1、Spring Boot 3.x、Maven 4及Docker容器化部署,帮助开发者快速掌握现代Java开发技能。
1048 1
|
4月前
|
Java 开发者
Java并发编程:CountDownLatch实战解析
Java并发编程:CountDownLatch实战解析
488 100
|
5月前
|
数据采集 JSON Java
Java爬虫获取1688店铺所有商品接口数据实战指南
本文介绍如何使用Java爬虫技术高效获取1688店铺商品信息,涵盖环境搭建、API调用、签名生成及数据抓取全流程,并附完整代码示例,助力市场分析与选品决策。
|
4月前
|
人工智能 Java API
Java AI智能体实战:使用LangChain4j构建能使用工具的AI助手
随着AI技术的发展,AI智能体(Agent)能够通过使用工具来执行复杂任务,从而大幅扩展其能力边界。本文介绍如何在Java中使用LangChain4j框架构建一个能够使用外部工具的AI智能体。我们将通过一个具体示例——一个能获取天气信息和执行数学计算的AI助手,详细讲解如何定义工具、创建智能体并处理执行流程。本文包含完整的代码示例和架构说明,帮助Java开发者快速上手AI智能体的开发。
1416 8