前言
在现代化 Web 开发中,JavaScript 是必不可少的一环。前端框架的涌现让前端的开发效率大大提高,但是,仍然有很多复杂的业务场景需要我们自己去实现。而有一款强大的 npm 包 jssm 可以帮助我们更加便捷地完成这些复杂的业务场景开发。本篇文章将会详细介绍 npm 包 jssm 的使用教程。
简介
jssm 是一个基于 JavaScript 的开源状态机库,它允许我们用状态机的方式去描述复杂的业务逻辑,从而让我们可以更加简单地实现这些逻辑。jssm 具有以下特点:
- 开源免费:我们可以在任何场景下免费使用
jssm。 - 对面向对象编程友好:我们可以在
jssm中使用类似 OOP 中的概念,从而更好地封装业务逻辑。 - 代码易读、易扩展:使用
jssm,我们可以将复杂的逻辑切分成一些轻松理解的状态,从而让代码更易读、易扩展。 - 可视化工具友好:
jssm提供了多种可视化工具,可以方便地将我们的状态机图形化。
使用教程
接下来,我们将具体介绍如何使用 jssm。
安装
我们可以通过 npm 来安装 jssm,命令为:
npm install jssm
安装完毕后,我们就可以在代码中使用 jssm 了。
基本概念
在 jssm 中,我们可以通过 State 类来定义状态,如:
-- -------------------- ---- -------
----- - ----- - - ---------------
----- ----------- - --- -------
----- ---------
------------ -
- ------- --------- --- ------------- -
-
--
----- ------------- - --- -------
----- -----------
------------ -
- ------- --------- --- ----------- -
-
--在这个状态机中,我们定义了一些状态(lockedState 和 unlockedState),并通过 transitions 属性来描述它们之间的转换规则。例如,从 lockedState 状态,当有一个 coin 的输入时,我们将会进入 unlockedState 状态。
接下来,我们需要将这些状态组装成一个状态机:
const { Machine } = require('jssm')
const vendingMachine = new Machine({
startState: lockedState,
states: [lockedState, unlockedState],
name: 'vendingMachine'
})在上述代码中,我们通过 Machine 类来组装状态机,将 lockedState 和 unlockedState 作为参数传入,并将 lockedState 指定为状态机的初始状态。
输入输出
我们可以通过 step 方法来对状态机进行步进操作(输入一个事件):
const { input } = require('jssm/helpers')
const result = vendingMachine.step(input('coin')) // 此时从 lockedState 会转换到 unlockedState输入 coin 后,状态机会从 lockedState 转移到 unlockedState 状态。
除了 step 方法外,jssm 还提供了一些其他有用的方法,例如 isState 方法(判断一个变量是否是一个状态)、isMachine 方法(判断一个变量是否是一个状态机)。
此外,我们还可以通过 sm_log 方法打印当前状态机的状态:
const { sm_log } = require('jssm/helpers')
sm_log(vendingMachine) // 此时会输出状态信息实际场景示例
下面,我们来模拟一个简单的购物车场景。假设我们有一个购物车,在购物车中,我们可以添加、删除商品,结算等操作。那么我们可以将不同的操作抽象成不同的状态,并将它们组合成一个状态机。
我们可以首先定义一些状态,例如:
-- -------------------- ---- -------
----- ---------- - --- -------
----- --------
------------ -
- ------- -------- --- ------------ --
- ------- ----------- --- --------------- --
- ------- ------------- --- ------------- --
-
--
----- ------------ - --- -------
----- ----------
------------ -
- ------- ----------- --- ---------- --
- ------- ----------- --- ---------- -
-
--
----- --------------- - --- -------
----- -------------
------------ -
- ------- ----------- --- ---------- --
- ------- ----------- --- ---------- -
-
--
----- ------------- - --- -------
----- -----------
------------ -
- ------- ----------- --- ---------- --
- ------- -------- --- ------------ -
-
--
----- ------------ - --- -------
----- ----------
------------ -
- ------- ------------ --- ------------ --
- ------- --------- --- --------- --
-
--
----- ------------ - --- -------
----- ----------
------------ --
--
----- --------- - --- -------
----- -------
------------ --
--在这个状态机中,我们定义了 cartsState 作为购物车的初始状态,并定义了如何添加、删除、结算购物车的状态。其中,根据操作的不同,购物车会跳转不同的状态。例如,当我们从 cartsState 中触发了 add 事件,则状态机会跳转到 addItemState 状态。
接下来,我们将这些状态组装成购物车状态机:
-- -------------------- ---- -------
----- ------------ - --- ---------
----------- -----------
------- -
-----------
-------------
----------------
--------------
-------------
-------------
---------
--
----- --------------
--最后,我们可以根据实际的业务需求来进行状态机的操作:
shoppingCart.step(input('add')) // 添加商品
shoppingCart.step(input('commit')) // 提交添加操作
shoppingCart.step(input('checkout')) // 触发结算操作
shoppingCart.step(input('cancel')) // 取消结算操作总结
至此,我们已经学习了 jssm 的基本使用方法,包括如何定义状态和状态机、如何输入输出、以及一个具体的实际场景示例。
通过使用 jssm,我们可以将复杂的逻辑拆分成易于理解的状态,从而更好地封装业务逻辑,提高代码的易读性和可扩展性。同时,状态机的可视化工具也可以方便我们更好地理解整个流程。
在实际开发中,我们可以根据具体的业务需求,用 jssm 来描述不同的场景,并将其实现成一个可复用的状态机,从而便捷地完成业务逻辑实现。
Source: FunTeaLearn,Please indicate the source for reprints https://funteas.com/post/64401