社区编辑申请
注册/登录
干掉项目中杂乱的 if-else,试试状态模式,这才是优雅的实现方式!
开发 后端
原来以为写一个简单的类型翻译器花不了太多时间,可是真做起来,才发现要注意的点太多了。

 IF-ELSE 方式

原来以为写一个简单的类型翻译器花不了太多时间,可是真做起来,才发现要注意的点太多了。

首先是处理容器的开启和闭合,这就需要使用栈来保存预期的下一个字符类型,再对比栈顶字符类型和当前处理字符,决定解析的结果。

还要注意类型嵌套的情况下,内层嵌套的容器作为外层容器的元素被解析完成时,需要修改外层容器的预期字符。而且 Map 作为一种相对 Set 和 List 比较特殊的容器,还要处理它的左右元素。同时还不能忘记处理各种异常,如未知字符、容器内是原始类型、容器未正确闭合等。

而这些逻辑混杂在一块就更添复杂度了,通常是一遍代码写下来挺顺畅,找几个特殊的 case 一验证,往往就有没有考虑到的点,你以为解决了这个点就好了,殊不知这个问题点的解决方案又引起了另一个问题。

最终修修补补好多次,终于把代码写完了,连优化的想法都没了,担心又引入新的问题。更多 Java 核心技术教程:https://github.com/javastacks/javastack,一起来学习吧。

最终的伪代码如下: 

  1. public String parseToFullType() throws IllegalStateException {  
  2.     StringBuilder sb = new StringBuilder();  
  3.     for (; ; this.scanner.next()) {  
  4.         Character currentChar = scanner.current();  
  5.         if (currentChar == '\uFFFF') {  
  6.             return sb.toString();  
  7.         }  
  8.         if (isCollection()) {  
  9.             if (CollectionEnd()) {  
  10.                 dealCollectionEleEnd();  
  11.             }else {  
  12.                 throw new IllegalStateException("unexpected char '" + currentChar + "' at position " + scanner.getIndex());  
  13.             }  
  14.         } else if (isWrapperType()) {  
  15.             dealSingleEleEnd();  
  16.         } else if (parseStart()) {  
  17.             if (collectionStart()) {  
  18.                 putCollecitonExpectEle()  
  19.             }  
  20.         } else {  
  21.             throw new IllegalStateException("unknown char '" + currentChar + "' at position " + scanner.getIndex());  
  22.         }  
  23.     }    

状态机方式

是不是看起来非常乱,这还没有列出各个方法里的条件判断语句呢。这么多逻辑混杂,造成的问题就是很难改动,因为你不知道改动会影响哪些其他逻辑。

面对这种问题,当然有一套被反复使用、多数人知晓的、经过分类编目的、代码设计经验的总结,就是状态机。

状态机

有限状态机(finite-state machine,缩写:FSM)又称有限状态自动机(finite-state automation,缩写:FSA),简称状态机,是表示有限个状态以及在这些状态之间的转移和动作等行为的数学计算模型。

像我们生活中在公路上驾驶汽车就像在维护一个状态机,遇到红灯就停车喝口水,红灯过后再继续行车,遇到了黄灯就要减速慢行。而实现状态机前要首先明确四个主体:

  •  状态 State:状态是一个系统在其生命周期的某一刻时的运行状态,如驾车的例子中状态就包括 正常速度行驶、停车和低速行驶三种状态。
  •  事件 Event:事件就是某一时刻施加于系统的某个信号,在上面的例子中事件是指红灯、绿灯和黄灯。所有的状态变化都要依赖事件,但事件也可能导致状态不发生变化,如正常行驶中遇到绿灯就不用做什么反应。
  •  变换 Transition:变换是在事件发生之后系统要做出的状态变化,如上面例子中的减速、停车或加速。
  •  动作 Action:动作是同样是事件发生之后系统做出的反应,不同的是,动作不会改变系统状态,像驾车遇到红灯停车后,喝水这个动作没有对系统状态造成影响。

将状态机的四种要素提取之后,就可以很简单地将状态和事件进行解耦了。

状态拆分

还是拿我的这个需求来分析,先画出状态变化图从整体上把握状态间的关系。

通过上面的图一步步拆解状态机:

    1. 首先是确定状态,我定义了 Start/SetStart/SetEle/ListStart/ListEel/MapStart/MapLeft/MapRight 八种基础状态,由于一次只解析一个类型,容器闭合就代表着解析结束,所以没有对各个容器设置结束状态。又因为有状态嵌套的存在,而一个状态没法表达状态机的准确状态,需要使用栈来存储整体的解析状态,我使用这个栈为空来代表 End 状态,又省略了一个状态。

    2. 再拆分事件,事件是扫描到的每一个字符,由于字符种类较多,而像 integer 和 double、String 和 Long 的处理又没有什么区别,我将事件类型抽象为 包装类型元素(WRAPPED_ELE),原始类型元素(PRIMITIVE_ELE),MAP、List 和 Set 五种。

    3. 变幻和动作都是事件发生后系统的反应,在我的需要里需要转变解析状态,并将结构结果保存起来。这里我将它们整体抽象为一个事件处理器接口,如: 

  1. public interface StateHandler {  
  2.     /**  
  3.      * @param event 要处理的事件  
  4.      * @param states 系统整体状态  
  5.      * @param result 解析的结果  
  6.      */  
  7.     void handle(Event event, Stack<State> states, StringBuilder result);  

代码示例

将状态机的各个要素都抽出来之后,再分别完善每个 StateHandler 的处理逻辑就行,这部分就非常简单了,下面是 MapLeftHandler 的详情。 

  1. public class MapLeftHandler implements StateHandler {  
  2.     @Override  
  3.     public void handle(Event event, Stack<State> states, StringBuilder result) {  
  4.         // 这里是核心的 Action,将单步解析结果放到最终结果内  
  5.         result.append(",");  
  6.         result.append(event.getParsedVal());  
  7.         // 状态机的典型处理方式,处理各种事件发生在当前状态时的逻辑  
  8.         switch (event.getEventType()) {  
  9.             case MAP:  
  10.                 states.push(State.MAP_START);  
  11.                 break;  
  12.             case SET:  
  13.                 states.push(State.SET_START);  
  14.                 break;  
  15.             case LIST:  
  16.                 states.push(State.LIST_START);  
  17.                 break;  
  18.             case WRAPPED_ELE:  
  19.                 // 使用 pop 或 push 修改栈顶状态来修改解析器的整体状态  
  20.                 states.pop();  
  21.                 states.push(State.MAP_RIGHT);  
  22.                 break;  
  23.             case PRIMITIVE_ELE:  
  24.                 // 当前状态不能接受的事件类型要抛异常中断  
  25.                 throw new IllegalStateException("unexpected primitive char '" + event.getCharacter() + "' at position " + event.getIndex());  
  26.             default:  
  27.         }  
  28.     }  

主类内的代码如下: 

  1. public static String parseToFullType(String shortenType) throws IllegalStateException {  
  2.     StringBuilder result = new StringBuilder();  
  3.     StringCharacterIterator scanner = new StringCharacterIterator(shortenType);  
  4.     Stack<State> states = new Stack<>();  
  5.     states.push(State.START);  
  6.     for (; ; scanner.next()) { 
  7.         char currentChar = scanner.current();  
  8.         if (currentChar == '\uFFFF') {  
  9.             return result.toString();  
  10.         }  
  11.         // 使用整体状态为空来代表解析结束  
  12.         if (states.isEmpty()) {  
  13.             throw new IllegalStateException("unexpected char '" + currentChar + "' at position " + scanner.getIndex());  
  14.         }  
  15.         // 将字符规整成事件对象,有利于参数的传递  
  16.         Event event = Event.parseToEvent(currentChar, scanner.getIndex());  
  17.         if (event == null) {  
  18.             throw new IllegalStateException("unknown char '" + currentChar + "' at position " + scanner.getIndex());  
  19.         }  
  20.         // 这里需要一个 Map 来映射状态和状态处理器  
  21.         STATE_TO_HANDLER_MAPPING.get(states.peek()).handle(event, states, result);  
  22.     }  
  23.  

小结

状态模式

如果你对设计模式较熟的话,会发现这不就是状态模式嘛。

有解释说,状态模式会将事件类型也再解耦,即 StateHandler 里不只有一个方法,而是会有八个方法,分别为 handleStart,HandleListEle 等,但我觉得模式并不是定式,稍微的变形是没有问题的,如果单个事件类型的处理足够复杂,将其再拆分更合理一些。

代码结构

最后,对比 if-else 实现,从代码量上来看,状态机实现增加了很多,这是解耦的代价,当然也有很多重复代码的缘故,比如在容器闭合时校验当前容器是否内嵌容器,并针对内嵌容器做处理的逻辑就完全一样,为了代码清晰我就没有再抽取方法。

从可维护性上来说,状态机实现由于逻辑拆分比较清晰,在添加或删除一种状态时比较方便,添加一个状态和状态处理器就行,但在添加一种事件类型时较为复杂,需要修改所有状态处理器里的实现,不过从整体上来看是利大于弊的,毕竟代码清晰易改动最重要。

了解了状态机实现的固定套路之后,你也可以写出高大上的状态机代码了,快 Get 起来替换掉项目里杂乱的 if-else 吧。 

 

责任编辑:庞桂玉 来源: Hollis
相关推荐

2021-01-04 05:46:08

代码编程重构

2022-06-14 10:49:33

代码优化Java

2022-07-11 08:16:55

2022-04-12 07:32:40

2021-05-17 14:57:23

策略模式代码

2019-11-26 10:07:10

业务开发逻辑

2019-04-25 14:25:24

Spring Bootif elseJava

2020-07-17 13:01:44

If-Else代码编程

2020-04-09 08:29:50

2019-11-19 09:43:41

技术代码开发

2021-01-29 07:45:27

if-else代码数据

2021-11-04 08:53:00

2019-11-19 16:10:24

2021-06-05 05:11:52

2019-09-30 11:00:42

2020-12-29 09:16:36

程序员对象开发

2019-10-22 09:11:50

策略业务代码

2021-11-16 07:02:05

2021-10-27 09:10:50

2020-04-20 15:40:03

if-elseJava优化

同话题下的热门内容

八个流行的 Python 可视化工具包,你喜欢哪个?太赞了! 菜鸟利用Python实现网站自动签到Python办公自动化,五分钟掌握openpyxl操作!跟着 Guava 学 Java 之 不可变集合速度起飞!替代 pandas 的八个神库如何在 Windows 上写 Python 代码?优秀攻略来袭!浅谈Python+requests+pytest接口自动化测试框架的搭建C开发中段错误的三种调试方法

编辑推荐

使用Kotlin做开发一个月后的感想面试官问你什么是消息队列?把这篇甩给他!五大自动化测试的Python框架图文详解两种算法:深度优先遍历(DFS)和广度优先遍历(BFS)2018年最流行的十大编程语言,其中包括你用的语言吗?
我收藏的内容
点赞
收藏

AISummit人工智能大会