易拓展、易修改的状态流程设计和实现

1，前言

Workflow(https://en.wikipedia.org/wiki/Workflow)是一个极其常见的业务场景，基本所有行业都能涉及到流程管理上的问题。工作流，个人认为可以等价的理解为状态流(state flow)，因为工作流的主要工作就是流程管理或者就是状态转移。如果用状态转移来抽象描述问题的话，基本大多数业务系统都可以状态转移来描述，且不说OA、ERP等软件，在常见交易系统软件里产品管理的流程、在线交易系统里订单的各个状态流程等。

使用状态转移来描述问题的优势是语义简洁、易于图像化描述(计算机专业所熟知的计算理论中的状态机)。日前已有像Spring webflow、jBPM等开源workflow实现，但本文对这些不相关，本文主要是围绕使用Spring Statemachine(http://projects.spring.io/spring-statemachine/)，以一个具体应用实例来设计和实现一个简单基本但易拓展、易修改的状态流程。

2，问题描述

在一些网络上的金融产品平台上，我们可以看到各种类型的定期理财产品。这些理财产品实际都是金融公司依据国家的一些监管要求，打包成的一系列金融资产。所以这些资产在平台上正式对外公开募集资金前，实际是需要是需要经过一系列评审流程的。例如假设有一笔资产A，对这笔资产首先需要发起一场沟通会议，然后风控经理做好第一道最重要的风控问题、再是产品经理审批，最后进行评审、表决是否通过、拒绝或待议。

既然是状态转移问题，忽略异常状态和中间状态终止或转移流程，我们通过语义来描述上述问题的正常流程：

1) 状态定义: Meeting("项目沟通会"), RiskManager("风控经理"), ProdManager("产品经理"), Review(“评审"), Pass("通过"), Reject("否决"), Discussing("待议")；

2) 状态转移事件: {from=Meeting, to=RiskManager, on=PASS_MEETING("通过项目沟通会")},

{from=RiskManager, to=ProdManager, on=PASS_RISK_MANAGER("风控经理审核通过")},

{from=ProdManager, to=Review, on=PASS_PROD_MANAGER("产品经理审核通过")},

{from=Review, to=Pass, on=REVIEW_PASS("通过")},

{from=Review, to=Reject, on=REVIEW_REJECT("否决")},

{from=Review, to=Discussing, on=REVIEW_DISCUSSING("待议")};

图1

问题如果使用状态机描述的话，则如图1所示。

3，领域建模

图2 领域抽象

从图2中可以看出，资产评审的领域核心Entity即是Review。State和Feature是刻画Review状态转移的基本组件，如第2部分语义所描述的。状态转移的发生都是通过FeatureEvent来触发，从FeatureEvent我们可以看到每一个Feature都是对应一个单例的触发Event，每一个FeatureEvent都标明了它将使Review从具体一个状态跳转到另一个状态。Review的构成除了基本user和asset数据外，featureCode和state记录了该Review的状态转移语义。state表明该Review当前所处的状态，featureCode标识了对应的触发状态转移的FeatureEvent。特别的，所有的流程都应当有一个初始的状态，这就是Review#initial()需要完成的工作。

4，编码实现

4.1，领域核心实现

Review.java

  1 import org.springframework.beans.factory.support.StaticListableBeanFactory;
  2 import org.springframework.core.task.SyncTaskExecutor;
  3 import org.springframework.messaging.Message;
  4 import org.springframework.statemachine.StateMachine;
  5 import org.springframework.statemachine.config.StateMachineBuilder;
  6 import org.springframework.statemachine.config.builders.StateMachineTransitionConfigurer;
  7 import org.springframework.statemachine.listener.StateMachineListenerAdapter;
  8 import org.springframework.statemachine.transition.Transition;
  9 import org.springframework.util.Assert;
 10
 11 import java.util.*;
 12
 13 /**
 14 * @author shenjixiaodao
 15 */
 16 public class Review {
 17     private Long reviewId;
 18     private Users user;
 19     private String featureCode;
 20     private Assets asset;
 21     private State state;
 22
 23     public enum State{
 24          Meeting("项目沟通会"), RiskManager("风控经理审批"),
 25          ProdManager("产品经理审批"), Review("评审"),
 26          Pass("评审通过"), Reject("否决"), Discussing("待议");
 27          private String desc;
 28         State(String desc) {
 29             this.desc = desc;
 30         }
 31         public String getDesc(){return this.desc;}
 32     }
 33
 34     private StateMachine<State, FeatureEvent> machine = null;
 35 /**
 36 * 触发状态转移动作
 37 * @return true:允许状态转移
 38 */
 39     public boolean fire(){
 40         return this.fireEvent(FeatureEvent.codeOf(featureCode));
 41     }
 42     private boolean fireEvent(FeatureEvent event){
 43         try {
 44             if(machine == null) {
 45                 machine = buildSyncMachine();
 46                 machine.addStateListener(new StateMachineListenerAdapter<State, FeatureEvent>() {
 47                     @Override
 48                     public void eventNotAccepted(Message<FeatureEvent> msg) {
 49                         FeatureEvent event = msg.getPayload();
 50                         StringBuilder appender = new StringBuilder();
 51                         appender.append("【").append(event.featureName()).append("】只能将资产从")
 52                                 .append(event.reviewState()).append("修改为").append(event.nextState());
 53                         throw new IllegalArgumentException(appender.toString());
 54                     }
 55
 56                     @Override
 57                     public void transitionEnded(Transition<State, FeatureEvent> transition) {
 58                         FeatureEvent event = transition.getTrigger().getEvent();
 59                         state = event.nextState();
 60                     }
 61                 });
 62             }
 63             return machine.sendEvent(event);
 64         } catch (Exception e) {
 65             throw new RuntimeException(e);
 66         }
 67     }
 68
 69     public Review(Integer userId, Integer assetId, String featureCode) {
 70         this.user = new Users();
 71         this.user.setId(userId);
 72         this.asset = new Assets();
 73         this.asset.setId(assetId);
 74         this.featureCode = featureCode;
 75     }
 76
 77     public static Review initial(Integer assetId){
 78         Review review = new Review();
 79         review.asset = new Assets();
 80         review.asset.setId(assetId);
 81         review.state = State.Publish;
 82         return review;
 83     }
 84
 85     public void setReviewId(Long reviewId) {
 86         this.reviewId = reviewId;
 87         for(Attachment attachment:attachments)
 88             attachment.setReviewId(reviewId);
 89     }
 90
 91     public State state() {
 92         return state;
 93     }
 94
 95     public Review state(State state) {
 96         this.state = state;
 97         return this;
 98     }
 99
100     Review() {
101         //for ORM
102     }
103 /**
104 * 构建线程同步状态机
105 */
106     private StateMachine<State, FeatureEvent> buildSyncMachine() throws Exception {
107         Assert.notNull(state,"状态不能为空");
108         StateMachineBuilder.Builder<State, FeatureEvent> builder = StateMachineBuilder.builder();
109         builder.configureConfiguration().withConfiguration()
110                 .taskExecutor(new SyncTaskExecutor())
111                 .beanFactory(new StaticListableBeanFactory())
112                 .autoStartup(true);
113         //配置状态
114         builder.configureStates()
115                 .withStates()
116                 .initial(state)
117                 .states(EnumSet.allOf(State.class));
118         //配置状态转移
119         StateMachineTransitionConfigurer<State, FeatureEvent> transition = builder.configureTransitions();
120         for(FeatureEvent event:FeatureEvent.values()) {
121             transition = transition.withExternal()
122                     .source(event.reviewState())
123                     .target(event.nextState())
124                     .event(event)
125                     .and();
126         }
127         return builder.build();
128     }
129
130 }

从Review的状态转移实现主要依赖 buildSyncMachine()方法，在 buildSyncMachine()方法里使用Spring Statemachine（的使用在本文不作描述）实现了第2部分描述的状态转移语义，定义状态和状态转移事件。fireEvent(FeatureEvent event)是触发review发生状态转移的动作，其中主要是实现对拒绝动作和状态正确转移地操作。

4.2，调用接口设计

ReviewServiceImpl.java

 1 import org.springframework.beans.factory.annotation.Autowired;
 2 import org.springframework.stereotype.Service;
 3 import org.springframework.transaction.annotation.Transactional;
 4 import java.util.List;
 5
 6 /**
 7 * @author shenjixiaodao
 8 */
 9 @Service
10 public class ReviewServiceImpl implements ReviewService {
11
12     @Autowired
13     private ReviewRepository repository;
14
15     @Transactional
16     public void review(Review review) {
17         //// FIXME: 2017/7/10 检查资产是否存在
18         Review lastReview = repository.findLastUpdated(review.asset().getId());
19         boolean accept = review.state(lastReview.state()).fire();
20         if(!accept) return;
21         repository.save(review);
22     }
23
24 }

如上ReviewServiceImpl.java源码所示，定义了一个ReviewService#review(Review)接口来执行所有评审动作。从review(Review)的实现源码看，在触发状态转移之前，我需要从数据库中恢复Review当前所处的状态。最后如果状态迁移成功，则将Review持久化存储。

时间： 2024-10-27 11:50:20

易拓展、易修改的状态流程设计和实现

易拓展、易修改的状态流程设计和实现的相关文章

System Center 2012 R2 POC部署之Orchestrator设计监控DHCP服务状态流程

佩特来项目经验小集合(5)___系统流程设计

流程设计--页面介绍

流程设计--引擎理念

流程设计-流程模式

流程设计（抽象节点法）

审核流(2)流程设计-SNF.WorkFlow功能使用说明--SNF快速开发平台3.1

流程中心使用详情（三）流程设计

jQuery+jsPlumb简易流程设计