pqc
/
new-demo
1
1
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Page: State和Action的定义与作用
Pages
初识Oak框架 Checker和Trigger State和Action的定义与作用
1 State和Action的定义与作用
Pan Qiancheng edited this page 2024-10-31 17:14:36 +08:00
Unescape Escape
Table of Contents
This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

State和Action

前置知识

这里涉及到很多的ts语法，注意参考线上文档：【TypeScript】TS中常见的9种操作符&运算符（八）_ts 操作符-CSDN博客

什么是State

State是实体的一种属性，通常表示一种状态，比如以下：

  • 一篇文章的发布状态（1
    • 未发布，已发布，已撤回
  • 一篇文章的置顶状态（2
    • 已置顶，未置顶
  • 评论的申请状态（3
    • 待提交，已提交，通过，未通过
  • 等等等等

如何定义一个State

了解：在传统开发模式下

在传统的前后端开发模式下，我们实际上认为一类State其实就是这个数据库表中的一个字段，比如

  • 看（1
    • 实际上是文章中的publishState这个字段，取值是枚举
  • 看（2
    • 实际上是文章中的isTop这个字段，取值可以是boolean
  • 看（3
    • 实际上是评论的applyState这个字段，取值是枚举

比如我们在Demo项目中的Essay实体中，就有这么一个属性：

​ image-20241031162613970

这就是一种传统的定义方式，在实体的属性中添加isTop这个字段，然后去调用update去更新这个属性

在Oak框架中定义一个State（需要熟悉）

我们只需要在实体定义中，导出一个类型，里面去定义状态值的枚举即可，如下：

  • image-20241031163508522

  • 然后在State的类型中，添加上这个新的state，比如：

  • image-20241031163608488

  • (这里的写法是联合类型（Union Types），表示取值可以为多种类型中的⼀种)

什么是Action

在oak框架中，Action其实就是用户的行为（具体的某一个业务行为），比如用户对你的文章点赞，用户对你进行关注。

这些一般情况下会表现为前端的一个按钮，我所定义的按钮点击之后的行为，就是一个Action

在Oak中编写一个Action

  • Action的编写与State类似，如下：
    • image-20241031164155501
    • 首先定义一个类型，其取值表示具体的Action名称，比如这里的enable就是启用，disable就是禁用，EnabledAction表示这一套Action的作用是启用或者禁用（取一个容易记忆的名字，方便后面编程）
    • 然后将这个类型联合到Action定义中即可

State和Action相结合，实现状态转移

  • 前面我们提到了State和Action，我们很容易发现，一般情况下，通常都是一个或者多个State下，可以执行某一项Action，从而使当前的State转换为另一个State（这里需要理解一下，就比如点击发布按钮之后从未发布变成已发布,同理在已撤回的文章上点击发布按钮，也可以转换为已发布)
  • 举个例子：
    • 一篇文章的置顶与否
      • 初始状态为未置顶
      • 执行名为setTop的Action之后，会从未置顶 -> 已置顶
      • 执行名为cancelTop的Action之后，会从已置顶 -> 未置顶
  • 这里的文章置顶状态是一套State，文章的setTop和cancelTop是一套Action，他们之间是强关联的，可以说这一套的State和Action就是相伴而生的，我的Action就是为了转换State的值，而State的值又限制了到底能执行哪个Action。

在Oak框架中定义这种状态转移

  • 不难得知，我们定义State和Action的关联，需要以下这几个值

    • 初始状态（Initial state）
    • 转移矩阵（State transition matrix）
      • 前一个状态 ---一个具体行为---> 后一个状态
      • 前一个状态 ---一个具体行为---> 后一个状态
      • 前一个状态 ---一个具体行为---> 后一个状态

  • 所以我们就以下面的形式进行定义：

    • image-20241031165144565
    • 这里的stm就是状态转移矩阵，里面的参数名指的就是动作的名称，后面的元组中定义的就是可以从什么状态，转移到什么状态
    • 比如这里的publish，其可以从未发布或者已撤回的状态转移为已发布
    • 这里的withdraw，可以从已发布转换为已撤回

  • 注意这里的Action和State具有一定的命名规范，具体的规范是这样的：

  • Action的名称必须为xxxAction，以大写开头

  • State的名称必须为xxxState，以大写开头

  • 转移方程的定义中，export const的变量名必须是：xxxActionDef，xxx以大写开头

在entity中应用这个状态

当我们定义完这个State之后，别忘了在EntityDesc中引用这个具体的状态信息，其会被作为entity的属性之一

image-20241031171052410

State和Action组合写法的优势

  1. 避免了根据state去检查action的Checker的编写。
  2. 避免了action相关的Trigger的编写。
  3. 统一了行为的名称和State的检查
  4. 统一的Action的定义颜色和不同State的状态名称以及颜色

小任务

现在项目中的Essay实体中的isTop属性，还是传统的属性定义方式，并且编写了checker和trigger去实现，还有一些projection用到了这个属性。

现在请你将Essay实体中的isTop属性删除，修改为State和Action的定义形式。