springboot状态机模式

古城微笑少年丶 2023-10-07 18:09 16阅读 0赞

链接: [状态机和工作流的区别][Link 1].  
链接: [状态机引擎选型][Link 2].  
链接: [彻底搞懂Spring状态机原理，实现订单与物流解耦][Spring].  
链接: [spring statemachine收录][spring statemachine].  
链接: [spring statemachine的企业可用级开发指南][spring statemachine 1].  
链接: [Spring Statemachine 简介][Spring Statemachine].  
链接: [实现一个状态机引擎，教你看清DSL的本质][DSL].  
链接: [COLA下的cola-statemachine状态机][COLA_cola-statemachine].  
链接: [爱奇艺团队-领域驱动设计框架Axon实践][-_Axon].  
链接: [COLA 4.0：应用架构的最佳实践][COLA 4.0].  
链接: [阿里高级技术专家谈开源DDD框架：COLA4.1，分离架构和组件（下）][DDD_COLA4.1].  
链接: [【架构设计】无状态状态机在代码中的实践][Link 3].

### 状态机框架 ###

*  [Spring Statemachine （重量级选手）1.2k+ star][Spring Statemachine _1.2k_ star].
 *  [squirrel-foundation（松鼠）1.8k+ star][Spring Statemachine _1.2k_ star].
 *  [cola-statemachine （可乐）6.6k+ star][cola-statemachine _6.6k_ star].

### springboot合cola-statemachine 4.0.1 ###

#### cola-statemachine（阿里出品） ####

github链接: [cola-components][cola-statemachine _6.6k_ star].  
gitcode链接: [cola-components][].

<dependency>
        <groupId>com.alibaba.cola</groupId>
        <artifactId>cola-component-statemachine</artifactId>
        <version>4.0.1</version>
        <type>jar</type>
    </dependency>

package com.zm;
    
    import com.alibaba.cola.statemachine.Action;
    import com.alibaba.cola.statemachine.Condition;
    import com.alibaba.cola.statemachine.StateMachine;
    import com.alibaba.cola.statemachine.StateMachineFactory;
    import com.alibaba.cola.statemachine.builder.StateMachineBuilder;
    import com.alibaba.cola.statemachine.builder.StateMachineBuilderFactory;
    import lombok.extern.slf4j.Slf4j;
    import org.junit.jupiter.api.Test;
    
    
    @Slf4j
    public class StateMachineTest {
        
    
        static String MACHINE_ID1 = "TestStateMachine1";
        static String MACHINE_ID2 = "TestStateMachine2";
        static String MACHINE_ID3 = "TestStateMachine3";
        static String MACHINE_ID4 = "TestStateMachine4";
        static String MACHINE_ID5 = "TestStateMachine5";
    
        static enum States {
        
            /**
             * 申请
             */
            APPLY(1,"申请"),
            /**
             *初审
             */
            FIRST_TRIAL(2,"初审"),
            /**
             *终审
             */
            FINAL_JUDGMENT(3,"终审"),
            /**
             *移出
             */
            REMOVE(4,"移出");
    
            States(Integer value, String name) {
        
                this.value = value;
                this.name = name;
            }
    
            private final Integer value;
    
            private final String name;
    
            public Integer getValue() {
        
                return value;
            }
    
            public String getName() {
        
                return name;
            }
    
        }
    
        static enum Events {
        
            /**
             * 保存申请
             */
            SAVE_APPLICATION,
            /**
             * 提交申请
             */
            SUBMIT_APPLICATION,
            /**
             * 审核通过
             */
            AUDIT_PASS,
            /**
             * 审核退回
             */
            AUDIT_REJECT
        }
    
        /**
         * 参数
         */
        static class Context{
        
            String operator = "flw";
            String entityId = "7758258";
            String name = "zhoumin";
        }
    
    
    
        @Test
        public void test(){
        
            testExternalTransitionNormal();
            testInternalNormal();
            testExternalTransitionsNormal();
            testExternalTransitionNormal1();
            testExternalTransitionNormal2();
            StateMachine<States, Events, Context> stateMachine1 = StateMachineFactory.get(MACHINE_ID1);
            StateMachine<States, Events, Context> stateMachine2 = StateMachineFactory.get(MACHINE_ID2);
            StateMachine<States, Events, Context> stateMachine3 = StateMachineFactory.get(MACHINE_ID3);
            System.out.println(stateMachine1.generatePlantUML());
            System.out.println(stateMachine2.generatePlantUML());
            System.out.println(stateMachine3.generatePlantUML());
            System.out.println(StateMachineFactory.get(MACHINE_ID4).generatePlantUML());
            System.out.println(StateMachineFactory.get(MACHINE_ID5).generatePlantUML());
        }
    
    
        /**
         * State：状态
         * Event：事件，状态由事件触发，引起变化
         * Transition：流转，表示从一个状态到另一个状态
         * External Transition：外部流转，两个不同状态之间的流转
         * Internal Transition：内部流转，同一个状态之间的流转
         * Condition：条件，表示是否允许到达某个状态
         * Action：动作，到达某个状态之后，可以做什么
         * StateMachine：状态机
         * ————————————————
         * 版权声明：本文为CSDN博主「张建飞（Frank）」的原创文章，遵循CC 4.0 BY-SA版权协议，转载请附上原文出处链接及本声明。
         * 原文链接：https://blog.csdn.net/significantfrank/article/details/104996419
         */
        @Test
        public void testExternalTransitionNormal(){
        
            // 第一步：生成一个状态机builder
            StateMachineBuilder<States, Events, Context> builder = StateMachineBuilderFactory.create();
            // 第二步：设置一个外部状态转移类型的builder，并设置from\to\on\when\perform
            builder.externalTransition()    // 外部状态流转
                    .from(States.APPLY)     // 起始状态：申请
                    .to(States.FIRST_TRIAL)        // 目的状态：初审
                    .on(Events.SUBMIT_APPLICATION)       // 事件：提交申请
                    .when(checkCondition()) // 流转需要校验的条件，校验不通过不会进行doAction
                    .perform(doAction());   // 执行流转操作 这个action 我们可以按自己所需修改，比如这种Action<R,T> service的方法Service::method
            // 第三步：设置状态机的id和ready，并在StateMachineFactory中的stateMachineMap进行注册
            builder.build(MACHINE_ID1);
            // 第四步：触发状态机
            StateMachine<States, Events, Context> stateMachine = StateMachineFactory.get(MACHINE_ID1);
            stateMachine.showStateMachine();
            // 通过状态机执行 待审核状态执行审核操作，
            States target1 = stateMachine.fireEvent(States.APPLY, Events.SUBMIT_APPLICATION, new Context());
    
        }
    
        @Test
        public void testExternalTransitionNormal1(){
        
            StateMachineBuilder<States, Events, Context> builder = StateMachineBuilderFactory.create();
            builder.externalTransition()
                    .from(States.FIRST_TRIAL)
                    .to(States.FINAL_JUDGMENT)
                    .on(Events.AUDIT_PASS)
                    .when(checkCondition())
                    .perform(doAction());
            builder.build(MACHINE_ID4);
        }
    
        @Test
        public void testExternalTransitionNormal2(){
        
            StateMachineBuilder<States, Events, Context> builder = StateMachineBuilderFactory.create();
            builder.externalTransition()
                    .from(States.FINAL_JUDGMENT)
                    .to(States.REMOVE)
                    .on(Events.AUDIT_PASS)
                    .when(checkCondition())
                    .perform(doAction());
            builder.build(MACHINE_ID5);
        }
    
        /**
         * 状态在申请时 可以进行保存
         */
        @Test
        public void testInternalNormal(){
        
            StateMachineBuilder<States, Events, Context> builder = StateMachineBuilderFactory.create();
            // 内部流转 internal transition
            // 假设现在只是用户补全资料，只需要进行一些更新数据操作，不需要状态流转。这种需求可以通过内部状态流转实现
            builder.internalTransition()
                    .within(States.APPLY)
                    .on(Events.SAVE_APPLICATION)
                    .when(checkCondition())
                    .perform(doAction());
            StateMachine<States, Events, Context> stateMachine = builder.build(MACHINE_ID2);
            // 打印状态机里面的流程流转图谱
            stateMachine.showStateMachine();
            // 通过状态机执行 待审核状态执行审核操作，
            States target = stateMachine.fireEvent(States.APPLY, Events.SAVE_APPLICATION, new Context());
    
        }
    
    
        /**
         * 只要退回则回到申请箱的状态
         */
        @Test
        public void testExternalTransitionsNormal(){
        
            StateMachineBuilder<States, Events, Context> builder = StateMachineBuilderFactory.create();
            // external transitions 任意一个状态
            builder.externalTransitions()
                    .fromAmong(States.FIRST_TRIAL, States.FINAL_JUDGMENT)
                    .to(States.APPLY)
                    .on(Events.AUDIT_REJECT)
                    .when(checkCondition())
                    .perform(doAction());
            StateMachine<States, Events, Context> stateMachine = builder.build(MACHINE_ID3);
            // 打印状态机里面的流程流转图谱
            stateMachine.showStateMachine();
            // 通过状态机执行 待审核状态执行审核操作，
            States target1 = stateMachine.fireEvent(States.FIRST_TRIAL, Events.AUDIT_REJECT, new Context());
            States target2 = stateMachine.fireEvent(States.FINAL_JUDGMENT, Events.AUDIT_REJECT, new Context());
        }
    
    
    
        /**
         * 条件，表示是否允许到达某个状态
         */
        private Condition<StateMachineTest.Context> checkCondition() {
        
            return (ctx) -> true; // 默认返回true
        }
    
        /**
         * 动作，到达某个状态之后，可以做什么
         */
        private Action<StateMachineTest.States, StateMachineTest.Events, StateMachineTest.Context> doAction() {
        
            return (from, to, event, ctx)-> log.info(ctx.operator+" is operating "+ctx.entityId+" from:"+from.getName()+" to:"+to.getName()+" on:"+event+";"+ctx.name);
        }
    
    }

#### 可以生成PlantUML格式 ####

stateMachine.generatePlantUML();

![在这里插入图片描述][watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBAcXFfMjUwMDU2ODY4_size_20_color_FFFFFF_t_70_g_se_x_16]

### 使用COLA-statemachine事务失效的错误用法 ###

链接: [COLA-statemachine事务失效踩坑][COLA-statemachine]

/**
    	* 事务不会生效
    	**/
        @Transactional(rollbackFor = Exception.class)
        @Override
        public Action<State, Event, Context> passAction() {
        
            return (from, to, event, context) -> {
        
      
            };
        }

### springboot合Spring Statemachine 2.x ###

待续~

### 生成PlantUML图 ###

网站链接: [planttext][].

#### idea插件 ####

idea安装 PlantUML插件  
idea直接安装：File -> Settings -> Plugins 搜索 PlantUML ，找到 PlantUML integration 并安装

经过安装包引入

下载插件包安装：地址http://plugins.jetbrains.com/plugin/7017-plantuml-integration
    
     我已经下载好，能够使用：plantuml4idea.zip
    
    ctrl+ alt + s 打开setting，搜索plugins,

### cola架构快速生成 ###

![在这里插入图片描述][watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBAcXFfMjUwMDU2ODY4_size_20_color_FFFFFF_t_70_g_se_x_16 1]

链接: [阿里云代码生成][Link 4].

[Link 1]: https://www.jianshu.com/p/306412cb6109
[Link 2]: https://segmentfault.com/a/1190000009906317#articleHeader15
[Spring]: https://www.jianshu.com/p/f16e2ef9e3dd
[spring statemachine]: https://www.jianshu.com/c/fcf45a85f359
[spring statemachine 1]: https://segmentfault.com/a/1190000019448517?utm_source=sf-similar-article
[Spring Statemachine]: https://blog.csdn.net/qq_22076345/article/details/109266901
[DSL]: https://blog.csdn.net/significantfrank/article/details/104996419
[COLA_cola-statemachine]: https://www.jianshu.com/p/895047a04ae5
[-_Axon]: https://my.oschina.net/u/4484233/blog/4549703
[COLA 4.0]: https://blog.csdn.net/significantfrank/article/details/110934799
[DDD_COLA4.1]: https://developer.aliyun.com/article/861220
[Link 3]: https://www.cnblogs.com/simple-flw/p/15413022.html
[Spring Statemachine _1.2k_ star]: https://github.com/spring-projects/spring-statemachine
[cola-statemachine _6.6k_ star]: https://github.com/alibaba/COLA/tree/master/cola-components/cola-component-statemachine
[cola-components]: https://gitcode.net/mirrors/alibaba/cola?utm_source=csdn_github_accelerator
[watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBAcXFfMjUwMDU2ODY4_size_20_color_FFFFFF_t_70_g_se_x_16]: https://img-blog.csdnimg.cn/17f8b6fa171d4060b661c9541a101a72.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBAcXFfMjUwMDU2ODY4,size_20,color_FFFFFF,t_70,g_se,x_16
[COLA-statemachine]: https://blog.csdn.net/qq_34438435/article/details/130730959
[planttext]: https://www.planttext.com/
[watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBAcXFfMjUwMDU2ODY4_size_20_color_FFFFFF_t_70_g_se_x_16 1]: https://img-blog.csdnimg.cn/3cdb7a9141b24058a33f67742334fadd.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBAcXFfMjUwMDU2ODY4,size_20,color_FFFFFF,t_70,g_se,x_16
[Link 4]: https://start.aliyun.com/bootstrap.html