【Alibaba Cola 状态机】重点解析以及实践案例

2024-08-20 22:28

本文主要是介绍【Alibaba Cola 状态机】重点解析以及实践案例,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

【Alibaba Cola 状态机】重点解析以及实践案例

1. 状态模式

状态模式是一种行为型设计模式,允许对象在内部状态改变时改变其行为,简单地讲就是,一个拥有状态的context对象,在不同状态下,其行为会发生改变。看起来是改变了对象各个接口方法的实现一样。

模式中包含角色:

  1. 上下文
  2. 抽象状态
  3. 具体状态

优点包括解耦客户端和状态对象,可扩展性强,避免大量条件语句。

缺点是可能增加系统类的数量和复杂性。

适用场景如自动售货机的状态转换、线程状态管理等。代码示例展示了自动售卖机如何利用状态模式实现不同状态的切换。

推荐文章:23种设计模式之状态模式(State Pattern)_状态模式哪种状态切换好-CSDN博客

2. 状态机

状态机(Finite State Machine,简称FSM)是一个数学模型,用于描述对象在其生命周期中可能的状态以及状态之间的转换。

它由一组状态、一组事件、一组转换规则和一组动作组成,能够清晰地表示和管理对象的行为和状态变化。

在状态机中,“有限”指的是状态和事件都是有限的,即存在一个有限的状态集和事件集。这使得状态机具有明确的、可控的行为模式,便于分析和实现。

在这里插入图片描述

状态机的组成元素:状态、事件、转换、动作

状态(State): 表示对象的当前情况或条件。状态机中的状态是有限的,例如:待机、运行、暂停、停止等。

事件(Event): 触发状态转换的输入或信号。事件可以是外部输入、内部触发或其他系统生成的信号。

转换(Transition): 定义了状态之间的切换规则。当特定的事件发生时,状态机会根据转换规则从一个状态转换到另一个状态。

动作(Action): 在状态转换过程中执行的操作或任务。动作可以是状态进入前执行的预处理、状态转换时执行的中间操作或状态退出后执行的清理工作。

状态机的优缺点

优点:

  1. 逻辑清晰:状态机将复杂的系统行为分解为简单的状态和状态之间的转换,使系统逻辑更加清晰和易于理解。
  2. 可维护性高:由于状态机的逻辑是模块化的,任何状态的修改或扩展只需在该状态的实现部分进行,不会影响其他部分,增强了代码的可维护性。
  3. 可扩展性强:新的状态和转换可以方便地添加到现有的状态机中,使系统具有良好的扩展性。

缺点:状态爆炸,对于复杂系统,状态和转换的数量可能非常庞大,导致状态机图变得复杂难以管理,这被称为“状态爆炸”问题。

3. Alibaba Cola 状态机

实现一个状态机引擎,教你看清DSL的本质_状态机 dsl-CSDN博客

相比Spring statemachine状态机等的复杂,功能多;

但是我们 实际业务员 需要常用的功能,简单使用,所以这类就显得不简洁;再看cola-statemachine相比就是小巧、无状态、简单、轻量、性能极高的状态机DSL实现,解决业务中的状态流转问题。

如果是实现业务的话,阿里状态机是不二之选,更加适合我们日常开发!KISS(Keep It Simple and Stupid)

而如果是比较复杂的业务或者组件开发,这个状态机可能也能 妙用进行应对,面对不了可能就得用 Spring statemachine 有状态的状态机,或者对阿里状态机进行 二次开发

开源者的初心就是,让开发更舒适,结合实际需求抽离出必要部分,而不是严格按照传统状态模式,传统状态机

无状态状态机–cola stateMachine-CSDN博客

状态机本身没有状态,而是提供一个状态机单例,通过输入参数 “起始状态”、“事件”、“上下文”,这些参数足以确定一次状态轮转,期间通过 condition 和 action 后,返回“最终状态”,若轮转失败,则返回原状态;

由于没有状态,所以调用者使用这个状态机都是互不干扰的,通过输入决定输出(一次轮转),做到一个实例服务多个调用者

  • 这里的上下文,就是过程中的通行数据罢了
  • 你也可以在上下文里面去设置状态,像状态模式那样,当其实在使用状态机的时候,状态机就相当于状态模式的上下文,这样看,发挥状态机的优势,就没必要设置了。

采用了无状态设计之后,我们就可以使用一个状态机 Instance 来响应所有的请求了,性能会大大的提升

原本的状态机是有状态的,状态机当前的状态决定了其行为,这样导致每次请求,都是申请一个新的状态机去维护状态的轮转,轮转的过程,状态机的状态也在时刻发生变化;

当阿里状态机理念是状态机每次进行一次轮转就行了,哪怕需要连续的过程性的轮转,多次请求状态机即可(一个轮转的 action 嵌套执行外部轮转的事件,返回的最终状态可能与实际不符,最好嵌套执行内部轮转而不是外部轮转;或者等轮转结束,再按照这次请求的响应进行下次轮转)

有状态的状态机就相当于可以本地运行的应用,不同客户之间是隔离的,状态在应用内部轮转

无状态的状态机就相当于 web 应用,所有客户访问同一个 web,请求一次,执行一次特定的轮转,响应结果

4. Alibaba Cola 状态机使用

源码其实不难,大部分还是容易看懂的,如果出现问题按照思路可以调试去查查,这里就是我总结的用法。

在这里插入图片描述

/*** Alibaba Cola 状态机关键词* State:状态* Event:事件,状态由事件触发,引起变化* Transition:流转,表示从一个状态到另一个状态* External Transition:外部流转,两个不同状态之间的流转* Internal Transition:内部流转,同一个状态之间的流转* Condition:条件,表示是否允许到达某个状态* Action:动作,到达某个状态之后,可以做什么* StateMachine:状态机*/

4.1 StateMachineUtil(核心方法封装)

@Slf4j
public class StateMachineUtil {public static <S, E, C> StateMachine<S, E, C> getMachine(String machineId) {return StateMachineFactory.get(machineId);}public static void showMachine(String machineId) {getMachine(machineId).showStateMachine();}public static String generatePlantUML(String machineId) {return getMachine(machineId).generatePlantUML();}public static <S, E, C> void printMachine(String machineId) {StateMachine<S, E, C> stateMachine = getMachine(machineId);stateMachine.showStateMachine();System.out.println(stateMachine.generatePlantUML());}public static <S, E, C> S fireEvent(String machineId, S state, E event, C context) {return (S) getMachine(machineId).fireEvent(state, event, context);}}
  1. 通过 machineId 获得状态机实例:StateMachineFactory.get(machineId)
  2. 打印状态机(注意重写 toString 方法到想要的效果)
  3. 执行状态机(machineId,起始状态,事件,上下文)(返回最终状态)

4.2 状态机准备信息

根据状态机轮转所需的信息,也就是准备信息,在状态机构建过程中需要用到;

我将其抽象成接口,有两个:外部流转助手、内部流转助手

  • 状态的事件会让状态变成别的状态,还是不变就是这里外和内
public interface StateExternalTransitionHelper<S, E, C> {List<S> getFromState();S getToState(S from) throws GlobalServiceException;E getOnEvent();Condition<C> getWhenCondition();Action<S, E, C> getPerformAction();}

from 为 list 是因为有时候同一事件,多个状态都可以执行,其中 getToState 通过 from 得知 to,并允许抛出异常;

public interface StateInternalTransitionHelper<S, E, C> {List<S> getWithinList();E getOnEvent();Condition<C> getWhenCondition();Action<S, E, C> getPerformAction();
}

4.3 通过准备信息构造状态机

外部流转助手、内部流转助手 的实现类,就蕴含了准备信息,将这些在状态机构造过程中应用:

private static <S, E, C> void builderAssign(StateMachineBuilder<S, E, C> builder,StateExternalTransitionHelper<S, E, C> helper) {List<S> fromStateList = helper.getFromState();if(!CollectionUtil.isEmpty(fromStateList)) {E onEvent = helper.getOnEvent();Condition<C> whenCondition = helper.getWhenCondition();Action<S, E, C> performAction = helper.getPerformAction();fromStateList.forEach(fromState -> {try {S toState = helper.getToState(fromState); // 若抛异常就忽略这一个,构造下一个状态轮转// 不保证每个 toState 相等的情况下,不用 externalTransitions 与 fromAmongbuilder.externalTransition().from(fromState).to(toState).on(onEvent).when(whenCondition).perform(performAction);} catch (GlobalServiceException e) {log.warn(e.getMessage());}});}
}private static <S, E, C> void builderAssign(StateMachineBuilder<S, E, C> builder,StateInternalTransitionHelper<S, E, C> helper) {List<S> withinList = helper.getWithinList();if(!CollectionUtil.isEmpty(withinList)) {E onEvent = helper.getOnEvent();Condition<C> whenCondition = helper.getWhenCondition();Action<S, E, C> performAction = helper.getPerformAction();withinList.forEach(within -> {builder.internalTransition().within(within).on(onEvent).when(whenCondition).perform(performAction);});}
}public static <S, E, C> void buildMachine(String machineId,List<? extends StateExternalTransitionHelper<S, E, C>> externalHelpers,List<? extends StateInternalTransitionHelper<S, E, C>> internalHelpers) {// 创建一个 builderStateMachineBuilder<S, E, C> builder = StateMachineBuilderFactory.create();// 添加轮转externalHelpers.forEach(helper -> {builderAssign(builder, helper);});internalHelpers.forEach(helper -> {builderAssign(builder, helper);});// 创建状态机builder.build(machineId);
}

4.4 示例(简历状态轮转)

不要直接实现那两个接口,要先用模块内部的接口继承,这样注入 Spring 容器中的 bean,获取的时候指定我们自己的接口类型,防止获得别的模块的 helper bean

public interface ResumeStateExternalTransitionHelper extends StateExternalTransitionHelper<ResumeStatus, ResumeEvent, ResumeContext> {}
public interface ResumeStateInternalTransitionHelper extends StateInternalTransitionHelper<ResumeStatus, ResumeEvent, ResumeContext> {}

在这里插入图片描述

上下文:

@Getter
@Setter
@Builder
@AllArgsConstructor
@NoArgsConstructor
@Slf4j
public class ResumeContext {private Long managerId;private StuResume resume;ResumeExecuteDTO executeDTO;public void log(ResumeStatus from, ResumeStatus to, ResumeEvent event) {log.info("resume state from {} to {} run {} currentResume {} managerId {} executeDTO {}",from, to, event, resume.getId(), managerId, executeDTO);}}

简历状态:

@Getter
public enum ResumeStatus {DRAFT("草稿", 0),PENDING_SELECTION("待筛选", 1),REJECTED("筛选不通过", 2),SCHEDULE_INITIAL_INTERVIEW("待安排初试", 3),PENDING_INITIAL_INTERVIEW("待初试", 4),INITIAL_INTERVIEW_PASSED("初试通过", 5), // 仅当初试为最后一个流程时显示INITIAL_INTERVIEW_FAILED("初试不通过", 6), // 仅当初试为最后一个流程时显示SCHEDULE_SECOND_INTERVIEW("待安排复试", 7),PENDING_SECOND_INTERVIEW("待复试", 8),SECOND_INTERVIEW_PASSED("复试通过", 9), // 仅当复试为最后一个流程时显示SECOND_INTERVIEW_FAILED("复试不通过", 10), // 仅当复试为最后一个流程时显示SCHEDULE_FINAL_INTERVIEW("待安排终试", 11),PENDING_FINAL_INTERVIEW("待终试", 12),FINAL_INTERVIEW_PASSED("终试通过", 13), // 仅当复试为最后一个流程时显示FINAL_INTERVIEW_FAILED("终试不通过", 14), // 仅当复试为最后一个流程时显示PENDING_HANDLING("待处理", 15),SUSPENDED("挂起", 16),;ResumeStatus(String message, Integer code) {this.message = message;this.code = code;}@Overridepublic String toString() {return message;}private final String message;@EnumValue@JsonValueprivate final Integer code;public static ResumeStatus get(Integer code) {for (ResumeStatus resumeStatus : ResumeStatus.values()) {if(resumeStatus.getCode().equals(code)) {return resumeStatus;}}throw new GlobalServiceException(GlobalServiceStatusCode.USER_RESUME_STATUS_EXCEPTION);}
}

简历事件:

@Getter
public enum ResumeEvent {NEXT(1, "推进"),APPROVE(2, "通过"),ELIMINATE(3, "淘汰"),RESET(4, "重置"),PENDING(5, "待处理"),SUSPEND(6, "挂起"),CONFIRM(7, "转正"),;@Overridepublic String toString() {return description;}private final Integer event;private final String description;ResumeEvent(Integer event, String description) {this.event = event;this.description = description;}public static ResumeEvent get(Integer event) {for (ResumeEvent resumeEvent : ResumeEvent.values()) {if(resumeEvent.getEvent().equals(event)) {return resumeEvent;}}throw new GlobalServiceException(GlobalServiceStatusCode.USER_RESUME_STATUS_TRANS_EVENT_ERROR);}}

你也可以不是枚举类,但是我们要提供有限的固定的实例,并且代表状态和事件,枚举太适用了!

常量类:

public interface ResumeStateMachineConstants {String RESUME_STATE_MACHINE_ID = "resumeStateMachineId";}

配置类:

@Configuration
@RequiredArgsConstructor
public class ResumeStateMachineBuildConfig {private final List<ResumeStateExternalTransitionHelper> externalHelpers;private final List<ResumeStateInternalTransitionHelper> internalHelpers;@PostConstructpublic void buildInterviewMachine() {StateMachineUtil.buildMachine(ResumeStateMachineConstants.RESUME_STATE_MACHINE_ID,externalHelpers,internalHelpers);StateMachineUtil.printMachine(ResumeStateMachineConstants.RESUME_STATE_MACHINE_ID);}}

一个 helper 实现展示:

@Component
@RequiredArgsConstructor
public class ResumeNextStateHelper implements ResumeStateExternalTransitionHelper {private final Condition<ResumeContext> defaultResumeCondition;private final Action<ResumeStatus, ResumeEvent, ResumeContext> defaultResumeAction;@Overridepublic List<ResumeStatus> getFromState() {return List.of(DRAFT,PENDING_SELECTION,SCHEDULE_INITIAL_INTERVIEW,PENDING_INITIAL_INTERVIEW,SCHEDULE_SECOND_INTERVIEW,PENDING_SECOND_INTERVIEW,SCHEDULE_FINAL_INTERVIEW);}@Overridepublic ResumeStatus getToState(ResumeStatus from) throws GlobalServiceException {return switch (from) {case DRAFT -> PENDING_SELECTION;case PENDING_SELECTION -> SCHEDULE_INITIAL_INTERVIEW;case SCHEDULE_INITIAL_INTERVIEW -> PENDING_INITIAL_INTERVIEW;case PENDING_INITIAL_INTERVIEW -> SCHEDULE_SECOND_INTERVIEW;case SCHEDULE_SECOND_INTERVIEW -> PENDING_SECOND_INTERVIEW;case PENDING_SECOND_INTERVIEW -> SCHEDULE_FINAL_INTERVIEW;case SCHEDULE_FINAL_INTERVIEW -> PENDING_FINAL_INTERVIEW;default -> throw new GlobalServiceException(GlobalServiceStatusCode.USER_RESUME_STATUS_EXCEPTION);};}@Overridepublic ResumeEvent getOnEvent() {return ResumeEvent.NEXT;}@Overridepublic Condition<ResumeContext> getWhenCondition() {return defaultResumeCondition;}@Overridepublic Action<ResumeStatus, ResumeEvent, ResumeContext> getPerformAction() {return defaultResumeAction;}
}

在这里插入图片描述

这里这两个是我写的默认值,并注入了容器,这样的写法,需要注意 bean 的名称不要冲突了

通过以上代码,在项目启动的时候即可构造出状态机:

在这里插入图片描述

执行状态机(代码片段):

在这里插入图片描述

我个人觉得没必要在状态机内部将状态落库,根据请求状态机的响应,进行落库

5. 小思考 · 状态机设计的合理性

状态机并不是通过 from 和 to 确定 event,而是 from 和 event 确定轮转

通过 from 到 to 的变化,是确定不了事件的,实现通过 from 到 to 的变化触发某一事件,事件可能不止一个,而且并不保证触发我们想要的那一个

比如一次请求,对象的当前属性就是 from,请求是以 event 作为参数,还是以 to 作为参数

① 若是 event 作为参数,那么根据 fromevent 即可进行状态轮转,并返回最终的状态

② 若是 to 作为参数,fromto 的这个状态变化会触发什么特定行为

状态机更注重的是状态的轮转,也就是 ①,而 ② 是状态变化的后置行为

以“一场面试”为例,一场面试的状态可以是: 未开始进行中已结束

如果是 ①,传入的参数可以是 “开始面试” 这一具体事件,当前面试状态是 ”未开始“,就可以轮转成”进行中“,也可以是 “通知用户” 这一事件,状态内部流转的过程中对用户进行面试通知;

如果是 ②,传入的参数可以是 ”进行中“,面试状态将直接更新成”进行中“,状态变化触发对应的事件,但做不了内部轮转

① 这种方式靠的是状态机,让请求行为更加具体,如进行“开始面试”,“通知用户”这种具体的行为

而 ② 更加狭隘,如果我们设计一份代码来管理 fromto 触发的事件,如果要符合我们的接口预期,这往往可能 并不能做到 ① 的可读性高、灵活性高、通用性高、可扩展性高

用 ② 来进行状态轮转不太合适,但是也不是完全没用,更适合用其管理一些状态变化固定的“副作用”,作为状态轮转的后置行为,还是不错的!可以结合责任链模式去实现

但是又说回来,fromto 的转变的副作用,在编写代码的时候应该也就是规定对应事件的副作用吧,比如 “未开始” 到 “进行中”,就是“面试开始” 这一具体行为的副作用,那其实在状态机就能实现啊;

也就是说 ② 这种方式适合,有多个事件可以进行 fromto 的轮转,并且这些事件都有共同的副作用,这个副作用就可以用 ② 来管理,出现这种情况也很极端了~

在比较简单的系统,fromto 能够 可以确定唯一的事件,没有内部轮转的需求 ,用这个也无所谓

如果非要 ② 这种请求方式,不想指定 event,出现特殊的状态变化,就得自动触发对应事件,这种就属于特殊需求了, fromto 触发的事件的映射关系,也只能在 to 已知的情况下可以复用,甚至只用于这一特殊请求,代码写得可能比较死,不太优雅🙁,太为难了(;′⌒`),反正我不是很喜欢,我个人比较喜欢优雅直观的设计;

我个人认为要是有个接口可以任意改变状态,那么应该不需要触发什么特定事件了,毕竟都允许可以任意更改了,或者说有一个统一的事件

可以定义一个”任意更改状态“的事件,上下文携带 toState,所有状态都可以触发,在状态机的内部/外部轮转(状态的行为)即可

但这不符合状态机明确的设计理念

综上所述,

用 ① 更加合适,可以让请求行为更加优雅具体直观和灵活,开发低耦合更具有扩展性,能实现的功能更多;② 的这种请求方式适合那种状态变化没有任何事件触发的场景,或触发的都是同一事件的场景,等不具有状态轮转的过程概念的场景。

BUT,

规矩是死的,视具体需求而论,切勿只纸上谈兵!

以上也只是我的想法,不同人有不同的想法和理念!

状态机还可以结合很多其他的设计模式,更多妙用等你开发!

状态机你爱咋用咋用,只要合理都 OK 啦!

开发是灵活的过程,开发者的理念为准,没有固定的强限定,但是我们要满足其基本的优秀写法!

这篇关于【Alibaba Cola 状态机】重点解析以及实践案例的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1091346

相关文章

Python通用唯一标识符模块uuid使用案例详解

《Python通用唯一标识符模块uuid使用案例详解》Pythonuuid模块用于生成128位全局唯一标识符,支持UUID1-5版本,适用于分布式系统、数据库主键等场景,需注意隐私、碰撞概率及存储优... 目录简介核心功能1. UUID版本2. UUID属性3. 命名空间使用场景1. 生成唯一标识符2. 数

PostgreSQL的扩展dict_int应用案例解析

《PostgreSQL的扩展dict_int应用案例解析》dict_int扩展为PostgreSQL提供了专业的整数文本处理能力,特别适合需要精确处理数字内容的搜索场景,本文给大家介绍PostgreS... 目录PostgreSQL的扩展dict_int一、扩展概述二、核心功能三、安装与启用四、字典配置方法

Spring WebFlux 与 WebClient 使用指南及最佳实践

《SpringWebFlux与WebClient使用指南及最佳实践》WebClient是SpringWebFlux模块提供的非阻塞、响应式HTTP客户端,基于ProjectReactor实现,... 目录Spring WebFlux 与 WebClient 使用指南1. WebClient 概述2. 核心依

MyBatis-Plus 中 nested() 与 and() 方法详解(最佳实践场景)

《MyBatis-Plus中nested()与and()方法详解(最佳实践场景)》在MyBatis-Plus的条件构造器中,nested()和and()都是用于构建复杂查询条件的关键方法,但... 目录MyBATis-Plus 中nested()与and()方法详解一、核心区别对比二、方法详解1.and()

Spring Boot @RestControllerAdvice全局异常处理最佳实践

《SpringBoot@RestControllerAdvice全局异常处理最佳实践》本文详解SpringBoot中通过@RestControllerAdvice实现全局异常处理,强调代码复用、统... 目录前言一、为什么要使用全局异常处理?二、核心注解解析1. @RestControllerAdvice2

Spring事务传播机制最佳实践

《Spring事务传播机制最佳实践》Spring的事务传播机制为我们提供了优雅的解决方案,本文将带您深入理解这一机制,掌握不同场景下的最佳实践,感兴趣的朋友一起看看吧... 目录1. 什么是事务传播行为2. Spring支持的七种事务传播行为2.1 REQUIRED(默认)2.2 SUPPORTS2

深度解析Java DTO(最新推荐)

《深度解析JavaDTO(最新推荐)》DTO(DataTransferObject)是一种用于在不同层(如Controller层、Service层)之间传输数据的对象设计模式,其核心目的是封装数据,... 目录一、什么是DTO?DTO的核心特点:二、为什么需要DTO?(对比Entity)三、实际应用场景解析

深度解析Java项目中包和包之间的联系

《深度解析Java项目中包和包之间的联系》文章浏览阅读850次,点赞13次,收藏8次。本文详细介绍了Java分层架构中的几个关键包:DTO、Controller、Service和Mapper。_jav... 目录前言一、各大包1.DTO1.1、DTO的核心用途1.2. DTO与实体类(Entity)的区别1

Java中的雪花算法Snowflake解析与实践技巧

《Java中的雪花算法Snowflake解析与实践技巧》本文解析了雪花算法的原理、Java实现及生产实践,涵盖ID结构、位运算技巧、时钟回拨处理、WorkerId分配等关键点,并探讨了百度UidGen... 目录一、雪花算法核心原理1.1 算法起源1.2 ID结构详解1.3 核心特性二、Java实现解析2.

Python中re模块结合正则表达式的实际应用案例

《Python中re模块结合正则表达式的实际应用案例》Python中的re模块是用于处理正则表达式的强大工具,正则表达式是一种用来匹配字符串的模式,它可以在文本中搜索和匹配特定的字符串模式,这篇文章主... 目录前言re模块常用函数一、查看文本中是否包含 A 或 B 字符串二、替换多个关键词为统一格式三、提